.. 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.dnac.wireless_settings_certificate_renewal_profiles_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.wireless_settings_certificate_renewal_profiles module -- Resource module for Wireless Settings Certificate Renewal Profiles ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.46.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. 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.dnac.wireless_settings_certificate_renewal_profiles`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.46.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Wireless Settings Certificate Renewal Profiles. - This API is used to Create LSC Certificate Renewal Profile. - Delete LSC Certificate Renewal Profile by 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.dnac.wireless_settings_certificate_renewal_profiles_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.11.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.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofilesetting: .. rst-class:: ansible-option-title **CalendarProfileSetting** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Settings Certificate Renewal Profiles's CalendarProfileSetting. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofilesetting/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.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofilesetting/duration/schedulerdate: .. rst-class:: ansible-option-title **schedulerDate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Dates in a month (1 to 31) on which execution is scheduled. If the specified date does not exist in that month, no execution will be triggered for that date. For example, on the dates 1, 10, 30 in February, execution would occur only on dates 1 and 10. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofilesetting/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
List of days in a week on which certificate renewal has to be scheduled. Example SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATERDAY. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofilesetting/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. Example 23 59. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofilesetting/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. Example 13 00. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-calendarprofilesetting/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.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA 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.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA 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.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. 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.dnac.wireless_settings_certificate_renewal_profiles_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA 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.dnac.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. LSC Certificate Renewal Profile ID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.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.dnac.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
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.dnac.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.dnac.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 DNA 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\_l\_s\_c\_certificate\_renewal\_profile, wireless.Wireless.delete\_l\_s\_c\_certificate\_renewal\_profile\_by\_id, wireless.Wireless.update\_l\_s\_c\_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 the embedded connection manager from Cisco DNAC SDK - The parameters starting with dnac\_ are used by the Cisco DNAC Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Wireless CreateLSCCertificateRenewalProfile `_ Complete reference of the CreateLSCCertificateRenewalProfile API. `Cisco DNA Center documentation for Wireless DeleteLSCCertificateRenewalProfileByID `_ Complete reference of the DeleteLSCCertificateRenewalProfileByID API. `Cisco DNA Center documentation for Wireless UpdateLSCCertificateRenewalProfile `_ Complete reference of the UpdateLSCCertificateRenewalProfile API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.dnac.wireless_settings_certificate_renewal_profiles: 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}}" state: present CalendarProfileSetting: duration: schedulerDate: string schedulerDay: - string schedulerEndTime: string schedulerStartTime: string schedulerType: string lscProfileName: string renewalDueInDays: 0 renewalType: string - name: Delete by id cisco.dnac.wireless_settings_certificate_renewal_profiles: 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}}" state: absent id: string - name: Update by id cisco.dnac.wireless_settings_certificate_renewal_profiles: 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}}" state: present CalendarProfileSetting: duration: schedulerDate: string 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.dnac.wireless_settings_certificate_renewal_profiles_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_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 DNAC 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 ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors