Developer Documentation
Citrix ADM NITRO API Reference

jazz_license

June 20, 2023
Contributed by: 
C

Configuration for Jazz License Information resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
session_id Read-write Session id for license.
name Read-write Name of license.
serial_no Read-write Serial Number for license.
id Read-write ID for license.
bind_type Read-write Bind Type for license.
use_proxy Read-write Use license proxy configured to connect to citrix backoffice.
date_purchased Read-only Purchase Date for license.
features Read-only Features for license.
relevance Read-only Relevance of license.
count_total Read-only Count Total of license.
count_available Read-only Count Available of license.
date_exp Read-only Expiry Date for license.

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

fetch

URL: https://<MGMT-IP>/nitro/v2/config/jazz_license?action=fetch;onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload: 

{"jazz_license": {
"use_proxy":<Boolean_value>,
"name":<String_value>,
"session_id":<String_value>,
"id":<String_value>,
"bind_type":<String_value>,
"serial_no":<String_value>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/jazz_license HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>}]}

<!--NeedCopy-->
jazz_license
June 20, 2023
Contributed by: 
C
June 20, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.