cisco / cisco.dnac / 6.13.3 / module / site_workflow_manager Resource module for Site operations | "added in version" 6.6.0 of cisco.dnac" Authors: Madhan Sankaranarayanan (@madhansansel) Rishita Chowdhary (@rishitachowdhary) Abhishek Maheshwari (@abhishekmaheshwari)cisco.dnac.site_workflow_manager (6.13.3) — module
Install with ansible-galaxy collection install cisco.dnac:==6.13.3
collections: - name: cisco.dnac version: 6.13.3
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.
- 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
state: choices: - merged - deleted default: merged description: The state of Catalyst Center after module completion. type: str config: description: It represents a list of details for creating/managing/deleting sites, including areas, buildings, and floors. elements: dict required: true suboptions: site: description: Contains details about the site being managed including areas, buildings and floors. suboptions: area: description: Configuration details for creating or managing an area within a site. suboptions: name: description: Name of the area to be created or managed (e.g., "Area1"). type: str parent_name: description: The full name of the parent under which the area will be created/managed/deleted (e.g., "Global/USA"). type: str type: dict building: description: Configuration details required for creating or managing a building within a site. suboptions: address: description: Physical address of the building that is to be created or managed. type: str latitude: description: Geographical latitude coordinate of the building. For example, use 37.338 for a location in San Jose, California. Valid values range from -90.0 to +90.0 degrees. type: float longitude: description: Geographical longitude coordinate of the building. For example, use -121.832 for a location in San Jose, California. Valid values range from -180.0 to +180.0 degrees. type: float name: description: Name of the building (e.g., "Building1"). type: str parent_name: description: Hierarchical parent path of the building, indicating its location within the site (e.g., "Global/USA/San Francisco"). type: str type: dict floor: description: Configuration details required for creating or managing a floor within a site. suboptions: floor_number: description: Floor number within the building site (e.g., 5). This value can only be specified during the creation of the floor and cannot be modified afterward. type: int height: description: Height of the floor in feet (e.g., 15.23). type: float length: description: Length of the floor in feet (e.g., 100.11). type: float name: description: Name of the floor (e.g., "Floor-1"). type: str parent_name: description: Hierarchical parent path of the floor, indicating its location within the site (e.g., "Global/USA/San Francisco/BGL_18"). type: str rf_model: description: The RF (Radio Frequency) model type for the floor, which is essential for simulating and optimizing wireless network coverage. Select from the following allowed values, which describe different environmental signal propagation characteristics. Type of floor (allowed values are 'Cubes And Walled Offices', 'Drywall Office Only', 'Indoor High Ceiling', 'Outdoor Open Space'). Cubes And Walled Offices - This RF model typically represents indoor areas with cubicles or walled offices, where radio signals may experience attenuation due to walls and obstacles. Drywall Office Only - This RF model indicates an environment with drywall partitions, commonly found in office spaces, which may have moderate signal attenuation. Indoor High Ceiling - This RF model is suitable for indoor spaces with high ceilings, such as auditoriums or atriums, where signal propagation may differ due to the height of the ceiling. Outdoor Open Space - This RF model is used for outdoor areas with open spaces, where signal propagation is less obstructed and may follow different patterns compared to indoor environments. type: str width: description: Width of the floor in feet (e.g., 100.22). type: float type: dict type: dict site_type: description: Type of site to create/update/delete (eg area, building, floor). type: str type: list dnac_log: default: false description: - 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. type: bool dnac_host: description: - The hostname of the Cisco Catalyst Center. required: true type: str dnac_port: default: '443' description: - Specifies the port number associated with the Cisco Catalyst Center. type: str dnac_debug: default: false description: - Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. type: bool dnac_verify: default: true description: - Flag to enable or disable SSL certificate verification. type: bool dnac_version: default: 2.2.3.3 description: - Specifies the version of the Cisco Catalyst Center that the SDK should use. type: str config_verify: default: false description: Set to True to verify the Cisco Catalyst Center config after applying the playbook config. type: bool dnac_password: description: - The password for authentication at the Cisco Catalyst Center. type: str dnac_username: aliases: - user default: admin description: - The username for authentication at the Cisco Catalyst Center. type: str dnac_log_level: default: WARNING description: - 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. type: str dnac_log_append: default: true description: Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode. type: bool dnac_log_file_path: default: dnac.log description: - 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. type: str dnac_api_task_timeout: default: 1200 description: 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. type: int dnac_task_poll_interval: default: 2 description: Specifies the interval in seconds between successive calls to the API to retrieve task details. type: int validate_response_schema: default: true description: - Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. type: bool
response_1: description: A dictionary with API execution details as returned by the Cisco Catalyst Center Python SDK returned: always sample: "{\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" type: dict response_2: description: A dictionary with existing site details. returned: always sample: "{\n \"response\":\n {\n \"site\": {},\n \"siteId\": String,\n\ \ \"type\": String\n },\n \"msg\": String\n}\n" type: dict response_3: description: A dictionary with API execution details as returned by the Cisco Catalyst Center Python SDK returned: always sample: "{\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" type: dict response_4: description: A list with the response returned by the Cisco Catalyst Center Python returned: always sample: "{\n \"response\": [],\n \"msg\": String\n}\n" type: list