diff options
Diffstat (limited to 'lib/ansible/modules/cloud/ovirt/ovirt_vm_info.py')
-rw-r--r-- | lib/ansible/modules/cloud/ovirt/ovirt_vm_info.py | 160 |
1 files changed, 0 insertions, 160 deletions
diff --git a/lib/ansible/modules/cloud/ovirt/ovirt_vm_info.py b/lib/ansible/modules/cloud/ovirt/ovirt_vm_info.py deleted file mode 100644 index 9e5a1edff2..0000000000 --- a/lib/ansible/modules/cloud/ovirt/ovirt_vm_info.py +++ /dev/null @@ -1,160 +0,0 @@ -#!/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 = {'metadata_version': '1.1', - 'status': ['preview'], - 'supported_by': 'community'} - - -DOCUMENTATION = ''' ---- -module: ovirt_vm_info -short_description: Retrieve information about one or more oVirt/RHV virtual machines -author: "Ondra Machacek (@machacekondra)" -version_added: "2.3" -description: - - "Retrieve information about one or more oVirt/RHV virtual machines." - - This module was called C(ovirt_vm_facts) before Ansible 2.9, returning C(ansible_facts). - Note that the M(ovirt_vm_info) module no longer returns C(ansible_facts)! -notes: - - "This module returns a variable C(ovirt_vms), which - contains a list of virtual machines. You need to register the result with - the I(register) keyword to use it." -options: - pattern: - description: - - "Search term which is accepted by oVirt/RHV 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." - type: bool - case_sensitive: - description: - - "If I(true) performed search will take case into account." - type: bool - default: true - max: - description: - - "The maximum number of results to return." - next_run: - description: - - "Indicates if the returned result describes the virtual machine as it is currently running or if describes - the virtual machine with the modifications that have already been performed but that will only come into - effect when the virtual machine is restarted. By default the value is set by engine." - type: bool - version_added: "2.8" -extends_documentation_fragment: ovirt_info -''' - -EXAMPLES = ''' -# Examples don't contain auth parameter for simplicity, -# look at ovirt_auth module to see how to reuse authentication: - -# Gather information about all VMs which names start with C(centos) and -# belong to cluster C(west): -- ovirt_vm_info: - pattern: name=centos* and cluster=west - register: result -- debug: - msg: "{{ result.ovirt_vms }}" - -# Gather info about next run configuration of virtual machine named myvm -- ovirt_vm_info: - pattern: name=myvm - next_run: true - register: result -- debug: - msg: "{{ result.ovirt_vms[0] }}" -''' - -RETURN = ''' -ovirt_vms: - description: "List of dictionaries describing the VMs. VM attributes are mapped to dictionary keys, - all VMs attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#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_info_full_argument_spec, -) - - -def main(): - argument_spec = ovirt_info_full_argument_spec( - pattern=dict(default='', required=False), - all_content=dict(default=False, type='bool'), - next_run=dict(default=None, type='bool'), - case_sensitive=dict(default=True, type='bool'), - max=dict(default=None, type='int'), - ) - module = AnsibleModule(argument_spec) - is_old_facts = module._name == 'ovirt_vm_facts' - if is_old_facts: - module.deprecate("The 'ovirt_vm_facts' module has been renamed to 'ovirt_vm_info', " - "and the renamed one no longer returns ansible_facts", version='2.13') - - check_sdk(module) - - try: - auth = module.params.pop('auth') - connection = create_connection(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'], - ) - if module.params['next_run']: - vms = [vms_service.vm_service(vm.id).get(next_run=True) for vm in vms] - - result = 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 - ], - ) - if is_old_facts: - module.exit_json(changed=False, ansible_facts=result) - else: - module.exit_json(changed=False, **result) - except Exception as e: - module.fail_json(msg=str(e), exception=traceback.format_exc()) - finally: - connection.close(logout=auth.get('token') is None) - - -if __name__ == '__main__': - main() |