File: //lib/python3.9/site-packages/ansible_collections/community/skydive/plugins/lookup/skydive.py
#
# Copyright 2018 Red Hat | Ansible
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = r"""
lookup: skydive
short_description: Query Skydive objects
description:
- Uses the Skydive python REST client to return the queried object from Skydive network
analyzer.
requirements:
- skydive-client
extends_documentation_fragment:
- community.skydive.skydive
options:
filter:
description: a dict object that is used to filter the return objects
"""
EXAMPLES = r"""
- 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 = r"""
_list:
description:
- The list of queried object metadata
returned: always
type: list
"""
from ansible.plugins.lookup import LookupBase
from ansible_collections.community.skydive.plugins.module_utils.network.skydive.api import (
skydive_lookup,
)
from ansible.module_utils._text import to_text
from ansible.errors import AnsibleError
class LookupModule(LookupBase):
def run(self, terms, variables=None, **kwargs):
provider = kwargs.pop("provider", {})
filter_data = kwargs.pop("filter", {})
try:
skydive_obj = skydive_lookup(provider)
result = skydive_obj.lookup_query(filter_data)
except Exception as exc:
raise AnsibleError(to_text(exc))
return [result]