cisco.iosxr.iosxr_logging – Управление конфигурацией системного логирования на сетевых устройствах IOS XR
Примечание
Этот плагин является частью коллекции cisco.iosxr (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install cisco.iosxr.
Для использования в playbook, укажите: cisco.iosxr.iosxr_logging.
Новое в версии 1.0.0: плагина cisco.iosxr
Обзор
- Этот модуль предоставляет декларативное управление конфигурацией системного логирования (syslog) на устройствах Cisco IOS XR.
Примечание
У этого модуля есть соответствующий плагин действий.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- ncclient >= 0.5.3 при использовании netconf
- lxml >= 4.1.1 при использовании netconf
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate список / элементы=словарь | Список определений конфигурации логирования syslog. | ||
| dest строка |
| Назначение для сообщений системного логирования (syslog). | |
| facility строка | Для настройки типа syslog-объекта, в который отправляются сообщения системного логирования (syslog) на syslog-серверы. Дополнительная настройка для dest = host | ||
| hostnameprefix строка | Для добавления префикса имени хоста к сообщениям системного логирования (syslog), отправляемым на syslog-серверы. Дополнительная настройка для dest = host | ||
| level строка |
| Указывает уровень серьезности логирования. псевдонимы: severity | |
| name строка | Когда dest = файл, имя указывает имя файла.Когда dest = хост, имя указывает имя хоста или IP-адрес syslog-сервера. | ||
| size целое число | Размер буфера, когда dest = buffered. Допустимое значение находится в диапазоне от 307200 до 125000000 байтов. По умолчанию 307200Размер файла, когда dest = file. Допустимое значение находится в диапазоне от 1 до 2097152 КБ. По умолчанию 2 ГБ | ||
| state строка |
| Состояние конфигурации логирования на узле. | |
| vrf строка | Имя VRF, когда настроен syslog-сервер, dest = host | ||
| dest строка |
| Назначение для сообщений системного логирования (syslog). | |
| facility строка | По умолчанию: "local7" | Для настройки типа syslog-объекта, в который отправляются сообщения системного логирования (syslog) на syslog-серверы. Дополнительная настройка для dest = host | |
| hostnameprefix строка | Для добавления префикса имени хоста к сообщениям системного логирования (syslog), отправляемым на syslog-серверы. Дополнительная настройка для dest = host | ||
| level строка |
| Указывает уровень серьезности логирования. псевдонимы: severity | |
| name строка | Когда dest = файл, имя указывает имя файла.Когда dest = хост, имя указывает имя хоста или IP-адрес syslog-сервера. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуем использовать connection: network_cli. Для получения дополнительной информации см. Руководство по сети. Объект словаря, содержащий сведения о подключении. | ||
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для подключения к удалённому устройству. | ||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение представляет путь к ключу, используемому для аутентификации SSH-сессии. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. | ||
| transport строка |
| Указывает тип подключения по транспорту. | |
| username строка | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| size целое число | Размер буфера, когда dest = buffered. Допустимое значение находится в диапазоне от 307200 до 125000000 байтов. По умолчанию 307200Размер файла, когда dest = file. Допустимое значение находится в диапазоне от 1 до 2097152 КБ. По умолчанию 2 ГБ | ||
| state строка |
| Состояние конфигурации логирования на узле. | |
| vrf строка | По умолчанию: "default" | Имя VRF, когда настроен syslog-сервер, dest = host | |
Примечания
Примечание
- Этот модуль работает с подключениями
network_cliиnetconf. См. варианты платформы IOS-XR. - Тестировался на IOS XRv 6.1.3
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сети Ansible
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco.
Примеры
- name: configure logging for syslog server host
cisco.iosxr.iosxr_logging:
dest: host
name: 10.10.10.1
level: critical
state: present
- name: add hostnameprefix configuration
cisco.iosxr.iosxr_logging:
hostnameprefix: host1
state: absent
- name: add facility configuration
cisco.iosxr.iosxr_logging:
facility: local1
state: present
- name: configure console logging level
cisco.iosxr.iosxr_logging:
dest: console
level: debugging
state: present
- name: configure monitor logging level
cisco.iosxr.iosxr_logging:
dest: monitor
level: errors
state: present
- name: configure syslog to a file
cisco.iosxr.iosxr_logging:
dest: file
name: file_name
size: 2048
level: errors
state: present
- name: configure buffered logging with size
cisco.iosxr.iosxr_logging:
dest: buffered
size: 5100000
- name: Configure logging using aggregate
cisco.iosxr.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
cisco.iosxr.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>'] |
Авторы
- 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.10/collections/cisco/iosxr/iosxr_logging_module.html