Download full document:

ns_config_audit_settings

Configuration for Config Audit Setting resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
audit_on_trap_receive<Boolean>Read-writeRun config audit for an ip after config save trap is received.
id<String>Read-writeId is system generated key for all the events.
time_after_receive<Integer>Read-writeTime after which Config Audit is run for a particular IP after config save trap is received.

Operations

(click to see Properties)

GET (ALL)| GET| UPDATE

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

HTTP Method: null

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_config_audit_settings":[{
"audit_on_trap_receive":<Boolean_value>,
"id":<String_value>,
"time_after_receive":<Integer_value>}]}

get

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

HTTP Method: null

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_config_audit_settings":[{
"audit_on_trap_receive":<Boolean_value>,
"id":<String_value>,
"time_after_receive":<Integer_value>}]}

update

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

HTTP Method: null

Request Payload: 

{ns_config_audit_settings:{
<b>"id":<String_value></b>,
"time_after_receive":<Integer_value>,
"audit_on_trap_receive":<Boolean_value>}}

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_config_audit_settings":[{
"audit_on_trap_receive":<Boolean_value>,
"id":<String_value>,
"time_after_receive":<Integer_value>}]}