cisco.nxos.nxos_nxapi – Управление конфигурацией NXAPI на устройстве NXOS.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в плейбуке укажите: cisco.nxos.nxos_nxapi.
Новое в версии 1.0.0: из cisco.nxos
Описание
- Настраивает функцию NXAPI на устройствах, работающих под управлением Cisco NXOS. Функция NXAPI по умолчанию отсутствует в конфигурации. Поскольку этот модуль управляет функцией NXAPI, он поддерживает только использование транспорта
Cli.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| http boolean |
| Управляет состоянием протокола HTTP в качестве одного из основных транспортных протоколов для NXAPI. По умолчанию NXAPI включит транспорт HTTP при первой настройке функции. Чтобы отключить использование транспорта HTTP, установите значение этого аргумента в False. алиасы: enable_http | |
| http_port integer | Значение по умолчанию: 80 | Настройте порт, на котором HTTP-сервер будет прослушивать запросы. По умолчанию NXAPI привяжет HTTP-сервис к стандартному порту HTTP 80. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535. | |
| https boolean |
| Управляет состоянием протокола HTTPS в качестве одного из основных транспортных протоколов для NXAPI. По умолчанию NXAPI отключит транспорт HTTPS при первой настройке функции. Чтобы включить использование транспорта HTTPS, установите значение этого аргумента в True. алиасы: enable_https | |
| https_port integer | Значение по умолчанию: 443 | Настройте порт, на котором HTTPS-сервер будет прослушивать запросы. По умолчанию NXAPI привяжет HTTPS-сервис к стандартному порту HTTPS 443. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535. | |
| provider dictionary | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удален в выпуске после 2022-06-01. Дополнительная информация в руководстве NXOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass string | Указывает пароль, который нужно использовать, если требуется входить в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host string | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| password string | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port integer | Указывает порт, используемый при создании подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует стандартному порту для транспорта, если оно не указано в задаче (cli=22, http=80, https=443). | ||
| ssh_keyfile string | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может быть медленным при возврате на длительные команды (sh mac, sh bgp и т.д.). | ||
| transport string |
| Настраивает транспортное подключение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy boolean |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает transport для использования SSL, если установлено значение yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username string | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых пользователем, использующих самозаверенные сертификаты. Если аргумент transport не равен nxapi, это значение игнорируется. | |
| sandbox boolean |
| Функция NXAPI предоставляет веб-интерфейс для разработчиков для ввода команд. Эта функция изначально отключена при первой настройке функции NXAPI. Когда аргумент sandbox устанавливается в True, URL песочницы разработчика будет принимать запросы, а когда значение устанавливается в False, URL песочницы недоступен. Поддерживается на устройствах серии NX-OS 7K.алиасы: enable_sandbox | |
| ssl_strong_ciphers boolean |
| Управляет использованием настроек сильных или слабых шифров. По умолчанию эта функция отключена, и настроены слабые шифры. Чтобы включить использование сильных шифров, установите значение этого аргумента в True. | |
| state string |
| Аргумент state управляет тем, настроена ли функция NXAPI на удалённом устройстве или нет. Когда значение present, конфигурация функции NXAPI присутствует в конфигурации running-config устройства. Когда значение absent, конфигурация функции удаляется из running-config. | |
| tlsv1_0 boolean |
| Управляет использованием протокола Transport Layer Security версии 1.0. По умолчанию эта функция включена. Чтобы отключить использование TLSV1.0, установите значение этого аргумента в True. | |
| tlsv1_1 boolean |
| Управляет использованием протокола Transport Layer Security версии 1.1. По умолчанию эта функция отключена. Чтобы включить использование TLSV1.1, установите значение этого аргумента в True. | |
| tlsv1_2 boolean |
| Управляет использованием протокола Transport Layer Security версии 1.2. По умолчанию эта функция отключена. Чтобы включить использование TLSV1.2, установите значение этого аргумента в True. | |
Примечания
Примечание
- Справочная информация по использованию CLI и NX-API находится в руководстве по параметрам платформы NXOS
- Дополнительная информация по использованию Ansible для управления сетевыми устройствами находится в руководстве по сети Ansible
- Дополнительная информация по использованию Ansible для управления устройствами Cisco находится на странице интеграции Cisco.
Примеры
- name: Enable NXAPI access with default configuration
cisco.nxos.nxos_nxapi:
state: present
- name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled
cisco.nxos.nxos_nxapi:
enable_http: false
https_port: 9443
https: yes
enable_sandbox: no
- name: remove NXAPI configuration
cisco.nxos.nxos_nxapi:
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже представлены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| updates список / элементы=строка | всегда | Возвращает список команд, которые необходимо передать на удаленное устройство для выполнения аргументов Пример: ['no feature nxapi'] |
Авторы
- Peter Sprygada (@privateip)
© 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_nxapi_module.html
