netscaler / netscaler.adc / 2.5.1 / module / auditnslogaction Configuration for ns log action resource. | "added in version" 2.0.0 of netscaler.adc" Authors: Sumanth Lingappa (@sumanth-lingappa) preview | supported by communitynetscaler.adc.auditnslogaction (2.5.1) — module
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections: - name: netscaler.adc version: 2.5.1
Configuration for ns log action resource.
acl: choices: - ENABLED - DISABLED description: - Log access control list (ACL) messages. type: str alg: choices: - ENABLED - DISABLED description: - Log the ALG messages type: str lsn: choices: - ENABLED - DISABLED description: - Log the LSN messages type: str tcp: choices: - NONE - ALL description: - Log TCP messages. type: str name: description: - 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'). type: str nsip: description: - 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. required: true type: str state: choices: - present - absent - unset default: present description: - The state of the resource being configured by the module on the NetScaler ADC node. - When C(present), the resource will be added/updated configured according to the module's parameters. - When C(absent), the resource will be deleted from the NetScaler ADC node. - When C(unset), the resource will be unset on the NetScaler ADC node. type: str api_path: default: nitro/v1/config description: - Base NITRO API path. - Define only in case of an ADM service proxy call type: str loglevel: choices: - ALL - EMERGENCY - ALERT - CRITICAL - ERROR - WARNING - NOTICE - INFORMATIONAL - DEBUG - NONE description: - Audit log level, which specifies the types of events to log. - 'Available settings function as follows:' - '* C(ALL) - All events.' - '* C(EMERGENCY) - Events that indicate an immediate crisis on the server.' - '* C(ALERT) - Events that might require action.' - '* C(CRITICAL) - Events that indicate an imminent server crisis.' - '* C(ERROR) - Events that indicate some type of error.' - '* C(WARNING) - Events that require action in the near future.' - '* C(NOTICE) - Events that the administrator should know about.' - '* C(INFORMATIONAL) - All but low-level events.' - '* C(DEBUG) - All events, in extreme detail.' - '* C(NONE) - No events.' elements: str type: list serverip: description: - IP address of the nslog server. type: str timezone: choices: - GMT_TIME - LOCAL_TIME description: - Time zone used for date and timestamps in the logs. - 'Available settings function as follows:' - '* C(GMT_TIME). Coordinated Universal Time.' - '* C(LOCAL_TIME). The server''s timezone setting.' type: str dateformat: choices: - MMDDYYYY - DDMMYYYY - YYYYMMDD description: - Format of dates in the logs. - 'Supported formats are:' - '* C(MMDDYYYY) - U.S. style month/date/year format.' - '* C(DDMMYYYY) - European style date/month/year format.' - '* C(YYYYMMDD) - ISO style year/month/date format.' type: str nitro_pass: description: - The password with which to authenticate to the NetScaler ADC node. required: false type: str nitro_user: description: - The username with which to authenticate to the NetScaler ADC node. required: false type: str serverport: description: - Port on which the nslog server accepts connections. type: int logfacility: choices: - LOCAL0 - LOCAL1 - LOCAL2 - LOCAL3 - LOCAL4 - LOCAL5 - LOCAL6 - LOCAL7 description: - Facility value, as defined in RFC 3164, assigned to the log message. - Log facility values are numbers 0 to 7 (C(LOCAL0) through C(LOCAL7)). Each number indicates where a specific message originated from, such as the Citrix ADC itself, the VPN, or external. type: str save_config: default: false description: - If C(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. type: bool urlfiltering: choices: - ENABLED - DISABLED description: - Log URL filtering event information type: str appflowexport: choices: - ENABLED - DISABLED description: - 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. type: str subscriberlog: choices: - ENABLED - DISABLED description: - Log subscriber session event information type: str nitro_protocol: choices: - http - https default: https description: - Which protocol to use when accessing the nitro API objects. type: str validate_certs: default: true description: - If C(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. required: false type: bool sslinterception: choices: - ENABLED - DISABLED description: - Log SSL Interception event information type: str domainresolvenow: description: - Immediately send a DNS query to resolve the server's domain name. type: bool nitro_auth_token: description: - The authentication token provided by a login operation. type: str version_added: 2.6.0 version_added_collection: netscaler.adc serverdomainname: description: - Auditserver name as a FQDN. Mutually exclusive with serverIP type: str domainresolveretry: description: - 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. type: int userdefinedauditlog: choices: - 'YES' - 'NO' description: - Log user-configurable log messages to nslog. - Setting this parameter to C(NO) causes auditing to ignore all user-configured message actions. Setting this parameter to C(YES) causes auditing to log user-configured message actions that meet the other logging criteria. type: str contentinspectionlog: choices: - ENABLED - DISABLED description: - Log Content Inspection event information type: str
changed: description: Indicates if any change is made by the module returned: always sample: true type: bool diff: description: Dictionary of before and after changes returned: always sample: after: key2: pqr before: key1: xyz prepared: changes done type: dict diff_list: description: 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' type: list failed: description: Indicates if the module failed or not returned: always sample: false type: bool loglines: description: list of logged messages by the module returned: always sample: - message 1 - message 2 type: list