cisco.dnac.planned_access_points 模块 – 计划接入点的资源模块

注意

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

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

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

要在剧本中使用它，请指定： cisco.dnac.planned_access_points。

cisco.dnac 6.0.0 中的新增功能

概要 

此模块表示模块 planned_access_points_v1 的别名。

注意

此模块具有相应的 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 浮点数	此无线电运行的 Tx 功率 (以 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。
需要注意的是，此模块是 planned_access_points_v1 的别名。
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参阅 

另请参阅

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

示例 

- name: Update all
  cisco.dnac.planned_access_points:
    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:
    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:
    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)