cisco.dnac.site_delete – Resource module for Site Delete

Note

This plugin is part of the cisco.dnac collection (version 3.1.3).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.site_delete.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Manage operation delete of the resource Site Delete.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
site
dictionary
Site Delete's site.
area
dictionary
Site Delete's area.
name
string
Name.
parentName
string
Parent Name.
building
dictionary
Site Delete's building.
address
string
Address.
latitude
integer
Latitude.
longitude
integer
Longitude.
name
string
Name.
parentName
string
Parent Name.
floor
dictionary
Site Delete's floor.
height
integer
Height.
length
integer
Length.
name
string
Name.
rfModel
string
Rf Model.
width
integer
Width.
siteId
string
SiteId path parameter. Site id to which site details to be updated.
type
string
Type.

See Also

See also

Site Delete reference

Complete reference of the Site Delete object model.

Examples

- name: Update by id
  cisco.dnac.site_delete:
    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}}"
    site:
      area:
        name: string
        parentName: string
      building:
        address: string
        latitude: 0
        longitude: 0
        name: string
        parentName: string
      floor:
        height: 0
        length: 0
        name: string
        rfModel: string
        width: 0
    siteId: string
    type: string

- name: Delete by id
  cisco.dnac.site_delete:
    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}}"
    siteId: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "result": "string", "response": { "endTime": "string", "version": "string", "startTime": "string", "progress": "string", "data": "string", "serviceType": "string", "operationIdList": [ "string" ], "isError": "string", "rootId": "string", "instanceTenantId": "string", "id": "string" }, "status": "string" }


Authors

  • Rafael Campos (@racampos)