cisco.dnac.sda_site_member_member_info 模块 – Sda 站点成员信息信息模块

注意

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

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

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

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

cisco.dnac 6.14.0 中的新增功能

概要

  • 此模块表示模块 sda_site_member_member_v1_info 的别名。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

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"

headers

字典

附加的头部。

id

字符串

Id 路径参数。站点 ID。

level

字符串

Level 查询参数。要考虑列出设备的站点层次结构的深度。如果提供的值为 -1,则将列出所有子站点的设备。

limit

字符串

Limit 查询参数。要列出的设备数量。默认值和最大支持值为 500。

memberType

字符串

MemberType 查询参数。成员类型(此 API 仅支持“networkdevice”类型)。

offset

字符串

Offset 查询参数。分页的偏移量/起始索引。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志,用于启用根据 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法为 sites.Sites.get_devices_that_are_assigned_to_a_site_v1,

  • 使用的路径为 get /dna/intent/api/v1/site-member/{id}/member,

  • 需要注意的是,此模块是 sda_site_member_member_v1_info 的别名。

  • 支持 check_mode

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

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

另请参见

另请参见

Cisco DNA Center 站点 GetDevicesThatAreAssignedToASiteV1 文档

GetDevicesThatAreAssignedToASiteV1 API 的完整参考。

示例

- name: Get all Sda Site Member Member Info
  cisco.dnac.sda_site_member_member_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    offset: string
    limit: string
    memberType: string
    level: string
    id: string
  register: result

返回值

常见的返回值已在 此处 记录,以下是此模块特有的字段。

描述

dnac_response

列表 / 元素=字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表。

已返回:始终

示例: "[\n  {\n    \"instanceUuid\": \"字符串\",\n    \"instanceId\": 0,\n    \"authEntityId\": 0,\n    \"authEntityClass\": 0,\n    \"instanceTenantId\": \"字符串\",\n    \"deployPending\": \"字符串\",\n    \"instanceVersion\": 0,\n    \"apManagerInterfaceIp\": \"字符串\",\n    \"associatedWlcIp\": \"字符串\",\n    \"bootDateTime\": \"字符串\",\n    \"collectionInterval\": \"字符串\",\n    \"collectionIntervalValue\": \"字符串\",\n    \"collectionStatus\": \"字符串\",\n    \"description\": \"字符串\",\n    \"deviceSupportLevel\": \"字符串\",\n    \"dnsResolvedManagementAddress\": \"字符串\",\n    \"family\": \"字符串\",\n    \"hostname\": \"字符串\",\n    \"interfaceCount\": \"字符串\",\n    \"inventoryStatusDetail\": \"字符串\",\n    \"lastUpdateTime\": 0,\n    \"lastUpdated\": \"字符串\",\n    \"lineCardCount\": \"字符串\",\n    \"lineCardId\": \"字符串\",\n    \"lastDeviceResyncStartTime\": \"字符串\",\n    \"macAddress\": \"字符串\",\n    \"managedAtleastOnce\": true,\n    \"managementIpAddress\": \"字符串\",\n    \"managementState\": \"字符串\",\n    \"memorySize\": \"字符串\",\n    \"paddedMgmtIpAddress\": \"字符串\",\n    \"pendingSyncRequestsCount\": \"字符串\",\n    \"platformId\": \"字符串\",\n    \"reachabilityFailureReason\": \"字符串\",\n    \"reachabilityStatus\": \"字符串\",\n    \"reasonsForDeviceResync\": \"字符串\",\n    \"reasonsForPendingSyncRequests\": \"字符串\",\n    \"role\": \"字符串\",\n    \"roleSource\": \"字符串\",\n    \"serialNumber\": \"字符串\",\n    \"series\": \"字符串\",\n    \"snmpContact\": \"字符串\",\n    \"snmpLocation\": \"字符串\",\n    \"softwareType\": \"字符串\",\n    \"softwareVersion\": \"字符串\",\n    \"tagCount\": \"字符串\",\n    \"type\": \"字符串\",\n    \"upTime\": \"字符串\",\n    \"uptimeSeconds\": 0,\n    \"vendor\": \"字符串\",\n    \"displayName\": \"字符串\"\n  }\n]\n"

作者

  • Rafael Campos (@racampos)