Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

auditsyslogparams

August 17, 2023
Contributed by: 
C

Configuration for system log parameters resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
serverip Read-write IP address of the syslog server.

Minimum length = 1
serverport Read-write Port on which the syslog server accepts connections.

Minimum value = 1
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
    		•
    loglevel <String[]> Read-write Types of information to be logged. 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
    		•
    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 Use the server’s timezone setting. Possible values = GMT_TIME, LOCAL_TIME
    		•
    userdefinedauditlog Read-write Log user-configurable log messages to syslog.

    Setting this parameter to NO causes audit to ignore all user-configured message actions. Setting this parameter to YES causes audit 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
    dns Read-write Log DNS related syslog messages.

    Possible values = ENABLED, DISABLED
    sslinterception Read-write Log SSL Interceptionn 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 ifnormation.

    Possible values = ENABLED, DISABLED
    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.

    Operations

    (click to see Properties )

    • UPDATE
    • UNSET
    • 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=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

    update

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

    HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"auditsyslogparams":{
      "serverip":<String_value>,
      "serverport":<Integer_value>,
      "dateformat":<String_value>,
      "loglevel":<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>,
      "dns":<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/auditsyslogparams? action=unset

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"auditsyslogparams":{
      "serverip":true,
      "serverport":true,
      "loglevel":true,
      "dateformat":true,
      "logfacility":true,
      "tcp":true,
      "acl":true,
      "timezone":true,
      "userdefinedauditlog":true,
      "appflowexport":true,
      "lsn":true,
      "alg":true,
      "subscriberlog":true,
      "dns":true,
      "contentinspectionlog":true,
      "sslinterception":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/auditsyslogparams

    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: 

    
{ "auditsyslogparams": [ {
      "name":<String_value>,
      "serverip":<String_value>,
      "serverport":<Integer_value>,
      "dateformat":<String_value>,
      "loglevel":<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>,
      "dns":<String_value>,
      "sslinterception":<String_value>,
      "urlfiltering":<String_value>,
      "contentinspectionlog":<String_value>
}]}

<!--NeedCopy-->
    auditsyslogparams
    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.