community.network.icx_logging – Manage logging on Ruckus ICX 7000 series switches
Note
This plugin is part of the community.network collection (version 3.0.0).
You might already have this collection installed if you are using the ansible
package.
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 community.network
.
To use it in a playbook, specify: community.network.icx_logging
.
Synopsis
This module provides declarative management of logging on Ruckus ICX 7000 series switches.
Parameters
Parameter |
Comments |
---|---|
List of logging definitions. |
|
Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter. Choices:
|
|
Destination of the logs. Choices:
|
|
Specifies log facility to log messages from the device. Choices:
|
|
Specifies the message level. Choices:
|
|
ipv4 address/ipv6 address/name of syslog server. |
|
State of the logging configuration. Choices:
|
|
UDP port of destination host(syslog server). |
|
Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter. Choices:
|
|
Destination of the logs. Choices:
|
|
Specifies log facility to log messages from the device. Choices:
|
|
Specifies the message level. Choices:
|
|
ipv4 address/ipv6 address/name of syslog server. |
|
State of the logging configuration. Choices:
|
|
UDP port of destination host(syslog server). |
Notes
Note
Tested against ICX 10.1.
For information on using ICX platform, see the ICX OS Platform Options guide.
Examples
- name: Configure host logging.
community.network.icx_logging:
dest: host
name: 172.16.0.1
udp_port: 5555
- name: Remove host logging configuration.
community.network.icx_logging:
dest: host
name: 172.16.0.1
udp_port: 5555
state: absent
- name: Disables the real-time display of syslog messages.
community.network.icx_logging:
dest: console
state: absent
- name: Enables local syslog logging.
community.network.icx_logging:
dest : on
state: present
- name: Configure buffer level
community.network.icx_logging:
dest: buffered
level: critical
- name: Configure logging using aggregate
community.network.icx_logging:
aggregate:
- { dest: buffered, level: ['notifications','errors'] }
- name: Remove logging using aggregate
community.network.icx_logging:
aggregate:
- { dest: console }
- { dest: host, name: 172.16.0.1, udp_port: 5555 }
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always Sample: [“logging host 172.16.0.1”, “logging console”] |
Authors
Ruckus Wireless (@Commscope)