cisco.nxos.nxos_nxapi 模块 – 在 NXOS 设备上管理 NXAPI 配置。

注意

此模块是 cisco.nxos 集合 (版本 9.2.1) 的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.nxos。

要在 playbook 中使用它，请指定：cisco.nxos.nxos_nxapi。

cisco.nxos 1.0.0 中的新增功能

概要 

在运行 Cisco NXOS 的设备上配置 NXAPI 功能。默认情况下，配置中不存在 NXAPI 功能。由于此模块管理 NXAPI 功能，它仅支持使用 Cli 传输。

参数 

参数	注释
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 功能为开发人员提供了一个基于 Web 的 UI 来输入命令。首次配置 NXAPI 功能时，此功能最初处于禁用状态。当 `sandbox` 参数设置为 True 时，开发人员沙箱 URL 将接受请求，当该值设置为 False 时，沙箱 URL 将不可用。这在 NX-OS 7K 系列上受支持。选项 `false` `true`
ssl_strong_ciphers 布尔值	控制是否配置强密码或弱密码。默认情况下，此功能处于禁用状态，并配置弱密码。要启用强密码的使用，请将此参数的值设置为 True。选项 `false` ← (默认) `true`
state 字符串	`state` 参数控制是否在远程设备上配置 NXAPI 功能。当值为 `present` 时，NXAPI 功能配置存在于设备运行配置中。当值为 `absent` 时，该功能配置将从运行配置中删除。选项 `"present"` ← (默认) `"absent"`
tlsv1_0 布尔值	控制是否配置传输层安全协议版本 1.0 的使用。默认情况下，此功能处于启用状态。要禁用 TLSV1.0 的使用，请将此参数的值设置为 True。选项 `false` `true` ← (默认)
tlsv1_1 布尔值	控制是否配置传输层安全协议版本 1.1 的使用。默认情况下，此功能处于禁用状态。要启用 TLSV1.1 的使用，请将此参数的值设置为 True。选项 `false` ← (默认) `true`
tlsv1_2 布尔值	控制是否配置传输层安全协议版本 1.2 的使用。默认情况下，此功能处于禁用状态。要启用 TLSV1.2 的使用，请将此参数的值设置为 True。选项 `false` ← (默认) `true`

说明 

注意

对 Cisco MDS 的有限支持
有关使用 CLI 和 NX-API 的信息，请参阅 :ref:`NXOS 平台选项指南 <nxos_platform_options>`
有关使用 Ansible 管理网络设备的更多信息，请参阅 :ref:`Ansible 网络指南 <network_guide>`
有关使用 Ansible 管理 Cisco 设备的更多信息，请参阅 `Cisco 集成页面 <https://ansible.org.cn/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 列表 / elements=string	返回需要推送到远程设备以满足参数的命令列表返回：始终示例： `["no feature nxapi"]`

作者

Peter Sprygada (@privateip)