Product Documentation

nssimpleacl6

Sep 07, 2016

Configuration for simple ACL6 resource.

Properties (click to see Operations)

Name Data Type Permissions Description
aclname
<String>
Read-write
Name for the simple ACL6 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 ACL6 rule is created.
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.
Minimum value = 0
Maximum value = 4094
aclaction
<String>
Read-write
Drop incoming IPv6 packets that match the simple ACL6 rule.
Possible values = DENY
srcipv6
<String>
Read-write
IP address to match against the source IP address of an incoming IPv6 packet.
destport
<Integer>
Read-write
Port number to match against the destination port number of an incoming IPv6 packet.

Omitting the port number creates an all-ports simple ACL6 rule, which matches any port. In that case, you cannot create another simple ACL6 rule specifying a specific port and the same source IPv6 address.
protocol
<String>
Read-write
Protocol to match against the protocol of an incoming IPv6 packet. You must set this parameter if you set the Destination Port parameter.
Possible values = TCP, UDP
ttl
<Double>
Read-write
Number of seconds, in multiples of four, after which the simple ACL6 rule expires. If you do not want the simple ACL6 rule to expire, do not specify a TTL value.
Minimum value = 4
Maximum value = 2147483647
estsessions
<Boolean>
Read-write
.
hits
<Double>
Read-only
Number of hits for this SACL6 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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: http://<netscaler-ip-address>/nitro/v1/config/nssimpleacl6

HTTP Method: POST

Request Headers:

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

Request Payload:

{"nssimpleacl6":{
      "aclname":<String_value>,
      "td":<Double_value>,
      "aclaction":<String_value>,
      "srcipv6":<String_value>,
      "destport":<Integer_value>,
      "protocol":<String_value>,
      "ttl":<Double_value>
}}

Response:

HTTP Status Code on Success: 201 Created
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

clear

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"nssimpleacl6":{
}}

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

flush

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"nssimpleacl6":{
      "estsessions":<Boolean_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

delete

URL: http://<netscaler-ip-address>/nitro/v1/config/nssimpleacl6/aclname_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

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/nssimpleacl6

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/nssimpleacl6?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/nssimpleacl6?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<netscaler-ip-address>/nitro/v1/config/nssimpleacl6?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/nssimpleacl6?pagesize=#no&pageno=#no

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

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 Headers:

Content-Type:application/json

Response Payload:

{ "nssimpleacl6": [ {
      "aclname":<String_value>,
      "aclaction":<String_value>,
      "td":<Double_value>,
      "srcipv6":<String_value>,
      "destport":<Integer_value>,
      "protocol":<String_value>,
      "ttl":<Double_value>,
      "hits":<Double_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/nssimpleacl6/aclname_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/nssimpleacl6/aclname_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<netscaler-ip-address>/nitro/v1/config/nssimpleacl6/aclname_value<String>?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

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 Headers:

Content-Type:application/json

Response Payload:

{ "nssimpleacl6": [ {
      "aclname":<String_value>,
      "aclaction":<String_value>,
      "td":<Double_value>,
      "srcipv6":<String_value>,
      "destport":<Integer_value>,
      "protocol":<String_value>,
      "ttl":<Double_value>,
      "hits":<Double_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/nssimpleacl6?count=yes

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 Headers:

Content-Type:application/json

Response Payload:

{ "nssimpleacl6": [ { "__count": "#no"} ] }