Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-ProvVM

August 3, 2023
Contributed by: 
C

Gets the VMs created using Machine Creation Services.

Syntax


Get-ProvVM [[-ProvisioningSchemeName] <String>] [-ProvisioningSchemeUid <Guid>] [-VMName <String>] [-Locked <Boolean>] [-Tag <String>] [-OutOfDate] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to obtain a list of the VMs that were created using Citrix Machine Creation Services.

Parameters

Name Description Required? Pipeline Input Default Value
ProvisioningSchemeName The name of the provisioning scheme. false false  
ProvisioningSchemeUid The unique identifier of the provisioning scheme. false false  
VMName The name of the VM in the hypervisor. false false  
Locked Indicates whether only VMs that are marked as locked are returned or not (see Lock-ProvVM and Unlock-ProvVM for details). false false  
Tag The tag string that was associated with the VM when it was locked. false false  
OutOfDate Indicates that the image currently assigned to the VM is out of date. The image will be updated the next time the VM is restarted. false false  
ReturnTotalRecordCount See about_Prov_Filtering for details. false false false
MaxRecordCount See about_Prov_Filtering for details. false false false
Skip See about_Prov_Filtering for details. false false 0
SortBy See about_Prov_Filtering for details. false false  
Filter See about_Prov_Filtering for details. false false  
FilterScope Gets only results allowed by the specified scope id. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing user false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress The address of a Citrix Virtual Apps and Desktops controller that the PowerShell snap-in connects to. You can provide this as a host name or an IP address. false false LocalHost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

Citrix.Machinecreation.Sdk.Provisionedvirtualmachine

The object has the following properties:

  • ADAccountSid &lt;string&gt; The SID of the AD computer account that the VM is using.

  • ADAccountName &lt;string&gt; The name of the AD computer account that the VM is using.

  • CpuCount &lt;int&gt; The number of processors allocated to the VM.

  • CreationDate &lt;DateTime&gt; The date and time when the VM was created.

  • Domain &lt;string&gt; The Domain of the AD computer account that the VM is using.

  • ImageOutOfDate &lt;bool&gt; Indicates if the image will be updated next time the VM is started.

  • Lock &lt;bool&gt; Indicates whether the VM is locked or not.

  • MemoryMB &lt;int&gt; The maximum amount of memory allocated to the VM.

  • ProvisioningSchemeName &lt;string&gt; The name of the provisioning scheme associated with the VM.

  • ProvisioningSchemeUid &lt;Guid&gt; The unique identifier of the provisioning scheme associated with the VM.

  • ProvisioningSchemeUpdateRequested &lt;DateTime&gt; If the time span for this VM been powered on exceeds this time length, an update will take place to match the current state of the provisioning scheme.

  • ProvisioningSchemeVersion &lt;int&gt; The version of the provisioning scheme currently used by this VM.

  • Tag &lt;string&gt; Provides the string associated with a locked VM.

  • VMId &lt;string&gt; The identifier for the VM in the hypervisor.

  • VMName &lt;string&gt; The name of the VM in the hypervisor.

  • AssignedImage &lt;string&gt; The identifier (in the hypervisor) for the hard disk image that the VM is currently assigned.

  • BootedImage &lt;string&gt; The identifier (in the hypervisor) for the hard disk image with which the VM is currently started.

  • HostingUnitUid &lt;Guid&gt; The unique identifier of the hosting unit that was used to create the VM.

  • HypervisorConnectionUid &lt;Guid&gt; The unique identifier of the hypervisor connection that was used to create the VM.

  • IdentityDiskIndex &lt;int&gt; The disk index on which the identity disk is attached.

  • LastBootTime &lt;DateTime&gt; The date and time of the last start of the VM.

  • OSDiskIndex &lt;int&gt; The disk index on which the hard disk image, from which the VM is currently started, is attached. It is set to [int]::MinValue for VMs inherited from versions of XenDesktop 5.6 or earlier.

  • PersonalVDiskIndex &lt;int&gt; The disk index on which the personal vdisk is attached. Defaults to [int]::MinValue for VMs without a personal vDisk.

  • PersonalVDiskStorage &lt;string&gt; The identifier (in the hypervisor) for the storage on which the personal vDisk image attached to the VM is located. This is set only if the VM has a personal vDisk attached.

  • StorageId &lt;string&gt; The identifier (in the hypervisor) for the storage on which the hard disk image, from which the VM is currently started, is located.

  • NetworkMaps &lt;Citrix.MachineCreation.Sdk.NetworkMap[]&gt; The NIC/network mappings Used to create the VM.

  • IdentityDiskId &lt;string&gt; The identifier (in the hypervisor) for the identity disk attached to the VM.

  • IdentityDiskStorage &lt;string&gt; The identifier (in the hypervisor) for the storage on which the identity disk image from which the VM is currently started is located.

  • PersonalVDiskId &lt;string&gt; The identifier (in the hypervisor) for the personal vDisk attached to the VM. This is set only if the VM has a personal vDisk attached.

  • SecurityGroups &lt;string[]&gt; The security groups that has been applied to the VM. This only applies in a Cloud provisioning context.

  • AdditionalStorage &lt;System.Collections.Generic.Dictionary[string, AdditionalStorageDiskImage]&gt; Additional storage disk images attached to this VM keyed by their storage tier names.

  • WriteBackCacheMemorySize &lt;int&gt; The size of the write-back memory cache if specified in MB.

  • UseFullDiskCloneProvisioning &lt;bool&gt; Indicates if the VM was created using the dedicated full disk clone feature.

  • CustomVmData &lt;string&gt; Hypervisor specific custom data packet that has been associated with the virtual machine if any.

  • WorkgroupMachine &lt;bool&gt; Indicates if the VM is joined to a workgroup.

Notes

In the case of failure, the following errors can result.

  • PartialData: Only a subset of the available data was returned.

  • CouldNotQueryDatabase: The query required to get the database was not defined.

  • PermissionDenied: The user does not have administrative rights to perform this operation.

  • ConfigurationLoggingError: The operation could not be performed because of a configuration logging error CommunicationError An error occurred while communicating with the service.

  • DatabaseNotConfigured: The operation could not be completed because the database for the service is not configured.

  • InvalidFilter: A filtering expression was supplied that could not be interpreted for this cmdlet.

  • ExceptionThrown: An unexpected error occurred.

For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops logs.

Examples

Example 1 


C:\PS>Get-ProvVM -provisioningSchemeName MyScheme

ADAccountName                     : MYDomain\computer2$

ADAccountSid                      : S-1-5-21-3751941309-1176885247-1409628468-3179

CpuCount                          : 1

CreationDate                      : 17/05/2021 09:35:22

Domain                            : steve.dum.local

ImageOutOfDate                    : False

Lock                              : True

MemoryMB                          : 512

ProvisioningSchemeName            : XenPS

ProvisioningSchemeUid             : 5135a865-ba49-4e5f-87f2-2d65ee7a4e51

ProvisioningSchemeUpdateRequested : 17/05/2021 09:39:03

ProvisioningSchemeVersion         : 1

Tag                               : Brokered

VMId                              : a830de93-ddc5-b763-dc1a-35580a31401c

VMName                            : IP0051

AssignedImage                     : 57fc60c3-eb9b-4d38-8646-0afceec85335

BootedImage                       : 57fc60c3-eb9b-4d38-8646-0afceec85335

HostingUnitUid                    : ea17840f-cf2d-4d80-94e0-3b752b32e0af

HypervisorConnectionUid           : 99f9f826-31fc-4453-8ca0-9ba54306c3ac

IdentityDiskIndex                 : 1

LastBootTime                      : 17/05/2021 09:35:22

OSDiskIndex                       : 0

PersonalVDiskIndex                : -2147483648

PersonalVDiskStorage              :

StorageId                         : 33ad07a7-edd7-589b-716a-86cad4739f5e

NetworkMaps                       : {0}

IdentityDiskId                    : MCS-IdentityDisk-0001

IdentityDiskStorage               : {XDHyp:\Connections\XDHost\Local-Storage-For-Identity-Disk.Storage}

PersonalVDiskId                   :

SecurityGroups                    : {}

AdditionalStorage                 : {}

WriteBackCacheMemorySize          : 0

UseFullDiskCloneProvisioning      : False

CustomVmData                      :

WorkgroupMachine                  : False

<!--NeedCopy-->

Description

Gets all the Virtual Machines that were provisioned using the Provisioning Scheme called ‘MyScheme’.

Example 2 


C:\PS>Get-ProvVM -Locked $true

ADAccountName                     : MYDomain\computer1$

ADAccountSid                      : S-1-5-21-3751941309-1176885247-1409628468-3178

CpuCount                          : 1

CreationDate                      : 17/05/2021 09:35:30

Domain                            : steve.dum.local

ImageOutOfDate                    : False

Lock                              : True

MemoryMB                          : 512

ProvisioningSchemeName            : XenPS

ProvisioningSchemeUid             : 5135a865-ba49-4e5f-87f2-2d65ee7a4e51

ProvisioningSchemeUpdateRequested : 17/05/2021 09:39:03

ProvisioningSchemeVersion         : 1

Tag                               : Brokered

VMId                              : a830de93-ddc5-b763-dc1a-35580a31401c

VMName                            : IP0051

AssignedImage                     : 57fc60c3-eb9b-4d38-8646-0afceec85335

BootedImage                       : 57fc60c3-eb9b-4d38-8646-0afceec85335

HostingUnitUid                    : ea17840f-cf2d-4d80-94e0-3b752b32e0af

HypervisorConnectionUid           : 99f9f826-31fc-4453-8ca0-9ba54306c3ac

IdentityDiskIndex                 : 1

LastBootTime                      : 17/05/2021 09:35:22

OSDiskIndex                       : 0

PersonalVDiskIndex                : -2147483648

PersonalVDiskStorage              :

StorageId                         : 33ad07a7-edd7-589b-716a-86cad4739f5e

NetworkMaps                       : {0}

IdentityDiskId                    : MCS-IdentityDisk-0001

IdentityDiskStorage               : {XDHyp:\Connections\XDHost\Local-Storage-For-Identity-Disk.Storage}

PersonalVDiskId                   :

SecurityGroups                    : {}

AdditionalStorage                 : {}

WriteBackCacheMemorySize          : 0

UseFullDiskCloneProvisioning      : False

CustomVmData                      :

WorkgroupMachine                  : False

<!--NeedCopy-->

Description

Gets all the Virtual Machines that were locked, regardless of which Provisioning Scheme the VM was created with.

Get-ProvVM
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.