cisco.dnac.site_update module – Resource module for Site Update

Note

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

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.

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

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operation update of the resource Site Update.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.3.3

• python >= 3.5

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: no ← (default) yes
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port string	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: no yes ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: “2.2.2.3”
site dictionary	Site Update’s site.
area dictionary	Site Update’s area.
name string	Name.
parentName string	Parent Name.
building dictionary	Site Update’s building.
address string	Address.
latitude integer	Latitude.
longitude integer	Longitude.
name string	Name.
parentName string	Parent Name.
floor dictionary	Site Update’s floor.
height integer	Height.
length integer	Length.
name string	Name.
rfModel string	Rf Model.
width integer	Width.
siteId string	SiteId path parameter. Site id to which site details to be updated.
type string	Type.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: no yes ← (default)

Notes

Note

• 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

Site Update reference

Complete reference of the Site Update object model.

Examples

- name: Update by id
  cisco.dnac.site_update:
    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}}"
    site:
      area:
        name: string
        parentName: string
      building:
        address: string
        latitude: 0
        longitude: 0
        name: string
        parentName: string
      floor:
        height: 0
        length: 0
        name: string
        rfModel: string
        width: 0
    siteId: string
    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: “{\n \”result\”: \”string\”,\n \”response\”: {\n \”endTime\”: \”string\”,\n \”version\”: \”string\”,\n \”startTime\”: \”string\”,\n \”progress\”: \”string\”,\n \”data\”: \”string\”,\n \”serviceType\”: \”string\”,\n \”operationIdList\”: [\n \”string\”\n ],\n \”isError\”: \”string\”,\n \”rootId\”: \”string\”,\n \”instanceTenantId\”: \”string\”,\n \”id\”: \”string\”\n },\n \”status\”: \”string\”\n}\n”

Authors

• Rafael Campos (@racampos)