cisco.dnac.wireless_settings_certificate_renewal_profiles_info module -- Information 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_info.

New in cisco.dnac 6.46.0

Synopsis

  • Get all Wireless Settings Certificate Renewal Profiles.

  • Get Wireless Settings Certificate Renewal Profiles by id.

  • GET LSC Certificate Renewal Profile by ID. - > Retrieves the access point certificate renewal profiles that are created in the catalyst centre network design for wireless. Filtering can be done on access point certificate renewal profile name and renewal type.

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

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

headers

dictionary

Additional headers.

id

string

Id path parameter. LSC Certificate Renewal Profile ID.

limit

integer

Limit query parameter. Pagination limit.

lscProfileName

string

LscProfileName query parameter. Access point certificate renewal profile name. Use this query parameter to obtain the details of access point certificate renewal profile by its name.

offset

integer

Offset query parameter. Pagination offset.

renewalType

string

RenewalType query parameter. Access point certificate renewal profile renewal type. Use this query parameter to obtain the details of access point certificate renewal profile by its renewal type name. Example STAGGERED, 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.get_l_s_c_certificate_renewal_profile_by_id, wireless.Wireless.get_l_s_c_certificate_renewal_profiles,

  • Paths used are get /dna/intent/api/v1/wirelessSettings/certificateRenewalProfiles, get /dna/intent/api/v1/wirelessSettings/certificateRenewalProfiles/{id},

  • Supports 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 GETLSCCertificateRenewalProfileByID

Complete reference of the GETLSCCertificateRenewalProfileByID API.

Cisco DNA Center documentation for Wireless GetLSCCertificateRenewalProfiles

Complete reference of the GetLSCCertificateRenewalProfiles API.

Examples

---
- name: Get all Wireless Settings Certificate Renewal Profiles
  cisco.dnac.wireless_settings_certificate_renewal_profiles_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    lscProfileName: string
    renewalType: string
    limit: 0
    offset: 0
  register: result
- name: Get Wireless Settings Certificate Renewal Profiles by id
  cisco.dnac.wireless_settings_certificate_renewal_profiles_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    id: string
  register: result

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:`{"CalendarProfileSetting": {"duration": {"schedulerDate": "string", "schedulerDay": ["string"], "schedulerEndTime": "string", "schedulerStartTime": "string"}, "schedulerType": "string"}, "lscProfileName": "string", "renewalDueInDays": 0, "renewalType": "string"}`

Authors

  • Rafael Campos (@racampos)