cisco.dnac.site_info – Information module for Site

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Get all 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.
limit string		Limit query parameter. Number of sites to be retrieved. The default value is 500.
name string		Name query parameter. SiteNameHierarchy (ex global/groupName).
offset string		Offset query parameter. Offset/starting row. The default value is 1.
siteId string		SiteId query parameter. Site id to which site details to retrieve.
type string		Type query parameter. Type (ex area, building, floor).

See Also

See also

Site reference

Complete reference of the Site object model.

Examples

- name: Get all Site
  cisco.dnac.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
    name: string
    siteId: string
    type: string
    offset: string
    limit: string
  register: result

Return Values

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

Key	Returned	Description
dnac_response list / elements=dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: [ { "parentId": "string", "name": "string", "additionalInfo": [ "string" ], "siteHierarchy": "string", "siteNameHierarchy": "string", "instanceTenantId": "string", "id": "string" } ]

Authors

• Rafael Campos (@racampos)