Citrix Daas SDK

Test-BrokerMachineNameAvailable

August 9, 2024

Contributed by:

C C

Determine whether the proposed Machine MachineName is available for use.

Syntax

Test-BrokerMachineNameAvailable
    [-MachineName] <String[]>
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

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
<!--NeedCopy-->

EXAMPLE 2

Checks whether each of the specified names is available.

Test-BrokerMachineNameAvailable @("Test1","Test2","Test3")
<!--NeedCopy-->

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

String

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.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Test-BrokerMachineNameAvailable

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

Test-BrokerMachineNameAvailable

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-MachineName

CitrixCommonParameters

CommonParameters

Inputs

String

Outputs

Citrix.Broker.Admin.SDK.NameAvailability

Related Links

In this article