community.network.ce_info_center_global – Управляет выводом журналов на коммутаторах HUAWEI CloudEngine.
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.ce_info_center_global.
Обзор
- Этот модуль предоставляет возможность вывода в буфер журнала, файл журнала, консоль, терминал или хост журнала на коммутаторах HUAWEI CloudEngine.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| channel_cfg_name строка | По умолчанию: "консоль" | Имя канала. Значение — строка от 1 до 30 символов, чувствительная к регистру. Значение по умолчанию — консоль. |
| channel_id строка | Номер канала. Значение — целое число от 0 до 9. Значение по умолчанию — 0. | |
| channel_name строка | Имя канала. Значение — строка от 1 до 30 символов, чувствительная к регистру. | |
| channel_out_direct строка |
| Направление вывода информации. |
| facility строка |
| Инструмент записи журнала. |
| filter_feature_name строка | Имя фильтрации журнала. Значение — строка от 1 до 31 символа, нечувствительная к регистру. | |
| filter_log_name строка | Имя отфильтрованного журнала. Значение — строка от 1 до 63 символов, чувствительная к регистру. | |
| info_center_enable строка |
| Включена ли функция info-center. Значение — булево. |
| ip_type строка |
| Тип адреса сервера журнала, IPv4 или IPv6. |
| is_default_vpn boolean |
| Использовать VPN по умолчанию или нет. |
| level строка |
| Уровень журналов, сохраняемых на сервере журналов. |
| logfile_max_num строка | Максимальное количество файлов журналов одного типа. Значение по умолчанию — 200. Диапазон значений для файлов журналов — [3, 500], для файлов безопасности — [1, 3], а для операционных файлов — [1, 7]. | |
| logfile_max_size строка |
32 | Максимальный размер (в МБ) файла журнала. Значение по умолчанию — 32. Диапазон значений для файлов журналов — [4, 8, 16, 32], для файлов безопасности — [1, 4], а для операционных файлов — [1, 4]. |
| packet_priority строка | Установите приоритет пакета syslog. Значение — целое число от 0 до 7. Значение по умолчанию — 0. | |
| server_domain строка | Имя сервера. Значение — строка от 1 до 255 символов, чувствительная к регистру. | |
| server_ip строка | Адрес сервера журнала, тип IPv4 или IPv6. Значение — строка от 0 до 255 символов. Значение может быть действительным адресом IPv4 или IPv6. | |
| server_port строка | Номер порта для отправки журналов. Значение — целое число от 1 до 65535. Для UDP значение по умолчанию — 514. Для TCP — 601. Для TSL — 6514. | |
| source_ip строка | IP-адрес источника журнала, тип IPv4 или IPv6. Значение — строка от 0 до 255 символов. Значение может быть действительным адресом IPv4 или IPv6. | |
| ssl_policy_name строка | Имя политики SSL. Значение — строка от 1 до 23 символов, чувствительная к регистру. | |
| state строка |
| Укажите требуемое состояние ресурса. |
| suppress_enable строка |
| Включено ли подавление дублированных статистических данных на устройстве. Значение — булево. |
| timestamp строка |
| Отметка времени сервера журнала. Значение — перечисление, чувствительное к регистру. |
| transport_mode строка |
| Режим передачи. Значение — перечисление, чувствительное к регистру. |
| vrf_name строка | Имя VPN на сервере журнала. Значение — строка от 1 до 31 символа, чувствительная к регистру. Значение по умолчанию — _public_. |
Примечания
Примечание
- Для этого модуля требуется, чтобы на удаленном управляемом устройстве была включена служба netconf.
- Рекомендуемая конфигурация подключения —
netconf. - Этот модуль также работает с
localподключениями для устаревших задач.
Примеры
- name: Info center global module 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: Config info-center enable
community.network.ce_info_center_global:
info_center_enable: true
state: present
provider: "{{ cli }}"
- name: Config statistic-suppress enable
community.network.ce_info_center_global:
suppress_enable: true
state: present
provider: "{{ cli }}"
- name: Config info-center syslog packet-priority 1
community.network.ce_info_center_global:
packet_priority: 2
state: present
provider: "{{ cli }}"
- name: Config info-center channel 1 name aaa
community.network.ce_info_center_global:
channel_id: 1
channel_cfg_name: aaa
state: present
provider: "{{ cli }}"
- name: Config info-center logfile size 10
community.network.ce_info_center_global:
logfile_max_num: 10
state: present
provider: "{{ cli }}"
- name: Config info-center console channel 1
community.network.ce_info_center_global:
channel_out_direct: console
channel_id: 1
state: present
provider: "{{ cli }}"
- name: Config info-center filter-id bymodule-alias snmp snmp_ipunlock
community.network.ce_info_center_global:
filter_feature_name: SNMP
filter_log_name: SNMP_IPLOCK
state: present
provider: "{{ cli }}"
- name: Config info-center max-logfile-number 16
community.network.ce_info_center_global:
logfile_max_size: 16
state: present
provider: "{{ cli }}"
- name: Config syslog loghost domain.
community.network.ce_info_center_global:
server_domain: aaa
vrf_name: aaa
channel_id: 1
transport_mode: tcp
facility: local4
server_port: 100
level: alert
timestamp: UTC
state: present
provider: "{{ cli }}"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed boolean | всегда | проверка, были ли внесены изменения на устройстве Пример: True |
| end_state словарь | всегда | параметры aaa в формате ключ/значение после выполнения модуля Пример: {'server_domain_info': [{'chnlId': '1', 'chnlName': 'монитор', 'facility': 'local4', 'isBriefFmt': 'false', 'isDefaultVpn': 'true', 'level': 'alert', 'serverDomain': 'aaa', 'serverPort': '100', 'sourceIP': '0.0.0.0', 'sslPolicyName': None, 'timestamp': 'localtime', 'transportMode': 'tcp', 'vrfName': '_public_'}, {'chnlId': '1', 'chnlName': 'монитор', 'facility': 'local4', 'isBriefFmt': 'false', 'isDefaultVpn': 'false', 'level': 'alert', 'serverDomain': 'aaa', 'serverPort': '100', 'sourceIP': '0.0.0.0', 'sslPolicyName': 'gmc', 'timestamp': 'UTC', 'transportMode': 'tcp', 'vrfName': 'aaa'}]} |
| existing словарь | всегда | параметры существующей отмены в формате ключ/значение Пример: {'server_domain_info': [{'chnlId': '1', 'chnlName': 'монитор', 'facility': 'local4', 'isBriefFmt': 'false', 'isDefaultVpn': 'false', 'level': 'alert', 'serverDomain': 'aaa', 'serverPort': '100', 'sourceIP': '0.0.0.0', 'sslPolicyName': 'gmc', 'timestamp': 'UTC', 'transportMode': 'tcp', 'vrfName': 'aaa'}]} |
| proposed словарь | всегда | переданные в модуль параметры в формате ключ/значение Пример: {'channel_id': '1', 'facility': 'local4', 'is_default_vpn': True, 'level': 'alert', 'server_domain': 'aaa', 'server_port': '100', 'state': 'наличие', 'timestamp': 'localtime', 'transport_mode': 'tcp'} |
| updates список / элементы=строка | всегда | команда, отправленная на устройство Пример: ['info-center loghost domain aaa level alert port 100 facility local4 channel 1 localtime transport tcp'] |
Авторы
- Ли Яньфен (@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_global_module.html