Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

auditnslogaction

August 17, 2023
Contributed by: 
C

Configuration for ns log action resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name of the nslog action. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Cannot be changed after the nslog action is added. The following requirement applies only to the Citrix ADC CLI If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my nslog action” or ‘my nslog action’). Minimum length = 1
serverip Read-write IP address of the nslog server.

Minimum length = 1
serverdomainname Read-write Auditserver name as a FQDN. Mutually exclusive with serverIP.

Minimum length = 1

Maximum length = 255
domainresolveretry Read-write Time, in seconds, for which the Citrix ADC waits before sending another DNS query to resolve the host name of the audit server if the last query failed.

Default value: 5

Minimum value = 5

Maximum value = 20939
serverport Read-write Port on which the nslog server accepts connections.

Minimum value = 1
loglevel <String[]> Read-write Audit log level, which specifies the types of events to log. Available settings function as follows
  • ALL - All events.
  • EMERGENCY - Events that indicate an immediate crisis on the server.
  • ALERT - Events that might require action.
  • CRITICAL - Events that indicate an imminent server crisis.
  • ERROR - Events that indicate some type of error.
  • WARNING - Events that require action in the near future.
  • NOTICE - Events that the administrator should know about.
  • INFORMATIONAL - All but low-level events.
  • DEBUG - All events, in extreme detail.
  • NONE - No events. Possible values = ALL, EMERGENCY, ALERT, CRITICAL, ERROR, WARNING, NOTICE, INFORMATIONAL, DEBUG, NONE
    		•
    dateformat Read-write Format of dates in the logs. Supported formats are
  • MMDDYYYY - U.S. style month/date/year format.
  • DDMMYYYY - European style date/month/year format.
  • YYYYMMDD - ISO style year/month/date format. Possible values = MMDDYYYY, DDMMYYYY, YYYYMMDD
    		•
    logfacility Read-write Facility value, as defined in RFC 3164, assigned to the log message.

    Log facility values are numbers 0 to 7 (LOCAL0 through LOCAL7). Each number indicates where a specific message originated from, such as the Citrix ADC itself, the VPN, or external.

    Possible values = LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7
    tcp Read-write Log TCP messages.

    Possible values = NONE, ALL
    acl Read-write Log access control list (ACL) messages.

    Possible values = ENABLED, DISABLED
    timezone Read-write Time zone used for date and timestamps in the logs. Available settings function as follows
  • GMT_TIME. Coordinated Universal Time.
  • LOCAL_TIME. The server’s timezone setting. Possible values = GMT_TIME, LOCAL_TIME
    		•
    userdefinedauditlog Read-write Log user-configurable log messages to nslog.

    Setting this parameter to NO causes auditing to ignore all user-configured message actions. Setting this parameter to YES causes auditing to log user-configured message actions that meet the other logging criteria.

    Possible values = YES, NO
    appflowexport Read-write Export log messages to AppFlow collectors.

    Appflow collectors are entities to which log messages can be sent so that some action can be performed on them.

    Possible values = ENABLED, DISABLED
    lsn Read-write Log the LSN messages.

    Possible values = ENABLED, DISABLED
    alg Read-write Log the ALG messages.

    Possible values = ENABLED, DISABLED
    subscriberlog Read-write Log subscriber session event information.

    Possible values = ENABLED, DISABLED
    sslinterception Read-write Log SSL Interception event information.

    Possible values = ENABLED, DISABLED
    urlfiltering Read-write Log URL filtering event information.

    Possible values = ENABLED, DISABLED
    contentinspectionlog Read-write Log Content Inspection event information.

    Possible values = ENABLED, DISABLED
    domainresolvenow Read-write Immediately send a DNS query to resolve the server’s domain name.
    ip Read-only The resolved IP address of the auditserver.
    builtin <String[]> Read-only Indicates that a variable is a built-in (SYSTEM INTERNAL) type.

    Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
    feature Read-only The feature to be checked while applying this config.
    __count Read-only count parameter

    Operations

    (click to see Properties )

    • ADD
    • DELETE
    • UPDATE
    • UNSET
    • GET (ALL)
    • GET
    • COUNT

    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

    add

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditnslogaction

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"auditnslogaction":{
<b>      "name":<String_value>,
</b>      "serverip":<String_value>,
      "serverdomainname":<String_value>,
      "domainresolveretry":<Integer_value>,
      "serverport":<Integer_value>,
<b>      "loglevel":<String[]_value>,
</b>      "dateformat":<String_value>,
      "logfacility":<String_value>,
      "tcp":<String_value>,
      "acl":<String_value>,
      "timezone":<String_value>,
      "userdefinedauditlog":<String_value>,
      "appflowexport":<String_value>,
      "lsn":<String_value>,
      "alg":<String_value>,
      "subscriberlog":<String_value>,
      "sslinterception":<String_value>,
      "urlfiltering":<String_value>,
      "contentinspectionlog":<String_value>
}}

<!--NeedCopy-->

    Response:

    HTTP Status Code on Success: 201 Created

    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

    delete

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditnslogaction/ name_value<String>

    HTTP Method: DELETE

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    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

    update

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditnslogaction

    HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"auditnslogaction":{
<b>      "name":<String_value>,
</b>      "serverip":<String_value>,
      "serverdomainname":<String_value>,
      "domainresolveretry":<Integer_value>,
      "domainresolvenow":<Boolean_value>,
      "serverport":<Integer_value>,
      "loglevel":<String[]_value>,
      "dateformat":<String_value>,
      "logfacility":<String_value>,
      "tcp":<String_value>,
      "acl":<String_value>,
      "timezone":<String_value>,
      "userdefinedauditlog":<String_value>,
      "appflowexport":<String_value>,
      "lsn":<String_value>,
      "alg":<String_value>,
      "subscriberlog":<String_value>,
      "sslinterception":<String_value>,
      "urlfiltering":<String_value>,
      "contentinspectionlog":<String_value>
}}

<!--NeedCopy-->

    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

    unset

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditnslogaction? action=unset

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"auditnslogaction":{
<b>      "name":<String_value>,
</b>      "serverport":true,
      "loglevel":true,
      "dateformat":true,
      "logfacility":true,
      "tcp":true,
      "acl":true,
      "timezone":true,
      "userdefinedauditlog":true,
      "appflowexport":true,
      "lsn":true,
      "alg":true,
      "subscriberlog":true,
      "sslinterception":true,
      "contentinspectionlog":true,
      "urlfiltering":true
}}

<!--NeedCopy-->

    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

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditnslogaction

    Query-parameters:

    attrs

    http:// <netscaler-ip-address> /nitro/v1/config/auditnslogaction? attrs=property-name1,property-name2

    Use this query parameter to specify the resource details that you want to retrieve.

    filter

    http:// <netscaler-ip-address> /nitro/v1/config/auditnslogaction? filter=property-name1:property-val1,property-name2:property-val2

    Use this query-parameter to get the filtered set of auditnslogaction resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

    view

    http:// <netscaler-ip-address> /nitro/v1/config/auditnslogaction? view=summary

    Use this query-parameter to get the summary output of auditnslogaction resources configured on NetScaler.

    Note: By default, the retrieved results are displayed in detail view (?view=detail).

    pagination

    http:// <netscaler-ip-address> /nitro/v1/config/auditnslogaction? pagesize=#no;pageno=#no

    Use this query-parameter to get the auditnslogaction resources in chunks.

    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: 

    
{ "auditnslogaction": [ {
      "name":<String_value>,
      "serverip":<String_value>,
      "serverdomainname":<String_value>,
      "domainresolveretry":<Integer_value>,
      "domainresolvenow":<Boolean_value>,
      "ip":<String_value>,
      "serverport":<Integer_value>,
      "loglevel":<String[]_value>,
      "dateformat":<String_value>,
      "logfacility":<String_value>,
      "tcp":<String_value>,
      "acl":<String_value>,
      "timezone":<String_value>,
      "userdefinedauditlog":<String_value>,
      "appflowexport":<String_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>,
      "lsn":<String_value>,
      "alg":<String_value>,
      "subscriberlog":<String_value>,
      "sslinterception":<String_value>,
      "urlfiltering":<String_value>,
      "contentinspectionlog":<String_value>
}]}

<!--NeedCopy-->

    get

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditnslogaction/ name_value<String>

    Query-parameters:

    attrs

    http:// <netscaler-ip-address> /nitro/v1/config/auditnslogaction/ name_value<String> ? attrs=property-name1,property-name2

    Use this query parameter to specify the resource details that you want to retrieve.

    view

    http:// <netscaler-ip-address> /nitro/v1/config/auditnslogaction/ name_value<String> ? view=summary

    Use this query-parameter to get the summary output of auditnslogaction resources configured on NetScaler.

    Note: By default, the retrieved results are displayed in detail view (?view=detail).

    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: 

    
{  "auditnslogaction": [ {
      "name":<String_value>,
      "serverip":<String_value>,
      "serverdomainname":<String_value>,
      "domainresolveretry":<Integer_value>,
      "domainresolvenow":<Boolean_value>,
      "ip":<String_value>,
      "serverport":<Integer_value>,
      "loglevel":<String[]_value>,
      "dateformat":<String_value>,
      "logfacility":<String_value>,
      "tcp":<String_value>,
      "acl":<String_value>,
      "timezone":<String_value>,
      "userdefinedauditlog":<String_value>,
      "appflowexport":<String_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>,
      "lsn":<String_value>,
      "alg":<String_value>,
      "subscriberlog":<String_value>,
      "sslinterception":<String_value>,
      "urlfiltering":<String_value>,
      "contentinspectionlog":<String_value>
}]}

<!--NeedCopy-->

    count

    URL: http:// <netscaler-ip-address> /nitro/v1/config/auditnslogaction? count=yes

    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: 

    
{ "auditnslogaction": [ { "__count": "#no"} ] }

<!--NeedCopy-->
    auditnslogaction
    August 17, 2023
    Contributed by: 
    C
    August 17, 2023
    Contributed by: 
    C

    In this article

    Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
    © 1999- Cloud Software Group, Inc. All rights reserved.