nxos_banner - Управление многострочными баннерами на устройствах Cisco NXOS
Новое в версии 2.4.
Описание
- Этот модуль настраивает баннеры exec и motd на удалённых устройствах, работающих на Cisco NXOS. Он позволяет плейбукам добавлять или удалять текст баннера из активной конфигурации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| banner обязательно |
Нет |
Указывает, какой баннер следует настроить на удалённом устройстве. |
|
| provider | Значение по умолчанию: Нет |
Устаревший
Начиная с Ansible 2.5, рекомендуется использовать
connection: network_cli. Этот параметр необходим только при использовании NX-API.
Для получения дополнительной информации см. руководство NXOS Platform Options.
Объект словаря, содержащий данные подключения. |
|
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. |
||
| authorize (добавлено в 2.5.3) |
|
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. |
|
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. |
||
| use_proxy (добавлено в 2.5) |
|
Если no, переменные среды http_proxy и https_proxy будут проигнорированы. |
|
| auth_pass (добавлено в 2.5.3) |
Значение по умолчанию: нет |
Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, этот параметр ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. |
|
| host обязательно |
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. |
||
| timeout (добавлено в 2.3) |
Значение по умолчанию: 10 |
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т. д.). |
|
| use_ssl |
|
Настраивает транспорт transport для использования SSL, если значение равно true, только когда transport=nxapi, в противном случае это значение игнорируется. |
|
| password | Значение по умолчанию: Нет |
Указывает пароль для аутентификации подключения к удалённому устройству. Это общий параметр, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. |
|
| validate_certs |
Нет |
Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах с контролируемым доступом, использующих самозаверенные сертификаты. Если параметр transport не nxapi, это значение игнорируется. |
|
| port | Значение по умолчанию: 0 (использовать стандартный порт) |
Указывает порт для подключения к удалённому устройству. Это значение применяется к cli или nxapi. Значение порта по умолчанию соответствует стандартному порту транспорта, если он не указан в задаче. (cli=22, http=80, https=443). |
|
| transport обязательно |
Значение по умолчанию: cli |
Настраивает транспортное подключение для подключения к удалённому устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi. |
|
| state |
|
Указывает, присутствует ли конфигурация в текущей активной конфигурации устройства. |
|
| text | Значение по умолчанию: Нет |
Текст баннера, который должен присутствовать в конфигурации удалённого устройства. Этот параметр принимает многострочный текст без пустых строк. Требуется state=present. |
|
Примечания
Примечание
- Дополнительную информацию о работе с CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: configure the exec banner
nxos_banner:
banner: exec
text: |
this is my exec banner
that contains a multiline
string
state: present
- name: remove the motd banner
nxos_banner:
banner: motd
state: absent
- name: Configure banner from file
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'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Поддержка
Дополнительную информацию о поддержке данного модуля компанией Red Hat см. в этой статье базы знаний.
Автор
- 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.5/modules/nxos_banner_module.html
