Skip to content
Was this article helpful?

Remove-Provschemecontrolleraddress

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>]<br><br>Remove-ProvSchemeControllerAddress -ProvisioningSchemeUid <Guid> -ControllerAddress <String[]> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

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.
Error Codes
-----------
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<br><br>CleanOnBoot                  : True<br><br>ControllerAddress            : {}<br><br>CpuCount                     : 1<br><br>DiskSize                     : 20<br><br>HostingUnitName              : HostUnit1<br><br>HostingUnitUid               : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501<br><br>IdentityPoolName             : idPool1<br><br>IdentityPoolUid              : 03743136-e43b-4a87-af74-ab71686b3c16<br><br>MachineCount                 : 0<br><br>MachineProfile               :<br><br>MasterImageVM                : Base.vm/base.snapshot<br><br>MasterImageVMDate            : 17/05/2020 09:53:40<br><br>MemoryMB                     : 1024<br><br>Metadata                     : {Department = Sales}<br><br>MetadataMap                  : {[Department = Sales]}<br><br>ProvisioningSchemeUid        : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501<br><br>ProvisioningSchemeName       : Scheme2<br><br>ProvisioningSchemeVersion    : 1<br><br>TaskId                       : 00000000-0000-0000-0000-000000000000<br><br>VMMetadata                   : {0, 1, 0, 0...}<br><br>PersonalVDiskDriveLetter     :<br><br>PersonalVDiskDriveSize       : 0<br><br>UsePersonalVDiskStorage      : False<br><br>NetworkMaps                  : {0}<br><br>Scopes                       :<br><br>DedicatedTenancy             : False<br><br>GpuTypeId                    :<br><br>ResetAdministratorPasswords  : False<br><br>SecurityGroups               : {}<br><br>ServiceOffering              :<br><br>TenancyType                  : Shared<br><br>AzureAdJoinType              :<br><br>CurrentMasterImageUid        : c0571690-4f57-4476-901b-fe64d6aecb79<br><br>CustomProperties             :<br><br>IdentityType:                : ActiveDirectory<br><br>UseFullDiskCloneProvisioning : False<br><br>UseWriteBackCache            : True<br><br>WriteBackCacheDiskSize       : 24<br><br>WriteBackCacheMemorySize     : 256<br><br>Warnings                     : {}<br><br>WriteBackCacheDiskIndex      : 0

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)<br><br>CleanOnBoot                  : True<br><br>ControllerAddress            : {ddcB.citrix.com}<br><br>CpuCount                     : 1<br><br>DiskSize                     : 20<br><br>HostingUnitName              : HostUnit1<br><br>HostingUnitUid               : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501<br><br>IdentityPoolName             : idPool1<br><br>IdentityPoolUid              : 03743136-e43b-4a87-af74-ab71686b3c16<br><br>MachineCount                 : 0<br><br>MachineProfile               :<br><br>MasterImageVM                : Base.vm/base.snapshot<br><br>MasterImageVMDate            : 17/05/2020 09:53:40<br><br>MemoryMB                     : 1024<br><br>Metadata                     : {Department = Sales}<br><br>MetadataMap                  : {[Department = Sales]}<br><br>ProvisioningSchemeName       : Scheme2<br><br>ProvisioningSchemeUid        : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501<br><br>ProvisioningSchemeVersion    : 1<br><br>TaskId                       : 00000000-0000-0000-0000-000000000000<br><br>VMMetadata                   : {0, 1, 0, 0...}<br><br>PersonalVDiskDriveLetter     :<br><br>PersonalVDiskDriveSize       : 0<br><br>UsePersonalVDiskStorage      : False<br><br>NetworkMaps                  : {0}<br><br>Scopes                       :<br><br>DedicatedTenancy             : False<br><br>GpuTypeId                    :<br><br>ResetAdministratorPasswords  : False<br><br>SecurityGroups               : {}<br><br>ServiceOffering              :<br><br>TenancyType                  : Shared<br><br>AzureAdJoinType              :<br><br>CurrentMasterImageUid        : c0571690-4f57-4476-901b-fe64d6aecb79<br><br>CustomProperties             :<br><br>IdentityType:                : ActiveDirectory<br><br>UseFullDiskCloneProvisioning : False<br><br>UseWriteBackCache            : True<br><br>WriteBackCacheDiskSize       : 24<br><br>WriteBackCacheMemorySize     : 256<br><br>Warnings                     : {}<br><br>WriteBackCacheDiskIndex      : 0

Description

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

Was this article helpful?