Spec-Zone.ru › Ansible 2.6

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
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Дополнительную информацию можно найти в Руководстве по сети.
Объект типа dict, содержащий данные подключения.
host
обязательно
Указывает имя DNS-хоста или адрес для подключения к удаленному устройству по указанному протоколу. Значение параметра host используется в качестве адреса назначения для транспорта.
port По умолчанию:
22
Указывает порт для создания подключения к удаленному устройству.
username
Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME.
password
Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
timeout По умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку.
ssh_keyfile
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
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
список

(добавлено в 2.5)
всегда (пустой список, если нет 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>']


Статус

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

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что он поддерживается командой по работе с сетями Ansible. Подробнее см. в разделе Поддержка и техническое обслуживание модулей.

Список других модулей, также поддерживаемых командой Ansible по работе с сетями, см. здесь.

Поддержка

Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний: https://access.redhat.com/articles/rhel-top-support-policies/

Автор

  • 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.6/modules/iosxr_logging_module.html

Spec-Zone.ru

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