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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 string / обязательный	Указывает тип баннера для настройки на удалённом устройстве. Варианты: `"login"` `"motd"`
state string	Состояние конфигурации на устройстве. Варианты: `"present"` ← (по умолчанию) `"absent"`
text string	Текст баннера для настройки. Принимает многострочную строку без пустых строк. При использовании многострочной строки первый и последний символы должны быть разделителями начала и конца баннера. Требует 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 list / elements=string	Список команд режима конфигурации, отправленных устройству с помощью транспорта `cli` Возвращается: всегда (пустой список, если команды для отправки отсутствуют) Пример: `["banner login", "@this is my login banner", "that contains a multiline", "string@"]`
xml list / elements=string	XML-запрос NetConf rpc, отправленный устройству с помощью транспорта `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>"]`

Ключ

Описание

list / elements=string

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

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

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

list / elements=string

XML-запрос NetConf rpc, отправленный устройству с помощью транспорта 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/iosxr/iosxr_banner_module.html