W3cubDocs

/Ansible

cisco.dnac.site_create_v1 module – Resource module for Site Create V1

Note

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

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

New in cisco.dnac 3.1.0

Synopsis

  • Manage operation create of the resource Site Create V1.
  • Creates site with area/building/floor with specified hierarchy.

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"

headers

dictionary

Additional headers.

site

dictionary

Site Create’s site.

area

dictionary

Site Create’s area.

name

string

Name of the area (eg Area1).

parentName

string

Parent hierarchical name (Example Global/USA/CA).

building

dictionary

Site Create’s building.

address

string

Address of the building to be created.

country

string

Country (eg United States).

latitude

float

Latitude coordinate of the building (eg 37.338).

longitude

float

Longitude coordinate of the building (eg -121.832).

name

string

Name of the building (eg building1).

parentName

string

Parent hierarchical name (Example Global/USA/CA/SantaClara).

floor

dictionary

Site Create’s floor.

floorNumber

float

Floor number. (eg 5).

height

float

Height of the floor. Unit of measure is ft. (eg 15).

length

float

Length of the floor. Unit of measure is ft. (eg 100).

name

string

Name of the floor (eg floor-1).

parentName

string

Parent hierarchical name (Example Global/USA/CA/SantaClara/Academic).

rfModel

string

Type of floor (eg Cubes And Walled Offices0.

width

float

Width of the floor. Unit of measure is ft. (eg 100).

type

string

Type of site to create (eg 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:

  • false
  • true ← (default)

Notes

Note

  • SDK Method used are sites.Sites.create_site_v1,
  • Paths used are post /dna/intent/api/v1/site,
  • 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 Sites CreateSiteV1

Complete reference of the CreateSiteV1 API.

Examples

- name: Create
  cisco.dnac.site_create_v1:
    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}}'
    site:
      area:
        name: string
        parentName: string
      building:
        address: string
        country: string
        latitude: 0
        longitude: 0
        name: string
        parentName: string
      floor:
        floorNumber: 0
        height: 0
        length: 0
        name: string
        parentName: string
        rfModel: string
        width: 0
    type: string

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: {"executionId": "string", "executionStatusUrl": "string", "message": "string"}

Authors

  • Rafael Campos (@racampos)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/site_create_v1_module.html