Модуль community.network.ce_info_center_global — Управляет выводом журналов на коммутаторах HUAWEI CloudEngine.

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.network.

Для использования в плейбуке укажите: community.network.ce_info_center_global.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль предоставляет возможность вывода в буфер журнала, файл журнала, консоль, терминал или хост журнала на коммутаторах HUAWEI CloudEngine.

Псевдонимы: network.cloudengine.ce_info_center_global

Параметры

Параметр	Комментарии
channel_cfg_name string	Имя канала. Значение представляет собой строку из 1 до 30 символов с учетом регистра. Значение по умолчанию — console. Default: `"console"`
channel_id string	Номер канала. Значение представляет собой целое число в диапазоне от 0 до 9. Значение по умолчанию — 0.
channel_name string	Имя канала. Значение представляет собой строку из 1 до 30 символов с учетом регистра.
channel_out_direct string	Направление вывода информации. Choices: `"console"` `"monitor"` `"trapbuffer"` `"logbuffer"` `"snmp"` `"logfile"`
facility string	Инструмент записи логов. Choices: `"local0"` `"local1"` `"local2"` `"local3"` `"local4"` `"local5"` `"local6"` `"local7"`
filter_feature_name string	Имя функции отфильтрованного лога. Значение представляет собой строку из 1 до 31 символа без учета регистра.
filter_log_name string	Имя отфильтрованного лога. Значение представляет собой строку из 1 до 63 символов с учетом регистра.
info_center_enable string	Включена ли функция info-center. Значение имеет булевый тип. Choices: `"true"` `"false"`
ip_type string	Тип адреса сервера журналов, IPv4 или IPv6. Choices: `"ipv4"` `"ipv6"`
is_default_vpn boolean	Использовать VPN по умолчанию или нет. Choices: `false` ← (default) `true`
level string	Уровень журналов, сохраняемых на сервере журналов. Choices: `"emergencies"` `"alert"` `"critical"` `"error"` `"warning"` `"notification"` `"informational"` `"debugging"`
logfile_max_num string	Максимальное количество файлов журналов одного типа. Значение по умолчанию — 200. Диапазон значений для файлов журналов — [3, 500], для файлов безопасности — [1, 3] и для операционных файлов — [1, 7].
logfile_max_size string	Максимальный размер (в МБ) файла журнала. Значение по умолчанию — 32. Диапазон значений для файлов журналов — [4, 8, 16, 32], для файлов безопасности — [1, 4], и для операционных файлов — [1, 4]. Choices: `"4"` `"8"` `"16"` `"32"` Default: `32`
packet_priority string	Установите приоритет пакета syslog. Значение представляет собой целое число в диапазоне от 0 до 7. Значение по умолчанию — 0.
server_domain string	Имя сервера. Значение представляет собой строку из 1 до 255 символов с учетом регистра.
server_ip string	Адрес сервера журналов, тип IPv4 или IPv6. Значение представляет собой строку из 0 до 255 символов. Значение может быть допустимым адресом IPv4 или IPv6.
server_port string	Номер порта отправки журналов. Значение представляет собой целое число в диапазоне от 1 до 65535. Для UDP значение по умолчанию — 514. Для TCP значение по умолчанию — 601. Для TSL значение по умолчанию — 6514.
source_ip string	Источник IP-адреса журнала, тип IPv4 или IPv6. Значение представляет собой строку из 0 до 255 символов. Значение может быть допустимым адресом IPv4 или IPv6.
ssl_policy_name string	Имя политики SSL. Значение представляет собой строку из 1 до 23 символов с учетом регистра.

состояние строка	Укажите желаемое состояние ресурса. Варианты: `"present"` ← (по умолчанию) `"absent"`
suppress_enable строка	Включено ли подавление дублирующей статистики на устройстве. Значение имеет тип boolean. Варианты: `"false"` `"true"`
временная_метка строка	Временная метка сервера логов. Значение имеет перечислимый тип и регистрозависимо. Варианты: `"UTC"` `"localtime"`
режим_транспорта строка	Режим транспорта. Значение имеет перечислимый тип и регистрозависимо. Варианты: `"tcp"` `"udp"`
имя_vrf строка	Имя VPN на сервере логов. Значение — строка из 1 до 31 регистрозависимого символа. Значение по умолчанию — _public_.

Примечания

Примечание

Для этого модуля необходимо, чтобы служба netconf системы была включена на управляемом удалённом устройстве.
Рекомендуемое соединение — netconf.
Этот модуль также работает с local подключениями для устаревших playbooks.

Примеры

- name: Info center global module test
  hosts: cloudengine
  connection: local
  gather_facts: false
  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 }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
изменён булево	проверка, были ли внесены изменения на устройстве Возвращается: всегда Пример: `true`
конечное_состояние словарь	k/v пары параметров aaa после выполнения модуля Возвращается: всегда Пример: {"server_domain_info": [{"chnlId": "1", "chnlName": "monitor", "facility": "local4", "isBriefFmt": "false", "isDefaultVpn": "true", "level": "alert", "serverDomain": "aaa", "serverPort": "100", "sourceIP": "0.0.0.0", "sslPolicyName": null, "timestamp": "localtime", "transportMode": "tcp", "vrfName": "_public_"}, {"chnlId": "1", "chnlName": "monitor", "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"}]}
существующее словарь	k/v пары существующего развёртывания Возвращается: всегда Пример: `{"server_domain_info": [{"chnlId": "1", "chnlName": "monitor", "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"}]}`
предложенное словарь	k/v пары параметров, переданных в модуль Возвращается: всегда Пример: `{"channel_id": "1", "facility": "local4", "is_default_vpn": true, "level": "alert", "server_domain": "aaa", "server_port": "100", "state": "present", "timestamp": "localtime", "transport_mode": "tcp"}`
обновления список / элементы=строка	команда, отправленная устройству Возвращается: всегда Пример: `["info-center loghost domain aaa level alert port 100 facility local4 channel 1 localtime transport tcp"]`

Авторы

Ли Яньфэн (@QijunPan)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/ce_info_center_global_module.html