cisco.dnac.network_device_user_defined_field_update_v1 模块 – 网络设备用户自定义字段更新 V1 资源模块
注意
此模块是 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_update_v1。
cisco.dnac 6.14.0 中的新增功能
概要
管理资源网络设备用户自定义字段更新 V1 的操作更新。
将现有的全局用户自定义字段分配给设备。如果 UDF 已分配给特定设备，则它会相应地更新设备 UDF 值。请注意，分配的 UDF“名称”必须是现有的全局 UDF。否则将显示错误。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
DeviceId 路径参数。要添加 UDF 的设备的 UUID。 |
|
用于 Cisco DNA Center SDK 以启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 使用哪个版本的 Cisco DNA Center。 默认： |
|
网络设备用户自定义字段更新的有效负载。 |
|
用户自定义字段的名称。 |
|
将分配给设备的用户自定义字段的值。 |
|
用于 Cisco DNA Center SDK 以启用根据 JSON 模式验证请求正文。 选项
|
备注
注意
使用的 SDK 方法是 devices.Devices.add_user_defined_field_to_device_v1，
使用的路径是 put /dna/intent/api/v1/network-device/{deviceId}/user-defined-field，
不支持
check_mode插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 设备 AddUserDefinedFieldToDeviceV1 文档
AddUserDefinedFieldToDeviceV1 API 的完整参考。
示例
- name: Update all
cisco.dnac.network_device_user_defined_field_update_v1:
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}}"
deviceId: string
payload:
- name: string
value: string
返回值
常见的返回值已记录在 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回： 始终 示例： |