eos_banner – Управление многострочными баннерами на устройствах Arista EOS
Краткое описание
- Этот модуль настраивает баннеры входа в систему и баннеры motd на удалённых устройствах, работающих на Arista EOS. Он позволяет плейбукам добавлять или удалять текст баннеров из активной рабочей конфигурации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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. | |
| banner - / обязательно |
| Указывает, какой баннер должен быть настроен на удалённом устройстве. | |
| 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 целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | ||
| 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 Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании 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 list | всегда | Список команд режима конфигурации для отправки устройству Пример: ['banner login', 'this is my login banner', 'that contains a multiline', 'string', 'EOF'] |
| session_name string | при изменениях | Имя сеанса конфигурации 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.9/modules/eos_banner_module.html
