Set-BrokerRemotePCAccount
Modify one or more RemotePCAccounts.
Syntax
Set-BrokerRemotePCAccount
[-InputObject] <RemotePCAccount[]>
[-PassThru]
[-AllowSubfolderMatches <Boolean>]
[-MachinesExcluded <String[]>]
[-MachinesIncluded <String[]>]
[-OU <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Modify one or more RemotePCAccounts.
Examples
EXAMPLE 1
Make all RemotePCAccounts filter out machines from DOMAIN42.
Get-BrokerRemotePCAccount | Set-BrokerRemotePCAccount -MachinesExcluded @('DOMAIN42\*')
Parameters
-InputObject
Specifies the RemotePCAccounts to modify.
| Type: | RemotePCAccount[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-PassThru
This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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'.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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*
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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*
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 196 |
-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 modified into this cmdlet.
Outputs
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.