Citrix Virtual Apps and Desktops SDK

Test-BrokerLicenseServer

August 9, 2024

Contributed by:

Tests whether or not a license server can be used by the broker.

Syntax

Test-BrokerLicenseServer
    [-ComputerName] <String>
    [[-Port] <Int32>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Description

Tests whether or not a given license server can be used by the broker.

Examples

EXAMPLE 1

Tests whether or not the license server “machine.domain” with port number 1234 can be used.

Test-BrokerLicenseServer -LicenseServerAddress "machine.domain" 1234
<!--NeedCopy-->

EXAMPLE 2

Tests whether or not the license server “machine.domain” with port number 2700 can be used.

Test-BrokerLicenseServer -LicenseServerAddress "machine.domain"
<!--NeedCopy-->

Parameters

-ComputerName

The name of the license server to test (machine.domain).

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Port

The port number to use on the server.

Type:	Int32
Position:	3
Default value:	27000
Required:	False
Accept pipeline input:	False
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

None

You cannot pipe input into this cmdlet.

Outputs

String

Test-BrokerLicenseServer returns:

‘Compatible’ - the server is a compatible license server that can be used.
‘Incompatible’ - the server is an incompatible license server that can’t be used.
‘Inaccessible’ - the server cannot be accessed. The server may be down, unreachable,

or non-existent.
‘InternalError - the server can’t be used due to an internal error. A required licensing

component on the server may not be installed, configured, or working correctly.

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-BrokerLicenseServer

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Test-BrokerLicenseServer

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-ComputerName

-Port

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

String

Related Links

In this article