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 используется в качестве адреса назначения для транспорта. | ||
| port | Значение по умолчанию: 22 | Указывает порт, используемый при построении подключения к удалённому устройству. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| timeout | Значение по умолчанию: 10 | Указывает таймаут в секундах для взаимодействия с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| 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 Team. Дополнительная информация см. в Поддержка и техническое обслуживание модулей.
Список других модулей, также поддерживаемых командой Ansible Network Team, см. здесь.
Поддержка
Дополнительная информация о поддержке данного модуля компанией 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.6/modules/iosxr_banner_module.html
