junos_banner - Управление многострочными баннерами на устройствах Juniper JUNOS
Новая версия 2.4.
Обзор
- Этот модуль настраивает баннеры входа и MOTD на сетевых устройствах. Он позволяет плейбукам добавлять или удалять текст баннера из активной рабочей конфигурации.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- ncclient (>=v0.5.2)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| active bool |
| Указывает, активна или деактивирована конфигурация. | |
| banner обязательно |
| Указывает, какой баннер должен быть настроен на удаленном устройстве. Значение login обозначает сообщение системы об входе до аутентификации, motd — сообщение о входе после успешной аутентификации. | |
| provider | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli или connection: netconf. Дополнительная информация находится в руководстве Junos OS Platform Options. Объект dict, содержащий данные подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: 22 | Указывает порт, который необходимо использовать при построении соединения с удаленным устройством. Значение порта по умолчанию — 22 (для transport=cli) или 830 (для transport=netconf) устройства. | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| state |
| Указывает, присутствует ли конфигурация в текущей активной рабочей конфигурации устройства. | |
| text | Текст баннера, который должен присутствовать в рабочей конфигурации удаленного устройства. Этот аргумент принимает многострочный текст без пустых строк. Требуется state=present. | ||
Примечания
Примечание
- Для этого модуля требуется, чтобы на управляемом удаленном устройстве была включена служба netconf.
- Проверено на vSRX JUNOS версии 15.1X49-D15.4, vqfx-10000 JUNOS версии 15.1X53-D60.4.
- Рекомендуемое подключение —
netconf. См. настройки платформы Junos OS. - Этот модуль также работает с подключениями
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 строка | при изменении конфигурации и включенном параметре diff. | Разница в конфигурации до и после применения изменений. Пример: [edit system login] + message "это мой баннер входа"; |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по работе с сетями. Дополнительная информация — в разделе Обслуживание и поддержка модулей.
Список других модулей, поддерживаемых командой Ansible по работе с сетями, находится здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля 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.6/modules/junos_banner_module.html
