Download full document:

ipset

Configuration for network ipset resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
name	<String>	Read-write	Name for the IP set. Must begin with a letter, number, or the underscore character (_), and can consist of letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore characters. Cannot be changed after the IP set is created. Choose a name that helps identify the IP set.<br>Minimum length = 1
td	<Double>	Read-write	Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.<br>Minimum value = 0<br>Maximum value = 4094
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties)

ADD | DELETE | GET (ALL) | GET | COUNT

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

add

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
"sessionid":"##sessionid",
"ipset":{
      "name":<String_value>,
      "td":<Double_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete

URL: http://<NSIP>/nitro/v1/config/ipset/name_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/ipset/name_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/ipset

Query-parameters:

filter

http://<NSIP>/nitro/v1/config/ipset?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of ipset resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<NS_IP>/nitro/v1/config/ipset?view=summary

Use this query-parameter to get the summary output of ipset resources configured on NetScaler.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/ipset?pagesize=#no;pageno=#no

Use this query-parameter to get the ipset resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/ipset?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "ipset": [ {
      "name":<String_value>,
      "td":<Double_value>

}]}

get

URL: http://<NS_IP>/nitro/v1/config/ipset/name_value<String>

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "ipset": [ {
      "name":<String_value>,
      "td":<Double_value>

}]}

count

URL: http://<NS_IP>/nitro/v1/config/ipset?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",ipset: [ { "__count": "#no"} ] }