Skip to content

nsaptlicense

Configuration for aptlicense resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
serialno<String>Read-writeHardware Serial Number/License Activation Code(LAC).
useproxy<String>Read-writeSpecifies whether to use the licenseproxyserver to reach the internet. Make sure to configure licenseproxyserver to use this option.
Default value: NO
Possible values = YES, NO
id<String>Read-writeLicense ID.
sessionid<String>Read-writeSession ID.
bindtype<String>Read-writeBind type.
countavailable<String>Read-writeThe user can allocate one or more licenses. Ensure the value is less than (for partial allocation) or equal to the total number of available licenses.
licensedir<String>Read-writeLicense Directory.
response<String>Read-onlyResponse data as text blob.
counttotal<String>Read-onlyCount.
name<String>Read-onlyLicense name.
relevance<String>Read-onlyLicense relevance.
datepurchased<String>Read-onlyLicense purchase date.
datesa<String>Read-onlyLicense SA date.
dateexp<String>Read-onlyLicense expiry date.
features<String[]>Read-onlyFeatures.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

CHANGE| GET (ALL)| COUNT

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

change

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsaptlicense?action=update

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"nsaptlicense":{
<b>"id":<String_value>,
</b><b>"sessionid":<String_value>,
</b><b>"bindtype":<String_value>,
</b><b>"countavailable":<String_value>,
</b>"licensedir":<String_value>,
"useproxy":<String_value>
}}

Response:

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

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsaptlicense

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsaptlicense?args=serialno:<String_value>,useproxy:<String_value>

Use this query-parameter to get nsaptlicense resources based on additional properties.

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "nsaptlicense": [ {
<b>serialno:<String_value>,</b>useproxy:<String_value>"response":<String_value>,
"id":<String_value>,
"sessionid":<String_value>,
"bindtype":<String_value>,
"countavailable":<String_value>,
"counttotal":<String_value>,
"name":<String_value>,
"relevance":<String_value>,
"datepurchased":<String_value>,
"datesa":<String_value>,
"dateexp":<String_value>,
"features":<String[]_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsaptlicense?args=serialno:<String_value>,useproxy:<String_value>;count=yes

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "nsaptlicense": [ { "__count": "#no"} ] }