eos_banner – Управление многострочными баннерами на устройствах Arista EOS
Новая версия 2.3.
Обзор
- Этот модуль настраивает баннеры входа и motd на удаленных устройствах с операционной системой Arista EOS. Он позволяет плейбукам добавлять или удалять текст баннера из активной рабочей конфигурации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass - | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации обратитесь к руководству по платформам EOS Руководство по платформам EOS. Указывает пароль, который используется для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент не используется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации обратитесь к руководству по платформам EOS Руководство по платформам EOS. Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| banner - / обязательно |
| Указывает, какой баннер должен быть настроен на удаленном устройстве. | |
| provider - | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации обратитесь к руководству по платформам EOS Руководство по платформам EOS. Объект словаря, содержащий данные подключения. | ||
| auth_pass - | Указывает пароль, который используется для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент не используется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS . | ||
| authorize boolean |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения 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 boolean добавлен в 2.5 |
| Если no, переменные окружения http_proxy и https_proxy будут игнорироваться. | |
| use_ssl boolean |
| Настраивает transport для использования SSL, если значение true только когда transport=eapi. Если параметр transport не eapi, это значение игнорируется. | |
| username - | Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME . | ||
| validate_certs boolean |
| Если 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', 'это мой баннер входа', 'который содержит многострочный', 'строка', '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.7/modules/eos_banner_module.html
