On this page
ce_info_center_log - Manages information center log configuration on HUAWEI CloudEngine switches.
New in version 2.4.
Synopsis
- Setting the Timestamp Format of Logs. Configuring the Device to Output Logs to the Log Buffer.
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
channel_id |
no |
Specifies a channel ID. The value is an integer ranging from 0 to 9.
|
||
log_buff_enable |
no | no_use |
|
Enables the Switch to send logs to the log buffer.
|
log_buff_size |
no |
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 |
no | no_use |
|
Indicates whether log filtering is enabled.
|
log_level |
no |
|
Specifies a log severity.
|
|
log_time_stamp |
no |
|
Sets the timestamp format of logs.
|
|
module_name |
no |
Specifies the name of a module. The value is a module name in registration logs.
|
||
state |
no | present |
|
Determines whether the config should be present or not on the device.
|
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"
ce_info_center_log:
log_time_stamp: date_tenthsecond
provider: "{{ cli }}"
- name: "Enabled to output information to the log buffer"
ce_info_center_log:
log_buff_enable: true
provider: "{{ cli }}"
- name: "Set the maximum number of logs in the log buffer"
ce_info_center_log:
log_buff_size: 100
provider: "{{ cli }}"
- name: "Set a rule for outputting logs to a channel"
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 Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
changed |
check to see if a change was made on the device
|
always | boolean | True |
end_state |
k/v pairs of configuration after module execution
|
verbose mode | dict | {'log_time_stamp': 'date_tenthsecond'} |
existing |
k/v pairs of existing configuration
|
verbose mode | dict | {'log_time_stamp': 'date_second'} |
proposed |
k/v pairs of parameters passed into module
|
verbose mode | dict | {'log_time_stamp': 'date_tenthsecond', 'state': 'present'} |
updates |
commands sent to the device
|
always | list | ['info-center timestamp log date precision-time tenth-second'] |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ce_info_center_log_module.html