cisco.dnac.site_intent module – Resource module for Site operations

Note

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

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

New in cisco.dnac 6.6.0

Synopsis 

Manage operation create, update and delete of the resource Sites.
Creates site with area/building/floor with specified hierarchy.
Updates site with area/building/floor with specified hierarchy.
Deletes site with area/building/floor with specified hierarchy.

Requirements 

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

dnacentersdk == 2.4.5
python >= 3.5

Parameters 

Parameter	Comments
config list / elements=dictionary / required	List of details of site being managed.
site dictionary	Site Details.
area dictionary	Site Create’s area.
name string	Name of the area (eg Area1).
parentName string	Complete Parent name of the Area to be created/deleted(eg Global/).
building dictionary	Building Details.
address string	Address of the building to be created.
latitude integer	Latitude coordinate of the building (eg 37.338).Values between -90 to +90.
longitude integer	Longitude coordinate of the building (eg -121.832).Values between -180 to +180.
name string	Name of the building (eg building1).
parent_name string	Complete Parent name of the Building to be created/deleted(eg Global/USA/San Francisco).
floor dictionary	Site Create’s floor.
floor_number integer	Floor number in the building/site (eg 5).once created, it can’t be modified.
height integer	Height of the floor units is ft. (eg 15).
length integer	Length of the floor units is ft. (eg 100).
name string	Name of the floor (eg floor-1).
parentName string	Complete Parent name of the floor to be created(eg Global/USA/San Francisco/BGL_18).
rf_model string	Type of floor. Allowed values are ‘Cubes And Walled Offices’, ‘Drywall Office Only’, ‘Indoor High Ceiling’, ‘Outdoor Open Space’.
width integer	Width of the floor units is ft. (eg 100).
type string	Type of site to create/update/delete (eg area, building, floor).
config_verify boolean	Set to True to verify the Cisco Catalyst Center config after applying the playbook config. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_host string / required	The Cisco DNA Center hostname.
dnac_log boolean	Flag to enable/disable playbook execution logging. When true and dnac_log_file_path is provided, - Create the log file at the execution location with the specified name. When true and dnac_log_file_path is not provided, - Create the log file at the execution location with the name ‘dnac.log’. When false, - Logging is disabled. If the log file doesn’t exist, - It is created in append or write mode based on the “dnac_log_append” flag. If the log file exists, - It is overwritten or appended based on the “dnac_log_append” flag. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_log_append boolean	Determines the mode of the file. Set to True for ‘append’ mode. Set to False for ‘write’ mode. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_log_file_path string	Governs logging. Logs are recorded if dnac_log is True. If path is not specified, - When ‘dnac_log_append’ is True, ‘dnac.log’ is generated in the current Ansible directory; logs are appended. - When ‘dnac_log_append’ is False, ‘dnac.log’ is generated; logs are overwritten. If path is specified, - When ‘dnac_log_append’ is True, the file opens in append mode. - When ‘dnac_log_append’ is False, the file opens in write (w) mode. - In shared file scenarios, without append mode, content is overwritten after each module execution. - For a shared log file, set append to False for the 1st module (to overwrite); for subsequent modules, set append to True. Default: :ansible-option-default:`"dnac.log"`
dnac_log_level string	Sets the threshold for log level. Messages with a level equal to or higher than this will be logged. Levels are listed in order of severity [CRITICAL, ERROR, WARNING, INFO, DEBUG]. CRITICAL indicates serious errors halting the program. Displays only CRITICAL messages. ERROR indicates problems preventing a function. Displays ERROR and CRITICAL messages. WARNING indicates potential future issues. Displays WARNING, ERROR, CRITICAL messages. INFO tracks normal operation. Displays INFO, WARNING, ERROR, CRITICAL messages. DEBUG provides detailed diagnostic info. Displays all log messages. Default: :ansible-option-default:`"WARNING"`
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port string	The Cisco DNA Center port. Default: :ansible-option-default:`"443"`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.2.3.3"`
state string	The state of Catalyst Center after module completion. Choices: :ansible-option-choices-entry-default:`"merged"` ← (default) :ansible-option-choices-entry:`"deleted"`
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes 

Note

SDK Method used are sites.Sites.create_site, sites.Sites.update_site, sites.Sites.delete_site
Paths used are post /dna/intent/api/v1/site, put dna/intent/api/v1/site/{siteId}, delete 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 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

Examples 

- name: Create a new area site
  cisco.dnac.site_intent:
    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}}"
    dnac_log_level: "{{dnac_log_level}}"
    dnac_log: "{{dnac_log}}"
    state: merged
    config:
    - site:
        area:
          name: string
          parentName: string
      type: string

- name: Create a new building site
  cisco.dnac.site_intent:
    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}}"
    dnac_log_level: "{{dnac_log_level}}"
    dnac_log: "{{dnac_log}}"
    state: merged
    config:
    - site:
        building:
          address: string
          latitude: 0
          longitude: 0
          name: string
          parentName: string
      type: string

- name: Create a Floor site under the building
  cisco.dnac.site_intent:
    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}}"
    dnac_log_level: "{{dnac_log_level}}"
    dnac_log: "{{dnac_log}}"
    state: merged
    config:
    - site:
        floor:
          name: string
          parent_name: string
          length: int
          width: int
          height: int
          rf_model: string
          floor_number: int
      type: string

- name: Updating the Floor details under the building
  cisco.dnac.site_intent:
    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}}"
    dnac_log_level: "{{dnac_log_level}}"
    dnac_log: "{{dnac_log}}"
    state: merged
    config:
    - site:
        floor:
          name: string
          parent_name: string
          length: int
          width: int
          height: int
      type: string

- name: Deleting any site you need site name and parentName
  cisco.dnac.site_intent:
    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}}"
    dnac_log_level: "{{dnac_log_level}}"
    dnac_log: "{{dnac_log}}"
    state: deleted
    config:
    - site:
        floor:
          name: string
          parent_name: string
      type: string

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
response_1 dictionary	A dictionary with API execution details as returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`"{\\n \\"response\\":\\n {\\n \\"bapiExecutionId\\": String,\\n \\"bapiKey\\": String,\\n \\"bapiName\\": String,\\n \\"endTime\\": String,\\n \\"endTimeEpoch\\": 0,\\n \\"runtimeInstanceId\\": String,\\n \\"siteId\\": String,\\n \\"startTime\\": String,\\n \\"startTimeEpoch\\": 0,\\n \\"status\\": String,\\n \\"timeDuration\\": 0\\n\\n },\\n \\"msg\\": \\"string\\"\\n}\\n"`
response_2 dictionary	A dictionary with existing site details. Returned: always Sample: :ansible-rv-sample-value:`"{\\n \\"response\\":\\n {\\n \\"site\\": {},\\n \\"siteId\\": String,\\n \\"type\\": String\\n },\\n \\"msg\\": String\\n}\\n"`
response_3 dictionary	A dictionary with API execution details as returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`"{\\n \\"response\\":\\n {\\n \\"bapiError\\": String,\\n \\"bapiExecutionId\\": String,\\n \\"bapiKey\\": String,\\n \\"bapiName\\": String,\\n \\"endTime\\": String,\\n \\"endTimeEpoch\\": 0,\\n \\"runtimeInstanceId\\": String,\\n \\"startTime\\": String,\\n \\"startTimeEpoch\\": 0,\\n \\"status\\": String,\\n \\"timeDuration\\": 0\\n\\n },\\n \\"msg\\": \\"string\\"\\n}\\n"`
response_4 list / elements=string	A list with the response returned by the Cisco Catalyst Center Python Returned: always Sample: :ansible-rv-sample-value:`["{\\n \\"response\\": []", "\\n \\"msg\\": String\\n}\\n"]`

Authors

Madhan Sankaranarayanan (@madhansansel) Rishita Chowdhary (@rishitachowdhary) Abhishek Maheshwari (@abhishekmaheshwari)

Collection links

Issue Tracker Repository (Sources)

cisco.dnac.site_intent module – Resource module for Site operations

Synopsis

Requirements

Parameters

Notes

Examples

Return Values