nslicenseserver

Last published : Oct 30, 2026
Configuration for licenseserver resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
licenseserverip <String> Read-write IP address of the License server.
Minimum length = 1
servername <String> Read-write Fully qualified domain name of the License server.
port <Integer> Read-write License server port.
forceupdateip <Boolean> Read-write If this flag is used while adding the licenseserver, existing config will be overwritten. Use this flag only if you are sure that the new licenseserver has the required capacity.
licensemode <String> Read-write This paramter indicates type of license customer interested while configuring add/set licenseserver.
Possible values = Pooled, VCPU, CICO, SelfManagedPool, SelfManagedvCPU, LAS
username <String> Read-write Username to authenticate with ADM Agent for LAS licensing. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters.
Minimum length = 1
Maximum length = 127
password <String> Read-write Password to use when authenticating with ADM Agent for LAS licensing.
Minimum length = 1
deviceprofilename <String> Read-write Device profile is created on ADM and contains the user name and password of the instance(s). ADM will use this info to add the NS for registration.
Minimum length = 1
Maximum length = 255
nodeid <Integer> Read-write Unique number that identifies the cluster node.
Minimum value = 0
Maximum value = 31
status <Integer> Read-only Status of license server.
grace <Integer> Read-only Grace status of server.
gptimeleft <Integer> Read-only Grace time left.
type <String> Read-only License Server type CLA/ADM.
Possible values = ADM, CLA
_nextgenapiresource <String> Read-only .
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • ADD
  • DELETE
  • UPDATE
  • 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 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

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/nslicenseserver HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"nslicenseserver":{
"licenseserverip":<String_value>,
"servername":<String_value>,
"port":<Integer_value>,
"forceupdateip":<Boolean_value>,
"licensemode":<String_value>,
"username":<String_value>,
"password":<String_value>,
"deviceprofilename":<String_value>
}}
Response: HTTP Status Code on Success: 201 Created
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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/nslicenseserver/ licenseserverip_value<String> Query-parameters: args=servername: <String_value>

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/nslicenseserver HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"nslicenseserver":{
"licenseserverip":<String_value>,
"servername":<String_value>,
"port":<Integer_value>,
"licensemode":<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 NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/nslicenseserver Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/nslicenseserver? args=licenseserverip: <String_value> ,servername: <String_value> ,nodeid: <Integer_value>
Use this query-parameter to get nslicenseserver resources based on additional properties.
attrs http:// <netscaler-ip-address> /nitro/v1/config/nslicenseserver? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
filter http:// <netscaler-ip-address> /nitro/v1/config/nslicenseserver? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of nslicenseserver resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/nslicenseserver? view=summary
Use this query-parameter to get the summary output of nslicenseserver resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination http:// <netscaler-ip-address> /nitro/v1/config/nslicenseserver? pagesize=#no;pageno=#no
Use this query-parameter to get the nslicenseserver resources in chunks.
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:
{ "nslicenseserver": [ {
licenseserverip:<String_value>,servername:<String_value>,nodeid:<Integer_value>"port":<Integer_value>,
"status":<Integer_value>,
"grace":<Integer_value>,
"gptimeleft":<Integer_value>,
"type":<String_value>,
"deviceprofilename":<String_value>,
"licensemode":<String_value>,
"_nextgenapiresource":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/nslicenseserver? 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 NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "nslicenseserver": [ { "__count": "#no"} ] }