cisco.iosxr.iosxr_logging – Управление конфигурацией системных служб протоколирования на сетевых устройствах
Примечание
Этот плагин входит в коллекцию cisco.iosxr (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install cisco.iosxr.
Для использования в плейбуке укажите: 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 = file имя указывает имя файлаКогда dest = host имя указывает имя хоста или 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 = file имя указывает имя файлаКогда dest = host имя указывает имя хоста или IP-адрес сервера syslog. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Дополнительную информацию см. в руководстве по сети Multiple Communication Protocols. Объект словаря, содержащий сведения о соединении. | ||
| 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 NetConf RPC, отправленные устройству с транспортом 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/iosxr/iosxr_logging_module.html