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 |
Comments |
---|---|
a dict object that is used to filter the return objects |
|
A dict object containing connection details. |
|
Specifies the hostname/address along with the port as |
|
Ignore SSL certification verification. Choices:
|
|
Specifies the password to use to authenticate the connection to the remote instance of SKYDIVE client. |
|
Specifies the ssl parameter that decides if the connection type shall be http or https. Choices:
|
|
Configures the username to use to authenticate the connection to the remote instance of SKYDIVE client. |
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 |
Description |
---|---|
The list of queried object metadata Returned: always |