cisco.catalystcenter.wireless_controllers_intended_access_points_calendar_profiles_weekly_configs module -- Resource module for Wireless Controllers Intended Access Points Calendar Profiles Weekly Configs

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

New in cisco.catalystcenter 2.11.0

Synopsis

• Manage operations create and delete of the resource Wireless Controllers Intended Access Points Calendar Profiles Weekly Configs. - > This API operation creates an intended WeeklyConfig resource, and the subsequent "deploy" API call will configure the changes on the underlying wireless controller, and this API is applicable for per-device based configuration. - > This API operation deletes an intended WeeklyConfig resource, and the subsequent "deploy" API call will configure the changes on the underlying wireless controller, and this API is applicable for per-device based configuration.

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
calendarProfileId string	CalendarProfileId path parameter. Instance UUID of the CalendarProfile.
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"`
id string	Id path parameter. Instance UUID of the WeeklyConfig.
networkDeviceId string	NetworkDeviceId path parameter. Network device ID of the wireless controller to provision. The API /dna/intent/api/v1/network-device can be used to get the network device ID.
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_a_new_instance_of_an_intended_weekly_config_feature_on_a_wireless_controller, wireless.Wireless.delete_configurations_for_a_specific_instance_of_an_intended_weekly_config_feature_on_a_wireless_controller,

• Paths used are post /dna/campus/api/v1/wirelessControllers/{networkDeviceId}/intended/accessPoints/calendarProfiles/{calendarProfileId}/weeklyConfigs, delete /dna/campus/api/v1/wirelessControllers/{networkDeviceId}/intended/accessPoints/calendarProfiles/{calendarProfileId}/weeklyConfigs/{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 CreateANewInstanceOfAnIntendedWeeklyConfigFeatureOnAWirelessController

Complete reference of the CreateANewInstanceOfAnIntendedWeeklyConfigFeatureOnAWirelessController API.

Cisco Catalyst Center documentation for Wireless DeleteConfigurationsForASpecificInstanceOfAnIntendedWeeklyConfigFeatureOnAWirelessController

Complete reference of the DeleteConfigurationsForASpecificInstanceOfAnIntendedWeeklyConfigFeatureOnAWirelessController API.

Examples

---
- name: Create
  cisco.catalystcenter.wireless_controllers_intended_access_points_calendar_profiles_weekly_configs:
    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
    calendarProfileId: dd584a8a-a7ae-4323-97f4-ab950cab52a6
    calendarProfileName: OfficeSchedule
    calendarWeeklyConfigDay: MONDAY
    configType: WEEKLY_CONFIGURATION
    deviceVersion: '17.16'
    networkDeviceId: dd584a8a-a7ae-4323-97f4-ab950cab52a6
- name: Delete by id
  cisco.catalystcenter.wireless_controllers_intended_access_points_calendar_profiles_weekly_configs:
    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
    calendarProfileId: dd584a8a-a7ae-4323-97f4-ab950cab52a6
    id: string
    networkDeviceId: dd584a8a-a7ae-4323-97f4-ab950cab52a6

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)