cisco.nd.nd_compliance_requirement_config_template (0.5.0) — module

Install collection

Install with ansible-galaxy collection install cisco.nd:==0.5.0

Add to requirements.yml

  collections:
    - name: cisco.nd
      version: 0.5.0

Description

Manage template configuration type compliance requirements on Cisco Nexus Dashboard Insights (NDI).

Requirements

• Nexus Dashboard v2.0 or newer

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get all template configuration type compliance requirements
  cisco.nd.nd_compliance_requirement_config_template:
    insights_group: igName
    state: query
  register: query_results

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get a specific template configuration type compliance requirement
  cisco.nd.nd_compliance_requirement_config_template:
    insights_group: igName
    name: complianceRequirementName
    state: query
  register: query_results

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create template configuration type compliance requirement
  cisco.nd.nd_compliance_requirement_config_template:
    insights_group: igName
    name: complianceRequirementName
    sites:
    - siteName1
    - siteName2
    enabled: false
    file: fileName.json
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete template configuration type compliance requirement
  cisco.nd.nd_compliance_requirement_config_template:
    insights_group: igName
    name: complianceRequirementName
    state: absent

Inputs

    
file:
    description:
    - The name of the template file to upload.
    type: str

host:
    aliases:
    - hostname
    description:
    - IP Address or hostname of the Nexus Dashboard (ND) host.
    - If the value is not specified in the task, the value of environment variable C(ND_HOST)
      will be used instead.
    type: str

name:
    description:
    - The name of the compliance requirement.
    type: str

port:
    description:
    - Port number to be used for the REST connection.
    - The default value depends on parameter `use_ssl`.
    - If the value is not specified in the task, the value of environment variable C(ND_PORT)
      will be used instead.
    type: int

sites:
    description:
    - The names of the sites.
    elements: str
    type: list

state:
    choices:
    - query
    - absent
    - present
    default: query
    description:
    - Use C(present) or C(absent) for adding or removing.
    - Use C(query) for listing an object or multiple objects.
    type: str

enabled:
    description:
    - Enable the compliance requirement.
    type: bool

timeout:
    default: 30
    description:
    - The socket level timeout in seconds.
    - If the value is not specified in the task, the value of environment variable C(ND_TIMEOUT)
      will be used instead.
    type: int

use_ssl:
    description:
    - If C(no), an HTTP connection will be used instead of the default HTTPS connection.
    - If the value is not specified in the task, the value of environment variable C(ND_USE_SSL)
      will be used instead.
    type: bool

password:
    description:
    - The password to use for authentication.
    - If the value is not specified in the task, the value of environment variables C(ND_PASSWORD)
      or C(ANSIBLE_NET_PASSWORD) will be used instead.
    type: str

username:
    description:
    - The username to use for authentication.
    - If the value is not specified in the task, the value of environment variables C(ND_USERNAME)
      or C(ANSIBLE_NET_USERNAME) will be used instead.
    type: str

use_proxy:
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    - If the value is not specified in the task, the value of environment variable C(ND_USE_PROXY)
      will be used instead.
    type: bool

description:
    aliases:
    - descr
    description:
    - The description of the compliance requirement.
    type: str

login_domain:
    description:
    - The login domain name to use for authentication.
    - The default value is DefaultAuth.
    - If the value is not specified in the task, the value of environment variable C(ND_LOGIN_DOMAIN)
      will be used instead.
    type: str

output_level:
    choices:
    - debug
    - info
    - normal
    default: normal
    description:
    - Influence the output of this ND module.
    - C(normal) means the standard output, incl. C(current) dict
    - C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts
    - C(debug) adds debugging output, incl. C(filter_string), C(method), C(response),
      C(status) and C(url) information
    - If the value is not specified in the task, the value of environment variable C(ND_OUTPUT_LEVEL)
      will be used instead.
    type: str

insights_group:
    aliases:
    - fab_name
    - ig_name
    description:
    - The name of the insights group.
    required: true
    type: str

validate_certs:
    description:
    - If C(no), SSL certificates will not be validated.
    - This should only set to C(no) when used on personally controlled sites using self-signed
      certificates.
    - If the value is not specified in the task, the value of environment variable C(ND_VALIDATE_CERTS)
      will be used instead.
    type: bool

selector_based_on_tags:
    default: false
    description:
    - Enable object selection based on Tag Annotation or Tag Instance.
    type: bool