cisco.nd.nd_pcv (0.5.0) — module

Manage pre-change validation job

| "added in version" 0.2.0 of cisco.nd"

Authors: Cindy Zhao (@cizhao)

preview | supported by community

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 pre-change validation job on Cisco Nexus Dashboard Insights (NDI).


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get prechange validation jobs' status
  cisco.nd.nd_pcv:
    insights_group: exampleIG
    state: query
  register: query_results
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get a specific prechange validation job status
  cisco.nd.nd_pcv:
    insights_group: exampleIG
    site_name: siteName
    name: demoName
    state: query
  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a new Pre-Change analysis from file
  cisco.nd.nd_pcv:
    insights_group: igName
    site_name: siteName
    name: demoName
    file: configFilePath
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Present Pre-Change analysis from manual changes
  cisco.nd.nd_pcv:
    insights_group: idName
    site_name: SiteName
    name: demoName
    manual: |
        [
            {
              "fvTenant": {
                "attributes": {
                  "name": "AnsibleTest",
                  "dn": "uni/tn-AnsibleTest",
                  "status": "deleted"
                }
              }
            }
        ]
    state: present
  register: present_pcv_manual
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Wait until Pre-Change analysis is completed, and query status
  cisco.nd.nd_pcv:
    insights_group: igName
    site_name: siteName
    name: demoName
    state: wait_and_query
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete Pre-Change analysis
  cisco.nd.nd_pcv:
    insights_group: igName
    site_name: siteName
    name: demoName
    state: absent

Inputs

    
file:
    description:
    - Optional parameter if creating new pre-change analysis from file.
    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 pre-change validation job.
    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

state:
    choices:
    - absent
    - present
    - query
    - wait_and_query
    default: query
    description:
    - Use C(present) or C(absent) for creating or deleting a Pre-Change Validation (PCV).
    - Use C(query) for retrieving the PCV information.
    - Use C(wait_and_query) to execute the query until the Pre-Change Validation (PCV)
      task status is COMPLETED or FAILED
    type: str

manual:
    description:
    - Optional parameter if creating new pre-change analysis from change-list (manual)
    type: str

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

site_name:
    aliases:
    - site
    description:
    - Name of the Assurance Entity.
    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:
    - Description for the pre-change validation job.
    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