cisco.dnac.sites_bulk module – Resource module for Sites Bulk

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

New in cisco.dnac 6.15.0

Synopsis

• This module represents an alias of the module sites_bulk_v1

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.4.9

• python >= 3.5

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: false ← (default) true
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: 443
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: "admin"
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: false true ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: "2.3.7.6"
payload list / elements=dictionary	Sites Bulk’s payload.
address string	Building address. Example 4900 Marie P. Debartolo Way, Santa Clara, California 95054, United States.
country string	Country name. Required for building.
floorNumber integer	Floor number. Required for floor.
height float	Floor height. Required for floor. Example 10.1.
latitude float	Building Latitude. Example 37.403712.
length float	Floor length. Required for floor. Example 110.3.
longitude float	Building Longitude. Example -121.971063.
name string	Site name.
parentNameHierarchy string	Parent hierarchical name. Example Global/USA/San Jose/Building1.
rfModel string	Floor RF Model. Required for floor.
type string	Type.
unitsOfMeasure string	Floor unit of measure. Required for floor.
width float	Floor width. Required for floor. Example 100.5.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: false true ← (default)

Notes

Note

• SDK Method used are site_design.SiteDesign.create_sites_v1,

• Paths used are post /dna/intent/api/v1/sites/bulk,

• It should be noted that this module is an alias of sites_bulk_v1

• Does not support 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 CreateSitesV1

Complete reference of the CreateSitesV1 API.

Examples

- name: Create
  cisco.dnac.sites_bulk:
    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}}"
    payload:
    - address: string
      country: string
      floorNumber: 0
      height: 0
      latitude: 0
      length: 0
      longitude: 0
      name: string
      parentNameHierarchy: string
      rfModel: string
      type: string
      unitsOfMeasure: string
      width: 0

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: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

• Rafael Campos (@racampos)

Collection links

• Issue Tracker
• Repository (Sources)