netscaler.adc.auditsyslogaction module – Configuration for system log action resource.

Note

This module is part of the netscaler.adc collection (version 2.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.auditsyslogaction.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for system log action resource.

Parameters

Parameter

Comments

acl

any

Log access control list (ACL) messages.

Choices:

  • "ENABLED"

  • "DISABLED"

alg

any

Log alg info

Choices:

  • "ENABLED"

  • "DISABLED"

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

appflowexport

any

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.

Choices:

  • "ENABLED"

  • "DISABLED"

contentinspectionlog

any

Log Content Inspection event information

Choices:

  • "ENABLED"

  • "DISABLED"

dateformat

any

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.

Choices:

  • "MMDDYYYY"

  • "DDMMYYYY"

  • "YYYYMMDD"

dns

any

Log DNS related syslog messages

Choices:

  • "ENABLED"

  • "DISABLED"

domainresolvenow

boolean

Immediately send a DNS query to resolve the server’s domain name.

Choices:

  • false

  • true

domainresolveretry

integer

Time, in seconds, for which the Citrix ADC waits before sending another DNS query to resolve the host name of the syslog server if the last query failed.

lbvservername

string

Name of the LB vserver. Mutually exclusive with syslog serverIP/serverName

logfacility

any

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.

Choices:

  • "LOCAL0"

  • "LOCAL1"

  • "LOCAL2"

  • "LOCAL3"

  • "LOCAL4"

  • "LOCAL5"

  • "LOCAL6"

  • "LOCAL7"

loglevel

any

Audit log level, which specifies the types of events to log.

Available values 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.

Choices:

  • "ALL"

  • "EMERGENCY"

  • "ALERT"

  • "CRITICAL"

  • "ERROR"

  • "WARNING"

  • "NOTICE"

  • "INFORMATIONAL"

  • "DEBUG"

  • "NONE"

lsn

any

Log lsn info

Choices:

  • "ENABLED"

  • "DISABLED"

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

maxlogdatasizetohold

any

Max size of log data that can be held in NSB chain of server info.

name

any

Name of the syslog 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 syslog 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 syslog action” or ‘my syslog action’).

netprofile

any

Name of the network profile.

The SNIP configured in the network profile will be used as source IP while sending log messages.

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

nsip

string / required

The ip address of the NetScaler ADC appliance where the nitro API calls will be made.

The port can be specified with the colon (:). E.g. 192.168.1.1:555.

save_config

boolean

If true the module will save the configuration on the NetScaler ADC node if it makes any changes.

The module will not save the configuration on the NetScaler ADC node if it made no changes.

Choices:

  • false ← (default)

  • true

serverdomainname

string

SYSLOG server name as a FQDN. Mutually exclusive with serverIP/lbVserverName

serverip

string

IP address of the syslog server.

serverport

any

Port on which the syslog server accepts connections.

sslinterception

any

Log SSL Interception event information

Choices:

  • "ENABLED"

  • "DISABLED"

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When absent, the resource will be deleted from the NetScaler ADC node.

When unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "absent"

  • "unset"

subscriberlog

any

Log subscriber session event information

Choices:

  • "ENABLED"

  • "DISABLED"

tcp

any

Log TCP messages.

Choices:

  • "NONE"

  • "ALL"

tcpprofilename

any

Name of the TCP profile whose settings are to be applied to the audit server info to tune the TCP connection parameters.

timezone

any

Time zone used for date and timestamps in the logs.

Supported settings are:

* GMT_TIME. Coordinated Universal time.

* LOCAL_TIME. Use the server’s timezone setting.

Choices:

  • "GMT_TIME"

  • "LOCAL_TIME"

transport

string

Transport type used to send auditlogs to syslog server. Default type is UDP.

Choices:

  • "TCP"

  • "UDP"

urlfiltering

any

Log URL filtering event information

Choices:

  • "ENABLED"

  • "DISABLED"

userdefinedauditlog

any

Log user-configurable log messages to syslog.

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.

Choices:

  • "YES"

  • "NO"

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Notes

Note

Examples

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

List of differences between the actual configured object and the configuration specified in the module

Returned: when changed

Sample: ["Attribute `key1` differs. Desired: (<class 'str'>) XYZ. Existing: (<class 'str'>) PQR"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)