ansible / ansible.builtin / v2.9.13 / module / nxos_logging Manage logging on network devices | "added in version" 2.4 of ansible.builtin" Authors: Trishna Guha (@trishnaguha) preview | supported by networkansible.builtin.nxos_logging (v2.9.13) — module
pip
Install with pip install ansible==2.9.13
This module provides declarative management of logging on Cisco NX-OS devices.
- name: configure console logging with level nxos_logging: dest: console level: 2 state: present
- name: remove console logging configuration nxos_logging: dest: console level: 2 state: absent
- name: configure file logging with level nxos_logging: dest: logfile name: testfile dest_level: 3 state: present
- name: Configure logging logfile with size nxos_logging: dest: logfile name: testfile dest_level: 3 file_size: 16384
- name: configure facility level logging nxos_logging: facility: daemon facility_level: 0 state: present
- name: remove facility level logging nxos_logging: facility: daemon facility_level: 0 state: absent
- name: Configure Remote Logging nxos_logging: dest: server remote_server: test-syslogserver.com facility: auth facility_level: 1 use_vrf: management state: present
- name: Configure Source Interface for Logging nxos_logging: interface: mgmt0 state: present
- name: Purge nxos_logging configuration not managed by this playbook nxos_logging: purge: true
- name: Configure logging timestamp nxos_logging: timestamp: milliseconds state: present
- name: Configure logging facility ethpm link status nxos_logging: facility: ethpm facility_link_status: link-up-notif state: present
- name: Configure logging message ethernet description nxos_logging: interface_message: add-interface-description state: present
- name: Configure logging event link enable nxos_logging: event: link-enable state: present
- name: Configure logging using aggregate nxos_logging: aggregate: - { dest: console, dest_level: 2 } - { dest: logfile, dest_level: 2, name: testfile } - { facility: daemon, facility_level: 0 } state: present
dest: choices: - console - logfile - module - monitor - server description: - Destination of the logs. name: description: - If value of C(dest) is I(logfile) it indicates file-name. event: choices: - link-enable - link-default - trunk-enable - trunk-default description: - Link/trunk enable/default interface configuration logging version_added: '2.8' version_added_collection: ansible.builtin purge: default: false description: - Remove any switch logging configuration that does not match what has been configured Not supported for ansible_connection local. All nxos_logging tasks must use the same ansible_connection type. type: bool version_added: '2.8' version_added_collection: ansible.builtin state: choices: - present - absent default: present description: - State of the logging configuration. use_vrf: description: - VRF to be used while configuring remote logging (when dest is 'server'). version_added: '2.7' version_added_collection: ansible.builtin facility: description: - Facility name for logging. provider: description: - B(Deprecated) - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).' - 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for NX-API.' - This option will be removed in a release after 2022-06-01. - For more information please see the L(NXOS Platform Options guide, ../network/user_guide/platform_nxos.html). - HORIZONTALLINE - A dict object containing connection details. suboptions: auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. type: str authorize: default: false description: - Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. type: bool host: description: - Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. type: str password: description: - Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either I(cli) or I(nxapi) transports. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. type: str port: description: - Specifies the port to use when building the connection to the remote device. This value applies to either I(cli) or I(nxapi). The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443). type: int ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the I(cli) transport. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. type: str timeout: description: - Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc). type: int transport: choices: - cli - nxapi default: cli description: - Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi. type: str use_proxy: default: true description: - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored. type: bool use_ssl: default: false description: - Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=nxapi), otherwise this value is ignored. type: bool username: description: - Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. type: str validate_certs: default: false description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored. type: bool type: dict aggregate: description: List of logging definitions. file_size: description: - Set logfile size version_added: '2.8' version_added_collection: ansible.builtin interface: description: - Interface to be used while configuring source-interface for logging (e.g., 'Ethernet1/2', 'mgmt0') version_added: '2.7' version_added_collection: ansible.builtin timestamp: choices: - microseconds - milliseconds - seconds description: - Set logging timestamp format version_added: '2.8' version_added_collection: ansible.builtin dest_level: aliases: - level description: - Set logging severity levels. remote_server: description: - Hostname or IP Address for remote logging (when dest is 'server'). version_added: '2.7' version_added_collection: ansible.builtin facility_level: description: - Set logging severity levels for facility based log messages. interface_message: choices: - add-interface-description description: - Add interface description to interface syslogs. Does not work with version 6.0 images using nxapi as a transport. version_added: '2.8' version_added_collection: ansible.builtin facility_link_status: choices: - link-down-notif - link-down-error - link-up-notif - link-up-error description: - Set logging facility ethpm link status. Not idempotent with version 6.0 images. version_added: '2.8' version_added_collection: ansible.builtin
commands: description: The list of configuration mode commands to send to the device returned: always sample: - logging console 2 - logging logfile testfile 3 - logging level daemon 0 type: list