.. 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.catalystcenter.wireless_settings_certificate_renewal_profiles_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.wireless_settings_certificate_renewal_profiles module -- Resource module for Wireless Settings Certificate Renewal Profiles ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.11.0). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. 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.catalystcenter.wireless_settings_certificate_renewal_profiles`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 2.3.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Wireless Settings Certificate Renewal Profiles. - \> This API allows users to create an access point certificate renewal profile by specifying the expiry due days, LSC profile name, and type of execution Staggered or Oneshot . - This API allows users to delete access point certificate renewal profiles by profile ID. - This API allows users to update access point certificate renewal profiles by profile ID. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.2.3.0.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofile: .. rst-class:: ansible-option-title **calendarProfile** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
This entity is the calendar profile setting construct on the wireless controller, which the wireless controller uses for any scheduling mechanism. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofile/duration: .. rst-class:: ansible-option-title **duration** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Settings Certificate Renewal Profiles's duration. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofile/duration/schedulerdate: .. rst-class:: ansible-option-title **schedulerDate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=integer` .. raw:: html
- .. raw:: html
Wireless Settings Certificate Renewal Profiles's schedulerDate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofile/duration/schedulerday: .. rst-class:: ansible-option-title **schedulerDay** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Wireless Settings Certificate Renewal Profiles's schedulerDay. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofile/duration/schedulerendtime: .. rst-class:: ansible-option-title **schedulerEndTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
End time on the wireless controller at which the scheduler should stop any execution. Format HH MM in 24-hour notation. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofile/duration/schedulerstarttime: .. rst-class:: ansible-option-title **schedulerStartTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Start time on the wireless controller at which the scheduler should begin any execution. Format HH MM in 24-hour notation. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofile/schedulertype: .. rst-class:: ansible-option-title **schedulerType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of scheduler (e.g., DAILY, WEEKLY, MONTHLY) \* DAILY schedule requires a schedulerStartTime input and an optional schedulerEndTime in the duration. \* WEEKLY schedule requires schedulerDay input in the duration along with a schedulerStartTime input and an optional schedulerEndTime in the duration. \* MONTHLY schedule requires schedulerDate input in the duration along with a schedulerStartTime input and an optional schedulerEndTime in the duration. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **catalystcenter_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_debug` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable debugging. .. 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.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_host: .. rst-class:: ansible-option-title **catalystcenter_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_host` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_password: .. rst-class:: ansible-option-title **catalystcenter_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_password` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_port: .. rst-class:: ansible-option-title **catalystcenter_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port` .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-user: .. rst-class:: ansible-option-title **catalystcenter_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_username, user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **catalystcenter_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_verify` .. 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.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_version: .. rst-class:: ansible-option-title **catalystcenter_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_version` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco Catalyst Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. Access point certificate renewal profile ID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-lscprofilename: .. rst-class:: ansible-option-title **lscProfileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the LSC profile. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-renewaldueindays: .. rst-class:: ansible-option-title **renewalDueInDays** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of days until renewal is due. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_module__parameter-renewaltype: .. rst-class:: ansible-option-title **renewalType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of renewal (e.g., ONESHOT, STAGGERED) \* STAGGERED execution when configured with calendarProfileSetting requires both start time and end time input from scheduler. STAGGERED execution also requires a percentage input which specifies the percentage of access points that can be considered for certificate renewal per iteration. \* ONESHOT execution when configured with calendarProfileSetting requires a start time input. ONESHOT execution does not need percentage input as all the access points certificate renewal happens at oneshot. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_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:: - SDK Method used are wireless.Wireless.create\_access\_point\_certificate\_renewal\_profile, wireless.Wireless.delete\_access\_point\_certificate\_renewal\_profile, wireless.Wireless.update\_access\_point\_certificate\_renewal\_profile, - Paths used are post /dna/intent/api/v1/wirelessSettings/certificateRenewalProfiles, delete /dna/intent/api/v1/wirelessSettings/certificateRenewalProfiles/{id}, put /dna/intent/api/v1/wirelessSettings/certificateRenewalProfiles/{id}, - Does not support \ :literal:`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) .. Seealso See Also -------- .. seealso:: `Cisco Catalyst Center documentation for Wireless CreateAccessPointCertificateRenewalProfile `_ Complete reference of the CreateAccessPointCertificateRenewalProfile API. `Cisco Catalyst Center documentation for Wireless DeleteAccessPointCertificateRenewalProfile `_ Complete reference of the DeleteAccessPointCertificateRenewalProfile API. `Cisco Catalyst Center documentation for Wireless UpdateAccessPointCertificateRenewalProfile `_ Complete reference of the UpdateAccessPointCertificateRenewalProfile API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.catalystcenter.wireless_settings_certificate_renewal_profiles: 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 calendarProfile: duration: schedulerDate: - 0 schedulerDay: - string schedulerEndTime: string schedulerStartTime: string schedulerType: string lscProfileName: string renewalDueInDays: 0 renewalType: string - name: Delete by id cisco.catalystcenter.wireless_settings_certificate_renewal_profiles: 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.wireless_settings_certificate_renewal_profiles: 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 calendarProfile: duration: schedulerDate: - 0 schedulerDay: - string schedulerEndTime: string schedulerStartTime: string schedulerType: string id: string lscProfileName: string renewalDueInDays: 0 renewalType: string .. 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.catalystcenter.wireless_settings_certificate_renewal_profiles_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Bryan Vargas (@bvargasre) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors