cisco.nd.nd_delta_analysis (0.5.0) — module

Manage delta analysis jobs

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

Authors: Alejandro de Alda (@adealdag)

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 delta analysis jobs on Cisco Nexus Dashboard Insights (NDI).


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Creates a new delta analysis job using epoch UUIDs
  cisco.nd.nd_delta_analysis:
    insights_group: exampleIG
    site_name: siteName
    name: testDeltaAnalysis
    earlier_epoch_id: 0e5604f9-53b9c234-03dc-3997-9850-501b925f7d65
    later_epoch_id: 0e5604f9-ad5b12ae-9834-348b-aed1-8ca124e32e9b
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Creates a new delta analysis job using epoch time
  cisco.nd.nd_delta_analysis:
    insights_group: exampleIG
    site_name: siteName
    name: testDeltaAnalysis
    earlier_epoch_time: 2023-01-15T12:24:34Z
    later_epoch_time: 2023-01-17T18:27:34Z
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Validates a running delta analysis job
  cisco.nd.nd_delta_analysis:
    insights_group: exampleIG
    site_name: siteName
    name: testDeltaAnalysis
    state: validate
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete an existing delta analysis
  cisco.nd.nd_delta_analysis:
    insights_group: exampleIG
    site_name: siteName
    name: testDeltaAnalysis
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Queries existing delta analysis jobs
  cisco.nd.nd_delta_analysis:
    insights_group: exampleIG
    site_name: siteName
    state: query
  register: query_results
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Queries an specific delta analysis job
  cisco.nd.nd_delta_analysis:
    insights_group: exampleIG
    site_name: siteName
    name: testDeltaAnalysis
    state: query
  register: query_results

Inputs

    
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:
    aliases:
    - job_name
    - delta_name
    description:
    - The name of the delta analysis 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
    - validate
    default: query
    description:
    - Use C(present) or C(absent) for creating or deleting a delta analysis job.
    - Use C(query) for querying existing delta analysis jobs.
    - Use C(validate) to wait for completion, validate and return an error if any unacknowledged
      anomalies (non-info) exist
    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

later_epoch_id:
    aliases:
    - later_epoch_uuid
    - later_epoch
    description:
    - Epoch UUID for the later epoch
    - Ignored if state is C(query) or C(absent)
    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

earlier_epoch_id:
    aliases:
    - earlier_epoch_uuid
    - earlier_epoch
    description:
    - Epoch UUID for the earlier epoch
    - Ignored if state is C(query) or C(absent)
    type: str

later_epoch_time:
    description:
    - Epoch collection time, in ISO format, for the later epoch
    - Ignored if state is C(query) or C(absent)
    type: str

earlier_epoch_time:
    description:
    - Epoch collection time, in ISO format, for the earlier epoch
    - Ignored if state is C(query) or C(absent)
    type: str