Citrix Virtual Apps and Desktops 2411 SDK

Remove-XDController

December 4, 2024

Contributed by:

Removes a Delivery Controller from an existing Site

Syntax

Remove-XDController
      -ControllerName <String>
      [-DoNotUpdateDatabaseServer]
      [-AdminAddress <String>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-XDController
      -ControllerName <String>
      -AdminDatabaseCredentials <PSCredential>
      [-AdminAddress <String>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-XDController
      -ControllerName <String>
      -SiteAdminDatabaseCredentials <PSCredential>
      -LoggingAdminDatabaseCredentials <PSCredential>
      -MonitorAdminDatabaseCredentials <PSCredential>
      [-AdminAddress <String>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Removes a Controller from an existing Site that currently has more than one Controller.

If no credentials are provided and DoNotUpdateDatabaseServer has not been specified, then all database update operations are attempted using the credentials of the user running the cmdlet.

If DatabaseCredentials is provided, then all database operations are attempted using the credentials.

If one or more of SiteDatabaseCredentials, LoggingDatabaseCredentials or MonitorDatabaseCredentials are provided, then all three must be provided. All operations are then attempted using the credentials appropriate to each Database.

Examples

EXAMPLE 1

Removes the Controller ‘MyControllerToRemove’ from the Site to which ‘MyExistingController’ is joined. The permissions associated with ‘MyControllerToRemove’ will be automatically removed from the Database using the implicit credentials of the user running the cmdlet.

Remove-XDController -AdminAddress MyExistingController -ControllerName MyControllerToRemove
<!--NeedCopy-->

EXAMPLE 2

Removes the Controller ‘MyControllerToRemove’ from the Site to which ‘MyExistingController’ is joined.

The permissions for ‘MyNewController’ will not be removed from the Database. Instead the Get-XDDatabaseSchema cmdlet is used to generate a SQL script that may be given to the database administrator of ‘MySQLServer’. The SQL script may be used to remove the permissions that previously allowed ‘MyControllerToRemove’ to manipulate data within the Database.

Remove-XDController -AdminAddress MyExistingController -ControllerName MyControllerToRemove -DoNotUpdateDatabaseServer
Get-XDDatabaseSchema -AdminAddress MyExistingController -SiteName MySite -DatabaseServer MySQLServer -ScriptType RemoveController -ControllerToRemoveSid MyControllerToRemove_SID > C:\removeController.sql
# Although not necessary, Citrix recommends you get a database administrator to run removeController.sql
<!--NeedCopy-->

EXAMPLE 3

Removes the Controller ‘MyControllerToRemove’ from the Site to which ‘MyExistingController’ is joined.

The credentials contained within ‘$credential’ will be used to remove the permissions associated with ‘MyControllerToRemove’ from the Database.

$credential = Get-Credential
Remove-XDController -AdminAddress MyExistingController -ControllerName MyControllerToRemove -DatabaseCredentials $credential
<!--NeedCopy-->

EXAMPLE 4

Removes the Controller ‘MyControllerToRemove’ from the Site to which ‘MyExistingController’ is joined.

The credentials contained within ‘$credentialSite’ will be used to remove the permissions associated with ‘MyControllerToRemove’ from the Site Configuration Database. The credentials contained within ‘$credentialLogging’ will be used to remove the permissions associated with ‘MyControllerToRemove’ from the Configuration Logging Database. The credentials contained within ‘$credentialMonitor’ will be used to remove the permissions associated with ‘MyControllerToRemove’ from the Monitoring Database.

$credentialSite = Get-Credential
$credentialLogging = Get-Credential
$credentialMonitor = Get-Credential
Remove-XDController -AdminAddress MyExistingController -ControllerName MyControllerToRemove -SiteDatabaseCredentials $credentialSite -LoggingDatabaseCredentials $credentialLogging -MonitorDatabaseCredentials $credentialMonitor
<!--NeedCopy-->

Parameters

-ControllerName

The name of the Controller that is to be removed. This may be in SID, DNS or SAM name form. This cannot be the same as the Controller identified by AdminAddress.

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

-AdminDatabaseCredentials

The security credentials, in the form of a PSCredential object, that will be used for administrator to connect to the SQL servers associated with the Site, Logging and Monitor databases.

Type:	PSCredential
Aliases:	DatabaseCredentials
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2411

-SiteAdminDatabaseCredentials

The security credentials, in the form of a PSCredential object, that will be used for administrator to connect to the SQL server associated with the Site database.

Type:	PSCredential
Aliases:	SiteDatabaseCredentials
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2411

-LoggingAdminDatabaseCredentials

The security credentials, in the form of a PSCredential object, that will be used for administrator to connect to the SQL server associated with the Logging database.

Type:	PSCredential
Aliases:	LoggingDatabaseCredentials
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2411

-MonitorAdminDatabaseCredentials

The security credentials, in the form of a PSCredential object, that will be used for administrator to connect to the SQL server associated with the Monitor database.

Type:	PSCredential
Aliases:	MonitorDatabaseCredentials
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Introduced in:	Citrix Virtual Apps and Desktop 7 2411

-AdminAddress

Specifies the address of the Delivery Controller to which the PowerShell module will connect. This can be provided as a host name or an IP address.

Type:	String
Position:	Named
Default value:	Localhost. Once a value is provided by any cmdlet, this value will become the default.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DoNotUpdateDatabaseServer

Results in the permissions associated with the Controller not being automatically removed from the database.

This switch may be useful when the person running the cmdlet has insufficient database privilege. The database permissions for the Controller must be removed manually after running this cmdlet.

Get-XDDatabaseSchema may be used to generate the SQL script which in turn may be used to remove the associated permissions from the Database.

This parameter results in all supplied credentials being ignored.

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

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.

Removed Parameters

Parameters in this section were available in older releases, and have been removed or replaced due to changes in functionality.

Inputs

None

You cannot pipe input to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Notes

If the user running this cmdlet does not have privilege to remove users from the Database, then either use the DoNotudpateDatabaseServer switch or supply alternative credentials using one or more of the Credentials arguments.

This cmdlet cannot be used to remove the last Controller from a Site; use the Remove-XDSite cmdlet instead.

The command can fail for the following reasons:

The Site has only one Controller. A Site must have multiple Controllers before a Controller can be removed.
The Controller that is to be removed is not a member of the Site.
The person running the cmdlet, or the supplied credentials, does not have sufficient privilege to update the Database. Either run this cmdlet as a user that has administrator privilege to the Database, or supply an account with suitable privileges using the PSCredential parameter(s).

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

December 4, 2024

Contributed by:

December 4, 2024

Contributed by:

Remove-XDController

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

EXAMPLE 3

EXAMPLE 4

Parameters

-ControllerName

-AdminDatabaseCredentials

-SiteAdminDatabaseCredentials

-LoggingAdminDatabaseCredentials

-MonitorAdminDatabaseCredentials

-AdminAddress

-DoNotUpdateDatabaseServer

CommonParameters

Removed Parameters

Inputs

None

Outputs

None

Notes

Related Links

In this article