Get-ProvSchemeDetails

Last published : Oct 31, 2026
Introduced in: Citrix Virtual Apps and Desktop 7 2511
Gets details of a provisioning scheme created using Machine Creation Services.
Related information
about_ProvMachineCreationSnapIn

Syntax

Get-ProvSchemeDetails
   -ProvisioningSchemeUid <Guid>
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Get-ProvSchemeDetails
   -ProvisioningSchemeName <String>
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

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

Examples

EXAMPLE 1

Gets the provisioning scheme details of the provisioning scheme "myProvScheme1".
Get-ProvSchemeDetails -ProvisioningSchemeName "myProvScheme1"
ProvisioningSchemeUid      : 9ECE4E31-AA85-4CF2-80EB-C53F51CBD523
ProvisioningSchemeName     : myCatalog
ProvisioningSchemeVersion  : 3
DiskInfo                   : {
                               "WBCDisk": "",
                               "DataDisk": "",
                               "StorageType": "Standard_LRS",
                               "EphemeralOSDiskMode": "Disabled",
                               "DataDiskStorageType": "",
                               "EncryptionSetting": "",
                               "StorageTypeAtShutdown": "",
                               "FailSafeStorageType": true
                             }
ImageAndTemplateInfo       : {
                               "MachineProfile": "machineprofile.folder\\test.resourcegroup\\testMP.templatespec\\1.tem
                             platespecversion",
                               "SharedImageGallery": false
                             }
MCSIOInfo                  : {
                               "UseTempDisk": false,
                               "PersistWBC": false,
                               "PersistOsDisk": false,
                               "PersistVm": false
                             }
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
                             }
SecurityInfo               : {
                               "SecurityType": "",
                               "EnableSecureBoot": false,
                               "EnablevTPM": false,
                               "EncryptionAtHost": false
                             }
UseWriteBackCache          : False
SchemeInfo                 : {
                               "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
                             }

Parameters

-ProvisioningSchemeUid

The unique identifier of the provisioning scheme.
Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: True

-ProvisioningSchemeName

The name of the provisioning scheme. If empty
Type: String
Position: Named
Default value: None
Required: True
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

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

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.ProvisioningSchemeDetailsFull

The object has the following properties:
ProvisioningSchemeUid \&lt;string\>
The id of the provisioning scheme.
ProvisioningSchemeName \&lt;string\>
The Name of the provisioning scheme.
ProvisioningSchemeVersion \&lt;string\>
The version of the provisioning scheme.
DiskInfo \&lt;string\>
The disk information of the provisioning scheme in JSON format.
NetworkInfo \&lt;string\>
The network information of the provisioning scheme in JSON format.
MCSInfo \&lt;string\>
The MCS information of the provisioning scheme in JSON format.
ImageInfo \&lt;string\>
The image information of the provisioning scheme in JSON format.
SecurityInfo \&lt;string\>
The security information of the provisioning scheme in JSON format.
SchemeInfo \&lt;string\>
Other general information of the provisioning scheme 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.