Product Documentation

nslicense

Sep 07, 2016

Configuration for license resource.

Properties (click to see Operations)

Name Data Type Permissions Description
wl
<Boolean>
Read-only
Web Logging.
sp
<Boolean>
Read-only
Surge Protection.
lb
<Boolean>
Read-only
Load Balancing.
cs
<Boolean>
Read-only
Content Switching.
cr
<Boolean>
Read-only
Cache Redirect.
sc
<Boolean>
Read-only
Sure Connect.
cmp
<Boolean>
Read-only
Compression.
delta
<Boolean>
Read-only
Delta Compression.
pq
<Boolean>
Read-only
Priority Queuing.
ssl
<Boolean>
Read-only
Secure Sockets Layer.
gslb
<Boolean>
Read-only
Global Server Load Balancing.
gslbp
<Boolean>
Read-only
GSLB Proximity.
hdosp
<Boolean>
Read-only
DOS Protection.
routing
<Boolean>
Read-only
Routing.
cf
<Boolean>
Read-only
Content Filter.
contentaccelerator
<Boolean>
Read-only
transparent Integrated Caching.
ic
<Boolean>
Read-only
Integrated Caching.
sslvpn
<Boolean>
Read-only
SSL VPN.
f_sslvpn_users
<Double>
Read-only
Number of licensed users allowed by this license.
f_ica_users
<Double>
Read-only
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-only
AAA.
ospf
<Boolean>
Read-only
OSPF Routing.
rip
<Boolean>
Read-only
RIP Routing.
bgp
<Boolean>
Read-only
BGP Routing.
rewrite
<Boolean>
Read-only
Rewrite.
ipv6pt
<Boolean>
Read-only
IPv6 protocol translation.
appfw
<Boolean>
Read-only
Application Firewall.
responder
<Boolean>
Read-only
Responder.
agee
<Boolean>
Read-only
.
nsxn
<Boolean>
Read-only
.
htmlinjection
<Boolean>
Read-only
HTML Injection.
modelid
<Double>
Read-only
Model Number ID.
push
<Boolean>
Read-only
NetScaler Push.
wionns
<Boolean>
Read-only
WI on NS.
appflow
<Boolean>
Read-only
AppFlow.
cloudbridge
<Boolean>
Read-only
CloudBridge.
cloudbridgeappliance
<Boolean>
Read-only
.
cloudextenderappliance
<Boolean>
Read-only
.
isis
<Boolean>
Read-only
ISIS Routing.
cluster
<Boolean>
Read-only
Clustering.
ch
<Boolean>
Read-only
Call Home.
appqoe
<Boolean>
Read-only
AppQoS.
appflowica
<Boolean>
Read-only
Appflow for ICA.
isstandardlic
<Boolean>
Read-only
Standard License.
isenterpriselic
<Boolean>
Read-only
Enterprise License.
isplatinumlic
<Boolean>
Read-only
Platinum License.
issgwylic
<Boolean>
Read-only
Simple Gateway License.
rise
<Boolean>
Read-only
RISE.
vpath
<Boolean>
Read-only
Vpath.
feo
<Boolean>
Read-only
Front End Optimization.
lsn
<Boolean>
Read-only
Large Scale NAT.
ispooledlicensing
<String>
Read-only
Pooled Licensed.
Default value: NO
Possible values = YES, NO
rdpproxy
<Boolean>
Read-only
RDPPROXY.
rep
<Boolean>
Read-only
Reputation Services.

Operations (click to see Properties)

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>

메모

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 Headers:

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>,
      "rise":<Boolean_value>,
      "vpath":<Boolean_value>,
      "feo":<Boolean_value>,
      "lsn":<Boolean_value>,
      "ispooledlicensing":<String_value>,
      "rdpproxy":<Boolean_value>,
      "rep":<Boolean_value>
}]}