Skip to content

jazz_license

Configuration for Jazz License Information resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
date_purchased<String>Read-writePurchase Date for license.
session_id<String>Read-writeSession id for license.
features<String>Read-writeFeatures for license.
relevance<Integer>Read-writeRelevance of license.
name<String>Read-writeName of license.
serial_no<String>Read-writeSerial Number for license.
count_total<Integer>Read-writeCount Total of license.
count_available<Integer>Read-writeCount Available of license.
id<String>Read-writeID for license.
date_exp<String>Read-writeExpiry Date for license.
bind_type<String>Read-writeBind Type for license.
use_proxy<Boolean>Read-writeUse license proxy configured to connect to citrix backoffice.

Operations

(click to see Properties)

FETCH| GET

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

fetch

URL: https://<MGMT-IP>/nitro/v1/config/jazz_license?action=fetch;onerror=<String_value>

HTTP Method: null

Request Payload:

{jazz_license: {
"id":<String_value>,
"bind_type":<String_value>,
"use_proxy":<Boolean_value>,
"name":<String_value>,
"count_total":<Integer_value>,
"date_exp":<String_value>,
"session_id":<String_value>,
"date_purchased":<String_value>,
"serial_no":<String_value>,
"count_available":<Integer_value>,
"features":<String_value>,
"relevance":<Integer_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "jazz_license":[{
"date_purchased":<String_value>,
"session_id":<String_value>,
"features":<String_value>,
"relevance":<Integer_value>,
"name":<String_value>,
"serial_no":<String_value>,
"count_total":<Integer_value>,
"count_available":<Integer_value>,
"id":<String_value>,
"date_exp":<String_value>,
"bind_type":<String_value>,
"use_proxy":<Boolean_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/jazz_license

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "jazz_license":[{
"date_purchased":<String_value>,
"session_id":<String_value>,
"features":<String_value>,
"relevance":<Integer_value>,
"name":<String_value>,
"serial_no":<String_value>,
"count_total":<Integer_value>,
"count_available":<Integer_value>,
"id":<String_value>,
"date_exp":<String_value>,
"bind_type":<String_value>,
"use_proxy":<Boolean_value>}]}