Download full document:

nssimpleacl

Configuration for simple ACL resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
aclname	<String>	Read-write	Name for the simple ACL rule. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the simple ACL rule is created.<br>Minimum length = 1
aclaction	<String>	Read-write	Drop incoming IPv4 packets that match the simple ACL rule.<br>Possible values = DENY
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
srcip	<String>	Read-write	IP address to match against the source IP address of an incoming IPv4 packet.
destport	<Integer>	Read-write	Port number to match against the destination port number of an incoming IPv4 packet. Omitting the port number creates an all-ports simple ACL rule, which matches any port. In that case, you cannot create another simple ACL rule specifying a specific port and the same source IPv4 address.
protocol	<String>	Read-write	Protocol to match against the protocol of an incoming IPv4 packet. You must set this parameter if you have set the Destination Port parameter.<br>Possible values = TCP, UDP
ttl	<Double>	Read-write	Number of seconds, in multiples of four, after which the simple ACL rule expires. If you do not want the simple ACL rule to expire, do not specify a TTL value.<br>Minimum value = 4<br>Maximum value = 2147483647
estsessions	<Boolean>	Read-write	.
hits	<Double>	Read-only	Number of hits for this ACL rule.
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties)

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",
"nssimpleacl":{
      "aclname":<String_value>,
      "aclaction":<String_value>,
      "td":<Double_value>,
      "srcip":<String_value>,
      "destport":<Integer_value>,
                  "protocol":<String_value>,
      "ttl":<Double_value>,
}}

Response Payload:

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

clear

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

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"clear"
},
"sessionid":"##sessionid",
"nssimpleacl":{
}}

Response Payload:

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

delete

URL: http://<NSIP>/nitro/v1/config/nssimpleacl/aclname_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/nssimpleacl/aclname_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": }

flush

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

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"flush"
},
"sessionid":"##sessionid",
"nssimpleacl":{
      "estsessions":<Boolean_value>,
}}

Response Payload:

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

get (all)

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

Query-parameters:

filter

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

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

view

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

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

pagesize=#no;pageno=#no

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

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

warning

http://<NS_IP>/nitro/v1/config/nssimpleacl?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>, "nssimpleacl": [ {
      "aclname":<String_value>,
      "aclaction":<String_value>,
      "td":<Double_value>,
      "srcip":<String_value>,
      "destport":<Integer_value>,
      "protocol":<String_value>,
      "ttl":<Double_value>,
      "hits":<Double_value>

}]}

get

URL: http://<NS_IP>/nitro/v1/config/nssimpleacl/aclname_value<String>

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "nssimpleacl": [ {
      "aclname":<String_value>,
      "aclaction":<String_value>,
      "td":<Double_value>,
      "srcip":<String_value>,
      "destport":<Integer_value>,
      "protocol":<String_value>,
      "ttl":<Double_value>,
      "hits":<Double_value>

}]}

count

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

HTTP Method: GET

Response Payload:

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