eos_banner — Управление многострочными баннерами на устройствах Arista EOS
Новое в версии 2.3.
Обзор
- Данный модуль настраивает баннеры входа и баннеры motd на удалённых устройствах, работающих под управлением Arista EOS. Он позволяет плейбукам добавлять или удалять текст баннера из активной рабочей конфигурации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass | Значение по умолчанию: нет | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Этот параметр необходим только при использовании eAPI. Дополнительная информация в руководстве EOS Platform Options. Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент не используется. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize |
| Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Этот параметр необходим только при использовании eAPI. Дополнительная информация в руководстве EOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| banner обязательно |
нет | Указывает, какой баннер следует настроить на удалённом устройстве. | |
| provider | Значение по умолчанию: нет | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании eAPI. Дополнительная информация в руководстве EOS Platform Options. Объект словаря, содержащий данные подключения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в командную строку или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| authorize |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлен в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| auth_pass | Значение по умолчанию: нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент не используется. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение хоста используется как адрес назначения для транспорта. | ||
| timeout | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. | |
| use_ssl |
| Настраивает транспорт transport для использования SSL, если значение true только при использовании transport=eapi. Если аргумент транспорта не eapi, это значение игнорируется. | |
| password | Значение по умолчанию: нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или eapi. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под собственным контролем, использующих самозаверенные сертификаты. Если аргумент транспорта не eapi, это значение игнорируется. | |
| port | Значение по умолчанию: 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение применяется к cli или eapi. Значение порта по умолчанию соответствует стандартному порту для транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| transport обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| state |
| Указывает, присутствует ли конфигурация в текущей активной рабочей конфигурации устройства. | |
| text | Значение по умолчанию: нет | Текст баннера, который должен присутствовать в рабочей конфигурации удалённого устройства. Этот аргумент принимает многострочный текст. Требует state=present. | |
Примечания
Примечание
- Проверено на EOS 4.15
- Дополнительная информация об использовании CLI, eAPI и привилегированного режима см. в руководстве EOS Platform Options
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительная информация об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista Arista integration page.
Примеры
- name: configure the login banner
eos_banner:
banner: login
text: |
this is my login banner
that contains a multiline
string
state: present
- name: remove the motd banner
eos_banner:
banner: motd
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в документации, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Список команд конфигурации, которые необходимо отправить устройству Пример: ['banner login', 'это мой баннер входа', 'который содержит многострочный', 'строку', 'EOF'] |
| session_name строка | при изменениях | Имя сеанса конфигурации EOS, используемого для загрузки конфигурации Пример: ansible_1479315771 |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется в обратной совместимости.
Поддержка
Дополнительную информацию о поддержке этого модуля Red Hat см. в статье Knowledge Base.
Автор
- Пётр Спрыгада (@privateip)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/eos_banner_module.html
