cisco.nd.nd_instant_assurance_analysis (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 instant online assurance analysis jobs 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: Trigger instant assurance analysis job
  cisco.nd.nd_instant_assurance_analysis:
    insights_group: exampleIG
    site_name: siteName
    state: present

Scanned by Steampunk Spotter

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

- name: Get history of instant assurance analysis
  cisco.nd.nd_instant_assurance_analysis:
    insights_group: exampleIG
    site_name: siteName
    state: query
  register: query_results

Inputs

    
id:
    aliases:
    - job_id
    description:
    - ID for the instant assurance job to query.
    - Optional. Ignored when state is C(present), only valid with C(query)
    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

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:
    - present
    - query
    default: query
    description:
    - Use C(present) for triggering an instant (on-demand) assurance analysis job.
    - Use C(query) for listing the history of instant assurance analysis jobs that are
      running or completed.
    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.
    required: true
    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

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