Citrix ADC 12.1 NITRO API Reference

nsacl6

Statistics for ACL6 entry resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
acl6name Read-write Name of the ACL6 rule whose statistics you want the Citrix ADC to display.
Minimum length = 1
clearstats Read-write Clear the statsistics / counters.
Possible values = basic, full
acl6totpktsbridged Read-only Packets matching a bridge IPv6 ACL, which is in transparent mode and bypasses service processing.
acl6pktsbridgedrate Read-only Rate (/s) counter for acl6totpktsbridged
acl6totpktsdenied Read-only Packets dropped because they match IPv6 ACLs with processing mode set to DENY.
acl6pktsdeniedrate Read-only Rate (/s) counter for acl6totpktsdenied
acl6totpktsallowed Read-only Packets matching IPv6 ACLs with processing mode set to ALLOW. Citrix ADC processes these packets.
acl6pktsallowedrate Read-only Rate (/s) counter for acl6totpktsallowed
acl6totpktsnat Read-only Packets matching a NAT ACL6, resulting in a NAT session.
acl6pktsnatrate Read-only Rate (/s) counter for acl6totpktsnat
acl6tothits Read-only Packets matching an IPv6 ACL.
acl6hitsrate Read-only Rate (/s) counter for acl6tothits
acl6totmisses Read-only Packets not matching any IPv6 ACL.
acl6missesrate Read-only Rate (/s) counter for acl6totmisses
acl6totpktsnat64 Read-only Packets matching a NAT64 ACL6, resulting in a NAT64 translation.
acl6pktsnat64rate Read-only Rate (/s) counter for acl6totpktsnat64
acl6totcount Read-only Total number of ACL6 rules configured.
dfdacl6totcount Read-only Total number of DFD ACL6 rules configured.
dfdacl6tothits Read-only Packets matching an dfd ACL6.
dfdacl6hitsrate Read-only Rate (/s) counter for dfdacl6tothits
dfdacl6totmisses Read-only Packets not matching any DFD ACL6.
dfdacl6missesrate Read-only Rate (/s) counter for dfdacl6totmisses
acl6perhits Read-only Number of times the acl6 was hit
acl6perhitsrate Read-only Rate (/s) counter for acl6perhits

Operations

(click to see Properties)

GET (ALL) GET

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

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/nsacl6

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/nsacl6?args=acl6name:<String_value>,detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get nsacl6 resources based on additional properties.

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:


{ "nsacl6": [ {
"acl6name":<String_value>,
"acl6pktsnatrate":<Double_value>,
"acl6missesrate":<Double_value>,
"acl6totmisses":<Double_value>,
"dfdacl6hitsrate":<Double_value>,
"acl6totpktsnat64":<Double_value>,
"acl6pktsnat64rate":<Double_value>,
"acl6totpktsnat":<Double_value>,
"dfdacl6tothits":<Double_value>,
"dfdacl6totmisses":<Double_value>,
"acl6perhitsrate":<Double_value>,
"acl6perhits":<Double_value>,
"acl6tothits":<Double_value>,
"acl6pktsbridgedrate":<Double_value>,
"acl6pktsallowedrate":<Double_value>,
"acl6totpktsbridged":<Double_value>,
"acl6totpktsdenied":<Double_value>,
"acl6totcount":<Double_value>,
"acl6totpktsallowed":<Double_value>,
"acl6pktsdeniedrate":<Double_value>,
"acl6hitsrate":<Double_value>,
"dfdacl6missesrate":<Double_value>,
"dfdacl6totcount":<Double_value>
}]}

<!--NeedCopy-->

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/nsacl6/acl6name_value><String>

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:


{ "nsacl6": [ {
"acl6name":<String_value>,
"acl6pktsnatrate":<Double_value>,
"acl6missesrate":<Double_value>,
"acl6totmisses":<Double_value>,
"dfdacl6hitsrate":<Double_value>,
"acl6totpktsnat64":<Double_value>,
"acl6pktsnat64rate":<Double_value>,
"acl6totpktsnat":<Double_value>,
"dfdacl6tothits":<Double_value>,
"dfdacl6totmisses":<Double_value>,
"acl6perhitsrate":<Double_value>,
"acl6perhits":<Double_value>,
"acl6tothits":<Double_value>,
"acl6pktsbridgedrate":<Double_value>,
"acl6pktsallowedrate":<Double_value>,
"acl6totpktsbridged":<Double_value>,
"acl6totpktsdenied":<Double_value>,
"acl6totcount":<Double_value>,
"acl6totpktsallowed":<Double_value>,
"acl6pktsdeniedrate":<Double_value>,
"acl6hitsrate":<Double_value>,
"dfdacl6missesrate":<Double_value>,
"dfdacl6totcount":<Double_value>
}]}

<!--NeedCopy-->
nsacl6