Citrix Virtual Apps and Desktops SDK

Export-ProvMachineProfile

August 9, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Get the machine profile of a prov scheme.

Syntax

Export-ProvMachineProfile
      [-ProvisioningSchemeUid <Guid>]
      [[-ProvisioningSchemeName] <String>]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

The primary use of this cmdlet is to export the machine profile contents for a provisioning scheme.

Examples

EXAMPLE 1

Exports the deparameterized machine profile for the provisioning scheme with the name “catalog”.

Export-ProvMachineProfile -ProvisioningSchemeName "catalog"
<!--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:	False

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

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

-ProvisioningSchemeName

The name of the provisioning scheme.

Type:	String
Position:	2
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

String

A JSON encoded string representing a deparameterized copy of the provisioning scheme’s machine profile.

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.

MachineProfileDoesNotExist

The catalog does not have a machine profile.

CapabilityNotSupported

The hypervisor does not support machine profile export.

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-ProvMachineProfile

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Export-ProvMachineProfile

Syntax

Description

Examples

EXAMPLE 1

Parameters

-ProvisioningSchemeUid

-LoggingId

-ProvisioningSchemeName

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

String

Notes

Related Links

In this article