cisco.catalystcenter.compliance_policys_rules module -- Resource module for Compliance Policys Rules

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

New in cisco.catalystcenter 2.3.0

Synopsis

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

  • This API operation creates a new rule within the specified compliance policy.

  • Deletes the rule within the specified compliance policy.

  • Updates the details of an existing rule within the specified 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:

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

conditionsCount

integer

The total number of conditions present within the rule.

description

string

A comprehensive description of the rule. This should provide detailed information about what the rule does, its scope, and any other pertinent details that explain its function and purpose.

deviceTypes

list / elements=dictionary

Defines device types by detailing their family, series, and model to enable the application of rules to targeted devices.

deviceFamily

string

The device family.

deviceModel

string

The device model. When a device model is specified, `deviceSeries` is required.

deviceSeries

string

The device series.

id

string

Id path parameter. The `id` of the rule within the compliance policy.

impact

string

This describes the potential impact when the conditions of this rule are violated.

name

string

This is the name of the rule. It should be a concise and descriptive title that clearly identifies the rule's purpose or function. The name must be unique within the specified policy.

policyId

string

PolicyId path parameter. The `id` of the compliance policy.

softwareType

string

Specifies the software type applicable to the rule. The options include - `IOS` Cisco Internetwork Operating System. - `IOS_XE` Cisco IOS-XE software. - `CISCO_CONTROLLER` AireOS operating system for Cisco wireless controllers.

suggestedFix

string

Suggestions on how to fix the issues detected by this rule.

validate_response_schema

boolean

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

Choices:

variablesCount

integer

The total number of variables present within the rule.

Notes

Note

  • SDK Method used are compliance.Compliance.create_a_new_rule, compliance.Compliance.delete_a_specific_rule, compliance.Compliance.update_an_existing_rule,

  • Paths used are post /dna/intent/api/v1/compliancePolicys/{policyId}/rules, delete /dna/intent/api/v1/compliancePolicys/{policyId}/rules/{id}, put /dna/intent/api/v1/compliancePolicys/{policyId}/rules/{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 CreateANewRule

Complete reference of the CreateANewRule API.

Cisco Catalyst Center documentation for Compliance DeleteASpecificRule

Complete reference of the DeleteASpecificRule API.

Cisco Catalyst Center documentation for Compliance UpdateAnExistingRule

Complete reference of the UpdateAnExistingRule API.

Examples

---
- name: Delete by id
  cisco.catalystcenter.compliance_policys_rules:
    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: e8eef5e2-1eab-426c-be77-97ee81dcba06
    policyId: c9eef5e2-1eab-426c-be77-97ee81dcba05
- name: Update by id
  cisco.catalystcenter.compliance_policys_rules:
    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
    conditionsCount: 0
    description: string
    deviceTypes:
      - deviceFamily: string
        deviceModel: string
        deviceSeries: string
    id: string
    impact: string
    name: string
    policyId: string
    softwareType: string
    suggestedFix: string
    variablesCount: 0
- name: Create
  cisco.catalystcenter.compliance_policys_rules:
    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
    conditionsCount: 0
    description: string
    deviceTypes:
      - deviceFamily: string
        deviceModel: string
        deviceSeries: string
    id: string
    impact: string
    name: string
    policyId: string
    softwareType: string
    suggestedFix: string
    variablesCount: 0

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)