Skip to content

nsfeature

Configuration for feature resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
feature <String[]> Read-write Feature to be enabled. Multiple features can be specified by providing a blank space between each feature.
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.
pq <Boolean> Read-only Priority Queuing.
ssl <Boolean> Read-only Secure Sockets Layer.
gslb <Boolean> Read-only Global Server Load Balancing.
hdosp <Boolean> Read-only DOS Protection.
cf <Boolean> Read-only Content Filter.
ic <Boolean> Read-only Integrated Caching.
sslvpn <Boolean> Read-only SSL VPN.
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.
htmlinjection <Boolean> Read-only HTML Injection.
push <Boolean> Read-only Citrix ADC Push.
appflow <Boolean> Read-only AppFlow.
cloudbridge <Boolean> Read-only CloudBridge.
isis <Boolean> Read-only ISIS Routing.
ch <Boolean> Read-only Call Home.
appqoe <Boolean> Read-only AppQoS.
contentaccelerator <Boolean> Read-only Transparent Integrated Caching.
rise <Boolean> Read-only RISE.
feo <Boolean> Read-only Optimize Web content (HTML, CSS, JavaScript, images).
lsn <Boolean> Read-only Large Scale NAT.
rdpproxy <Boolean> Read-only RDPPROXY.
rep <Boolean> Read-only Reputation Services.
urlfiltering <Boolean> Read-only URL Filtering.
videooptimization <Boolean> Read-only Video Optimization.
forwardproxy <Boolean> Read-only Forward Proxy.
sslinterception <Boolean> Read-only SSL Interception.
adaptivetcp <Boolean> Read-only Adaptive TCP.
cqa <Boolean> Read-only Connection Quality Analytics.
ci <Boolean> Read-only Content Inspection.
bot <Boolean> Read-only Bot Management.

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 error

Response Header:

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>,
      "forwardproxy":<Boolean_value>,
      "sslinterception":<Boolean_value>,
      "adaptivetcp":<Boolean_value>,
      "cqa":<Boolean_value>,
      "ci":<Boolean_value>,
      "bot":<Boolean_value>
}]}