Download full document:

nsfeature

Configuration for feature resource.

Properties

(click to see Operations)

Name Data Type PermissionsDescription
feature<String[]>Read-writeFeature to be enabled. Multiple features can be specified by providing a blank space between each feature.
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.
pq<Boolean>Read-onlyPriority Queuing.
ssl<Boolean>Read-onlySecure Sockets Layer.
gslb<Boolean>Read-onlyGlobal Server Load Balancing.
hdosp<Boolean>Read-onlyDOS Protection.
cf<Boolean>Read-onlyContent Filter.
ic<Boolean>Read-onlyIntegrated Caching.
sslvpn<Boolean>Read-onlySSL VPN.
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.
htmlinjection<Boolean>Read-onlyHTML Injection.
push<Boolean>Read-onlyNetScaler Push.
appflow<Boolean>Read-onlyAppFlow.
cloudbridge<Boolean>Read-onlyCloudBridge.
isis<Boolean>Read-onlyISIS Routing.
ch<Boolean>Read-onlyCall Home.
appqoe<Boolean>Read-onlyAppQoS.
contentaccelerator<Boolean>Read-onlyTransparent Integrated Caching.
rise<Boolean>Read-onlyRISE.
feo<Boolean>Read-onlyOptimize Web content (HTML, CSS, JavaScript, images).
lsn<Boolean>Read-onlyLarge Scale NAT.
rdpproxy<Boolean>Read-onlyRDPPROXY.
rep<Boolean>Read-onlyReputation Services.
urlfiltering<Boolean>Read-onlyURL Filtering.
videooptimization<Boolean>Read-onlyVideo Optimization.

Operations

(click to see Properties)

ENABLE | DISABLE | 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>.

enable

URL: http://<netscaler-ip-address>/nitro/v1/config/nsfeature?action=enable

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"nsfeature":{
      "feature":<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

disable

URL: http://<netscaler-ip-address>/nitro/v1/config/nsfeature?action=disable

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"nsfeature":{
      "feature":<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/nsfeature

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:

{ "nsfeature": [ {
      "feature":<String[]_value>,
      "wl":<Boolean_value>,
      "sp":<Boolean_value>,
      "lb":<Boolean_value>,
      "cs":<Boolean_value>,
      "cr":<Boolean_value>,
      "sc":<Boolean_value>,
      "cmp":<Boolean_value>,
      "pq":<Boolean_value>,
      "ssl":<Boolean_value>,
      "gslb":<Boolean_value>,
      "hdosp":<Boolean_value>,
      "routing":<Boolean_value>,
      "cf":<Boolean_value>,
      "ic":<Boolean_value>,
      "sslvpn":<Boolean_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>,
      "htmlinjection":<Boolean_value>,
      "push":<Boolean_value>,
      "appflow":<Boolean_value>,
      "cloudbridge":<Boolean_value>,
      "isis":<Boolean_value>,
      "ch":<Boolean_value>,
      "appqoe":<Boolean_value>,
      "contentaccelerator":<Boolean_value>,
      "rise":<Boolean_value>,
      "feo":<Boolean_value>,
      "lsn":<Boolean_value>,
      "rdpproxy":<Boolean_value>,
      "rep":<Boolean_value>,
      "urlfiltering":<Boolean_value>,
      "videooptimization":<Boolean_value>
}]}