Citrix Virtual Apps and Desktops SDK

Export-ProvScheme

August 9, 2024

Contributed by:

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

Syntax

Export-ProvScheme
      -ProvisioningSchemeName <String>
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Export-ProvScheme
      -ProvisioningSchemeUid <Guid>
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

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
<!--NeedCopy-->

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

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

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.

Error Codes

ProvisioningSchemeNotFound

The specified provisioning scheme could not be located.

ProvisioningSchemeNotReady

The specified provisioning scheme is not in Ready state.

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

Export-ProvScheme

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Export-ProvScheme

Syntax

Description

Examples

EXAMPLE 1

Parameters

-ProvisioningSchemeName

-ProvisioningSchemeUid

CitrixCommonParameters

CommonParameters

Inputs

Citrix.MachineCreation.Sdk.ProvisioningScheme

Outputs

String

Notes

Related Links

In this article