Citrix Virtual Apps and Desktops SDK

Remove-ProvSchemeControllerAddress

August 3, 2023

Contributed by:

Removes controller addresses from a provisioning scheme.

Syntax

Remove-ProvSchemeControllerAddress [-ProvisioningSchemeName] <String> [-ControllerAddress] <String[]> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-ProvSchemeControllerAddress -ProvisioningSchemeUid <Guid> -ControllerAddress <String[]> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Removes the specified controller addresses from the specified provisioning scheme.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ProvisioningSchemeName	The name of the provisioning scheme that controller addresses are to be removed from.	true	true (ByPropertyName)
ProvisioningSchemeUid	The unique identifier of the provisioning scheme that controller addresses are to be removed from.	true	false
ControllerAddress	Specifies the array of controller DNS names to be removed from the provisioning scheme.	true	true (ByPropertyName)
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.	false	false
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 that the PowerShell snap-in connects 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 Remove-ProvSchemeControllerAddress.

Return Values

Notes

In the case of failure, the following errors can result.

ProvisioningSchemeNotFound: The specified provisioning scheme could not be located.
ControllerAddressNotFound: The specified address was not associated with the provisioning scheme.
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.
ConfigurationLoggingError: The operation could not be performed because of a configuration logging error 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

C:\PS>Get-ProvScheme -ProvisioningSchemeName scheme1 | Remove-ProvSchemeControllerAddress

CleanOnBoot                  : True

ControllerAddress            : {}

CpuCount                     : 1

DiskSize                     : 20

HostingUnitName              : HostUnit1

HostingUnitUid               : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501

IdentityPoolName             : idPool1

IdentityPoolUid              : 03743136-e43b-4a87-af74-ab71686b3c16

MachineCount                 : 0

MachineProfile               :

MasterImageVM                : Base.vm/base.snapshot

MasterImageVMDate            : 17/05/2020 09:53:40

MemoryMB                     : 1024

Metadata                     : {Department = Sales}

MetadataMap                  : {[Department = Sales]}

ProvisioningSchemeUid        : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501

ProvisioningSchemeName       : Scheme2

ProvisioningSchemeVersion    : 1

TaskId                       : 00000000-0000-0000-0000-000000000000

VMMetadata                   : {0, 1, 0, 0...}

PersonalVDiskDriveLetter     :

PersonalVDiskDriveSize       : 0

UsePersonalVDiskStorage      : False

NetworkMaps                  : {0}

Scopes                       :

DedicatedTenancy             : False

GpuTypeId                    :

ResetAdministratorPasswords  : False

SecurityGroups               : {}

ServiceOffering              :

TenancyType                  : Shared

AzureAdJoinType              :

CurrentMasterImageUid        : c0571690-4f57-4476-901b-fe64d6aecb79

CustomProperties             :

IdentityType:                : ActiveDirectory

UseFullDiskCloneProvisioning : False

UseWriteBackCache            : True

WriteBackCacheDiskSize       : 24

WriteBackCacheMemorySize     : 256

Warnings:                    : {}

WriteBackCacheDiskIndex      : 0

<!--NeedCopy-->

Description

Remove all controller addresses from the provisioning scheme with the name “scheme1”.

Example 2

C:\PS>Remove-ProvSchemeControllerAddress -ProvisioningSchemeUid "01a4a008-8ce8-4165-ba9c-cdf15a6b0501" -ControllerAddress (ddcA.citrix.com,ddcC.citrix2.com)

CleanOnBoot                  : True

ControllerAddress            : {ddcB.citrix.com}

CpuCount                     : 1

DiskSize                     : 20

HostingUnitName              : HostUnit1

HostingUnitUid               : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501

IdentityPoolName             : idPool1

IdentityPoolUid              : 03743136-e43b-4a87-af74-ab71686b3c16

MachineCount                 : 0

MachineProfile               :

MasterImageVM                : Base.vm/base.snapshot

MasterImageVMDate            : 17/05/2020 09:53:40

MemoryMB                     : 1024

Metadata                     : {Department = Sales}

MetadataMap                  : {[Department = Sales]}

ProvisioningSchemeName       : Scheme2

ProvisioningSchemeUid        : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501

ProvisioningSchemeVersion    : 1

TaskId                       : 00000000-0000-0000-0000-000000000000

VMMetadata                   : {0, 1, 0, 0...}

PersonalVDiskDriveLetter     :

PersonalVDiskDriveSize       : 0

UsePersonalVDiskStorage      : False

NetworkMaps                  : {0}

Scopes                       :

DedicatedTenancy             : False

GpuTypeId                    :

ResetAdministratorPasswords  : False

SecurityGroups               : {}

ServiceOffering              :

TenancyType                  : Shared

AzureAdJoinType              :

CurrentMasterImageUid        : c0571690-4f57-4476-901b-fe64d6aecb79

CustomProperties             :

IdentityType:                : ActiveDirectory

UseFullDiskCloneProvisioning : False

UseWriteBackCache            : True

WriteBackCacheDiskSize       : 24

WriteBackCacheMemorySize     : 256

Warnings:                    : {}

WriteBackCacheDiskIndex      : 0

<!--NeedCopy-->

Description

Remove a subset of the controller address list from the provisioning scheme with the identifier “01a4a008-8ce8-4165-ba9c-cdf15a6b0501”.

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

Remove-ProvSchemeControllerAddress

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Remove-ProvSchemeControllerAddress

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Machinecreation.Sdk.Provisioningscheme

Return Values

Notes

Examples

Example 1

Description

Example 2

Description

In this article