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