junos_banner – Управление многострочными баннерами на устройствах Juniper JUNOS
Новое в версии 2.4.
Описание
- Этот модуль настраивает баннеры входа и motd на сетевых устройствах. Он позволяет плейбукам добавлять или удалять текст баннера из активной конфигурации.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- ncclient (>=v0.5.2)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| active boolean |
| Указывает, активна или деактивирована конфигурация | |
| banner - / обязательно |
| Указывает, какой баннер должен быть настроен на удалённом устройстве. Значение login обозначает сообщение системы входа до аутентификации, motd — объявление входа после успешной аутентификации. | |
| provider dictionary | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli или connection: netconf. Для получения дополнительной информации, пожалуйста, обратитесь к руководству Junos OS Platform Options. Объект dict, содержащий данные подключения. | ||
| host string / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. | ||
| password string | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port integer | По умолчанию: 22 | Указывает порт для подключения к удалённому устройству. Значение порта по умолчанию — известный порт SSH 22 (для transport=cli) или порт 830 (для transport=netconf) устройства. | |
| ssh_keyfile path | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | |
| username string | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии 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
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 string | при изменении конфигурации и включенном параметре diff. | Разница в конфигурации до и после применения изменения. Пример: [edit system login] + message "это мой баннер входа"; |
Статус
- Гарантированное обратное совместимость интерфейса этого модуля не обеспечивается. [превью]
- Этот модуль поддерживается командой Ansible Network Team. [сеть]
Поддержка Red Hat
Дополнительная информация о поддержке этого модуля Red Hat доступна в этой статье базы знаний 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.9/modules/junos_banner_module.html
