arista.eos.eos_logging – Управление журналированием на устройствах сети
Примечание
Этот плагин входит в коллекцию arista.eos (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install arista.eos.
Для использования в книге задач, укажите: arista.eos.eos_logging.
Новое в версии 1.0.0: of arista.eos
Описание
- Этот модуль обеспечивает декларативное управление журналированием на устройствах Arista Eos.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate список / элементы=словарь | Список определений журналирования. | ||
| dest строка |
| Место назначения журналов. | |
| facility строка | Установить объект журналирования. | ||
| level строка |
| Установить уровни серьезности журналирования. | |
| name строка | Имя хоста или IP-адрес места назначения. Обязательно при dest=host. | ||
| size целое число | Размер буфера. Допустимое значение находится в диапазоне от 10 до 2147483647 байт. | ||
| state строка |
| Состояние конфигурации журналирования. | |
| dest строка |
| Место назначения журналов. | |
| facility строка | Установить объект журналирования. | ||
| level строка |
| Установить уровни серьезности журналирования. | |
| name строка | Имя хоста или IP-адрес места назначения. Обязательно при dest=host. | ||
| provider словарь | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для eAPI.Этот параметр будет удален в версии после 2022-06-01. Для получения дополнительной информации см. Руководство по параметрам платформы EOS. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass строка | Указывает пароль для использования, если требуется для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя DNS-хоста или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | По умолчанию: 0 | Указывает порт, который будет использоваться при построении соединения с удалённым устройством. Это значение применяется к транспорту cli или eapi. Значение порта по умолчанию устанавливается для соответствующего стандартного порта транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с устройством сети для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| use_proxy булево |
| Если no, переменные среды http_proxy и https_proxy будут игнорироваться. | |
| use_ssl булево |
| Настраивает transport для использования SSL, если установлено yes, только когда transport=eapi. Если аргумент transport не eapi, это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с использованием самозаверенных сертификатов. Если аргумент transport не eapi, это значение игнорируется. | |
| size целое число | Размер буфера. Допустимое значение находится в диапазоне от 10 до 2147483647 байт. | ||
| state строка |
| Состояние конфигурации журналирования. | |
Примечания
Примечание
- Тестировалось на EOS 4.15
- Информация об использовании CLI, eAPI и привилегированного режима см. в Руководстве по параметрам платформы EOS
- Дополнительную информацию об использовании Ansible для управления устройствами сети см. в Руководстве по Ansible для сетевых устройств
- Дополнительную информацию об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista.
Примеры
- name: configure host logging
arista.eos.eos_logging:
dest: host
name: 172.16.0.1
state: present
- name: remove host logging configuration
arista.eos.eos_logging:
dest: host
name: 172.16.0.1
state: absent
- name: configure console logging level and facility
arista.eos.eos_logging:
dest: console
facility: local7
level: debugging
state: present
- name: enable logging to all
arista.eos.eos_logging:
dest: on
- name: configure buffer size
arista.eos.eos_logging:
dest: buffered
size: 5000
- name: Configure logging using aggregate
arista.eos.eos_logging:
aggregate:
- {dest: console, level: warnings}
- {dest: buffered, size: 480000}
state: present
Возвращаемые значения
Общие возвращаемые значения описаны в документации, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Список команд в режиме конфигурации, которые нужно отправить на устройство Пример: ['logging facility local7', 'logging host 172.16.0.1'] |
Авторы
- Trishna Guha (@trishnaguha)
© 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/arista/eos/eos_logging_module.html
