Download full document:

nsacl

Statistics for ACL entry resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
aclname<String>Read-writeName of the extended ACL rule whose statistics you want the Citrix ADC to display.
Minimum length = 1
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
acltotpktsbridged<Double>Read-onlyPackets matching a bridge ACL, which is in transparent mode and bypasses service processing.
aclpktsbridgedrate<Double>Read-onlyRate (/s) counter for acltotpktsbridged
acltotpktsdenied<Double>Read-onlyPackets dropped because they match ACLs with processing mode set to DENY.
aclpktsdeniedrate<Double>Read-onlyRate (/s) counter for acltotpktsdenied
acltotpktsallowed<Double>Read-onlyPackets matching ACLs with processing mode set to ALLOW. Citrix ADC processes these packets.
aclpktsallowedrate<Double>Read-onlyRate (/s) counter for acltotpktsallowed
acltotpktsnat<Double>Read-onlyPackets matching a NAT ACL, resulting in a NAT session.
aclpktsnatrate<Double>Read-onlyRate (/s) counter for acltotpktsnat
acltothits<Double>Read-onlyPackets matching an ACL.
aclhitsrate<Double>Read-onlyRate (/s) counter for acltothits
acltotmisses<Double>Read-onlyPackets not matching any ACL.
aclmissesrate<Double>Read-onlyRate (/s) counter for acltotmisses
acltotcount<Double>Read-onlyTotal number of ACL rules configured.
dfdacltothits<Double>Read-onlyPackets matching an dfd ACL.
dfdaclhitsrate<Double>Read-onlyRate (/s) counter for dfdacltothits
dfdacltotmisses<Double>Read-onlyPackets not matching any DFD ACL.
dfdaclmissesrate<Double>Read-onlyRate (/s) counter for dfdacltotmisses
dfdacltotcount<Double>Read-onlyTotal number of DFD ACL rules configured.
aclperhits<Double>Read-onlyNumber of times the acl was hit
aclperhitsrate<Double>Read-onlyRate (/s) counter for aclperhits

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 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<netscaler-ip-address>/nitro/v1/stat/nsacl

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/stat/nsacl?args=aclname:<String_value>,detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get nsacl 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 NetScaler-specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "nsacl": [ {
"aclname":<String_value>,
"acltotpktsnat":<Double_value>,
"aclpktsdeniedrate":<Double_value>,
"aclhitsrate":<Double_value>,
"aclpktsallowedrate":<Double_value>,
"dfdaclhitsrate":<Double_value>,
"dfdacltotcount":<Double_value>,
"dfdacltothits":<Double_value>,
"acltotpktsallowed":<Double_value>,
"aclpktsbridgedrate":<Double_value>,
"acltotpktsdenied":<Double_value>,
"acltothits":<Double_value>,
"aclperhits":<Double_value>,
"dfdaclmissesrate":<Double_value>,
"aclperhitsrate":<Double_value>,
"aclpktsnatrate":<Double_value>,
"dfdacltotmisses":<Double_value>,
"acltotcount":<Double_value>,
"acltotmisses":<Double_value>,
"acltotpktsbridged":<Double_value>,
"aclmissesrate":<Double_value>
}]}

get

URL:http://<netscaler-ip-address>/nitro/v1/stat/nsacl/aclname_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 NetScaler-specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "nsacl": [ {
"aclname":<String_value>,
"acltotpktsnat":<Double_value>,
"aclpktsdeniedrate":<Double_value>,
"aclhitsrate":<Double_value>,
"aclpktsallowedrate":<Double_value>,
"dfdaclhitsrate":<Double_value>,
"dfdacltotcount":<Double_value>,
"dfdacltothits":<Double_value>,
"acltotpktsallowed":<Double_value>,
"aclpktsbridgedrate":<Double_value>,
"acltotpktsdenied":<Double_value>,
"acltothits":<Double_value>,
"aclperhits":<Double_value>,
"dfdaclmissesrate":<Double_value>,
"aclperhitsrate":<Double_value>,
"aclpktsnatrate":<Double_value>,
"dfdacltotmisses":<Double_value>,
"acltotcount":<Double_value>,
"acltotmisses":<Double_value>,
"acltotpktsbridged":<Double_value>,
"aclmissesrate":<Double_value>
}]}