nxos_nxapi — Управление конфигурацией NXAPI на устройстве NXOS.

Новое в версии 2.1.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Поддержка
- Автор

Описание

Настраивает функцию NXAPI на устройствах, работающих под управлением Cisco NXOS. Функция NXAPI по умолчанию отсутствует в конфигурации. Поскольку этот модуль управляет функцией NXAPI, он поддерживает только использование Cli транспорта.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
http		Варианты: да ← нет	Управляет рабочим состоянием протокола HTTP как одного из базовых транспортов для NXAPI. По умолчанию NXAPI включит транспорт HTTP при первой настройке функции. Чтобы отключить использование транспорта HTTP, установите значение этого аргумента в False. псевдонимы: enable_http
http_port		Значение по умолчанию: 80	Настройка порта, на котором HTTP-сервер будет прослушивать запросы. По умолчанию NXAPI привяжет HTTP-сервис к стандартному порту HTTP 80. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535.
https		Варианты: да нет ←	Управляет рабочим состоянием протокола HTTPS как одного из базовых транспортов для NXAPI. По умолчанию NXAPI отключит транспорт HTTPS при первой настройке функции. Чтобы включить использование транспорта HTTPS, установите значение этого аргумента в True. псевдонимы: enable_https
https_port		Значение по умолчанию: 443	Настройка порта, на котором HTTPS-сервер будет прослушивать запросы. По умолчанию NXAPI привяжет HTTPS-сервис к стандартному порту HTTPS 443. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535.
provider		Значение по умолчанию: None	Устаревшее Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр нужен только при использовании NX-API. Дополнительную информацию можно найти в руководстве NXOS Platform Options. Объект словаря, содержащий детали подключения.
	username		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в командную строку или аутентификации 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)	Значение по умолчанию: none	Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	timeout (добавлено в 2.3)	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.).
	use_ssl	Варианты: да нет ←	Настраивает транспорт на использование SSL, если значение равно true только тогда, когда `transport=nxapi`, в противном случае это значение игнорируется.
	password	Значение по умолчанию: None	Указывает пароль для аутентификации подключения к удаленному устройству. Это распространенный аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_PASSWORD`.
	validate_certs	Варианты: да нет Значение по умолчанию: None	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Если аргумент транспорт не nxapi, это значение игнорируется.
	port	Значение по умолчанию: 0 (использовать общий порт)	Указывает порт для использования при построении подключения к удаленному устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию будет соответствовать общему порту соответствующего транспорта, если он не указан в задаче (cli=22, http=80, https=443).
	transport обязательно	Значение по умолчанию: cli	Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi.
sandbox		Варианты: да нет ←	Функция NXAPI предоставляет веб-интерфейс для разработчиков для ввода команд. Эта функция изначально отключена при первой настройке функции NXAPI. Когда аргумент `sandbox` устанавливается в True, URL песочницы разработчика будет принимать запросы, а при установке в False, URL песочницы недоступен. Поддерживается на устройствах NX-OS серии 7K. псевдонимы: enable_sandbox
state		Варианты: present ← absent	Аргумент `state` управляет тем, настроен ли на удаленном устройстве NXAPI. Когда значение `present`, конфигурация NXAPI присутствует в конфигурации устройства running-config. Когда значение `absent`, конфигурация функции удаляется из running-config.

Примечания

Примечание

Дополнительную информацию об использовании командной строки и NX-API см. в руководстве NXOS Platform Options
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

- 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 список	всегда	Возвращает список команд, которые необходимо отправить на удаленное устройство, чтобы выполнить аргументы. Пример: ['no feature nxapi']

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Поддержка

Для получения дополнительной информации о поддержке этого модуля Red Hat, пожалуйста, обратитесь к этой статье базы знаний

Автор

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.5/modules/nxos_nxapi_module.html