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

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 8.1.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 Platform Options <nxos_platform_options>`
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство :ref:`Ansible Network Guide <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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/nxos/nxos_banner_module.html