Citrix Virtual Apps and Desktops 2411 SDK

Remove-ProvSchemeControllerAddress

Removes controller addresses from a provisioning scheme.

Syntax

Remove-ProvSchemeControllerAddress [-ProvisioningSchemeName] <String> [-ControllerAddress] <String[]> [-LoggingId <Guid>] [<CitrixCommonParameters>] [<CommonParameters>]
Remove-ProvSchemeControllerAddress -ProvisioningSchemeUid <Guid> [-ControllerAddress] <String[]> [-LoggingId <Guid>] [<CitrixCommonParameters>] [<CommonParameters>]

Description

Removes the specified controller addresses from the specified provisioning scheme.

Examples

EXAMPLE 1

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

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

EXAMPLE 2

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

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

Parameters

-ProvisioningSchemeUid

The unique identifier of the provisioning scheme that controller addresses are to be removed from.

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

-ProvisioningSchemeName

The name of the provisioning scheme that controller addresses are to be removed from.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ControllerAddress

Specifies the array of controller DNS names to be removed from the provisioning scheme.

Type: String[]
Position: 3
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Type: String[]
Position: 3
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
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

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 Remove-ProvSchemeControllerAddress.

Outputs

None

By default, this cmdlet returns no output.

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.

Remove-ProvSchemeControllerAddress