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 Read-write Web Logging.
sp Read-write Surge Protection.
lb Read-write Load Balancing.
cs Read-write Content Switching.
cr Read-write Cache Redirect.
sc Read-write Sure Connect.
cmp Read-write Compression.
delta Read-write Delta Compression.
pq Read-write Priority Queuing.
ssl Read-write Secure Sockets Layer.
gslb Read-write Global Server Load Balancing.
gslbp Read-write GSLB Proximity.
hdosp Read-write DOS Protection.
routing Read-write Routing.
cf Read-write Content Filter.
contentaccelerator Read-write transparent Integrated Caching.
ic Read-write Integrated Caching.
sslvpn Read-write SSL VPN.
f_sslvpn_users Read-write Number of licensed users allowed by this license.
f_ica_users 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 Read-write AAA.
ospf Read-write OSPF Routing.
rip Read-write RIP Routing.
bgp Read-write BGP Routing.
rewrite Read-write Rewrite.
ipv6pt Read-write IPv6 protocol translation.
appfw Read-write Application Firewall.
responder Read-write Responder.
agee Read-write .
nsxn Read-write .
htmlinjection Read-write HTML Injection.
modelid 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 Read-write Citrix ADC Push.
    wionns Read-write WI on NS.
    appflow Read-write AppFlow.
    cloudbridge Read-write CloudBridge.
    cloudbridgeappliance Read-write .
    cloudextenderappliance Read-write .
    isis Read-write ISIS Routing.
    cluster Read-write Clustering.
    ch Read-write Call Home.
    appqoe Read-write AppQoS.
    appflowica Read-write Appflow for ICA.
    isstandardlic Read-write Standard License.
    isenterpriselic Read-write Enterprise License.
    isplatinumlic Read-write Platinum License.
    issgwylic Read-write Simple Gateway License.
    isswglic Read-write Secure Web Gateway License.
    feo Read-write Front End Optimization.
    lsn Read-write Large Scale NAT.
    licensingmode Read-write Pooled Licensed.

    Default value: Local

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

    Minimum value = 0

    Maximum value = 4294967294
    rdpproxy Read-write RDPPROXY.
    rep Read-write Reputation Services.
    urlfiltering Read-write URL Filtering.
    videooptimization Read-write Video Optimization.
    forwardproxy Read-write Forward Proxy.
    sslinterception Read-write SSL Interception.
    remotecontentinspection Read-write Remote Content Inspection.
    adaptivetcp Read-write Adaptive TCP.
    cqa Read-write Connection Quality Analytics.
    bot Read-write Bot Management.
    apigateway 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 | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
    © 1999- Cloud Software Group, Inc. All rights reserved.