Skip to content

audit_log

Configuration for Audit Log resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
tenant_id<String>Read-writeTenant Id of the audit log.
Minimum length = 1
Maximum length = 128
id<String>Read-writeId is system generated key for all the audit log entries.
command<String>Read-writeCommand given for this action.
status<String>Read-onlyStatus of this action whether accepted/rejected by system.
port<Integer>Read-onlyClient port from where operation specified for this entry was performed.
message<String>Read-onlyMessage for this action.
username<String>Read-onlyUser Name, who performed operation specified for this entry.
client_type<String>Read-onlyClient Type.
audittime<Integer>Read-onlyAction Time on which operation specified for this entry was started.
ip_address<String>Read-onlyClient IP Address from where operation specified for this entry was performed.
resource_name<String>Read-onlyResource Name on which operation specified for this entry was performed.
operation<String>Read-onlyOperation Type that is performed.
resource_type<String>Read-onlyResource Type on which operation specified for this entry was performed .

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

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/audit_log

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "audit_log":[{
"status":<String_value>,
"port":<Integer_value>,
"message":<String_value>,
"username":<String_value>,
"client_type":<String_value>,
"tenant_id":<String_value>,
"audittime":<Integer_value>,
"id":<String_value>,
"ip_address":<String_value>,
"resource_name":<String_value>,
"operation":<String_value>,
"command":<String_value>,
"resource_type":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/audit_log/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "audit_log":[{
"status":<String_value>,
"port":<Integer_value>,
"message":<String_value>,
"username":<String_value>,
"client_type":<String_value>,
"tenant_id":<String_value>,
"audittime":<Integer_value>,
"id":<String_value>,
"ip_address":<String_value>,
"resource_name":<String_value>,
"operation":<String_value>,
"command":<String_value>,
"resource_type":<String_value>}]}