community.network.ce_info_center_log – Manages information center log configuration on HUAWEI CloudEngine switches.
community.network.ce_info_center_log – Manages information center log configuration on HUAWEI CloudEngine switches.
Note
This plugin is part of the community.network collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.ce_info_center_log
.
Synopsis
- Setting the Timestamp Format of Logs. Configuring the Device to Output Logs to the Log Buffer.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
channel_id string |
Specifies a channel ID. The value is an integer ranging from 0 to 9. | |
log_buff_enable string |
|
Enables the Switch to send logs to the log buffer. |
log_buff_size string |
Specifies the maximum number of logs in the log buffer. The value is an integer that ranges from 0 to 10240. If logbuffer-size is 0, logs are not displayed. | |
log_enable string |
|
Indicates whether log filtering is enabled. |
log_level string |
|
Specifies a log severity. |
log_time_stamp string |
|
Sets the timestamp format of logs. |
module_name string |
Specifies the name of a module. The value is a module name in registration logs. | |
state string |
|
Determines whether the config should be present or not on the device. |
Notes
Note
- This module requires the netconf system service be enabled on the remote device being managed.
- Recommended connection is
netconf
. - This module also works with
local
connections for legacy playbooks.
Examples
- name: CloudEngine info center log test
hosts: cloudengine
connection: local
gather_facts: no
vars:
cli:
host: "{{ inventory_hostname }}"
port: "{{ ansible_ssh_port }}"
username: "{{ username }}"
password: "{{ password }}"
transport: cli
tasks:
- name: "Setting the timestamp format of logs"
community.network.ce_info_center_log:
log_time_stamp: date_tenthsecond
provider: "{{ cli }}"
- name: "Enabled to output information to the log buffer"
community.network.ce_info_center_log:
log_buff_enable: true
provider: "{{ cli }}"
- name: "Set the maximum number of logs in the log buffer"
community.network.ce_info_center_log:
log_buff_size: 100
provider: "{{ cli }}"
- name: "Set a rule for outputting logs to a channel"
community.network.ce_info_center_log:
module_name: aaa
channel_id: 1
log_enable: true
log_level: critical
provider: "{{ cli }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
changed boolean |
always |
check to see if a change was made on the device
Sample: True |
end_state dictionary |
verbose mode |
k/v pairs of configuration after module execution
Sample: {'log_time_stamp': 'date_tenthsecond'} |
existing dictionary |
verbose mode |
k/v pairs of existing configuration
Sample: {'log_time_stamp': 'date_second'} |
proposed dictionary |
verbose mode |
k/v pairs of parameters passed into module
Sample: {'log_time_stamp': 'date_tenthsecond', 'state': 'present'} |
updates list / elements=string |
always |
commands sent to the device
Sample: ['info-center timestamp log date precision-time tenth-second'] |
Authors
- QijunPan (@QijunPan)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/ce_info_center_log_module.html