vyos_banner - Управление многострочными баннерами на устройствах VyOS
Новая версия с 2.4.
Описание
- Данный модуль настраивает баннеры до входа в систему и после входа в систему на удалённых устройствах, работающих под управлением VyOS. Он позволяет плейбукам добавлять или удалять текст баннера из активной конфигурации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| banner обязательно |
| Указывает, какой баннер должен быть настроен на удалённом устройстве. | |
| provider | Устарело Начиная с Ansible 2.5, рекомендуем использовать connection: network_cli. Для получения дополнительной информации см. Руководство по сети. Объект типа dict, содержащий сведения о соединении. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: 22 | Указывает порт, используемый при подключении к удалённому устройству. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| timeout | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истекает до завершения операции, модуль вернёт ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| 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', 'это мой баннер до входа', 'который содержит многострочный', 'строку'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по работе с сетями. Подробную информацию см. в поддержке модулей.
Список других модулей, поддерживаемых командой Ansible по работе с сетями, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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.6/modules/vyos_banner_module.html
