cisco.catalystcenter.wireless_settings_certificate_renewal_profiles_info module -- Information module for Wireless Settings Certificate Renewal Profiles

Note

This module is part of the cisco.catalystcenter collection (version 2.12.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_info.

New in cisco.catalystcenter 2.3.0

Synopsis

  • Get all Wireless Settings Certificate Renewal Profiles.

  • Get Wireless Settings Certificate Renewal Profiles by id. - > Retrieves the access point certificate renewal profiles that are created in the Catalyst Centre network by profile 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 renwal type.

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

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

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:

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

headers

dictionary

Additional headers.

id

string

Id path parameter. Access point certificate renewal profile ID.

limit

integer

Limit query parameter.

lscProfileName

string

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

offset

integer

Offset query parameter.

renewalType

string

RenewalType query parameter. Access point certificate renewal profile renewal type. Use this query parameter to obtain the details of acess point certificate renewal profile by its renewal type name.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are wireless.Wireless.get_access_point_certificate_renewal_profile, wireless.Wireless.retrieve_the_access_point_certificate_renewal_profile_by_id,

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

Complete reference of the GetAccessPointCertificateRenewalProfile API.

Cisco Catalyst Center documentation for Wireless RetrieveTheAccessPointCertificateRenewalProfileByID

Complete reference of the RetrieveTheAccessPointCertificateRenewalProfileByID API.

Examples

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

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

Authors

  • Bryan Vargas (@bvargasre)