cisco.catalystcenter.field_notices_results_notices_v1_info module -- Information module for Field Notices Results Notices V1

Note

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

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

New in cisco.catalystcenter 6.17.0

Synopsis

  • Get all Field Notices Results Notices V1.

  • 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 >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

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

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

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

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

_version

string

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

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

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

float

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

float

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:

Notes

Note

  • SDK Method used are compliance.Compliance.get_field_notices_v1,

  • Paths used are get /dna/intent/api/v1/fieldNotices/results/notices,

  • 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 CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Compliance GetFieldNoticesV1

Complete reference of the GetFieldNoticesV1 API.

Examples

- name: Get all Field Notices Results Notices V1
  cisco.catalystcenter.field_notices_results_notices_v1_info:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    headers: "{{my_headers | from_json}}"
    id: string
    deviceCount: 0
    type: string
    offset: 0
    limit: 0
    sortBy: string
    order: 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 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)