Export-ProvScheme¶

Exports a provisioning scheme in the form of a JSON encoded string.

Syntax¶

Export-ProvScheme -ProvisioningSchemeName <String> [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Export-ProvScheme -ProvisioningSchemeUid <Guid> [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

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

Parameters¶

Name	Description	Required?	Pipeline Input	Default Value
ProvisioningSchemeName	The name of the provisioning scheme.	true	true (ByPropertyName)
ProvisioningSchemeUid	The unique identifier of the provisioning scheme.	true	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Specifies the Client IP of 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 the PowerShell snap-in will connect 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¶

Citrix.Machinecreation.Sdk.Provisioningscheme¶

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

Return Values¶

System.String¶

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.

ProvisioningSchemeNotFound The specified provisioning scheme could not be located.

Examples¶

Example 1¶

C:\PS> Export-ProvScheme -ProvisioningSchemeName MyScheme

Description¶

Exports the provisioning scheme with the name MyScheme.