junos_banner - Управление многострочными баннерами на устройствах Juniper JUNOS
Новое в версии 2.4.
Обзор
- Это позволит настроить баннеры входа и motd на сетевых устройствах. Это позволяет плейбукам добавлять или удалять текст баннеров из активной рабочей конфигурации.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ncclient (>=v0.5.2)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| active |
да | Указывает, активна или деактивирована конфигурация. | |
| banner обязательно |
| Указывает, какой баннер должен быть настроен на удаленном устройстве. Значение login обозначает сообщение системы входа перед аутентификацией, motd — сообщение входа после успешной аутентификации. | |
| provider | Значение по умолчанию: None | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli или connection: netconf. Дополнительную информацию см. в руководстве Junos OS Platform Options. Объект dict, содержащий данные соединения. | |
| username | Настраивает имя пользователя для аутентификации соединения с удаленным устройством. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола. | ||
| ssh_keyfile | Указывает SSH-ключ для аутентификации соединения с удаленным устройством. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. | |
| password | Значение по умолчанию: None | Указывает пароль для аутентификации соединения с удаленным устройством. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | |
| port | Значение по умолчанию: 22 | Указывает порт для подключения к удаленному устройству. Значение порта по умолчанию — 22 (для transport=cli) или 830 (для transport=netconf) устройства. | |
| state |
| Указывает, присутствует ли конфигурация в активной рабочей конфигурации устройства. | |
| text | Значение по умолчанию: None | Текст баннера, который должен присутствовать в конфигурации удаленного устройства. Этот аргумент принимает многострочную строку без пустых строк. Требуется 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 Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами Juniper см. на странице https://www.ansible.com/ansible-juniper.
Примеры
- name: configure the login banner
junos_banner:
banner: login
text: |
this is my login banner
that contains a multiline
string
state: present
- name: remove the motd banner
junos_banner:
banner: motd
state: absent
- name: deactivate the motd banner
junos_banner:
banner: motd
state: present
active: False
- name: activate the motd banner
junos_banner:
banner: motd
state: present
active: True
- name: Configure banner from file
junos_banner:
banner: motd
text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| diff.prepared строка | при изменении конфигурации и включенном параметре diff. | Разница в конфигурации до и после применения изменения. Пример: [edit system login] + message "это мой баннер входа"; |
Статус
Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость интерфейса.
Поддержка
Дополнительную информацию о поддержке Red Hat этого модуля см. в этой статье базы знаний
Автор
- Ganesh Nalawade (@ganeshrn)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете изменить его, чтобы улучшить его.
© 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/junos_banner_module.html