.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.site_workflow_manager_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.site_workflow_manager module -- Manage hierarchical sites in Cisco Catalyst Center +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.43.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.site_workflow_manager`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.6.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Complete management of sites in Cisco Catalyst Center, including hierarchical structures of areas, buildings, and floors. - Creates single or multiple sites with specified hierarchical relationships. - Updates existing site configurations, including physical attributes and RF characteristics. - Deletes sites and their components when no longer needed. - Supports bulk operations for efficiently managing multiple sites simultaneously. - Handles floor maps and RF modeling for wireless network planning. - Provides verification of site configurations after changes are applied. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.site_workflow_manager_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk == 2.4.5 - python \>= 3.9 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config: .. rst-class:: ansible-option-title **config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
List of site configurations to be created, updated, or deleted. Each item represents a single site operation. Required for all operations as it defines the target sites and their configurations. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site: .. rst-class:: ansible-option-title **site** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Contains the detailed configuration for the site being managed. Only one site component type (area, building, or floor) should be specified in each config entry. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/area: .. rst-class:: ansible-option-title **area** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configuration specific to an area-type site. Areas represent the highest level in the site hierarchy, typically representing geographical regions, campuses, or other logical divisions. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/area/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Name of the area to create, update, or delete. Must be unique within its parent site. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/area/parent_name: .. rst-class:: ansible-option-title **parent_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Full hierarchical path of the parent site. Format should be slash-separated notation (For example, "Global/USA"). For top-level areas, the parent is typically "Global". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/building: .. rst-class:: ansible-option-title **building** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configuration specific to a building-type site. Buildings represent physical structures within an area and contain floors. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/building/address: .. rst-class:: ansible-option-title **address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Physical street address of the building. Used for geographical positioning and identification. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/building/country: .. rst-class:: ansible-option-title **country** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The country where the building is located. Optional parameter for additional geolocation context. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/building/latitude: .. rst-class:: ansible-option-title **latitude** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Geographical latitude coordinate of the building. Must be between -90.0 and +90.0 degrees. For Example, 37.338 for a location in San Jose, California. Required for creating buildings, optional when updating. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/building/longitude: .. rst-class:: ansible-option-title **longitude** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Geographical longitude coordinate of the building. Must be between -180.0 and +180.0 degrees. For Example, -121.832 for a location in San Jose, California. Required for creating buildings, optional when updating. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/building/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Name of the building to create, update, or delete. Must be unique within its parent area. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/building/parent_name: .. rst-class:: ansible-option-title **parent_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Full hierarchical path of the parent area. Format should be slash-separated (e.g., "Global/USA/California"). The parent must exist before creating the building. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/floor: .. rst-class:: ansible-option-title **floor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configuration specific to a floor-type site. Floors represent levels within a building and can contain network devices and floor plans. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/floor/floor_number: .. rst-class:: ansible-option-title **floor_number** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Numerical identifier for the floor within the building. - Required for floor creation from Catalyst Center version 2.3.7.6 onwards. - Once set, this value cannot be modified. - For example, 1 for first floor, 0 for ground floor, -1 for basement. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/floor/force_upload_floor_image: .. rst-class:: ansible-option-title **force_upload_floor_image** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Controls whether to upload or update the floor image. - When true, the floor image specified in upload\_floor\_image\_path will be uploaded or updated, even if the floor already has an image. - When false, image upload is skipped during updates. - During initial floor creation, if upload\_floor\_image\_path is provided, the image will be uploaded regardless of this setting. - Set to true to replace an existing floor image during an update operation. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/floor/height: .. rst-class:: ansible-option-title **height** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Height of the floor in the specified units (default is feet). Represents the ceiling height, important for RF planning and signal propagation modeling. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/floor/length: .. rst-class:: ansible-option-title **length** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Length of the floor in the specified units (default is feet). Used for defining the floor dimensions for mapping purposes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/floor/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Name of the floor to create, update, or delete. Must be unique within its parent building. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/floor/parent_name: .. rst-class:: ansible-option-title **parent_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Full hierarchical path of the parent building. Format should be slash-separated notation (For example, "Global/USA/California/Building\_1"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/floor/rf_model: .. rst-class:: ansible-option-title **rf_model** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
RF (Radio Frequency) model type for the floor, essential for wireless network planning. Select one of the following options based on your environment: - "Cubes And Walled Offices": For indoor areas with cubicles or walled offices, where signal propagation is affected by walls and partitions. - "Drywall Office Only": For environments with drywall partitions (typically office spaces), which have moderate signal attenuation. - "Indoor High Ceiling": For spaces with high ceilings (e.g., auditoriums, warehouses), where vertical propagation patterns differ significantly. - "Outdoor Open Space": For outdoor areas with minimal obstruction, suitable for outdoor deployments or open campuses. The chosen RF model affects how the system calculates wireless coverage and capacity. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"Cubes And Walled Offices"` - :ansible-option-choices-entry:`"Drywall Office Only"` - :ansible-option-choices-entry:`"Indoor High Ceiling"` - :ansible-option-choices-entry:`"Outdoor Open Space"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/floor/units_of_measure: .. rst-class:: ansible-option-title **units_of_measure** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unit of measurement for floor dimensions (height, length, and width). - Available from Catalyst Center version 2.3.7.6 onwards. - Default is 'feet' if not specified. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"feet"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"meters"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/floor/upload_floor_image_path: .. rst-class:: ansible-option-title **upload_floor_image_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Local file path to an image that will be uploaded as the floor plan. Supported formats include JPG, PNG, and PDF. Feature available from Catalyst Center version 2.3.7.6 onwards. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site/floor/width: .. rst-class:: ansible-option-title **width** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Width of the floor in the specified units (default is feet). Used for defining the floor dimensions for mapping purposes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config/site_type: .. rst-class:: ansible-option-title **site_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Specifies the type of site component to manage. Must be one of "area", "building", or "floor". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"area"` - :ansible-option-choices-entry:`"building"` - :ansible-option-choices-entry:`"floor"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-config_verify: .. rst-class:: ansible-option-title **config_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Controls whether to verify site configurations after applying changes. When set to true, the module will confirm that site creation, updates, or deletion operations have been successfully completed in Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-dnac_api_task_timeout: .. rst-class:: ansible-option-title **dnac_api_task_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Defines the timeout in seconds for API calls to retrieve task details. If the task details are not received within this period, the process will end, and a timeout notification will be logged. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`1200` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The hostname of the Cisco Catalyst Center. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-dnac_log: .. rst-class:: ansible-option-title **dnac_log** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-dnac_log_append: .. rst-class:: ansible-option-title **dnac_log_append** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-dnac_log_file_path: .. rst-class:: ansible-option-title **dnac_log_file_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"dnac.log"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-dnac_log_level: .. rst-class:: ansible-option-title **dnac_log_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"WARNING"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The password for authentication at the Cisco Catalyst Center. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the port number associated with the Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"443"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-dnac_task_poll_interval: .. rst-class:: ansible-option-title **dnac_task_poll_interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the interval in seconds between successive calls to the API to retrieve task details. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`2` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The username for authentication at the Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the version of the Cisco Catalyst Center that the SDK should use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.2.3.3"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Defines the intended state of the sites after module execution. \ :literal:`merged`\ will create new sites or update existing ones. \ :literal:`deleted`\ will remove the specified sites from Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"merged"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"deleted"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - Floor number and units\_of\_measure require Catalyst Center version 2.3.7.6 or later. - Floor image upload is available from version 2.3.7.6 onwards. - Module requires dnacentersdk 2.4.5 or later. - Primary SDK Methods - sites.Sites.create\_site, sites.Sites.update\_site, sites.Sites.delete\_site - site.Sites.create\_sites, site.Sites.update\_a\_floor, site.Sites.update\_a\_building - site.Sites.update\_an\_area, site.Sites.delete\_a\_floor, site.Sites.delete\_a\_building - site.Sites.delete\_an\_area, site.Sites.get\_site\_assigned\_network\_devices - API Endpoints - POST /dna/intent/api/v1/site, PUT dna/intent/api/v1/site/{siteId} - DELETE dna/intent/api/v1/site/{siteId} DELETE/dna/intent/api/v2/buildings/{id} - DELETE/dna/intent/api/v1/areas/{id} DELETE/dna/intent/api/v2/floors/{id} PUT/dna/intent/api/v2/floors/{id} - PUT/dna/intent/api/v1/areas/{id} PUT/dna/intent/api/v2/buildings/{id} GET/dna/intent/api/v1/sites - POST/dna/intent/api/v1/sites/bulk GET/dna/intent/api/v1/networkDevices/assignedToSite - Sites must be created in order - areas first, then buildings, then floors. - Deleting a parent site will automatically delete all child sites. - RF models significantly impact wireless planning and should be selected based on the actual physical environment. - Floor dimensions (height, length, width) and RF models can be updated after creation, but floor\_number cannot be modified once set. - Floor images, once uploaded, remain associated with the floor until explicitly replaced using force\_upload\_floor\_image to true. - Large floor plan images may take time to upload; ensure the connection to Catalyst Center remains stable during upload. - Latitude must be between -90.0 and +90.0 degrees, with positive values representing north of the equator. - Longitude must be between -180.0 and +180.0 degrees, with positive values representing east of the prime meridian. - Use precise coordinates for buildings to ensure accurate positioning on maps and integration with location services. - Use unique names for sites to avoid confusion in complex hierarchies. - For bulk operations, limit the number of sites to avoid timeout issues. - Floor image uploads for multiple floors may impact performance; consider spreading large uploads across multiple tasks. - Site operations on a large scale (many floors or buildings) may take considerable time to complete. - Site names are case-sensitive in Catalyst Center; ensure consistent casing in your playbooks. - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins instead embedded connection manager from Cisco Catalyst Center SDK - The parameters starting with dnac\_ are used by the Cisco Catalyst Center Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Cisco Catalyst Center API Documentation `_ Complete API reference for device management. `Site Management API `_ Specific documentation for site operations in Catalyst Center version. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create a new area site cisco.dnac.site_workflow_manager: 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: Test parent_name: Global/India site_type: area - name: Create a new building site cisco.dnac.site_workflow_manager: 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: name: Building_1 parent_name: Global/India address: Bengaluru, Karnataka, India latitude: 24.12 longitude: 23.45 site_type: building - name: Create a Floor site under the building cisco.dnac.site_workflow_manager: 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: Floor_1 parent_name: Global/India/Building_1 length: 75.76 width: 35.54 height: 30.12 rf_model: Cubes And Walled Offices floor_number: 2 site_type: floor - name: Updating the Floor details under the building cisco.dnac.site_workflow_manager: 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: Floor_1 parent_name: Global/India/Building_1 length: 75.76 width: 35.54 height: 30.12 site_type: floor - name: Deleting any site you need site name and parent name cisco.dnac.site_workflow_manager: 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: Floor_1 parent_name: Global/India/Building_1 site_type: floor - name: Create bulk sites and upload floor map cisco.dnac.site_workflow_manager: 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: true dnac_log_level: DEBUG config_verify: true state: merged config: - site: area: name: bangalore99 parent_name: Global type: area - site: building: name: s1 address: 1234 Elm Street3 parent_name: Global/bangalore99 latitude: 37.373 longitude: -121.873 country: india type: building - site: floor: name: cherry88 parent_name: Global/bangalore99/s1 rf_model: Outdoor Open Space width: 117 length: 117 height: 13 floor_number: 3 units_of_measure: "feet" upload_floor_image_path: "/Users/skesali/Downloads/pngegg.png" force_upload_floor_image: true type: floor - site: floor: name: cherry5 parent_name: Global/bangalore9/s1 rf_model: Outdoor Open Space width: 113 length: 113 height: 13 floor_number: 3 units_of_measure: "feet" upload_floor_image_path: "/Users/skesali/Downloads/pngegg.png" force_upload_floor_image: true type: floor .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__return-response_1: .. rst-class:: ansible-option-title **response_1** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Detailed API execution results when a site is successfully created, updated, or deleted. Contains execution IDs, timestamps, status, and site identifiers. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when a site operation succeeds .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"msg": "Site Global/USA/California/San Jose/Building\_1 successfully created", "response": {"bapiExecutionId": "2f259f38-a005-4f44-9feb-a168312b503c", "bapiKey": "12345", "bapiName": "Sites", "endTime": "2025-07-25 14:32:45", "endTimeEpoch": 1658756565000, "runtimeInstanceId": "cisco-catc-01", "siteId": "9d963198-8ea0-4b1b-afe7-04401c9fd345", "startTime": "2025-07-25 14:32:30", "startTimeEpoch": 1658756550000, "status": "SUCCESS", "timeDuration": 15}}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__return-response_2: .. rst-class:: ansible-option-title **response_2** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Information about sites that already exist and do not require an update. Useful for idempotency checks and verification that sites are in the desired state. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when a site exists but doesn't need updating .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"msg": "Site Global/USA/California already exists with the requested configuration", "response": {"site": {"area": {"name": "California", "parentName": "Global/USA"}}, "siteId": "9d963198-8ea0-4b1b-afe7-04401c9fd345", "type": "area"}}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__return-response_3: .. rst-class:: ansible-option-title **response_3** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Error details when site creation, update, or deletion operations fail. Contains error messages, execution IDs, and timestamps to assist with troubleshooting. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when a site operation fails .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"msg": "Failed to create site: Parent site does not exist", "response": {"bapiError": "Parent site Global/NonExistentArea does not exist", "bapiExecutionId": "3e8721a9-b56f-43c2-8d01-5d7b318f7e22", "bapiKey": "12345", "bapiName": "Sites", "endTime": "2025-07-25 14:33:15", "endTimeEpoch": 1658756595000, "runtimeInstanceId": "cisco-catc-01", "startTime": "2025-07-25 14:33:00", "startTimeEpoch": 1658756580000, "status": "FAILURE", "timeDuration": 15}}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__return-response_4: .. rst-class:: ansible-option-title **response_4** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Empty response returned when attempting to delete a site that doesn't exist. Helps identify when deletion operations target non-existent sites. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when trying to delete a site that doesn't exist .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["{\\n \\"response\\": []", "\\n \\"msg\\": \\"Site Global/USA/California/NonExistentBuilding not found for deletion\\"\\n}\\n"]` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.site_workflow_manager_module__return-response_5: .. rst-class:: ansible-option-title **response_5** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Task status information for bulk site creation operations. Includes progress indicators, operation IDs, and status details. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when bulk site creation is performed .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"{\\n \\"response\\": {\\n \\"startTime\\": 1725427091204,\\n \\"version\\": 1725427091204,\\n \\"progress\\": \\"{\\\\\\"TOTAL\\\\\\":3,\\\\\\"VALIDATION\_FAILURE\_COUNT\\\\\\":0,\\\\\\"VALIDATION\_SUCCESS\_COUNT\\\\\\":3,\\\\\\n \\"VALIDATION\_PENDING\_COUNT\\\\\\":0,\\\\\\"CRAETION\_SUCCESS\_COUNT\\\\\\":3,\\\\\\"message\\\\\\":\\\\\\n \\"Group import completed successfully.\\\\\\"}\\",\\n \\"serviceType\\": \\"Grouping Service\\",\\n \\"operationIdList\\": [\\n \\"3e7f1f73-b6f8-4ac6-b925-22e372e72510\\"\\n ],\\n \\"isError\\": false,\\n \\"instanceTenantId\\": \\"6663114d388b29001399e46a\\",\\n \\"id\\": \\"0191bb78-0704-767c-94c6-95a6e5a511d1\\"\\n },\\n \\"version\\": \\"1.0\\",\\n \\"msg\\": \\"Successfully created 3 sites in bulk operation\\"\\n}\\n"` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Madhan Sankaranarayanan (@madhansansel) - Rishita Chowdhary (@rishitachowdhary) - Abhishek Maheshwari (@abhishekmaheshwari) - Megha Kandari (@kandarimegha) - Sonali Deepthi Kesali (@skesali) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors