cisco.catalystcenter.field_notices_results_notices_info module -- Information module for Field Notices Results Notices

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

New in cisco.catalystcenter 6.17.0

Synopsis

• Get all Field Notices Results Notices.

• Get Field Notices Results Notices by id.

• Get field notice by Id.

• Get field notices.

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"`
deviceCount float	DeviceCount query parameter. Return field notices with deviceCount greater than this deviceCount.
headers dictionary	Additional headers.
id string	Id query parameter. Id of the field notice.
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.
sortBy string	SortBy query parameter. A property within the response to sort by.
type string	Type query parameter. Return field notices with this type. Available values SOFTWARE, HARDWARE.
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_field_notice_by_id, compliance.Compliance.get_field_notices,

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

Complete reference of the GetFieldNoticeById API.

Cisco DNA Center documentation for Compliance GetFieldNotices

Complete reference of the GetFieldNotices API.

Examples

---
- name: Get all Field Notices Results Notices
  cisco.catalystcenter.field_notices_results_notices_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
    type: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result
- name: Get Field Notices Results Notices by id
  cisco.catalystcenter.field_notices_results_notices_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": {"deviceCount": 0, "firstPublishDate": 0, "id": "string", "lastUpdatedDate": 0, "name": "string", "potentialDeviceCount": 0, "publicationUrl": "string", "type": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)