cisco.catalystcenter.floors module -- Resource module for Floors

Note

This module is part of the cisco.catalystcenter collection (version 2.12.0).

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

New in cisco.catalystcenter 1.0.0

Synopsis

  • Manage operations create, update and delete of the resource Floors.

  • Create a floor in the network hierarchy under building.

  • Deletes a floor from the network hierarchy. This operations fails if there are any devices assigned to this floor.

  • Updates a floor in the network hierarchy.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

floorNumber

integer

Floor number.

height

float

Floor height.

id

string

Id path parameter. Floor ID.

length

float

Floor length.

name

string

Floor name.

nameHierarchy

string

Floor hierarchical name.

parentId

string

Parent Id.

rfModel

string

RF Model.

siteHierarchyId

string

Floor Hierarchical Id. Can be used to add the access groups using the API POST /dna/system/api/v1/accessGroups, this value should be used to populate the srcResourceId field of the request payload.

type

string

Site type.

unitsOfMeasure

string

Unit of measure for length, width, and height.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

width

float

Floor width.

Notes

Note

  • SDK Method used are site_design.SiteDesign.creates_a_floor, site_design.SiteDesign.deletes_a_floor, site_design.SiteDesign.updates_a_floor,

  • Paths used are post /dna/intent/api/v2/floors, delete /dna/intent/api/v2/floors/{id}, put /dna/intent/api/v2/floors/{id},

  • 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

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Site Design CreatesAFloor

Complete reference of the CreatesAFloor API.

Cisco Catalyst Center documentation for Site Design DeletesAFloor

Complete reference of the DeletesAFloor API.

Cisco Catalyst Center documentation for Site Design UpdatesAFloor

Complete reference of the UpdatesAFloor API.

Examples

---
- name: Delete by id
  cisco.catalystcenter.floors:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    id: string
- name: Update by id
  cisco.catalystcenter.floors:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    floorNumber: 1
    height: 10.1
    id: string
    length: 110.3
    name: Floor1
    parentId: 972587e8-065d-408e-8251-60a055184ad9
    rfModel: Free Space
    unitsOfMeasure: meters
    width: 100.5
- name: Create
  cisco.catalystcenter.floors:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    floorNumber: 1
    height: 10.1
    length: 110.3
    name: Floor1
    parentId: 972587e8-065d-408e-8251-60a055184ad9
    rfModel: Free Space
    unitsOfMeasure: meters
    width: 100.5

Return Values

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

Key

Description

catalystcenter_response

dictionary

A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)