Product Documentation

Remove-BrokerRemotePCAccount

Oct 21, 2016

Delete RemotePCAccounts from the system.

Syntax

Remove-BrokerRemotePCAccount [-InputObject] <RemotePCAccount[]> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Delete RemotePCAccounts from the site.

Parameters

-InputObject<RemotePCAccount[]>

Specifies the RemotePCAccounts to delete.

Required? true
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.RemotePCAccount You can pipe the RemotePCAccounts to be deleted into this cmdlet.

Return Values

None

Examples

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

C:\PS> Remove-BrokerRemotePCAccount 42

Delete RemotePCAccount 42.

-------------------------- EXAMPLE 2 --------------------------

C:\PS> Get-BrokerRemotePCAccount -OU 'any' | Remove-BrokerRemotePCAccount

Delete the 'any' OU RemotePCAccount.

-------------------------- EXAMPLE 3 --------------------------

C:\PS> Get-BrokerRemotePCAccount | Remove-BrokerRemotePCAccount

Delete all RemotePCAccounts.