cisco.dnac.site_delete – Resource module for Site Delete

Note

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

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
siteId
string
SiteId path parameter. Site id to which site details to be deleted.

See Also

See also

Site Delete reference

Complete reference of the Site Delete object model.

Examples

- 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)