Test-BrokerRemotePCAccountNameAvailable
Determine whether the proposed RemotePCAccount OU is available for use.
Syntax
Test-BrokerRemotePCAccountNameAvailable
[-OU] <String[]>
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
This cmdlet checks whether proposed RemotePCAccount OU is available for use. It returns a record for each OU indicating the availability of that OU, with \$true indicating that the OU is unused and available for use, or \$false if it is not available.
Examples
EXAMPLE 1
Checks whether the OU "Test1" is available.
Test-BrokerRemotePCAccountNameAvailable -OU Test1
EXAMPLE 2
Checks whether each of the specified names is available.
Test-BrokerRemotePCAccountNameAvailable @("Test1","Test2","Test3")
Parameters
-OU
The RemotePCAccount OU to be tested.
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
| Length range: | 1 to 196 |
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
You can pipe a string that contains the OU to test.
Outputs
Citrix.Broker.Admin.SDK.NameAvailability
The cmdlet returns a result for each OU specified. An availability of "True" indicates the OU is available for use, and "False" if it is not available.