Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

nslicense

August 17, 2023
Contributed by: 
C

Configuration for license resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
wl <Boolean> Read-write Web Logging.
sp <Boolean> Read-write Surge Protection.
lb <Boolean> Read-write Load Balancing.
cs <Boolean> Read-write Content Switching.
cr <Boolean> Read-write Cache Redirect.
sc <Boolean> Read-write Sure Connect.
cmp <Boolean> Read-write Compression.
delta <Boolean> Read-write Delta Compression.
pq <Boolean> Read-write Priority Queuing.
ssl <Boolean> Read-write Secure Sockets Layer.
gslb <Boolean> Read-write Global Server Load Balancing.
gslbp <Boolean> Read-write GSLB Proximity.
hdosp <Boolean> Read-write DOS Protection.
routing <Boolean> Read-write Routing.
cf <Boolean> Read-write Content Filter.
contentaccelerator <Boolean> Read-write transparent Integrated Caching.
ic <Boolean> Read-write Integrated Caching.
sslvpn <Boolean> Read-write SSL VPN.
f_sslvpn_users <Double> Read-write Number of licensed users allowed by this license.
f_ica_users <Double> Read-write Number of licensed users allowed by ICAONLY license. As long as the AG Feature is licensed,

unlimited number of ICA connections are accepted.

(In API, 0 value for this parameter means unlimited when AG license in ON).
aaa <Boolean> Read-write AAA.
ospf <Boolean> Read-write OSPF Routing.
rip <Boolean> Read-write RIP Routing.
bgp <Boolean> Read-write BGP Routing.
rewrite <Boolean> Read-write Rewrite.
ipv6pt <Boolean> Read-write IPv6 protocol translation.
appfw <Boolean> Read-write Application Firewall.
responder <Boolean> Read-write Responder.
agee <Boolean> Read-write .
nsxn <Boolean> Read-write .
htmlinjection <Boolean> Read-write HTML Injection.
modelid <Double> Read-write Model Number ID.

Represents different numbers for two types of licenses.:

* Bandwidth licenses - specifies the throughput bandwidth licensed for this appliance

e.g. (For 20 Gbps) Model Number ID: 20000

* vCPU licenses - specifies number of vCPUs licensed for this appliance.

e.g. (For 4 vCPU) Model Number ID: 4 vCPUs.
push <Boolean> Read-write Citrix ADC Push.
wionns <Boolean> Read-write WI on NS.
appflow <Boolean> Read-write AppFlow.
cloudbridge <Boolean> Read-write CloudBridge.
cloudbridgeappliance <Boolean> Read-write .
cloudextenderappliance <Boolean> Read-write .
isis <Boolean> Read-write ISIS Routing.
cluster <Boolean> Read-write Clustering.
ch <Boolean> Read-write Call Home.
appqoe <Boolean> Read-write AppQoS.
appflowica <Boolean> Read-write Appflow for ICA.
isstandardlic <Boolean> Read-write Standard License.
isenterpriselic <Boolean> Read-write Enterprise License.
isplatinumlic <Boolean> Read-write Platinum License.
issgwylic <Boolean> Read-write Simple Gateway License.
isswglic <Boolean> Read-write Secure Web Gateway License.
feo <Boolean> Read-write Front End Optimization.
lsn <Boolean> Read-write Large Scale NAT.
licensingmode <String> Read-write Pooled Licensed.

Default value: Local

Possible values = Local, Pooled, CICO, EXPRESS, CPU, CPU-Local
daystoexpiration <Double> Read-write Days to expire.

Minimum value = 0

Maximum value = 4294967294
rdpproxy <Boolean> Read-write RDPPROXY.
rep <Boolean> Read-write Reputation Services.
urlfiltering <Boolean> Read-write URL Filtering.
videooptimization <Boolean> Read-write Video Optimization.
forwardproxy <Boolean> Read-write Forward Proxy.
sslinterception <Boolean> Read-write SSL Interception.
remotecontentinspection <Boolean> Read-write Remote Content Inspection.
adaptivetcp <Boolean> Read-write Adaptive TCP.
cqa <Boolean> Read-write Connection Quality Analytics.
bot <Boolean> Read-write Bot Management.
apigateway <Boolean> Read-write API Gateway.

Operations

(click to see Properties )

  • 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

get (all)

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

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: 


{ "nslicense": [ {
      "wl":<Boolean_value>,
      "sp":<Boolean_value>,
      "lb":<Boolean_value>,
      "cs":<Boolean_value>,
      "cr":<Boolean_value>,
      "sc":<Boolean_value>,
      "cmp":<Boolean_value>,
      "delta":<Boolean_value>,
      "pq":<Boolean_value>,
      "ssl":<Boolean_value>,
      "gslb":<Boolean_value>,
      "gslbp":<Boolean_value>,
      "hdosp":<Boolean_value>,
      "routing":<Boolean_value>,
      "cf":<Boolean_value>,
      "contentaccelerator":<Boolean_value>,
      "ic":<Boolean_value>,
      "sslvpn":<Boolean_value>,
      "f_sslvpn_users":<Double_value>,
      "f_ica_users":<Double_value>,
      "aaa":<Boolean_value>,
      "ospf":<Boolean_value>,
      "rip":<Boolean_value>,
      "bgp":<Boolean_value>,
      "rewrite":<Boolean_value>,
      "ipv6pt":<Boolean_value>,
      "appfw":<Boolean_value>,
      "responder":<Boolean_value>,
      "agee":<Boolean_value>,
      "nsxn":<Boolean_value>,
      "htmlinjection":<Boolean_value>,
      "modelid":<Double_value>,
      "push":<Boolean_value>,
      "wionns":<Boolean_value>,
      "appflow":<Boolean_value>,
      "cloudbridge":<Boolean_value>,
      "cloudbridgeappliance":<Boolean_value>,
      "cloudextenderappliance":<Boolean_value>,
      "isis":<Boolean_value>,
      "cluster":<Boolean_value>,
      "ch":<Boolean_value>,
      "appqoe":<Boolean_value>,
      "appflowica":<Boolean_value>,
      "isstandardlic":<Boolean_value>,
      "isenterpriselic":<Boolean_value>,
      "isplatinumlic":<Boolean_value>,
      "issgwylic":<Boolean_value>,
      "isswglic":<Boolean_value>,
      "feo":<Boolean_value>,
      "lsn":<Boolean_value>,
      "licensingmode":<String_value>,
      "daystoexpiration":<Double_value>,
      "rdpproxy":<Boolean_value>,
      "rep":<Boolean_value>,
      "urlfiltering":<Boolean_value>,
      "videooptimization":<Boolean_value>,
      "forwardproxy":<Boolean_value>,
      "sslinterception":<Boolean_value>,
      "remotecontentinspection":<Boolean_value>,
      "adaptivetcp":<Boolean_value>,
      "cqa":<Boolean_value>,
      "bot":<Boolean_value>,
      "apigateway":<Boolean_value>
}]}

<!--NeedCopy-->
nslicense
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

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