Модуль cisco.iosxr.iosxr_banner — Модуль для настройки многострочных баннеров.

Примечание

Этот модуль является частью коллекции cisco.iosxr (версия 9.0.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.iosxr. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Для использования в плейбуке укажите: cisco.iosxr.iosxr_banner.

Введено в cisco.iosxr 1.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Этот модуль будет настраивать баннеры exec и motd на удаленном устройстве, работающем на Cisco IOS XR. Он позволяет плейбукам добавлять или удалять текст баннера из рабочей конфигурации.

Псевдонимы: banner

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

ncclient >= 0.5.3 при использовании netconf
lxml >= 4.1.1 при использовании netconf

Параметры

Параметр	Комментарии
banner строка / обязательный	Указывает тип баннера для настройки на удаленном устройстве. Варианты: `"login"` `"motd"`
state строка	Существующее состояние конфигурации на устройстве. Варианты: `"present"` ← (по умолчанию) `"absent"`
text строка	Текст баннера для настройки. Принимает многострочную строку без пустых строк. При использовании многострочной строки первые и последние символы должны быть начальным и конечным разделителями для баннера. Требует state=present.

Примечания

Примечание

Этот модуль работает с подключением network_cli и netconf. См. Опции платформы IOS-XR.
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в :ref:`Руководстве по сетям Ansible <network_guide>`
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице `Интеграция Cisco <https://www.ansible.com/integrations/networks/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 список / элементы=строка	NetConf rpc xml, отправленный устройству с транспортом `netconf` Возвращается: всегда (пустой список, если нет xml rpc для отправки) Пример: `["<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>"]`

Ключ

Описание

список / элементы=строка

Список команд конфигурации, отправленных устройству с транспортом cli

Возвращается: всегда (пустой список, если нет команд для отправки)

Пример: ["banner login", "@this is my login banner", "that contains a multiline", "string@"]

список / элементы=строка

NetConf rpc xml, отправленный устройству с транспортом netconf

Возвращается: всегда (пустой список, если нет xml rpc для отправки)

Пример: ["<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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/iosxr/iosxr_banner_module.html