cisco.catalystcenter.compliance_policys module -- Resource module for Compliance Policys

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

New in cisco.catalystcenter 2.3.0

Synopsis

• Manage operations create, update and delete of the resource Compliance Policys.

• This API operation creates a new compliance policy.

• Deletes a specific compliance policy.

• Updates the details of an existing compliance policy.

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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
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"`
description string	An optional field for providing a detailed description of the compliance policy.
id string	The `id` of the compliance policy.
name string	The unique name of the compliance policy.
rulesCount integer	The total number of rules within the compliance policy.
sitesCount integer	The total count of site IDs to which the compliance policy applies.
source string	The source of the compliance policy. Source can be - `USER` Indicates the policy was created by the user. - `SYSTEM` Indicates the policy was automatically generated by the system.
status string	The status of the compliance policy. Status can be - `ACTIVE` The policy is fully configured and operational. - `NO_RULES_CONFIGURED` The policy lacks defined rules. - `NO_CONDITIONS_CONFIGURED` The policy lacks conditions in all its rules. - `NO_SITES_ASSIGNED` The policy is not assigned to any sites. - `SITE_VARIABLES_PENDING` Awaiting resolution of site-specific variables.
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.create_a_new_policy, compliance.Compliance.delete_a_specific_policy, compliance.Compliance.update_an_existing_policy,

• Paths used are post /dna/intent/api/v1/compliancePolicys, delete /dna/intent/api/v1/compliancePolicys/{id}, put /dna/intent/api/v1/compliancePolicys/{id},

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

Complete reference of the CreateANewPolicy API.

Cisco Catalyst Center documentation for Compliance DeleteASpecificPolicy

Complete reference of the DeleteASpecificPolicy API.

Cisco Catalyst Center documentation for Compliance UpdateAnExistingPolicy

Complete reference of the UpdateAnExistingPolicy API.

Examples

---
- name: Create
  cisco.catalystcenter.compliance_policys:
    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}}"
    state: present
    description: string
    id: string
    name: string
    rulesCount: 0
    sitesCount: 0
    source: string
    status: string
- name: Delete by id
  cisco.catalystcenter.compliance_policys:
    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}}"
    state: absent
    id: c9eef5e2-1eab-426c-be77-97ee81dcba05
- name: Update by id
  cisco.catalystcenter.compliance_policys:
    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}}"
    state: present
    description: string
    id: string
    name: string
    rulesCount: 0
    sitesCount: 0
    source: string
    status: 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)

Collection links

Issue Tracker Repository (Sources)