community.skydive.skydive – Query Skydive objects

Note

This plugin is part of the community.skydive collection (version 1.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.skydive.

To use it in a playbook, specify: community.skydive.skydive.

Synopsis

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

Requirements

The below requirements are needed on the local controller node that executes this lookup.

  • skydive-client

Parameters

Parameter Choices/Defaults Configuration Comments
filter
string
a dict object that is used to filter the return objects
provider
string
A dict object containing connection details.
endpoint
string / required
Specifies the hostname/address along with the port as localhost:8082for connecting to the remote instance of SKYDIVE client over the REST API.
insecure
boolean
    Choices:
  • no ←
  • yes
Ignore SSL certification verification.
password
string
Specifies the password to use to authenticate the connection to the remote instance of SKYDIVE client.
ssl
boolean
    Choices:
  • no ←
  • yes
Specifies the ssl parameter that decides if the connection type shall be http or https.
user
string
Configures the username to use to authenticate the connection to the remote instance of SKYDIVE client.

Notes

Note

  • This module must be run locally, which can be achieved by specifying connection: local.

Examples

- 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')"}) }}

- 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'}) }}

Return Values

Common return values are documented here, the following are the fields unique to this lookup:

Key Returned Description
_list
list / elements=string
always
The list of queried object metadata