cisco.catalystcenter.compliance_sites_violations_acknowledge_bulk_create module -- Resource module for Compliance Sites Violations Acknowledge Bulk Create

Note

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

New in cisco.catalystcenter 2.11.0

Synopsis

  • Manage operation create of the resource Compliance Sites Violations Acknowledge Bulk Create.

  • Updates the acknowledgement status of compliance violations for a site.

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

acknowledgementStatus

string

Acknowledgment status of the violation(s). If any violation is acknowledged, the overall status becomes `ACKNOWLEDGED`.

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

siteId

string

SiteId path parameter. The `id` of the site. Use the `GET /dna/intent/api/v1/sites` endpoint to retrieve the sites.

validate_response_schema

boolean

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

Choices:

violations

list / elements=dictionary

List of violations with their target devices.

networkDeviceIds

list / elements=string

List of device IDs for the specific violation. If not provided or if an empty list is provided, the acknowledgement status will be updated for all devices at the site that have this violation.

violationId

string

The `id` of the violation to update.

Notes

Note

  • SDK Method used are compliance.Compliance.acknowledge_or_unacknowledge_compliance_violations,

  • Paths used are post /dna/intent/api/v1/compliance/sites/{siteId}/violations/acknowledge/bulk,

  • Does not support 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 Compliance AcknowledgeOrUnacknowledgeComplianceViolations

Complete reference of the AcknowledgeOrUnacknowledgeComplianceViolations API.

Examples

---
- name: Create
  cisco.catalystcenter.compliance_sites_violations_acknowledge_bulk_create:
    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}}"
    acknowledgementStatus: string
    siteId: b8eeb5e2-1eab-426c-be77-97ee81dcba07
    violations:
      - networkDeviceIds:
          - string
        violationId: string

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:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)