Citrix Virtual Apps and Desktops SDK

Get-ProvVMDetails

August 9, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Gets details of a VM created using Machine Creation Services.

Syntax

Get-ProvVMDetails
   [-ProvisioningSchemeUid <Guid>]
   [[-ProvisioningSchemeName] <String>]
   [-VMName <String>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to view detailed information about VMs created using Citrix Machine Creation Services.

Examples

EXAMPLE 1

Gets the VM details of “myVM1” in provisioning scheme “myCatalog”.

Get-ProvVMDetails -ProvisioningSchemeName "catalog" -VMName "myVM1"        

CpuCount                   : 2
DiskInfo                   : {
                               "OSDisk": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/citrix-xd-
                             b8cbab4d-aa9e-4132-bff0-1315950a3c39-gwegq/providers/Microsoft.Compute/disks/myVM1-os
                             disk-1fywp",
                               "IdentityDisk": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/citr
                             ix-xd-b8cbab4d-aa9e-4132-bff0-1315950a3c39-gwegq/providers/Microsoft.Compute/disks/matspo-
                             mp1-IdentityDisk-c86l6",
                               "WBCDisk": "",
                               "DataDisk": "",
                               "StorageType": "Standard_LRS",
                               "EphemeralOSDiskMode": "Disabled",
                               "DataDiskStorageType": "",
                               "EncryptionSetting": "",
                               "StorageTypeAtShutdown": "",
                               "FailSafeStorageType": true
                             }
Identities                 : 
IdentityType               : Workgroup
ImageAndTemplateInfo       : {
                               "AssignedImage": "template:/subscriptions/00000000-0000-0000-0000-000000000000/resourceG
                             roups/citrix-xd-b8cbab4d-aa9e-4132-bff0-1315950a3c39-gwegq/providers/Microsoft.Compute/sna
                             pshots/myCatalog-baseDisk-p683p",
                               "BootedImage": "template:/subscriptions/00000000-0000-0000-0000-000000000000/resourceGro
                             ups/citrix-xd-b8cbab4d-aa9e-4132-bff0-1315950a3c39-gwegq/providers/Microsoft.Compute/snaps
                             hots/myCatalog-baseDisk-p683p",
                               "MachineProfile": "machineprofile.folder\\test.resourcegroup\\testMP.templatespec\\1.tem
                             platespecversion",
                               "SharedImageGallery": false
                             }
ImageOutOfDate             : False
LastBootTime               : 4/3/2024 8:46:19 PM
MCSIOInfo                  : {
                               "UseTempDisk": false,
                               "PersistWBC": false,
                               "PersistOsDisk": false,
                               "PersistVm": false
                             }
MemoryMB                   : 8192
Name                       : myVM1
NetworkInfo                : {
                               "NetworkInterfaceIds": [
                                 "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/citrix-xd-b8cbab4d
                             -aa9e-4132-bff0-1315950a3c39-gwegq/providers/Microsoft.Network/networkInterfaces/myVM1-ceu
                             pu-0"
                               ],
                               "AcceleratedNetworking": false
                             }
Persistent                 : True
ProvVMConfigurationVersion : 
ProvisioningSchemeName     : myCatalog
ProvisioningSchemeVersion  : 3
SecurityInfo               : {
                               "SecurityType": "",
                               "EnableSecureBoot": false,
                               "EnablevTPM": false,
                               "EncryptionAtHost": false
                             }
UseWriteBackCache          : False
VMInfo                     : {
                               "ProvisioningSchemeType": "MCS",
                               "Region": "eastus",
                               "HostGroup": "",
                               "MachineSize": "eastus/Standard_DS11_v2",
                               "LicenseType": "Windows_Client",
                               "AvailabilityZone": "",
                               "ResourceGroup": "citrix-xd-b8cbab4d-aa9e-4132-bff0-1315950a3c39-gwegq",
                               "SupportsHibernation": false
                             }
WindowsActivationType      : KeyManagementService
WriteBackCacheDiskSize     : 0
WriteBackCacheMemorySize   : 0
<!--NeedCopy-->

Parameters

-ProvisioningSchemeUid

The unique identifier of the provisioning scheme.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-VMName

The name of the virtual machine.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-ReturnTotalRecordCount

See about_Prov_Filtering for details.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxRecordCount

See about_Prov_Filtering for details.

Type:	Int32
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Skip

See about_Prov_Filtering for details.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SortBy

See about_Prov_Filtering for details.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Filter

See about_Prov_Filtering for details.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilterScope

Gets only results allowed by the specified scope id.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProvisioningSchemeName

The name of the provisioning scheme. If empty

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

Citrix.MachineCreation.Sdk.VMDetailsFull

The object has the following properties:

Name <string>

The Name of the VM.

ProvisioningSchemeName <string>

The name of the provisioning scheme.

CpuCount <int>

The number of CPUs.

MemoryMB <int>

The amount of memory in MB.

Persistent <bool>

The persistency setting of the VM.

IdentityType <string>

The identity type of the VM.

ProvisioningSchemeVersion <string>

The version of the provisioning scheme.

ImageOutOfDate <bool>

The image is out of date.

LastBootTime <datetime>

The last boot time of the VM.

UseWriteBackCache <bool>

The write back cache setting of the VM.

WriteBackCacheDiskSize <int>

The size of the write back cache disk.

WriteBackCacheMemorySize <int>

The size of the write back cache memory.

Identities <string>

The domain name or Azure AD tenant ID of the VM.

ProvVMConfigurationVersion <int>

The version of the VM configuration.

WindowsActivationType <string>

The Windows activation type of the VM.

DiskInfo <string>

The disk information of the VM in JSON format.

NetworkInfo <string>

The network information of the VM in JSON format.

MCSInfo <string>

The MCS information of the VM in JSON format.

ImageInfo <string>

The image information of the VM in JSON format.

SecurityInfo <string>

The security information of the VM in JSON format.

VMInfo <string>

Other general information of the VM in JSON format.

Notes

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

Error Codes

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.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-ProvVMDetails

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Get-ProvVMDetails

Syntax

Description

Examples

EXAMPLE 1

Parameters

-ProvisioningSchemeUid

-VMName

-ReturnTotalRecordCount

-MaxRecordCount

-Skip

-SortBy

-Filter

-FilterScope

-ProvisioningSchemeName

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.MachineCreation.Sdk.VMDetailsFull

Notes

Related Links

In this article