cisco.catalystcenter.site_update module -- Resource module for Site Update

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

New in cisco.catalystcenter 3.1.0

Synopsis

  • Manage operation update of the resource Site Update.

  • Update site area/building/floor with specified hierarchy and new values.

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"`

headers

dictionary

Additional headers.

site

dictionary

Site Update's site.

area

dictionary

Site Update's area.

name

string

Area name.

parentName

string

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

building

dictionary

Site Update's building.

address

string

Building address (Example 4900 Marie P. Debartolo Way, Santa Clara, California 95054, United States).

country

string

Country name. This field is mandatory for air-gapped networks (Example United States).

latitude

float

Building latitude (Example 37.403712).

longitude

float

Building longitude (Example -121.971063).

name

string

Building name.

parentName

string

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

floor

dictionary

Site Update's floor.

floorNumber

float

Floor Number (Example 3).

height

float

Floor height in feet (Example 10).

length

float

Floor length in feet (Example 100).

name

string

Floor name.

parentName

string

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

rfModel

string

RF model (Example Cubes And Walled Offices).

width

float

Floor width in feet (Example 200).

siteId

string

SiteId path parameter. Site id to which site details to be updated.

type

string

Site type.

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.update_site,

  • Paths used are put /dna/intent/api/v1/site/{siteId},

  • 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 Sites UpdateSite

Complete reference of the UpdateSite API.

Examples

---
- name: Update by id
  cisco.catalystcenter.site_update:
    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}}"
    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
    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 CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"data": "string", "endTime": "string", "id": "string", "instanceTenantId": "string", "isError": "string", "operationIdList": ["string"], "progress": "string", "rootId": "string", "serviceType": "string", "startTime": "string", "version": "string"}, "result": "string", "status": "string"}`

Authors

  • Rafael Campos (@racampos)