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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.ios.

Чтобы использовать её в плейбуке, укажите: cisco.ios.ios_banner.

Добавлено в cisco.ios 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Модуль настраивает баннеры login и motd на удалённых устройствах под управлением Cisco IOS. Он позволяет плейбукам добавлять или удалять текст баннера в активной текущей конфигурации.

Примечание

Этому модулю соответствует плагин действий.

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

Параметры

Параметр	Комментарии
banner string / обязательный	Указывает, какой баннер следует настроить на удалённом устройстве. В Ansible 2.4 и более ранних версиях поддерживались только login и motd. Варианты: `"login"` `"motd"` `"exec"` `"incoming"` `"slip-ppp"`
multiline_delimiter string	Указывает символ-разделитель, который будет использоваться при настройке. По умолчанию: `"@"`
state string	Указывает, присутствует ли конфигурация в активной текущей конфигурации устройства. Варианты: `"present"` ← (по умолчанию) `"absent"`
text string	Текст баннера, который должен присутствовать в текущей конфигурации удалённого устройства. Этот аргумент принимает многострочную строку без пустых строк. Требуется state=present.

Примечания

Примечание

Проверено на Cisco IOSXE версии 17.3 в CML.
Этот модуль работает с подключением network_cli. См. https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в :ref:`руководстве по работе с сетями Ansible <network_guide>`
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на `странице интеграции с Cisco <https://www.ansible.com/integrations/networks/cisco>`_.

Примеры

- name: Configure the login banner
  cisco.ios.ios_banner:
    banner: login
    text: |
      this is my login banner
      that contains a multiline
      string
    state: present

- name: Remove the motd banner
  cisco.ios.ios_banner:
    banner: motd
    state: absent

- name: Configure banner from file
  cisco.ios.ios_banner:
    banner: motd
    text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}"  # Use unix formatted text files (LF not CRLF) to avoid idempotency issues.
    state: present

- name: Configure the login banner using delimiter
  cisco.ios.ios_banner:
    banner: login
    multiline_delimiter: x
    text: this is my login banner
    state: present

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
commands list / элементы=string	Список команд режима конфигурации, отправляемых устройству Возвращается: всегда Пример: `["banner login", "this is my login banner", "that contains a multiline", "string"]`

Авторы

Ricardo Carrillo Cruz (@rcarrillocruz)

Ссылки на коллекцию

© 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/ios/ios_banner_module.html