Citrix Virtual Apps and Desktops SDK

Test-BrokerLicenseServer

March 11, 2024

Contributed by:

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

Syntax

Test-BrokerLicenseServer [-ComputerName] <String> [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [[-Port] <Int32>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

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

Parameters

Name	Description	Required?	Pipeline Input	Default Value
ComputerName	The name of the license server to test (machine.domain).	true	false	None
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
AdminClientIP	Internal use only.	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
Port	The port number to use on the server.	false	false	27000

Input Type

None

You cannot pipe input into this cmdlet.

Return Values

System.String

Test-BrokerLicenseServer returns: o ‘Compatible’ - the server is a compatible license server that can be used. o ‘Incompatible’ - the server is an incompatible license server that can’t be used. o ‘Inaccessible’ - the server cannot be accessed. The server may be down, unreachable, or non-existent. o ‘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.

Examples

Example 1

C:\PS> Test-BrokerLicenseServer -LicenseServerAddress "machine.domain" 1234

<!--NeedCopy-->

Description

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

Example 2

C:\PS> Test-BrokerLicenseServer -LicenseServerAddress "machine.domain"

<!--NeedCopy-->

Description

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

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

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Test-BrokerLicenseServer

Syntax

Detailed Description

Related Commands

Parameters

Input Type

None

Return Values

System.String

Examples

Example 1

Description

Example 2

Description

In this article