mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
829c0b8f62
* Update validate-modules * Validates ANSIBLE_METADATA * Ensures imports happen after documentation vars * Some pep8 cleanup * Clean up some left over unneeded code * Update modules for new module guidelines and validate-modules checks * Update imports for ec2_vpc_route_table and ec2_vpc_nat_gateway
126 lines
4 KiB
Python
126 lines
4 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (c) 2016 Red Hat, Inc.
|
|
#
|
|
# 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/>.
|
|
#
|
|
|
|
ANSIBLE_METADATA = {'status': ['preview'],
|
|
'supported_by': 'community',
|
|
'version': '1.0'}
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: ovirt_vms_facts
|
|
short_description: Retrieve facts about one or more oVirt virtual machines
|
|
author: "Ondra Machacek (@machacekondra)"
|
|
version_added: "2.3"
|
|
description:
|
|
- "Retrieve facts about one or more oVirt virtual machines."
|
|
notes:
|
|
- "This module creates a new top-level C(ovirt_vms) fact, which
|
|
contains a list of virtual machines."
|
|
options:
|
|
pattern:
|
|
description:
|
|
- "Search term which is accepted by oVirt search backend."
|
|
- "For example to search VM X from cluster Y use following pattern:
|
|
name=X and cluster=Y"
|
|
all_content:
|
|
description:
|
|
- "If I(true) all the attributes of the virtual machines should be
|
|
included in the response."
|
|
case_sensitive:
|
|
description:
|
|
- "If I(true) performed search will take case into account."
|
|
max:
|
|
description:
|
|
- "The maximum number of results to return."
|
|
extends_documentation_fragment: ovirt_facts
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Examples don't contain auth parameter for simplicity,
|
|
# look at ovirt_auth module to see how to reuse authentication:
|
|
|
|
# Gather facts about all VMs which names start with C(centos) and
|
|
# belong to cluster C(west):
|
|
- ovirt_vms_facts:
|
|
pattern: name=centos* and cluster=west
|
|
- debug:
|
|
var: ovirt_vms
|
|
'''
|
|
|
|
RETURN = '''
|
|
ovirt_vms:
|
|
description: "List of dictionaries describing the VMs. VM attribues are mapped to dictionary keys,
|
|
all VMs attributes can be found at following url: https://ovirt.example.com/ovirt-engine/api/model#types/vm."
|
|
returned: On success.
|
|
type: list
|
|
'''
|
|
|
|
import traceback
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.ovirt import (
|
|
check_sdk,
|
|
create_connection,
|
|
get_dict_of_struct,
|
|
ovirt_facts_full_argument_spec,
|
|
)
|
|
|
|
|
|
def main():
|
|
argument_spec = ovirt_facts_full_argument_spec(
|
|
pattern=dict(default='', required=False),
|
|
all_content=dict(default=False, type='bool'),
|
|
case_sensitive=dict(default=True, type='bool'),
|
|
max=dict(default=None, type='int'),
|
|
)
|
|
module = AnsibleModule(argument_spec)
|
|
check_sdk(module)
|
|
|
|
try:
|
|
connection = create_connection(module.params.pop('auth'))
|
|
vms_service = connection.system_service().vms_service()
|
|
vms = vms_service.list(
|
|
search=module.params['pattern'],
|
|
all_content=module.params['all_content'],
|
|
case_sensitive=module.params['case_sensitive'],
|
|
max=module.params['max'],
|
|
)
|
|
module.exit_json(
|
|
changed=False,
|
|
ansible_facts=dict(
|
|
ovirt_vms=[
|
|
get_dict_of_struct(
|
|
struct=c,
|
|
connection=connection,
|
|
fetch_nested=module.params.get('fetch_nested'),
|
|
attributes=module.params.get('nested_attributes'),
|
|
) for c in vms
|
|
],
|
|
),
|
|
)
|
|
except Exception as e:
|
|
module.fail_json(msg=str(e), exception=traceback.format_exc())
|
|
finally:
|
|
connection.close(logout=False)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|