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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
http bool		Варианты: no да ←	Управляет состоянием протокола HTTP как одного из базовых протоколов для NXAPI. По умолчанию NXAPI включает транспорт HTTP при первой настройке функции. Чтобы отключить использование транспорта HTTP, установите значение этого аргумента в значение False. псевдонимы: enable_http
http_port		Значение по умолчанию: 80	Настройте порт, на котором HTTP-сервер будет прослушивать запросы. По умолчанию NXAPI привязывает HTTP-сервис к стандартному порту HTTP 80. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535.
https bool		Варианты: нет ← да	Управляет состоянием протокола HTTPS как одного из базовых протоколов для NXAPI. По умолчанию NXAPI отключает транспорт HTTPS при первой настройке функции. Чтобы включить использование транспорта HTTPS, установите значение этого аргумента в значение True. псевдонимы: enable_https
https_port		Значение по умолчанию: 443	Настройте порт, на котором HTTPS-сервер будет прослушивать запросы. По умолчанию NXAPI привязывает HTTPS-сервис к стандартному порту HTTPS 443. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535.
provider			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр необходим только если вы используете NX-API. Для получения дополнительной информации, обратитесь к руководству NXOS Platform Options. Объект словаря, содержащий детали соединения.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта.
	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)	Значение по умолчанию: "none"	Указывает пароль для использования, если требуется переход в привилегированный режим на удалённом устройстве. Если 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` будут игнорироваться.
sandbox bool		Варианты: нет ← да	Функция NXAPI предоставляет веб-интерфейс для разработчиков для ввода команд. Эта функция изначально отключена при первой настройке функции NXAPI. Когда аргумент `sandbox` установлен в True, URL-адрес песочницы разработчика будет принимать запросы, а при установке значения в False, URL-адрес песочницы недоступен. Поддерживается на устройствах NX-OS 7K серии. псевдонимы: enable_sandbox
state		Варианты: present ← absent	Аргумент `state` управляет тем, настроена ли функция NXAPI на удалённом устройстве. Когда значение `present`, конфигурация функции NXAPI присутствует в конфигурации running-config устройства. Когда значение `absent`, конфигурация функции удаляется из конфигурации running-config.

Примечания

Примечание

Дополнительную информацию об использовании CLI и NX-API см. в руководстве по параметрам платформы NXOS
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве по сети Ansible
Дополнительную информацию об использовании 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']

Статус

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

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по работе с сетями. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых командой Ansible по работе с сетями, см. здесь.

Поддержка

Дополнительную информацию о поддержке этого модуля компанией 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.6/modules/nxos_nxapi_module.html