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.3.
- Этот модуль работает с соединениями
network_cliиnetconf. См. опции платформы IOS-XR. - Дополнительную информацию об использовании 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 для отправки) | NetConf rpc xml, отправленный устройству с транспортом 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 по сетям. [сетевой]
Поддержка 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.9/modules/iosxr_banner_module.html
