cisco.dnac.network_device_user_defined_field 模块 – 网络设备用户自定义字段的资源模块

注意

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

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

要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定： cisco.dnac.network_device_user_defined_field。

cisco.dnac 3.1.0 中的新增功能

概要 

此模块表示模块 network_device_user_defined_field_v1 的别名

注意

此模块具有相应的操作插件。

要求 

执行此模块的主机需要满足以下要求。

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
description 字符串	UDF 的描述。
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"`
id 字符串	Id 路径参数。UDF id。
name 字符串	UDF 的名称。
validate_response_schema 布尔值	Cisco DNA Center SDK 的标志，用于启用针对 JSON 架构验证请求正文。选择 `false` `true` ←（默认）

备注 

注意

使用的 SDK 方法是 devices.Devices.create_user_defined_field_v1、devices.Devices.delete_user_defined_field_v1、devices.Devices.update_user_defined_field_v1，
使用的路径是 post /dna/intent/api/v1/network-device/user-defined-field、delete /dna/intent/api/v1/network-device/user-defined-field/{id}、put /dna/intent/api/v1/network-device/user-defined-field/{id}，
应该注意的是，此模块是 network_device_user_defined_field_v1 的别名
不支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

有关设备 CreateUserDefinedFieldV1 的 Cisco DNA Center 文档: CreateUserDefinedFieldV1 API 的完整参考。
有关设备 DeleteUserDefinedFieldV1 的 Cisco DNA Center 文档: DeleteUserDefinedFieldV1 API 的完整参考。
有关设备 UpdateUserDefinedFieldV1 的 Cisco DNA Center 文档: UpdateUserDefinedFieldV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.network_device_user_defined_field:
    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}}"
    state: present
    description: string
    name: string

- name: Update by id
  cisco.dnac.network_device_user_defined_field:
    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}}"
    state: present
    description: string
    id: string
    name: string

- name: Delete by id
  cisco.dnac.network_device_user_defined_field:
    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}}"
    state: absent
    id: string

返回值 

常见的返回值在此处记录这里，以下是此模块特有的字段

键	描述
dnac_response 字典	一个字典或列表，其中包含 Cisco DNAC Python SDK 返回的响应已返回：始终示例： `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)