eos_banner – Управление многострочными баннерами на устройствах Arista EOS
Новое в версии 2.3.
Обзор
- Это позволит настроить баннеры входа и motd на удаленных устройствах, работающих под управлением Arista EOS. Это позволяет плейбукам добавлять или удалять текст баннера из активной рабочей конфигурации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass строка | Устаревший Начиная с Ansible 2.5, рекомендуем использовать connection: network_cli и become: yes с become_pass. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации см. руководство по параметрам платформы EOS EOS Platform Options. Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, то этот аргумент не имеет эффекта. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое |
| Устаревший Начиная с Ansible 2.5, рекомендуем использовать connection: network_cli и become: yes.Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации см. руководство по параметрам платформы EOS EOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| banner - / обязательно |
| Указывает, какой баннер должен быть настроен на удалённом устройстве. | |
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуем использовать connection: network_cli. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации см. руководство по параметрам платформы EOS 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, это значение игнорируется. | |
| state - |
| Указывает, присутствует ли конфигурация в активной рабочей конфигурации текущего устройства. | |
| text - | Текст баннера, который должен быть в конфигурации удалённого устройства. Этот аргумент принимает многострочную строку. Требуется state=present. | ||
Примечания
Примечание
- Проверено на EOS 4.15
- Дополнительная информация об использовании CLI, eAPI и привилегированного режима см. в руководстве Параметры платформы EOS
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами см. в руководстве Руководство по сети Ansible
- Дополнительная информация об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista.
Примеры
- 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', 'this is my login banner', 'that contains a multiline', 'string', 'EOF'] |
| session_name строка | при изменениях | Имя сессии конфигурации EOS, используемой для загрузки конфигурации. Пример: ansible_1479315771 |
Статус
- У этого модуля нет гарантии обратной совместимости. [превью]
- Этот модуль поддерживается командой Ansible Network. [сеть]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- 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.8/modules/eos_banner_module.html
