Spec-Zone.ru › Ansible

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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install dellemc.enterprise_sonic.

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

Добавлено в dellemc.enterprise_sonic 2.1.0

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

Общие сведения

  • Этот модуль управляет конфигурацией ведения журналов на устройствах под управлением SONiC.

Параметры

Параметр

Комментарии

config

dictionary

Задаёт конфигурацию, связанную с ведением журналов.

remote_servers

list / elements=dictionary

Конфигурация удалённого сервера ведения журналов.

host

string / required

Адрес IPv4/IPv6 или имя хоста удалённого сервера ведения журналов.

message_type

string

Тип сообщений, получаемых удалённым сервером. По умолчанию используется значение «log».

Варианты:

  • "log"
  • "event"
  • "audit"
  • "auditd-system"

protocol

string

Тип протокола для отправки сообщений. По умолчанию используется значение «UDP».

Варианты:

  • "TCP"
  • "TLS"
  • "UDP"

remote_port

integer

Номер порта назначения для сообщений журнала, отправляемых на сервер.

severity

string

добавлено в dellemc.enterprise_sonic 3.1.0

Фильтр уровня важности для удалённого сервера syslog. По умолчанию используется значение «notice».

Варианты:

  • "debug"
  • "info"
  • "notice"
  • "warning"
  • "error"
  • "critical"
  • "alert"
  • "emergency"

source_interface

string

Исходный интерфейс, используемый в качестве исходного IP-адреса при отправке пакетов журналов.

vrf

string

Имя VRF, используемой удалённым сервером ведения журналов.

security_profile

string

добавлено в dellemc.enterprise_sonic 3.1.0

Задаёт имя профиля безопасности для глобальных параметров syslog.

state

string

Состояние конфигурации после выполнения модуля.

Варианты:

  • "merged" ← (по умолчанию)
  • "replaced"
  • "overridden"
  • "deleted"

Примечания

Примечание

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

Примеры

# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE   SEVERITY            PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.0.2       5         Ethernet24          -              event          notice              udp
# 10.11.1.1       616       Ethernet8           -              log            alert               tcp
# log1.dell.com   6         Ethernet28          -              audit          notice              udp
# 10.11.1.2       116       Ethernet6           -              log            notice              tls
#
# sonic# show running-configuration | grep logging
# !
# logging security-profile default
# !

- name: Delete logging server configuration
  sonic_logging:
    config:
      remote_servers:
        - host: 10.11.0.2
        - host: log1.dell.com
        - host: 10.11.1.1
          message_type: log
          protocol: tcp
          source_interface: Ethernet8
          severity: alert
      security_profile: "default"
    state: deleted

# After state:
# ------------
#
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE   SEVERITY            PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.1.1       616       -                   -              log            notice              udp
# 10.11.1.2       116       Ethernet6           -              log            notice              tls
#
# sonic# show running-configuration | grep logging
# sonic#
#
# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE   SEVERITY            PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.1.1       616       Ethernet8           -              log            notice              tcp
#
# sonic# show running-configuration | grep logging
# sonic#
- 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: 10.11.0.1
          remote_port: 4
          protocol: TLS
          source_interface: Ethernet2
        - host: 10.11.1.1
          severity: error
        - host: log1.dell.com
          remote_port: 6
          protocol: udp
          source_interface: Ethernet28
          message_type: audit
      security_profile: "default"
    state: merged

# After state:
# ------------
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE   SEVERITY            PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.0.2       5         Ethernet24          -              event          notice              udp
# 10.11.0.1       4         Ethernet2           -              log            notice              tls
# 10.11.1.1       616       Ethernet8           -              log            error               tcp
# log1.dell.com   6         Ethernet28          -              audit          notice              udp
# sonic# show running-configuration | grep logging
# !
# logging security-profile default
# !
#
#
# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE   SEVERITY            PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.1.1       616       Ethernet8           -              log            notice              tcp
# 10.11.1.2       626       Ethernet16          -              event          emergency           udp
# 10.11.1.3       626       Ethernet14          -              log            notice              tls
#
# sonic# show running-configuration | grep logging
# !
# logging security-profile default
# !
- name: Override logging server configuration
  sonic_logging:
    config:
      remote_servers:
        - host: 10.11.1.2
          remote_port: 622
          protocol: TCP
          source_interface: Ethernet24
          message_type: audit
          severity: alert
    state: overridden
#
# After state:
# ------------
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE   SEVERITY            PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.1.2       622       Ethernet24          -              audit          alert               tcp
# sonic# show running-configuration | grep logging
# sonic#
#
# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show logging servers
# ----------------------------------------------------------------------------------------------------------
# HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE   SEVERITY            PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.1.1       616       Ethernet8           -              log            notice              tcp
# 10.11.1.2       626       Ethernet16          -              event          notice              udp
#
# sonic# show running-configuration | grep logging
# sonic#
- name: Replace logging server configuration
  sonic_logging:
    config:
      remote_servers:
        - host: 10.11.1.2
          remote_port: 622
          protocol: UDP
          message_type: audit
          severity: debug
      security_profile: "default"
    state: replaced
#
# After state:
# ------------
#
# "MESSAGE-TYPE" has default value of "log"
#
# ----------------------------------------------------------------------------------------------------------
# HOST            PORT      SOURCE-INTERFACE    VRF            MESSAGE-TYPE   SEVERITY            PROTOCOL
# ----------------------------------------------------------------------------------------------------------
# 10.11.1.1       616       Ethernet8           -              log            notice              tcp
# 10.11.1.2       622       -                   -              audit          debug               udp
# sonic# show running-configuration | grep logging
# !
# logging security-profile default
# !
#

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

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

Ключ

Описание

after

list / elements=string

Итоговый вызов модуля конфигурации.

Возвращается: если конфигурация изменилась

Пример: ["The configuration returned will always be in the same format as the parameters above.\n"]

after(generated)

list / elements=string

Сгенерированный вызов модуля конфигурации.

Возвращается: когда check_mode

Пример: ["The configuration returned will always be in the same format as the parameters above.\n"]

before

list / elements=string

Конфигурация до вызова модуля.

Возвращается: всегда

Пример: ["The configuration returned will always be in the same format as the parameters above.\n"]

commands

list / elements=string

Набор команд, переданных удалённому устройству.

Возвращается: всегда

Пример: ["command 1", "command 2", "command 3"]

Авторы

    1. Zhang (@mingjunzhang2019)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/enterprise_sonic/sonic_logging_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API