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

Note

This module is part of the cisco.dnac collection (version 6.46.0).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.wireless_settings_certificate_renewal_profiles.

New in cisco.dnac 6.46.0

Synopsis

  • 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 action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk >= 2.11.0

  • python >= 3.12

Parameters

Parameter

Comments

CalendarProfileSetting

dictionary

Wireless Settings Certificate Renewal Profiles's CalendarProfileSetting.

duration

dictionary

Wireless Settings Certificate Renewal Profiles's duration.

schedulerDate

string

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.

schedulerDay

list / elements=string

List of days in a week on which certificate renewal has to be scheduled. Example SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATERDAY.

schedulerEndTime

string

End time on the wireless controller at which the scheduler should stop any execution. Format HH MM in 24-hour notation. Example 23 59.

schedulerStartTime

string

Start time on the wireless controller at which the scheduler should begin any execution. Format HH MM in 24-hour notation. Example 13 00.

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.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

id

string

Id path parameter. LSC Certificate Renewal Profile ID.

lscProfileName

string

Name of the LSC profile.

renewalDueInDays

integer

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.

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 DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

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

See Also

See also

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

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)