eos_logging – Управление журналированием на сетевых устройствах
Новая версия с 2.4.
Обзор
- Этот модуль предоставляет декларативное управление журналированием на устройствах Arista Eos.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate - | Список определений журналирования. | ||
| auth_pass строка | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Указывает пароль, необходимый для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот параметр не используется. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| dest - |
| Место назначения логов. | |
| facility - | Установить уровень журналирования. | ||
| level - |
| Установить уровни серьёзности журналирования. | |
| name - | Если значение dest равно host, должно быть указано name, что указывает имя хоста или IP-адрес. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| 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 целое число | Значение по умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку. | |
| transport строка / обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| use_proxy логическое значение добавлено в 2.5 |
| Если 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
eos_logging:
dest: host
name: 172.16.0.1
state: present
- name: remove host logging configuration
eos_logging:
dest: host
name: 172.16.0.1
state: absent
- name: configure console logging level and facility
eos_logging:
dest: console
facility: local7
level: debugging
state: present
- name: enable logging to all
eos_logging:
dest : on
- name: configure buffer size
eos_logging:
dest: buffered
size: 5000
- name: Configure logging using aggregate
eos_logging:
aggregate:
- { dest: console, level: warnings }
- { dest: buffered, size: 480000 }
state: present
Возвращаемые значения
Общие значения, возвращаемые модулем, описаны здесь, а ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Список команд режима конфигурации, которые нужно отправить устройству Пример: ['logging facility local7', 'logging host 172.16.0.1'] |
Статус
- Данный модуль не гарантирует обратной совместимости. [превью]
- Данный модуль поддерживается командой Ansible Network Команда Ansible по работе с модулями. [сеть]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний Red Hat.
Авторы
- 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.8/modules/eos_logging_module.html