cisco.dnac.topology_site_info – Information module for Topology Site

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.topology_site_info.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get all Topology Site.

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
headers
dictionary
Additional headers.

See Also

See also

Topology Site reference

Complete reference of the Topology Site object model.

Examples

- name: Get all Topology Site
  cisco.dnac.topology_site_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:
      custom: value
  register: result

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:
{ "response": { "sites": [ { "displayName": "string", "groupNameHierarchy": "string", "id": "string", "latitude": "string", "locationAddress": "string", "locationCountry": "string", "locationType": "string", "longitude": "string", "name": "string", "parentId": "string" } ] }, "version": "string" }


Authors

  • Rafael Campos (@racampos)