Citrix Virtual Apps and Desktops SDK


Determine whether the proposed Machine MachineName is available for use.


Test-BrokerMachineNameAvailable [-MachineName] <String[]> [-AdminAddress <String>] [-BearerToken <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.


Name Description Required? Pipeline Input Default Value
MachineName The Machine MachineName to be tested. true true (ByValue, ByPropertyName)  
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  

Input Type


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

Return Values


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.


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.