Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Set-Brokerremotepcaccount

August 3, 2023
Contributed by: 
C

Modify one or more RemotePCAccounts.

Syntax

Set-BrokerRemotePCAccount [-InputObject] <RemotePCAccount[]> [-PassThru] [-AllowSubfolderMatches <Boolean>] [-MachinesExcluded <String[]>] [-MachinesIncluded <String[]>] [-OU <String>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Modify one or more RemotePCAccounts.

Parameters

Name Description Required? Pipeline Input Default Value
InputObject Specifies the RemotePCAccounts to modify. true true (ByValue)  
PassThru This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record. false false False
AllowSubfolderMatches When true a machine matches this RemotePCAccount if the AD computer is in the container specified by the OU property, or within a child container of the OU.
When false the AD computer object only matches if it is directly in the AD container specified by the OU property.
This property is not meaningful when OU has the special value ‘any’.		 false false  
MachinesExcluded MachinesExcluded specifies a set of strings that can include asterisk wildcards. If a machine name matches any entries in MachinesExcluded then it cannot match with this RemotePCAccount regardless of whether there is a MachinesIncluded match.
Matches are performed against the domain name joined with the machine name by a backslash (DOMAIN\MACHINE), e.g.:
DOMAIN1\M
DOMAIN\M
\M*		 false false  
MachinesIncluded MachinesIncluded specifies a set of strings that can include asterisk wildcards. A machine may only match with this RemotePCAccount if it matches a MachinesIncluded entry and does not match any MachinesExcluded entries.
Matches are performed against the domain name joined with the machine name by a backslash (DOMAIN\MACHINE), e.g.:
DOMAIN1\M
DOMAIN\M
\M*		 false false  
OU Specifies the DN of an AD container, or has the special value ‘any’.
When an AD container is specified a machine may only match with the RemotePCAccount when the AD computer object is located relative to the OU.
When ‘any’ is specified the location of the AD computer object is ignored for purposes of matching this RemotePCAccount. The machine must still meet the MachinesIncluded and MachinesExcluded filters for a match to occur.
In the event that a machine matches with multiple RemotePCAccounts then the RemotePCAccount OU with the longest canonical name takes precedence. The special ‘any’ OU is treated as lowest priority.
Note that the OU value of every RemotePCAccount must be unique, and this includes only one ‘any’ entry being permitted.		 false 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. false false  
AdminAddress 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. false false Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken Specifies the bearer token assigned to the calling user false false  

Input Type

Citrix.Broker.Admin.Sdk.Remotepcaccount

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

Return Values

None Or Citrix.Broker.Admin.Sdk.Remotepcaccount

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.RemotePCAccount object.

Examples

Example 1 

C:\PS> Get-BrokerRemotePCAccount | Set-BrokerRemotePCAccount -MachinesExcluded @('DOMAIN42\\*')
<!--NeedCopy-->

Description

Make all RemotePCAccounts filter out machines from DOMAIN42.

Set-Brokerremotepcaccount
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.