Product Documentation

Remove-BrokerUser

Oct 01, 2013

Remove broker user objects from another broker object

Syntax

Remove-BrokerUser [-InputObject] <User[]> [-Application <Application>] [-Machine <Machine>] [-PrivateDesktop <PrivateDesktop>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Remove-BrokerUser [-Name] <String> [-Application <Application>] [-Machine <Machine>] [-PrivateDesktop <PrivateDesktop>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The Remove-BrokerUser cmdlet removes broker user objects from another specified object, such as a broker private desktop, to which the user had previously been added.

Parameters

-InputObject<User[]>

Specifies the user objects to remove.

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)

-Name<String>

Specifies the user objects to remove, based on their Name property.

Required? true
Default Value null
Accept Pipeline Input? true (ByPropertyName)

-Application<Application>

The application from which to remove the user

Required? false
Default Value null
Accept Pipeline Input? true (ByValue)

-Machine<Machine>

The machine from which to remove the user

Required? false
Default Value null
Accept Pipeline Input? true (ByValue)

-PrivateDesktop<PrivateDesktop>

The desktop from which to remove the user

Required? false
Default Value null
Accept Pipeline Input? true (ByValue)

-LoggingId<Guid>

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop 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.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

Citrix.Broker.Admin.SDK.USer You can pipe the users to be removed to Remove-BrokerUser.

Return Values

None

Notes

Specify one of the -Machine or -PrivateDesktop parameters only.

Examples

-------------------------- EXAMPLE 1 --------------------------

Remove-BrokerUser "DOMAIN\UserName" -PrivateDesktop "DOMAIN\MachineName"

Remove the assignment of the specified private desktop to the specified user.