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

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install cisco.nxos.

Чтобы использовать ее в плейбуке, укажите: cisco.nxos.nxos_nxapi.

Добавлено в cisco.nxos 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Примечание

Этому модулю соответствует плагин действия.

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

Параметры

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

Примечания

Примечание

Ограниченная поддержка Cisco MDS
Информацию об использовании CLI и NX-API см. в руководстве :ref:`Параметры платформы NXOS <nxos_platform_options>`
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в :ref:`Руководстве по сетям Ansible <network_guide>`
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на `странице интеграции Cisco <https://www.ansible.com/integrations/networks/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

Возвращаемые значения

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

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

Авторы

Peter Sprygada (@privateip)

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

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