cisco.dnac.interface_update 模块 – 用于接口更新的资源模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.dnac。您需要满足其他要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:cisco.dnac.interface_update

cisco.dnac 6.0.0 新增功能

概要

  • 此模块表示模块 interface_update_v1 的别名

注意

此模块具有相应的 action 插件

要求

在执行此模块的主机上需要以下要求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

adminStatus

字符串

管理状态为 (‘UP’/’DOWN’)。

deploymentMode

字符串

DeploymentMode 查询参数。预览/部署 “预览” 表示配置未推送到设备。“部署” 使配置推送到设备。

description

字符串

接口的描述。

dnac_debug

布尔值

用于 Cisco DNA Center SDK 以启用调试的标志。

选择

  • false ← (默认)

  • true

dnac_host

字符串 / 必需

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认值: 443

dnac_username

别名:user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认值: "admin"

dnac_verify

布尔值

用于启用或禁用 SSL 证书验证的标志。

选择

  • false

  • true ← (默认)

dnac_version

字符串

通知 SDK 使用哪个版本的 Cisco DNA Center。

默认值: "2.3.7.6"

interfaceUuid

字符串

InterfaceUuid 路径参数。接口 ID。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 以启用针对 JSON 模式验证请求主体的标志。

选择

  • false

  • true ← (默认)

vlanId

整数

要更新的 VLAN ID。

voiceVlanId

整数

要更新的语音 VLAN ID。

说明

注意

  • 使用的 SDK 方法是 devices.Devices.update_interface_details_v1,

  • 使用的路径是 put /dna/intent/api/v1/interface/{interfaceUuid},

  • 应该注意的是,此模块是 interface_update_v1 的别名

  • 不支持 check_mode

  • 该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

有关 Devices UpdateInterfaceDetailsV1 的 Cisco DNA Center 文档

UpdateInterfaceDetailsV1 API 的完整参考。

示例

- name: Update by id
  cisco.dnac.interface_update:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    adminStatus: string
    deploymentMode: string
    description: string
    interfaceUuid: string
    vlanId: 0
    voiceVlanId: 0

返回值

常用返回值在此处记录 此处,以下是此模块独有的字段

描述

dnac_response

字典

一个字典或列表,其中包含 Cisco DNAC Python SDK 返回的响应

返回值: 总是

示例: {"response": {"properties": {"taskId": {"type": "string"}, "url": {"type": "string"}}, "required": ["string"], "type": "string"}, "version": {"type": "string"}}

作者

  • Rafael Campos (@racampos)