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