Модуль cisco.nxos.nxos_nxapi – Управление конфигурацией NXAPI на устройстве NXOS.

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 8.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.nxos.

Для использования в playbook укажите: cisco.nxos.nxos_nxapi.

Новое в cisco.nxos 1.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Псевдонимы: nxapi

Параметры

Параметр	Комментарии
http Псевдонимы: enable_http boolean	Управляет рабочим состоянием протокола HTTP как одним из базовых транспортов для NXAPI. По умолчанию NXAPI включит транспорт HTTP при первой настройке функции. Чтобы отключить использование транспорта HTTP, установите значение этого аргумента в False. Варианты: `false` `true` ← (по умолчанию)
http_port целое число	Настройте порт, на котором HTTP-сервер будет прослушивать запросы. По умолчанию NXAPI свяжет HTTP-сервис со стандартным портом HTTP 80. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535. По умолчанию: `80`
https Псевдонимы: enable_https boolean	Управляет рабочим состоянием протокола HTTPS как одним из базовых транспортов для NXAPI. По умолчанию NXAPI отключит транспорт HTTPS при первой настройке функции. Чтобы включить использование транспорта HTTPS, установите значение этого аргумента в True. Варианты: `false` ← (по умолчанию) `true`
https_port целое число	Настройте порт, на котором HTTPS-сервер будет прослушивать запросы. По умолчанию NXAPI свяжет HTTPS-сервис со стандартным портом HTTPS 443. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535. По умолчанию: `443`
sandbox Псевдонимы: enable_sandbox boolean	Функция NXAPI предоставляет веб-базовый интерфейс для разработчиков для ввода команд. Эта функция изначально отключена при первой настройке функции NXAPI. Когда аргумент `sandbox` установлен в True, URL-адрес песочницы разработчика будет принимать запросы, а при установке в False URL-адрес песочницы недоступен. Это поддерживается на серии устройств NX-OS 7K. Варианты: `false` `true`
ssl_strong_ciphers boolean	Управляет использованием настройки сильных или слабых шифров. По умолчанию эта функция отключена, и настроены слабые шифры. Чтобы включить использование сильных шифров, установите значение этого аргумента в True. Варианты: `false` ← (по умолчанию) `true`
state строка	Аргумент `state` управляет тем, настроена ли функция NXAPI на удалённом устройстве. При значении `present` конфигурация функции NXAPI присутствует в текущей конфигурации устройства. При значении `absent` конфигурация функции удаляется из текущей конфигурации. Варианты: `"present"` ← (по умолчанию) `"absent"`
tlsv1_0 boolean	Управляет использованием протокола Transport Layer Security версии 1.0. По умолчанию эта функция включена. Чтобы отключить использование TLSV1.0, установите значение этого аргумента в True. Варианты: `false` `true` ← (по умолчанию)
tlsv1_1 boolean	Управляет использованием протокола Transport Layer Security версии 1.1. По умолчанию эта функция отключена. Чтобы включить использование TLSV1.1, установите значение этого аргумента в True. Варианты: `false` ← (по умолчанию) `true`
tlsv1_2 boolean	Управляет использованием протокола Transport Layer Security версии 1.2. По умолчанию эта функция отключена. Чтобы включить использование TLSV1.2, установите значение этого аргумента в True. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

Ограниченная поддержка Cisco MDS
Дополнительную информацию об использовании 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: true
    enable_sandbox: false

- name: remove NXAPI configuration
  cisco.nxos.nxos_nxapi:
    state: absent

END_OF_DOCUMENT_MARKER

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
updates список / элементы=строка	Возвращает список команд, которые необходимо передать на удаленное устройство для удовлетворения аргументов. Возвращается: всегда Пример: `["no feature nxapi"]`

Авторы

Peter Sprygada (@privateip)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/nxos/nxos_nxapi_module.html