Citrix Virtual Apps and Desktops SDK

Remove-BrokerRemotePCAccount

Delete RemotePCAccounts from the system.

Syntax

Remove-BrokerRemotePCAccount
      [-InputObject] <RemotePCAccount[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Delete RemotePCAccounts from the site.

Examples

EXAMPLE 1

Delete RemotePCAccount 42.

Remove-BrokerRemotePCAccount 42
<!--NeedCopy-->

EXAMPLE 2

Delete the ‘any’ OU RemotePCAccount.

Get-BrokerRemotePCAccount -OU 'any' | Remove-BrokerRemotePCAccount
<!--NeedCopy-->

EXAMPLE 3

Delete all RemotePCAccounts.

Get-BrokerRemotePCAccount | Remove-BrokerRemotePCAccount
<!--NeedCopy-->

Parameters

-InputObject

Specifies the RemotePCAccounts to delete.

Type: RemotePCAccount[]
Position: 2
Default value: Null
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-LoggingId

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.

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.Broker.Admin.SDK.RemotePCAccount

You can pipe the RemotePCAccounts to be deleted into this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerRemotePCAccount