cisco.dnac.sites_info module -- Information module for Sites

Note

This module is part of the cisco.dnac collection (version 6.46.0).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 6.15.0

Synopsis

  • Get all Sites.

  • Get Sites by id.

  • Get a site.

  • Get sites.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.11.0

  • python >= 3.12

Parameters

Parameter

Comments

_unitsOfMeasure

string

_unitsOfMeasure query parameter. Floor units of measure.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

headers

dictionary

Additional headers.

id

string

Id path parameter. Site Id. Represents a unique identifier that corresponds to one of the following - Global Id, Area Id, Building Id, Floor Id.

limit

integer

Limit query parameter. The number of records to show for this page;The minimum is 1, and the maximum is 500.

name

string

Name query parameter. Site name.

nameHierarchy

string

NameHierarchy query parameter. Site name hierarchy.

offset

integer

Offset query parameter. The first record to show for this page; the first record is numbered 1.

type

string

Type query parameter. Site type. Available values global, area, building, floor.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are site_design.SiteDesign.get_a_site, site_design.SiteDesign.get_sites,

  • Paths used are get /dna/intent/api/v1/sites, get /dna/intent/api/v1/sites/{id},

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Site Design GetASite

Complete reference of the GetASite API.

Cisco DNA Center documentation for Site Design GetSites

Complete reference of the GetSites API.

Examples

---
- name: Get all Sites
  cisco.dnac.sites_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: "{{my_headers | from_json}}"
    name: string
    nameHierarchy: string
    type: string
    _unitsOfMeasure: string
    offset: 0
    limit: 0
  register: result
- name: Get Sites by id
  cisco.dnac.sites_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: "{{my_headers | from_json}}"
    id: string
  register: result

Return Values

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"address": "string", "country": "string", "floorNumber": 0, "height": 0, "id": "string", "latitude": 0, "length": 0, "longitude": 0, "name": "string", "nameHierarchy": "string", "parentId": "string", "rfModel": "string", "type": "string", "unitsOfMeasure": "string", "width": 0}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)