arista.eos.eos_banner – Управление многострочными баннерами на устройствах Arista EOS
Примечание
Этот плагин входит в коллекцию arista.eos (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install arista.eos.
Для использования в книге задач укажите: arista.eos.eos_banner.
Новое в версии 1.0.0: плагина arista.eos
Обзор
- Это позволит настроить баннеры входа и motd на удаленных устройствах, работающих под управлением Arista EOS. Это позволяет задачам добавлять или удалять текст баннеров из активной рабочей конфигурации.
Примечание
У данного модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| banner строка / обязательный |
| Указывает, какой баннер должен быть настроен на удаленном устройстве. | |
| provider словарь | Устаревший Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6 рекомендуется использовать connection: httpapi для eAPI.Этот параметр будет удален в выпуске после 2022-06-01. Для получения дополнительной информации, пожалуйста, обратитесь к руководству по параметрам платформы EOS. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для использования при необходимости входа в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения 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, это значение игнорируется. | |
| state строка |
| Указывает, присутствует ли конфигурация в активной рабочей конфигурации текущего устройства. | |
| text строка | Текст баннера, который должен присутствовать в рабочей конфигурации удаленного устройства. Этот аргумент принимает многострочную строку. Требуется state=present. | ||
Примечания
Примечание
- Тестировалось с EOS 4.15
- Для получения информации об использовании CLI, eAPI и привилегированного режима, см. руководство по параметрам платформы EOS
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами, см. руководство по Ansible для сети
- Для получения дополнительной информации об использовании Ansible для управления устройствами Arista EOS, см. страницу интеграции Arista.
Примеры
- name: configure the login banner
arista.eos.eos_banner:
banner: login
text: |
this is my login banner
that contains a multiline
string
state: present
- name: remove the motd banner
arista.eos.eos_banner:
banner: motd
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Список команд конфигурации режима, которые необходимо отправить на устройство Пример: ['banner login', 'это мой баннер входа', 'который содержит многострочный', 'строку', 'EOF'] |
| session_name строка | при изменениях | Имя сеанса конфигурации EOS, используемого для загрузки конфигурации Пример: ansible_1479315771 |
Авторы
- Peter Sprygada (@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.10/collections/arista/eos/eos_banner_module.html
