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