8 Licenses

8.1 Get-anynodeLicenses

Returns a list of currently loaded licenses. For more information about the license status go to section 29.12,

Required Permissions

  • API

  • User Management Read/Write Access

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

Return Value Structure

The response body is strutured as an array. The array consists of License JSON objects. A description for its fields is at section 29.12.1. For the JSON schema refer to section 29.12.2.

8.2 Import-anynodeLOD

Requests a license using the LOD key.

Required Permissions

  • API

  • User Management Read/Write Access

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

  • CompanyName

    If the LOD key has already been used to generate a license using a different licensing device, please confirm that you are eligible for requesting a new license and provide the name of your company.

    Type: String

  • EmailAddress

    An additional copy of the generated license will be sent to the given e-mail address.

    Type: String

  • LicensingDevice

    Each license must be bound to a certain device already installed in your system. The list of devices available for licensing can be requested via section 8.3.Please specify the devices system ID that should be used to bind the new license to.

    Type: String

  • LodKey

    The LOD key that was supplied together with the product.

    Type: String

Return Value Structure

The response body is strutured as an array. The array consists of License JSON objects. A description for its fields is at section 29.12.1. For the JSON schema refer to section 29.12.2.

8.3 Get-anynodeSystemIds

Returns a list of the available device IDs for licensing.

Required Permissions

  • API

  • User Management Read/Write Access

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

Return Value Structure

The response body is strutured as an array. The array consists of SystemId JSON objects. A description for its fields is at section 29.68.1. For the JSON schema refer to section 29.68.2.

8.4 Import-anynodeLicense

Imports a xzlicense file.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

  • string: Filepath

    The path to the file that will be imported.