Skip to content

Test-Provschemenameavailable

Check if the proposed provisioning scheme name is unused.

Syntax

Test-ProvSchemeNameAvailable -ProvisioningSchemeName <String[]> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Provides the ability to validate if the proposed name for a provisioning scheme is unused. This check is not limited to scopes of existing provisioning schemes, therefore, the names of inaccessible schemes are also checked.

Parameters

Name Description Required? Pipeline Input Default Value
ProvisioningSchemeName The name or names of the provisioning scheme(s) to be tested. true true (ByValue, ByPropertyName)
BearerToken Specifies the bearer token assigned to 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 Test-ProvSchemeNameAvailable.

Return Values

Citrix.Machinecreation.Sdk.Nameavailability

Key value pairs of name and its availability.
Name <string> The provisioning scheme name to be tested. Available <bool> The availability of the name.

Notes

In the case of failure, the following errors can result.
Error Codes ----------- DatabaseError An error occurred in the service while attempting a database operation. DatabaseNotConfigured The operation could not be completed because the database for the service is not configured. ServiceStatusInvalidDb An error occurred in the service while attempting a database operation - communication with the database failed for for various reasons. CommunicationError An error occurred while communicating with the service. PermissionDenied The user does not have administrative rights to perform this operation. 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.

Examples

Example 1

Test-ProvSchemeNameAvailable -ProvisioningSchemeName $NewSchemeName  

Name      : NewScheme1  

Available : True

Description

This tests whether the value of \$NewSchemeName is unique or not, and can be used to create a new provisioning scheme or rename an existing one without failing. True is returned if the name is good.

Was this article helpful?