cisco.catalystcenter.security_advisories_results_advisories_info module -- Information module for Security Advisories Results Advisories

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

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

New in cisco.catalystcenter 6.17.0

Synopsis

• Get all Security Advisories Results Advisories.

• Get Security Advisories Results Advisories by id.

• Get security advisories affecting the network devices.

• Get security advisory affecting the network devices by Id.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.1.6.0.0

• python >= 3.12

Parameters

Parameter	Comments
catalystcenter_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 string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_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 string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
cvssBaseScore string	CvssBaseScore query parameter. Return advisories with cvssBaseScore greater than this cvssBaseScore. E.g. 8.5.
deviceCount float	DeviceCount query parameter. Return advisories with deviceCount greater than this deviceCount.
headers dictionary	Additional headers.
id string	Id query parameter. Id of the advisory.
limit integer	Limit query parameter. The number of records to show for this page. Minimum value is 1. Maximum value is 500. Default value is 500.
offset integer	Offset query parameter. The first record to show for this page; the first record is numbered 1. Default value is 1.
order string	Order query parameter. Whether ascending or descending order should be used to sort the response. Available values asc, desc. Default value is asc.
securityImpactRating string	SecurityImpactRating query parameter. Return advisories with this securityImpactRating. Available values CRITICAL, HIGH.
sortBy string	SortBy query parameter. A property within the response to sort by.
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 compliance.Compliance.get_security_advisories_affecting_the_network_devices, compliance.Compliance.get_security_advisory_affecting_the_network_devices_by_id,

• Paths used are get /dna/intent/api/v1/securityAdvisories/results/advisories, get /dna/intent/api/v1/securityAdvisories/results/advisories/{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

See Also

See also

Cisco DNA Center documentation for Compliance GetSecurityAdvisoriesAffectingTheNetworkDevices

Complete reference of the GetSecurityAdvisoriesAffectingTheNetworkDevices API.

Cisco DNA Center documentation for Compliance GetSecurityAdvisoryAffectingTheNetworkDevicesById

Complete reference of the GetSecurityAdvisoryAffectingTheNetworkDevicesById API.

Examples

---
- name: Get all Security Advisories Results Advisories
  cisco.catalystcenter.security_advisories_results_advisories_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
    deviceCount: 0
    cvssBaseScore: string
    securityImpactRating: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result
- name: Get Security Advisories Results Advisories by id
  cisco.catalystcenter.security_advisories_results_advisories_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
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": {"cveIds": ["string"], "cvssBaseScore": 0, "deviceCount": 0, "firstFixedVersionsList": [{"fixedVersions": ["string"], "vulnerableVersion": "string"}], "id": "string", "publicationUrl": "string", "securityImpactRating": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)