Product Documentation

Test-BrokerLicenseServer

Nov 06, 2015

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

Syntax

Test-BrokerLicenseServer [-ComputerName] <String> [-AdminAddress <String>] [[-Port] <Int32>] [<CommonParameters>]

Detailed Description

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

Parameters

-ComputerName<String>

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

Required? true
Default Value None
Accept Pipeline Input? false

-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

-Port<Int32>

The port number to use on the server.

Required? false
Default Value 27000
Accept Pipeline Input? false

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

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"

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