Developer Documentation
Citrix ADC 12.1 NITRO API Reference
Current Release 13.1 13

nsfeature

August 17, 2023
Contributed by: 
C

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 Read-only Web Logging.
sp Read-only Surge Protection.
lb Read-only Load Balancing.
cs Read-only Content Switching.
cr Read-only Cache Redirect.
sc Read-only Sure Connect.
cmp Read-only Compression.
pq Read-only Priority Queuing.
ssl Read-only Secure Sockets Layer.
gslb Read-only Global Server Load Balancing.
hdosp Read-only DOS Protection.
cf Read-only Content Filter.
ic Read-only Integrated Caching.
sslvpn Read-only SSL VPN.
aaa Read-only AAA.
ospf Read-only OSPF Routing.
rip Read-only RIP Routing.
bgp Read-only BGP Routing.
rewrite Read-only Rewrite.
ipv6pt Read-only IPv6 protocol translation.
appfw Read-only Application Firewall.
responder Read-only Responder.
htmlinjection Read-only HTML Injection.
push Read-only Citrix ADC Push.
appflow Read-only AppFlow.
cloudbridge Read-only CloudBridge.
isis Read-only ISIS Routing.
ch Read-only Call Home.
appqoe Read-only AppQoS.
contentaccelerator Read-only Transparent Integrated Caching.
rise Read-only RISE.
feo Read-only Optimize Web content (HTML, CSS, JavaScript, images).
lsn Read-only Large Scale NAT.
rdpproxy Read-only RDPPROXY.
rep Read-only Reputation Services.
urlfiltering Read-only URL Filtering.
videooptimization Read-only Video Optimization.
forwardproxy Read-only Forward Proxy.
sslinterception Read-only SSL Interception.
adaptivetcp Read-only Adaptive TCP.
cqa Read-only Connection Quality Analytics.
ci Read-only Content Inspection.

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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>.

enable

URL:http://<Citrix-ADC-IP-address(NSIP)>/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>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

disable

URL:http://<Citrix-ADC-IP-address(NSIP)>/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>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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>,
"forwardproxy":<Boolean_value>,
"sslinterception":<Boolean_value>,
"adaptivetcp":<Boolean_value>,
"cqa":<Boolean_value>,
"ci":<Boolean_value>
}]}

<!--NeedCopy-->
nsfeature
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.