junipernetworks.junos.junos_banner – Управление многострочными баннерами на устройствах Juniper JUNOS
Примечание
Этот плагин входит в коллекцию junipernetworks.junos (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install junipernetworks.junos.
Чтобы использовать его в плейбуке, укажите: junipernetworks.junos.junos_banner.
Новое в версии 1.0.0: of junipernetworks.junos
Обзор
- Данный модуль настраивает баннеры входа и motd на сетевых устройствах. Он позволяет плейбукам добавлять или удалять текст баннера из активной рабочей конфигурации.
Примечание
У данного модуля есть соответствующий плагин действий.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- ncclient (>=v0.5.2)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| active boolean |
| Указывает, активна или деактивирована конфигурация | |
| banner строка / обязательный |
| Указывает, какой баннер должен быть настроен на удаленном устройстве. Значение login обозначает сообщение системы входа перед аутентификацией, motd — сообщение входа после успешной аутентификации. | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli или connection: netconf.Для получения дополнительной информации, см. руководство Junos OS Platform Options. Объект словаря, содержащий детали подключения. | ||
| host строка | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для подключения к удаленному устройству. Значение порта по умолчанию составляет 22 для SSH ( transport=cli) или 830 (transport=netconf) для устройства. | ||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истекает до завершения операции, модуль вернет ошибку. | ||
| transport строка |
| Настраивает транспортное подключение для соединения с удаленным устройством. | |
| username строка | Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| state строка |
| Указывает, присутствует ли конфигурация в активной рабочей конфигурации устройства. | |
| text строка | Текст баннера, который должен присутствовать в рабочей конфигурации удаленного устройства. Этот аргумент принимает многострочный текст без пустых строк. Требуется state=present. | ||
Примечания
Примечание
- Данному модулю требуется, чтобы на удаленном управляемом устройстве был включен системный сервис netconf.
- Проверено на vSRX JUNOS версии 15.1X49-D15.4, vqfx-10000 JUNOS версии 15.1X53-D60.4.
- Рекомендуемое подключение —
netconf. См. справочник Junos OS Platform Options. - Этот модуль также работает с подключениями
localдля устаревших плейбуков. - Для получения информации о работе с CLI и netconf см. справочник по опциям платформы Junos OS
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Juniper см. в https://www.ansible.com/ansible-juniper.
Примеры
- name: configure the login banner
junipernetworks.junos.junos_banner:
banner: login
text: |
this is my login banner
that contains a multiline
string
state: present
- name: remove the motd banner
junipernetworks.junos.junos_banner:
banner: motd
state: absent
- name: deactivate the motd banner
junipernetworks.junos.junos_banner:
banner: motd
state: present
active: false
- name: activate the motd banner
junipernetworks.junos.junos_banner:
banner: motd
state: present
active: true
- name: Configure banner from file
junipernetworks.junos.junos_banner:
banner: motd
text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}"
state: present
Возвращаемые значения
Общие значения возврата описаны в разделе, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| diff.prepared строка | при изменении конфигурации и включенном параметре diff. | Разница в конфигурации до и после применения изменений. Пример: [edit system login] + message "это мой баннер входа"; |
Авторы
- Ganesh Nalawade (@ganeshrn)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/junipernetworks/junos/junos_banner_module.html