Модуль dellemc.enterprise_sonic.sonic_logging – Управление конфигурацией логирования на SONiC.

Примечание

Этот модуль входит в коллекцию dellemc.enterprise_sonic (версия 2.5.1).

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

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

Чтобы использовать его в playbook, укажите: dellemc.enterprise_sonic.sonic_logging.

Новый в dellemc.enterprise_sonic 2.1.0

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

Обзор

Этот модуль обеспечивает управление конфигурацией логирования для устройств, работающих под управлением SONiC.

Параметры

Параметр	Комментарии
config словарь	Указывает конфигурации, связанные с логированием.
remote_servers список / элементы=словарь	Конфигурация удалённого сервера логирования.
host строка / обязательно	IP-адрес IPv4/IPv6 или имя хоста удалённого сервера логирования.
message_type строка	Тип сообщений, которые получает удалённый сервер. message_type нельзя удалять. Варианты: `"log"` `"event"`
protocol строка	Тип протокола для отправки сообщений. Варианты: `"TCP"` `"UDP"`
remote_port целое число	Номер порта назначения для сообщений логирования, отправляемых на сервер. remote_port нельзя удалять.
source_interface строка	Интерфейс источника, используемый в качестве IP-адреса источника для отправки пакетов логирования. source_interface нельзя удалять.
vrf строка	Имя VRF, используемое удалённым сервером логирования.
state строка	Состояние конфигурации после завершения работы модуля. Варианты: `"merged"` ← (по умолчанию) `"replaced"` `"overridden"` `"deleted"`

Примечания

Примечание

Поддерживает check_mode.

Примеры

# Using deleted
#
# Before state:
# -------------
#
#sonic# show logging servers
#---------------------------------------------------------------------------------------
#HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE     PROTOCOL
#---------------------------------------------------------------------------------------
#10.11.0.2       5         Ethernet24          -              event              udp
#10.11.1.1       616       Ethernet8           -              log                tcp
#log1.dell.com   6         Ethernet28          -              log                udp
#
- name: Delete logging server configuration
  sonic_logging:
    config:
      remote_servers:
        - host: 10.11.0.2
        - host: log1.dell.com
    state: deleted

# After state:
# ------------
#
#sonic# show logging servers
#---------------------------------------------------------------------------------------
#HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE     PROTOCOL
#---------------------------------------------------------------------------------------
#10.11.1.1       616       Ethernet8           -              log               tcp
#
#
# Using merged
#
# Before state:
# -------------
#
#sonic# show logging servers
#--------------------------------------------------------------------------------------
#HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE    PROTOCOL
#--------------------------------------------------------------------------------------
#10.11.1.1       616       Ethernet8           -              log              tcp
#
- name: Merge logging server configuration
  sonic_logging:
    config:
      remote_servers:
        - host: 10.11.0.2
          remote_port: 5
          protocol: TCP
          source_interface: Ethernet24
          message_type: event
        - host: log1.dell.com
          remote_port: 6
          protocol: udp
          source_interface: Ethernet28
    state: merged

# After state:
# ------------
#
#sonic# show logging servers
#-------------------------------------------------------------------------------------
#HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE   PROTOCOL
#-------------------------------------------------------------------------------------
#10.11.0.2       5         Ethernet24          -              event           udp
#10.11.1.1       616       Ethernet8           -              log             tcp
#log1.dell.com   6         Ethernet28          -              log             udp
#
#
# Using overridden
#
# Before state:
# -------------
#
#sonic# show logging servers
#--------------------------------------------------------------------------------------
#HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE    PROTOCOL
#--------------------------------------------------------------------------------------
#10.11.1.1       616       Ethernet8           -              log              tcp
#10.11.1.2       626       Ethernet16          -              event            udp
#
- name: Replace logging server configuration
  sonic_logging:
    config:
      remote_servers:
        - host: 10.11.1.2
          remote_port: 622
          protocol: TCP
          source_interface: Ethernet24
          message_type: event
    state: overridden
#
# After state:
# ------------
#
#sonic# show logging servers
#--------------------------------------------------------------------------------------
#HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE    PROTOCOL
#--------------------------------------------------------------------------------------
#10.11.1.2       622       Ethernet24          -              event            tcp
#
# Using replaced
#
# Before state:
# -------------
#
#sonic# show logging servers
#--------------------------------------------------------------------------------------
#HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE    PROTOCOL
#--------------------------------------------------------------------------------------
#10.11.1.1       616       Ethernet8           -              log              tcp
#10.11.1.2       626       Ethernet16          -              event            udp
#
- name: Replace logging server configuration
  sonic_logging:
    config:
      remote_servers:
        - host: 10.11.1.2
          remote_port: 622
          protocol: UDP
    state: replaced
#
# After state:
# ------------
#
# "MESSAGE-TYPE" has default value of "log"
#
#sonic# show logging servers
#--------------------------------------------------------------------------------------
#HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE    PROTOCOL
#--------------------------------------------------------------------------------------
#10.11.1.1       616       Ethernet8           -              log              tcp
#10.11.1.2       622       -                   -              log              udp
#

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

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

Ключ	Описание
after список / элементы=строка	Результат выполнения модуля конфигурации. Возвращается: при изменении Пример: `["The configuration returned will always be in the same format as the parameters above.\n"]`
after(generated) список / элементы=строка	Сгенерированный результат выполнения модуля конфигурации. Возвращается: при `check_mode` Пример: `["The configuration returned will always be in the same format as the parameters above.\n"]`
before список / элементы=строка	Конфигурация до выполнения модуля. Возвращается: всегда Пример: `["The configuration returned will always be in the same format as the parameters above.\n"]`
commands список / элементы=строка	Набор команд, отправленных на удалённое устройство. Возвращается: всегда Пример: `["command 1", "command 2", "command 3"]`

Авторы

1. Zhang (@mingjunzhang2019)

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

© 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/dellemc/enterprise_sonic/sonic_logging_module.html