nslicenseparameters¶

Configuration for licenseparameters resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
alert1gracetimeout	<Double>	Read-write	If ADC remains in grace for the configured hours then first grace alert will be raised. Default value: 6 Minimum value = 0 Maximum value = 24
alert2gracetimeout	<Double>	Read-write	If ADC remains in grace for the configured hours then major grace alert will be raised. Default value: 240 Minimum value = 24 Maximum value = 720
licenseexpiryalerttime	<Double>	Read-write	If ADC termed license is nearer to expiry then SNMP expiry alert will be raised. Default value: 30 Minimum value = 1 Maximum value = 365
heartbeatinterval	<Double>	Read-write	Heartbeat between ADC and Licenseserver is configurable and applicable in case of pooled licensing. Default value: 280 Minimum value = 30 Maximum value = 280
inventoryrefreshinterval	<Double>	Read-write	Inventory refresh interval between ADC and Licenseserver is configurable and applicable in case of pooled licensing. Default value: 360 Minimum value = 45 Maximum value = 1440

Operations¶

(click to see Properties )

UPDATE
UNSET
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

update¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/nslicenseparameters HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nslicenseparameters":{
"alert1gracetimeout":<Double_value>,
"alert2gracetimeout":<Double_value>,
"licenseexpiryalerttime":<Double_value>,
"heartbeatinterval":<Double_value>,
"inventoryrefreshinterval":<Double_value>
}}

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

unset¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/nslicenseparameters? action=unset HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nslicenseparameters":{
"alert1gracetimeout":true,
"alert2gracetimeout":true,
"licenseexpiryalerttime":true,
"heartbeatinterval":true,
"inventoryrefreshinterval":true
}}

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/nslicenseparameters 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:

{ "nslicenseparameters": [ {
"alert1gracetimeout":<Double_value>,
"alert2gracetimeout":<Double_value>,
"licenseexpiryalerttime":<Double_value>,
"heartbeatinterval":<Double_value>,
"inventoryrefreshinterval":<Double_value>
}]}