cisco.catalystcenter.wireless_settings_remote_teleworkers module -- Resource module for Wireless Settings Remote Teleworkers

Note

This module is part of the cisco.catalystcenter collection (version 2.11.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.wireless_settings_remote_teleworkers.

New in cisco.catalystcenter 2.11.0

Synopsis

• Manage operations create and update of the resource Wireless Settings Remote Teleworkers. - > This API allows the user to enable / disable `Remote Teleworker` on the area. Supported only at area level and user should pass the area id only. - > This API allows the user to enable / disable `Remote Teleworker` on the area. Supported only at area level and user should pass the area id only.

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
areaId string	Area ID.
catalystcenter_debug aliases: dnac_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
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"`
enableRemoteTeleworker boolean	Flag that determines if Remote Teleworker is enabled on the area. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
id string	Id path parameter. Obtain the addressInheritedFrom ID value by using the API call GET /dna/intent/api/v1/site. Filter by type area. Example 85a9795c-577c-459d-ba5d-18aea7e94c40.
validate_response_schema boolean	Flag for Cisco Catalyst 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 wireless.Wireless.create_remote_teleworker_area, wireless.Wireless.update_remote_teleworker_area,

• Paths used are post /dna/intent/api/v1/wirelessSettings/remoteTeleworkers, put /dna/intent/api/v1/wirelessSettings/remoteTeleworkers/{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 Wireless CreateRemoteTeleworkerArea

Complete reference of the CreateRemoteTeleworkerArea API.

Cisco Catalyst Center documentation for Wireless UpdateRemoteTeleworkerArea

Complete reference of the UpdateRemoteTeleworkerArea API.

Examples

---
- name: Create
  cisco.catalystcenter.wireless_settings_remote_teleworkers:
    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
    areaId: string
    enableRemoteTeleworker: true
- name: Update by id
  cisco.catalystcenter.wireless_settings_remote_teleworkers:
    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
    areaId: string
    enableRemoteTeleworker: true
    id: string

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)

Collection links

Issue Tracker Repository (Sources)