cisco.dnac.planned_access_points_v1 模块 – 计划接入点 V1 资源模块

注意

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

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

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

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

cisco.dnac 6.0.0 中的新增功能

概要 

管理计划接入点 V1 资源的创建、更新和删除操作。
允许在现有楼层地图上创建一个新的计划接入点，包括其计划的无线电和天线详细信息。使用此 API 的 Get 变体来获取楼层的任何现有计划接入点。创建计划接入点的有效负载与该 API 的格式相同，只不过是一个对象而不是一个列表。
允许从现有楼层地图中删除计划接入点，包括其计划的无线电和天线详细信息。使用此 API 的 Get 变体来获取楼层的现有计划接入点。每个计划接入点属性中列出的 instanceUUID 充当此 API 的路径参数输入，以删除该特定实例。
允许更新现有楼层地图上的计划接入点，包括其计划的无线电和天线详细信息。使用此 API 的 Get 变体来获取楼层的现有计划接入点。更新计划接入点的有效负载与该 API 的格式相同，只不过是一个对象而不是一个列表。

注意

此模块具有相应的 action 插件。

需求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
attributes 字典	计划接入点的属性。
createDate 浮点数	计划接入点的创建日期。
domain 字符串	计划接入点所属的服务域。
heirarchyName 字符串	计划接入点的层次结构名称。
id 浮点数	计划接入点的唯一 ID。
instanceUuid 字符串	计划接入点的实例 UUID。
macAddress 字符串	计划接入点的 MAC 地址。
name 字符串	计划接入点的显示名称。
source 字符串	用于创建计划接入点的數據来源。
typeString 字符串	计划接入点的类型字符串表示。
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"`
floorId 字符串	FloorId 路径参数。楼层层次结构元素的实例 UUID。
isSensor 布尔值	指示 PAP 是否是传感器。选项 `false` `true`
location 字典	计划接入点的地理位置。
altitude 浮点数	计划接入点位置的海拔高度。
lattitude 浮点数	计划接入点位置的纬度。
longtitude 浮点数	计划接入点位置的经度。
plannedAccessPointUuid 字符串	PlannedAccessPointUuid 路径参数。要删除的计划接入点的实例 UUID。
position 字典	计划接入点的坐标位置。
x 浮点数	计划接入点在地图上的X坐标，以左上角为(0,0)点。
y 浮点数	计划接入点在地图上的Y坐标，以左上角为(0,0)点。
z 浮点数	计划接入点在地图上的Z坐标或高度。
radioCount 整数	计划接入点的无线电数量。
radios 列表 / 元素=字典	计划接入点的无线电信息。
antenna 字典	计划接入点的无线电天线信息。
azimuthAngle 浮点数	天线的方位角。
elevationAngle 浮点数	天线的仰角。
gain 浮点数	天线的增益。
mode 字符串	与该无线电关联的天线模式。
name 字符串	天线名称。
type 字符串	与该无线电关联的天线类型。
attributes 字典	计划接入点的属性。
channel 浮点数	该无线电工作的信道。
channelString 字符串	信道的字符串表示。
id 整数	无线电ID。
ifMode 字符串	无线电的IF模式。
ifTypeString 字符串	原生频段的字符串表示。
ifTypeSubband 字符串	无线电的子频段。
instanceUuid 字符串	无线电的实例UUID。
slotId 浮点数	无线电在其父接入点中所在的插槽号。
txPowerLevel 浮点数	该无线电工作的发射功率 (以dBm为单位)。
isSensor 布尔值	确定它是否是传感器。选项 `false` `true`
validate_response_schema 布尔值	Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。选项 `false` `true` ← (默认)

注释 

注意

使用的SDK方法为：devices.Devices.create_planned_access_point_for_floor_v1, devices.Devices.delete_planned_access_point_for_floor_v1, devices.Devices.update_planned_access_point_for_floor_v1,
使用的路径为：post /dna/intent/api/v1/floors/{floorId}/planned-access-points, delete /dna/intent/api/v1/floors/{floorId}/planned-access-points/{plannedAccessPointUuid}, put /dna/intent/api/v1/floors/{floorId}/planned-access-points,
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参阅 

另请参阅

Cisco DNA Center 文档，关于 Devices CreatePlannedAccessPointForFloorV1: CreatePlannedAccessPointForFloorV1 API 的完整参考。
Cisco DNA Center 文档，关于 Devices DeletePlannedAccessPointForFloorV1: DeletePlannedAccessPointForFloorV1 API 的完整参考。
Cisco DNA Center 文档，关于 Devices UpdatePlannedAccessPointForFloorV1: UpdatePlannedAccessPointForFloorV1 API 的完整参考。

示例 

- name: Update all
  cisco.dnac.planned_access_points_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}}"
    state: present
    attributes:
      createDate: 0
      domain: string
      heirarchyName: string
      id: 0
      instanceUuid: string
      macAddress: string
      name: string
      source: string
      typeString: string
    floorId: string
    isSensor: true
    location:
      altitude: 0
      lattitude: 0
      longtitude: 0
    position:
      x: 0
      y: 0
      z: 0
    radioCount: 0
    radios:
    - antenna:
        azimuthAngle: 0
        elevationAngle: 0
        gain: 0
        mode: string
        name: string
        type: string
      attributes:
        channel: 0
        channelString: string
        id: 0
        ifMode: string
        ifTypeString: string
        ifTypeSubband: string
        instanceUuid: string
        slotId: 0
        txPowerLevel: 0
      isSensor: true

- name: Create
  cisco.dnac.planned_access_points_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}}"
    state: present
    attributes:
      createDate: 0
      domain: string
      heirarchyName: string
      id: 0
      instanceUuid: string
      macAddress: string
      name: string
      source: string
      typeString: string
    floorId: string
    isSensor: true
    location:
      altitude: 0
      lattitude: 0
      longtitude: 0
    position:
      x: 0
      y: 0
      z: 0
    radioCount: 0
    radios:
    - antenna:
        azimuthAngle: 0
        elevationAngle: 0
        gain: 0
        mode: string
        name: string
        type: string
      attributes:
        channel: 0
        channelString: string
        id: 0
        ifMode: string
        ifTypeString: string
        ifTypeSubband: string
        instanceUuid: string
        slotId: 0
        txPowerLevel: 0
      isSensor: true

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

返回值 

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

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

作者

Rafael Campos (@racampos)