icx_logging – Manage logging on Ruckus ICX 7000 series switches
New in version 2.9.
Synopsis
- This module provides declarative management of logging on Ruckus ICX 7000 series switches.
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| aggregate
list
|
List of logging definitions.
|
||
| check_running_config
boolean
|
|
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.
|
|
| dest
string
|
|
Destination of the logs.
|
|
| facility
string
|
|
Specifies log facility to log messages from the device.
|
|
| level
list
|
|
Specifies the message level.
|
|
| name
string
|
ipv4 address/ipv6 address/name of syslog server.
|
||
| state
string
|
|
State of the logging configuration.
|
|
| udp_port
string
|
UDP port of destination host(syslog server).
|
||
| check_running_config
boolean
|
|
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.
|
|
| dest
string
|
|
Destination of the logs.
|
|
| facility
string
|
|
Specifies log facility to log messages from the device.
|
|
| level
list
|
|
Specifies the message level.
|
|
| name
string
|
ipv4 address/ipv6 address/name of syslog server.
|
||
| state
string
|
|
State of the logging configuration.
|
|
| udp_port
string
|
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.
icx_logging:
dest: host
name: 172.16.0.1
udp_port: 5555
- name: Remove host logging configuration.
icx_logging:
dest: host
name: 172.16.0.1
udp_port: 5555
state: absent
- name: Disables the real-time display of syslog messages.
icx_logging:
dest: console
state: absent
- name: Enables local syslog logging.
icx_logging:
dest : on
state: present
- name: configure buffer level.
icx_logging:
dest: buffered
level: critical
- name: Configure logging using aggregate
icx_logging:
aggregate:
- { dest: buffered, level: ['notifications','errors'] }
- name: remove logging using aggregate
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 | Returned | Description |
|---|---|---|
| commands
list
|
always |
The list of configuration mode commands to send to the device
Sample:
['logging host 172.16.0.1', 'logging console']
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Ruckus Wireless (@Commscope)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/icx_logging_module.html