audit
Statistics for audit.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| clearstats | <String> | Read-write | Clear the statsistics / counters.
Possible values = basic, full
|
| auditsyslogmsgsent | <Double> | Read-only | Syslog messages sent to the syslog server(s) over UDP. |
| auditsyslogmsgsentrate | <Double> | Read-only | Rate (/s) counter for auditsyslogmsgsent |
| auditsyslogmsggen | <Double> | Read-only | Syslog messages about to be sent to the syslog server. |
| auditsyslogmsggenrate | <Double> | Read-only | Rate (/s) counter for auditsyslogmsggen |
| auditsyslogmsgsenttcp | <Double> | Read-only | Syslog messages sent to the syslog server(s) over TCP. |
| auditsyslogmsgsenttcprate | <Double> | Read-only | Rate (/s) counter for auditsyslogmsgsenttcp |
| auditjsonobjcreated | <Double> | Read-only | Total number of JSON objects created for HTTP based syslog servers |
| auditjsonobjcreatedrate | <Double> | Read-only | Rate (/s) counter for auditjsonobjcreated |
| auditjsonbufexported | <Double> | Read-only | Total number of JSON buffers exported for HTTP based syslog servers |
| auditjsonbufexportedrate | <Double> | Read-only | Rate (/s) counter for auditjsonbufexported |
| auditjson2xxresp | <Double> | Read-only | Total number of 2xx responses received for HTTP based syslog servers |
| auditjson2xxresprate | <Double> | Read-only | Rate (/s) counter for auditjson2xxresp |
| auditjsonnon2xxresp | <Double> | Read-only | Total number of non 2xx responses received for HTTP based syslog servers |
| auditjsonnon2xxresprate | <Double> | Read-only | Rate (/s) counter for auditjsonnon2xxresp |
| auditsyslogmsgsentexternal | <Double> | Read-only | Syslog messages sent to external syslog server(s) over UDP. |
| auditsyslogmsgsentexternalrate | <Double> | Read-only | Rate (/s) counter for auditsyslogmsgsentexternal |
| auditnsballocfail | <Double> | Read-only | NAT allocation failed. |
| auditnsballocfailrate | <Double> | Read-only | Rate (/s) counter for auditnsballocfail |
| auditlog32errsyslogallocnsbfail | <Double> | Read-only | Nsb allocation failed. |
| auditlog32errsyslogallocnsbfailrate | <Double> | Read-only | Rate (/s) counter for auditlog32errsyslogallocnsbfail |
| auditmemallocfail | <Double> | Read-only | Failures in allocation of Access Gateway context structure. When an Access Gateway session is established, the Citrix ADC creates an internal context structure , which identifies the user and the IP address from which the user has logged in. |
| auditmemallocfailrate | <Double> | Read-only | Rate (/s) counter for auditmemallocfail |
| auditportallocfail | <Double> | Read-only | Number of times the Citrix ADC failed to allocate a port when sending a syslog message to the syslog server(s). |
| auditportallocfailrate | <Double> | Read-only | Rate (/s) counter for auditportallocfail |
| auditcontextnotfound | <Double> | Read-only | Failures in finding the context structure for an Access Gateway session during attempts to send session-specific audit messages. |
During an Access Gateway session, audit messages related to the session are queued up in the auditlog buffer for transmission to the audit log server(s). If the session is killed before the messages are sent, the context structure allocated at session creation is removed. This structure is needed for sending the queued auditlog messages. If it is not found, this counter is incremented.
Operations
(click to see Properties )
- GET (ALL)
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=yesIf 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
get (all)
URL: http:// <netscaler-ip-address> /nitro/v1/stat/audit Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/stat/audit? args=detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Integer_value> ,logfile: <String_value> ,clearstats: <String_value>
Use this query-parameter to get audit resources based on additional properties.
attrs http:// <netscaler-ip-address> /nitro/v1/stat/audit? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
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 Header:
Content-Type:application/json
Response Payload:
{ "audit": [ {
"nsbchainallocfailrate":<Double_value>,
"logunsentlbsys":<Double_value>,
"auditjsonobjcreateerrrate":<Double_value>,
"auditjsonnon2xxresprate":<Double_value>,
"auditportallocfail":<Double_value>,
"auditnsballocfailrate":<Double_value>,
"systcpconnfail":<Double_value>,
"auditjsonbufexporterrrate":<Double_value>,
"auditsyslogmsggen":<Double_value>,
"auditlog32errsyslogallocnsbfail":<Double_value>,
"logsdroppedtxminnsbsrate":<Double_value>,
"auditjsonobjcreated":<Double_value>,
"auditsyslogmsgsenttcp":<Double_value>,
"flushcmdcnt":<Double_value>,
"systcpconnfailrate":<Double_value>,
"nsbchainallocfail":<Double_value>,
"logunsentlbsysrate":<Double_value>,
"auditsyslogmsggenrate":<Double_value>,
"auditsyslogmsgsent":<Double_value>,
"logsdroppedrate":<Double_value>,
"auditjsonobjcreateerr":<Double_value>,
"auditnsballocfail":<Double_value>,
"auditlog32errsyslogallocnsbfailrate":<Double_value>,
"logsdroppedtxminnsbs":<Double_value>,
"logsdropped":<Double_value>,
"auditjson2xxresprate":<Double_value>,
"auditcontextnotfoundrate":<Double_value>,
"auditjsonobjcreatedrate":<Double_value>,
"clientconnfailrate":<Double_value>,
"auditjson2xxresp":<Double_value>,
"auditmemallocfail":<Double_value>,
"auditportallocfailrate":<Double_value>,
"auditcontextnotfound":<Double_value>,
"auditjsonbufexporterr":<Double_value>,
"auditsyslogmsgsentexternal":<Double_value>,
"flushcmdcntrate":<Double_value>,
"auditsyslogmsgsentexternalrate":<Double_value>,
"auditjsonbufexportedrate":<Double_value>,
"auditmemallocfailrate":<Double_value>,
"auditsyslogmsgsentrate":<Double_value>,
"auditsyslogmsgsenttcprate":<Double_value>,
"auditjsonbufexported":<Double_value>,
"clientconnfail":<Double_value>,
"auditjsonnon2xxresp":<Double_value>
}]}