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 на сайте Ansible.
Примеры
- 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 по сетевым модулям. [сетевой]
Поддержка 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.8/modules/iosxr_banner_module.html
