Product Documentation

Test-BrokerMachineNameAvailable

Apr 15, 2014

Determine whether the proposed Machine MachineName is available for use.

Syntax

Test-BrokerMachineNameAvailable [-MachineName] <String[]> [-AdminAddress <String>] [<CommonParameters>]

Detailed 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.

Parameters

-MachineName<String[]>

The Machine MachineName to be tested.

Required? true
Default Value  
Accept Pipeline Input? true (ByValue, ByPropertyName)

-AdminAddress<String>

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.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

System.String You can pipe a string that contains the MachineName to test.

Return Values

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.

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> Test-BrokerMachineNameAvailable -MachineName Test1

Checks whether the MachineName "Test1" is available.

-------------------------- EXAMPLE 2 --------------------------

C:\PS> Test-BrokerMachineNameAvailable @("Test1","Test2","Test3")

Checks whether each of the specified names is available.