Модуль cisco.nxos.nxos_banner — управление многострочными баннерами на устройствах Cisco NXOS

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.nxos.

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

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

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

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

Настраивает баннеры exec и motd на удалённых устройствах под управлением Cisco NXOS. Позволяет плейбукам добавлять или удалять текст баннера из активной текущей конфигурации.

Примечание

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

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

Параметры

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

Примечания

Примечание

Поскольку ответы устройства всегда считываются с удалёнными начальными и конечными пробелами, задачи, настраивающие баннеры с начальными или конечными пробелами, не будут идемпотентными.
Ограниченная поддержка Cisco MDS
Сведения об использовании CLI и NX-API см. в :ref:`руководстве по настройке платформы NXOS <nxos_platform_options>`
Дополнительные сведения об использовании Ansible для управления сетевыми устройствами см. в :ref:`руководстве по сетям Ansible <network_guide>`
Дополнительные сведения об использовании Ansible для управления устройствами Cisco см. на `странице интеграции Cisco <https://www.ansible.com/integrations/networks/cisco>`_.

Примеры

- name: configure the exec banner
  cisco.nxos.nxos_banner:
    banner: exec
    text: |
      this is my exec banner
      that contains a multiline
      string
    state: present
- name: remove the motd banner
  cisco.nxos.nxos_banner:
    banner: motd
    state: absent
- name: Configure banner from file
  cisco.nxos.nxos_banner:
    banner: motd
    text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}"
    state: present

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

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

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

Авторы

Trishna Guha (@trishnaguha)

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

© 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/nxos/nxos_banner_module.html