vyos_banner - Управление многострочными баннерами на устройствах VyOS
Новое в версии 2.4.
Обзор
- Этот модуль настраивает баннеры до входа и после входа в систему на удалённых устройствах, работающих под управлением VyOS. Он позволяет плейбукам добавлять или удалять текст баннеров из активной рабочей конфигурации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| banner обязательно |
Нет | Указывает, какой баннер должен быть настроен на удалённом устройстве. | |
| provider | Значение по умолчанию: Нет | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации см. Руководство по сети. Объект словаря, содержащий сведения о подключении. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение хоста используется в качестве адреса назначения для протокола. | ||
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. | |
| password | Значение по умолчанию: Нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_PASSWORD. | |
| port | Значение по умолчанию: 22 | Указывает порт, используемый при установлении соединения с удалённым устройством. | |
| state |
| Указывает, присутствует ли конфигурация в активной рабочей конфигурации текущего устройства. | |
| text | Значение по умолчанию: Нет | Текст баннера, который должен присутствовать в рабочей конфигурации удалённого устройства. Этот аргумент принимает многострочный текст без пустых строк. Требуется state=present. | |
Примечания
Примечание
- Проверено на VYOS 1.1.7
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по Ansible для сетей
Примеры
- name: configure the pre-login banner
vyos_banner:
banner: pre-login
text: |
this is my pre-login banner
that contains a multiline
string
state: present
- name: remove the post-login banner
vyos_banner:
banner: post-login
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе. Следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| commands список | всегда | Список команд режима конфигурации для отправки на устройство Пример: ['banner pre-login', 'это мой баннер до входа', 'который содержит многострочный', 'текст'] |
Статус
Этот модуль помечен как предварительная версия, что означает, что его интерфейс не гарантируется обратной совместимости.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний
Автор
- Trishna Guha (@trishnaguha)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/vyos_banner_module.html
