nxos_nxapi – Управление конфигурацией NXAPI на устройстве NXOS
Описание
- Конфигурирует функцию NXAPI на устройствах, работающих под управлением Cisco NXOS. Функция NXAPI отсутствует в конфигурации по умолчанию. Поскольку этот модуль управляет функцией NXAPI, он поддерживает только использование транспорта
Cli.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| http boolean |
| Управляет состоянием протокола HTTP как одного из базовых транспортов для NXAPI. По умолчанию NXAPI включает транспорт HTTP при первой настройке функции. Чтобы отключить использование транспорта HTTP, установите значение этого аргумента в False. Псевдонимы: enable_http | |
| http_port - | Значение по умолчанию: 80 | Настройте порт, на котором HTTP-сервер будет слушать запросы. По умолчанию NXAPI привязывает HTTP-сервис к стандартному порту HTTP 80. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535. | |
| https boolean |
| Управляет состоянием протокола HTTPS как одного из базовых транспортов для NXAPI. По умолчанию NXAPI отключает транспорт HTTPS при первой настройке функции. Чтобы включить использование транспорта HTTPS, установите значение этого аргумента в True. Псевдонимы: enable_https | |
| https_port - | Значение по умолчанию: 443 | Настройте порт, на котором HTTPS-сервер будет слушать запросы. По умолчанию NXAPI привязывает HTTPS-сервис к стандартному порту HTTPS 443. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535. | |
| provider dictionary | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только если вы используете NX-API. Для получения дополнительной информации, обратитесь к руководству NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass string добавлено в 2.5.3 | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean добавлено в 2.5.3 |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host string / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| password string | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port integer | Значение по умолчанию: "0 (использовать общий порт)" | Указывает порт для создания подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию будет соответствовать общему порту транспорта, если не указано в задаче. (cli=22, http=80, https=443). | |
| ssh_keyfile string | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может быть медленным для выполнения длительных команд (sh mac, sh bgp и т. д.). | |
| transport string / обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy boolean добавлено в 2.5 |
| Если 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 добавлено в 2.7 |
| Управляет использованием того, настроены ли сильные или слабые шифры. По умолчанию эта функция отключена, и настроены слабые шифры. Чтобы включить использование сильных шифров, установите значение этого аргумента в True. | |
| state - |
| Аргумент state управляет тем, настроен ли NXAPI на удалённом устройстве. Когда значение present, конфигурация NXAPI присутствует в running-конфигурации устройства. Когда значение absent, конфигурация функции удаляется из running-конфигурации. | |
| tlsv1_0 boolean добавлено в 2.7 |
| Управляет использованием протокола Transport Layer Security версии 1.0. По умолчанию эта функция включена. Чтобы отключить использование TLSV1.0, установите значение этого аргумента в True. | |
| tlsv1_1 boolean added in 2.7 |
| Управляет использованием версии Transport Layer Security 1.1. По умолчанию эта функция отключена. Для включения использования TLSV1.1 установите значение этого аргумента в True. | |
| tlsv1_2 boolean added in 2.7 |
| Управляет использованием версии Transport Layer Security 1.2. По умолчанию эта функция отключена. Для включения использования TLSV1.2 установите значение этого аргумента в True. | |
Примечания
Примечание
- Дополнительная информация о работе с командной строкой и NX-API находится в руководстве NXOS Platform Options
- Дополнительная информация о работе с Ansible для управления сетевыми устройствами находится в руководстве Ansible Network Guide
- Дополнительная информация о работе с Ansible для управления устройствами Cisco находится на странице интеграции Cisco Cisco integration page.
Примеры
- name: Enable NXAPI access with default configuration
nxos_nxapi:
state: present
- name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled
nxos_nxapi:
enable_http: false
https_port: 9443
https: yes
enable_sandbox: no
- name: remove NXAPI configuration
nxos_nxapi:
state: absent
Значения возврата
Общие значения возврата описаны в этом разделе, а следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| updates list | всегда | Возвращает список команд, которые необходимо передать на удалённое устройство для выполнения аргументов Пример: ['no feature nxapi'] |
Статус
- Интерфейс этого модуля не гарантируется как обратно совместимый. [preview]
- Этот модуль поддерживается командой Ansible Network. [network]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в статье базы знаний Red Hat Red Hat Knowledge Base article.
Авторы
- 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.9/modules/nxos_nxapi_module.html
