Export-ProvScheme

Last published : Oct 31, 2026
Exports a provisioning scheme in the form of a JSON encoded string.
Related information
about_ProvMachineCreationSnapIn

Syntax

Export-ProvScheme
      -ProvisioningSchemeName <String>
      [-SkipCertificateValidation]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
Export-ProvScheme
      -ProvisioningSchemeUid <Guid>
      [-SkipCertificateValidation]
      [<CitrixCommonParameters>]
      [<CommonParameters>]

Description

The primary use of this cmdlet is to export a provisioning scheme and the VMs provisioned with this scheme. The exported JSON string can then be used to import this provisioning scheme and provisioned VMs into another site. The exported JSON string contains data about the provisioning scheme, image history, and provisioned VMs. However, it does not contain any AD accounts created during provisioning. Use cmdlet Export-AcctIdentityPool to export the identity pool containing those AD accounts.

Examples

EXAMPLE 1

Exports the provisioning scheme with the name MyScheme.
Export-ProvScheme -ProvisioningSchemeName MyScheme

Parameters

-ProvisioningSchemeName

The name of the provisioning scheme.
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-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

-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
Introduced in: Citrix Virtual Apps and Desktop 7 2511

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

Citrix.MachineCreation.Sdk.ProvisioningScheme

You can pipe an object containing a parameter called 'ProvisioningSchemeName' to Export-ProvScheme.

Outputs

A JSON encoded string describing the provisioning scheme, image history, and VMs created with the provisioning scheme.

Notes

In the case of failure, the following errors can result.
Error Codes
ProvisioningSchemeNotFound
The specified provisioning scheme could not be located.
ProvisioningSchemeNotReady
The specified provisioning scheme is not in Ready state.