cisco.iosxr.iosxr_banner – Управление многострочными баннерами на устройствах Cisco IOS XR
Примечание
Этот плагин входит в коллекцию cisco.iosxr (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install cisco.iosxr.
Для использования в книге задач укажите: cisco.iosxr.iosxr_banner.
Введено в версии 1.0.0: of cisco.iosxr
Обзор
- Этот модуль будет настраивать баннеры 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 целое число | Указывает порт для создания соединения с удалённым устройством. | ||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации соединения с удалённым устройством. Это значение – путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку. | ||
| transport строка |
| Указывает тип транспорта соединения. | |
| 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
cisco.iosxr.iosxr_banner:
banner: login
text: |
@this is my login banner
that contains a multiline
string@
state: present
- name: remove the motd banner
cisco.iosxr.iosxr_banner:
banner: motd
state: absent
- name: Configure banner from file
cisco.iosxr.iosxr_banner:
banner: motd
text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}"
state: present
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда (пустой список, если нет команд для отправки) | Список команд конфигурации, отправленных устройству с транспортом cli
Пример: ['banner login', '@this is my login banner', 'that contains a multiline', 'string@'] |
| xml список / элементы=строка | всегда (пустой список, если нет 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 example</banner-text> </banner> </banners> </config>'] |
Авторы
- Trishna Guha (@trishnaguha)
- Kedar Kekan (@kedarX)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/iosxr/iosxr_banner_module.html
