Citrix Virtual Apps and Desktops SDK

Set-BrokerRemotePCAccount

August 3, 2023

Contributed by:

Modify one or more RemotePCAccounts.

Syntax

Set-BrokerRemotePCAccount [-InputObject] <RemotePCAccount[]> [-PassThru] [-AllowSubfolderMatches <Boolean>] [-MachinesExcluded <String[]>] [-MachinesIncluded <String[]>] [-OU <String>] [-LoggingId <Guid>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <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 | | | AdminClientIP | Internal use only. | 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 | | | TraceParent | Specifies the trace parent assigned for internal diagnostic tracing use | false | false | | | TraceState | Specifies the trace state assigned for internal diagnostic tracing use | false | false | | | VirtualSiteId | Specifies the virtual site the PowerShell snap-in will connect to. | 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.

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

Set-BrokerRemotePCAccount

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Set-BrokerRemotePCAccount

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Broker.Admin.Sdk.Remotepcaccount

Return Values

None Or Citrix.Broker.Admin.Sdk.Remotepcaccount

Examples

Example 1

Description

In this article