Download full document:

nslicense

Configuration for license resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
wl<Boolean>Read-onlyWeb Logging.
sp<Boolean>Read-onlySurge Protection.
lb<Boolean>Read-onlyLoad Balancing.
cs<Boolean>Read-onlyContent Switching.
cr<Boolean>Read-onlyCache Redirect.
sc<Boolean>Read-onlySure Connect.
cmp<Boolean>Read-onlyCompression.
delta<Boolean>Read-onlyDelta Compression.
pq<Boolean>Read-onlyPriority Queuing.
ssl<Boolean>Read-onlySecure Sockets Layer.
gslb<Boolean>Read-onlyGlobal Server Load Balancing.
gslbp<Boolean>Read-onlyGSLB Proximity.
hdosp<Boolean>Read-onlyDOS Protection.
routing<Boolean>Read-onlyRouting.
cf<Boolean>Read-onlyContent Filter.
contentaccelerator<Boolean>Read-onlytransparent Integrated Caching.
ic<Boolean>Read-onlyIntegrated Caching.
sslvpn<Boolean>Read-onlySSL VPN.
f_sslvpn_users<Double>Read-onlyNumber of licensed users allowed by this license.
f_ica_users<Double>Read-onlyNumber 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-onlyAAA.
ospf<Boolean>Read-onlyOSPF Routing.
rip<Boolean>Read-onlyRIP Routing.
bgp<Boolean>Read-onlyBGP Routing.
rewrite<Boolean>Read-onlyRewrite.
ipv6pt<Boolean>Read-onlyIPv6 protocol translation.
appfw<Boolean>Read-onlyApplication Firewall.
responder<Boolean>Read-onlyResponder.
agee<Boolean>Read-only.
nsxn<Boolean>Read-only.
htmlinjection<Boolean>Read-onlyHTML Injection.
modelid<Double>Read-onlyModel Number ID.
push<Boolean>Read-onlyNetScaler Push.
wionns<Boolean>Read-onlyWI on NS.
appflow<Boolean>Read-onlyAppFlow.
cloudbridge<Boolean>Read-onlyCloudBridge.
cloudbridgeappliance<Boolean>Read-only.
cloudextenderappliance<Boolean>Read-only.
isis<Boolean>Read-onlyISIS Routing.
cluster<Boolean>Read-onlyClustering.
ch<Boolean>Read-onlyCall Home.
appqoe<Boolean>Read-onlyAppQoS.
appflowica<Boolean>Read-onlyAppflow for ICA.
isstandardlic<Boolean>Read-onlyStandard License.
isenterpriselic<Boolean>Read-onlyEnterprise License.
isplatinumlic<Boolean>Read-onlyPlatinum License.
issgwylic<Boolean>Read-onlySimple Gateway License.
isswglic<Boolean>Read-onlySecure Web Gateway License.
rise<Boolean>Read-onlyRISE.
feo<Boolean>Read-onlyFront End Optimization.
lsn<Boolean>Read-onlyLarge Scale NAT.
licensingmode<String>Read-onlyPooled Licensed.
Default value: Local
Possible values = Local, Pooled, CICO, EXPRESS
rdpproxy<Boolean>Read-onlyRDPPROXY.
rep<Boolean>Read-onlyReputation Services.
urlfiltering<Boolean>Read-onlyURL Filtering.
videooptimization<Boolean>Read-onlyVideo Optimization.
forwardproxy<Boolean>Read-onlyForward Proxy.
sslinterception<Boolean>Read-onlySSL Interception.
remotecontentinspection<Boolean>Read-onlyRemote Content Inspection.
adaptivetcp<Boolean>Read-onlyAdaptive TCP.
cqa<Boolean>Read-onlyConnection Quality Analytics.

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 redand 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 errorResponse 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>,
"isswglic":<Boolean_value>,
"rise":<Boolean_value>,
"feo":<Boolean_value>,
"lsn":<Boolean_value>,
"licensingmode":<String_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>
}]}