cisco.nxos.nxos_banner – Управление многострочными баннерами на устройствах Cisco NXOS
Примечание
Этот плагин входит в состав коллекции cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos
Для использования в плейбуке укажите: cisco.nxos.nxos_banner
Новое в версии 1.0.0: из cisco.nxos
Обзор
- Это позволит настроить баннеры exec и motd на удалённых устройствах, работающих под управлением Cisco NXOS. Это позволяет плейбукам добавлять или удалять текст баннера из активной рабочей конфигурации.
Примечание
Для этого модуля существует соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| banner строка / обязательно |
| Указывает, какой баннер должен быть настроен на удалённом устройстве. | |
| provider словарь | Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cliНачиная с Ansible 2.6 рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удалён в релизе после 2022-06-01. Дополнительную информацию можно найти в руководстве NXOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass строка | Указывает пароль для использования, если требуется вход в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент не работает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS | ||
| authorize логическое значение |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспорта cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD | ||
| port целое число | Указывает порт для подключения к удалённому устройству. Это значение применяется как к cli, так и к nxapi. Если порт не указан в задаче, используется стандартный порт для транспорта. (cli=22, http=80, https=443). | ||
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.). | ||
| transport строка |
| Настраивает транспортное подключение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy логическое значение |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl логическое значение |
| Настраивает transport на использование SSL, если установлено yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверенными сертификатами. Если аргумент transport не nxapi, это значение игнорируется. | |
| state строка |
| Указывает, присутствует ли конфигурация в активной рабочей конфигурации текущего устройства. | |
| text строка | Текст баннера, который должен присутствовать в рабочей конфигурации удалённого устройства. Этот аргумент принимает многострочную строку без пустых строк. Требует state=present. | ||
Примечания
Примечание
- Так как ответы от устройства всегда читаются со снятыми окружающими пробелами, задачи, которые настраивают баннеры с предшествующими или последующими пробелами, не будут идемпотентными.
- Сведения об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве по сетям Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции 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', 'это мой баннер exec', 'который содержит многострочный', 'строку'] |
Авторы
- Trishna Guha (@trishnaguha)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/nxos/nxos_banner_module.html
