ADC NITRO APIs

nslaslicense

Configuration for laslicense resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
filename Read-write Name of the file. It should not include filepath.

Maximum length = 255
filelocation Read-write location of the file on Citrix ADC.

Maximum length = 255
fixedbandwidth Read-write apply fixed bandwidth license on ADC.
status Read-only Status of license activation.

Default value: INACTIVE

Possible values = INACTIVE, ACTIVE, EXPIRED
daystoexpiration Read-only Days to expire.

Minimum value = 0

Maximum value = 4294967294
renewalprev Read-only Previous LAS renewal time.
renewalnext Read-only Next LAS renewal time.
renewalprevdate Read-only Previous LAS renewal time.
renewalnextdate Read-only Next LAS renewal time.
_nextgenapiresource Read-only .

Operations

(click to see Properties )

  • APPLY
  • GET (ALL)

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

apply

URL: http:// <netscaler-ip-address> /nitro/v1/config/nslaslicense? action=apply

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nslaslicense":{
<b>"filename":<String_value>,
</b><b>"filelocation":<String_value>,
</b>"fixedbandwidth":<Boolean_value>
}}


<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/nslaslicense

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "nslaslicense": [ {
"status":<String_value>,
"daystoexpiration":<Integer_value>,
"renewalprev":<Integer_value>,
"renewalnext":<Integer_value>,
"renewalprevdate":<String_value>,
"renewalnextdate":<String_value>,
"_nextgenapiresource":<String_value>
}]}


<!--NeedCopy-->
nslaslicense