cisco.catalystcenter.site_v2_info module -- Information module for Site V2

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

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

To use it in a playbook, specify: cisco.catalystcenter.site_v2_info.

New in cisco.catalystcenter 6.14.0

Synopsis

  • Get all Site V2.

  • API to get sites by site-name-hierarchy or siteId or type. List all sites if these parameters are not given as an input.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

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

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

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

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

_version

string

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

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

groupNameHierarchy

string

GroupNameHierarchy query parameter. Site name hierarchy (E.g. Global/USA/CA).

headers

dictionary

Additional headers.

id

string

Id query parameter. Site Id.

limit

string

Limit query parameter. Number of sites to be listed. Default and max supported value is 500.

offset

string

Offset query parameter. Offset starting index for pagination.

type

string

Type query parameter. Site type (Acceptable values area, building, floor).

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are sites.Sites.get_site_v2,

  • Paths used are get /dna/intent/api/v2/site,

  • 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 CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Sites GetSiteV2

Complete reference of the GetSiteV2 API.

Examples

- name: Get all Site V2
  cisco.catalystcenter.site_v2_info:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    headers: "{{my_headers | from_json}}"
    groupNameHierarchy: string
    id: 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

Description

catalystcenter_response

list / elements=dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`"[\\n {\\n \\"parentId\\": \\"string\\",\\n \\"groupTypeList\\": [\\n \\"string\\"\\n ],\\n \\"groupHierarchy\\": \\"string\\",\\n \\"additionalInfo\\": [\\n {\\n \\"nameSpace\\": \\"string\\",\\n \\"attributes\\": {\\n \\"addressInheritedFrom\\": \\"string\\",\\n \\"type\\": \\"string\\",\\n \\"country\\": \\"string\\",\\n \\"address\\": \\"string\\",\\n \\"latitude\\": \\"string\\",\\n \\"longitude\\": \\"string\\"\\n }\\n }\\n ],\\n \\"groupNameHierarchy\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"instanceTenantId\\": \\"string\\",\\n \\"id\\": \\"string\\"\\n }\\n]\\n"`

Authors

  • Rafael Campos (@racampos)