iosxr_banner – Управление многострочными баннерами на устройствах Cisco IOS XR
Новое в версии 2.4.
Обзор
- Этот модуль будет настраивать баннеры exec и motd на удалённом устройстве, работающем на Cisco IOS XR. Он позволяет плейбукам добавлять или удалять текст баннеров из рабочей конфигурации.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ncclient >= 0.5.3 при использовании netconf
- lxml >= 4.1.1 при использовании netconf
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
|
banner
- / обязательно
|
|
Указывает тип баннера для настройки на удалённом устройстве. |
|
|
provider
-
|
Устаревшее
Начиная с Ansible 2.5, рекомендуется использовать
connection: network_cli.
Дополнительную информацию можно найти в Руководстве по сети.
Объект словаря, содержащий данные подключения.
|
||
|
host
- / обязательно
|
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. |
||
|
password
-
|
Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_PASSWORD.
|
||
|
port
-
|
По умолчанию: 22 |
Указывает порт для построения подключения к удалённому устройству. |
|
|
ssh_keyfile
-
|
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
|
||
|
timeout
-
|
По умолчанию: 10 |
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. |
|
|
username
-
|
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_USERNAME.
|
||
|
state
-
|
|
Существующее состояние конфигурации на устройстве. |
|
|
text
-
|
Текст баннера для настройки. Принимает многострочный текст без пустых строк. Требует state=present. |
||
Примечания
Примечание
- Тестировано на IOS XRv 6.1.2
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: configure the login banner
iosxr_banner:
banner: login
text: |
this is my login banner
that contains a multiline
string
state: present
- name: remove the motd banner
iosxr_banner:
banner: motd
state: absent
- name: Configure banner from file
iosxr_banner:
banner: motd
text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}"
state: present
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, а следующие — уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
|
commands
список
|
всегда (пустой список, если нет команд для отправки) |
Список команд конфигурационного режима, отправленных устройству с транспортом
cli
Пример:
['banner login', 'это мой баннер для входа', 'который содержит многострочный', 'строку']
|
|
xml
список
добавлен в 2.5
|
всегда (пустой список, если нет xml rpc для отправки) |
XML-RPC NetConf, отправленный устройству с транспортом
netconf
Пример:
['<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <banners xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-infra-infra-cfg"> <banner xc:operation="merge"> <banner-name>motd</banner-name> <banner-text>Пример баннера Ansible</banner-text> </banner> </banners> </config>']
|
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается командой Ansible Network. [сетевой]
Поддержка Red Hat
Дополнительную информацию о поддержке данного модуля компанией Red Hat можно найти в статье базы знаний Red Hat по этой ссылке.
Авторы
- Trishna Guha (@trishnaguha)
- Kedar Kekan (@kedarX)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/iosxr_banner_module.html
