cisco.catalystcenter.sites_bulk module -- Resource module for Sites Bulk

Note

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

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

New in cisco.catalystcenter 6.15.0

Synopsis

  • Manage operation create of the resource Sites Bulk. - > Create area/building/floor together in bulk. If site already exist, then that will be ignored. Sites in the request payload need not to be ordered.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catc_api_port

integer

The Cisco Catalyst Center port.

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

catc_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catc_host

string / required

The Cisco Catalyst Center hostname.

catc_password

string

The Cisco Catalyst Center password to authenticate.

catc_username

string

The Cisco Catalyst Center username to authenticate.

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

catc_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catc_version

string

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

Default: :ansible-option-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 Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are site_design.SiteDesign.create_sites,

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

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Site Design CreateSites

Complete reference of the CreateSites API.

Examples

---
- name: Create
  cisco.catalystcenter.sites_bulk:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_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 CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)