Spec-Zone.ru › Ansible 2.5

iosxr_logging — Управление конфигурацией службы системного логирования на сетевых устройствах

Новое в версии 2.4.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Поддержка
    • Автор

Обзор

  • Этот модуль обеспечивает декларативное управление конфигурацией системного логирования (syslog) на устройствах Cisco IOS XR.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

  • ncclient >= 0.5.3 при использовании netconf
  • lxml >= 4.1.1 при использовании netconf

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aggregate
Список определений конфигурации логирования syslog.
dest
    Варианты:
  • host
  • console
  • monitor
  • buffered
  • file
Назначение сообщений системного логирования (syslog).
facility Значение по умолчанию:
local7
Настройка типа объекта syslog, в котором отправляются сообщения системного логирования (syslog) на серверы syslog. Необязательная настройка для dest = host.
hostnameprefix
(добавлен в 2.5)
Добавить префикс имени хоста к сообщениям системного логирования (syslog), отправляемым на серверы syslog. Необязательная настройка для dest = host.
level Значение по умолчанию:
debugging
Указывает уровень серьезности для логирования.

псевдонимы: severity
name
Когда dest = file имя указывает имя файла
Когда dest = host имя указывает имя хоста или IP-адрес сервера syslog.
provider Значение по умолчанию:
None
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Дополнительная информация находится в Руководстве по сети.
Объект словаря, содержащий данные подключения.
username
Настраивает имя пользователя для аутентификации соединения с удаленным устройством. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использоваться значение переменной среды ANSIBLE_NET_USERNAME.
host
обязательно
Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
ssh_keyfile
Указывает SSH-ключ для аутентификации соединения с удаленным устройством. Это значение - путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использоваться значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout Значение по умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
password Значение по умолчанию:
None
Указывает пароль для аутентификации соединения с удаленным устройством. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использоваться значение переменной среды ANSIBLE_NET_PASSWORD.
port Значение по умолчанию:
22
Указывает порт для создания подключения к удаленному устройству.
size
Размер буфера, когда dest = buffered. Приемлемое значение находится в диапазоне от 307200 до 125000000 байт. Значение по умолчанию 307200
Размер файла, когда dest = file. Приемлемое значение находится в диапазоне от 1 до 2097152 КБ. Значение по умолчанию 2 ГБ
state
    Варианты:
  • present ←
  • absent
Существующее состояние конфигурации логирования на узле.
vrf
(добавлен в 2.5)
Значение по умолчанию:
default
Имя vrf, когда сервер syslog настроен, dest = host

Примечания

Примечание

  • Проверено на IOS XRv 6.1.2
  • Дополнительная информация об использовании Ansible для управления сетевыми устройствами находится в Руководстве по Ansible для сети
  • Дополнительная информация об использовании Ansible для управления устройствами Cisco находится на странице интеграции Cisco: https://www.ansible.com/integrations/networks/cisco.

Примеры

- name: configure logging for syslog server host
  iosxr_logging:
    dest: host
    name: 10.10.10.1
    level: critical
    state: present

- name: add hostnameprefix configuration
  iosxr_logging:
    hostnameprefix: host1
    state: absent

- name: add facility configuration
  iosxr_logging:
    facility: local1
    state: present

- name: configure console logging level
  iosxr_logging:
    dest: console
    level: debugging
    state: present

- name: configure monitor logging level
  iosxr_logging:
    dest: monitor
    level: errors
    state: present

- name: configure syslog to a file
  iosxr_logging:
    dest: file
    name: file_name
    size: 2048
    level: errors
    state: present

- name: configure buffered logging with size
  iosxr_logging:
    dest: buffered
    size: 5100000

- name: Configure logging using aggregate
  iosxr_logging:
    aggregate:
      - { dest: console, level: warning }
      - { dest: buffered, size: 4800000 }
      - { dest: file, name: file3, size: 2048}
      - { dest: host, name: host3, level: critical}

- name: Delete logging using aggregate
  iosxr_logging:
    aggregate:
      - { dest: console, level: warning }
      - { dest: buffered, size: 4800000 }
      - { dest: file, name: file3, size: 2048}
      - { dest: host, name: host3, level: critical}
    state: absent

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

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

Ключ Возвращаемое значение Описание
commands
список
всегда (пустой список, если нет команд для отправки)
Список команд конфигурации режима, которые необходимо отправить на устройство

Пример:
['logging 10.10.10.1 vrf default severity debugging', 'logging facility local7', 'logging hostnameprefix host1', 'logging console critical', 'logging buffered 2097153', 'logging buffered warnings', 'logging monitor errors', 'logging file log_file maxfilesize 1024 severity info']
xml
список
всегда (пустой список, если нет xml rpc для отправки)
XML rpc NetConf, отправленные на устройство с транспортом netconf

Пример:
['<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <syslog xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-infra-syslog-cfg"> <files> <file xc:operation="delete"> <file-name>file1</file-name> <file-log-attributes> <max-file-size>2097152</max-file-size> <severity>2</severity> </file-log-attributes> </file> </files> </syslog> </config>']


Статус

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

Поддержка

Дополнительная информация о поддержке этого модуля Red Hat находится в этом статье базы знаний.

Автор

  • Trishna Guha (@trishnaguha)
  • Kedar Kekan (@kedarX)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/iosxr_logging_module.html

Spec-Zone.ru

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