community.skydive.skydive (1.0.0) — lookup

Install collection

Install with ansible-galaxy collection install community.skydive:==1.0.0

Add to requirements.yml

  collections:
    - name: community.skydive
      version: 1.0.0

Description

Uses the Skydive python REST client to return the queried object from Skydive network analyzer.

Requirements

• skydive-client

Usage examples

Scanned by Steampunk Spotter

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

- name: return skydive metdata if present based on Name
  set_fact:
    skydive_meta: >-
        {{ lookup('community.skydive.skydive', filter={'query': "G.V().Has('Name', 'sumit-VirtualBox')"}) }}

Scanned by Steampunk Spotter

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

- name: return all the skydive metdata having parameter Name
  set_fact:
    skydive: >-
        {{ lookup('community.skydive.skydive', filter={'query': "G.V().Has('Name')"},
                      provider={'endpoint': 'localhost:8082', 'username': 'admin', 'password': 'password'}) }}

Inputs

    
filter:
    description: a dict object that is used to filter the return objects

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      endpoint:
        description:
        - Specifies the hostname/address along with the port as C(localhost:8082)for connecting
          to the remote instance of SKYDIVE client over the REST API.
        required: true
      insecure:
        default: false
        description:
        - Ignore SSL certification verification.
        type: bool
      password:
        description:
        - Specifies the password to use to authenticate the connection to the remote instance
          of SKYDIVE client.
      ssl:
        default: false
        description:
        - Specifies the ssl parameter that decides if the connection type shall be http
          or https.
        type: bool
      user:
        description:
        - Configures the username to use to authenticate the connection to the remote
          instance of SKYDIVE client.

Outputs

_list:
  description:
  - The list of queried object metadata
  returned: always
  type: list