cisco.catalystcenter.wireless_settings_certificate_renewal_profiles module -- Resource module for Wireless Settings Certificate Renewal Profiles

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

New in cisco.catalystcenter 2.3.0

Synopsis

• 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 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
calendarProfile dictionary	This entity is the calendar profile setting construct on the wireless controller, which the wireless controller uses for any scheduling mechanism.
duration dictionary	Wireless Settings Certificate Renewal Profiles's duration.
schedulerDate list / elements=integer	Wireless Settings Certificate Renewal Profiles's schedulerDate.
schedulerDay list / elements=string	Wireless Settings Certificate Renewal Profiles's schedulerDay.
schedulerEndTime string	End time on the wireless controller at which the scheduler should stop any execution. Format HH MM in 24-hour notation.
schedulerStartTime string	Start time on the wireless controller at which the scheduler should begin any execution. Format HH MM in 24-hour notation.
schedulerType string	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.
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. Access point certificate renewal profile ID.
lscProfileName string	Name of the LSC profile.
renewalDueInDays integer	Number of days until renewal is due.
renewalType string	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.
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_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 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 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

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

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)