#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright: (c) 2021, Ansible Project # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) # template: header.j2 # This module is autogenerated using the ansible.content_builder. # See: https://github.com/ansible-community/ansible.content_builder DOCUMENTATION = r""" module: vcenter_folder_info short_description: Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec. description: Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec. options: datacenters: aliases: - filter_datacenters description: - Datacenters that must contain the folder for the folder to match the filter. - If unset or empty, folder in any datacenter match the filter. - When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by M(vmware.vmware_rest.vcenter_datacenter_info). elements: str type: list folders: aliases: - filter_folders description: - Identifiers of folders that can match the filter. - If unset or empty, folders with any identifier match the filter. - When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by M(vmware.vmware_rest.vcenter_folder_info). elements: str type: list names: aliases: - filter_names description: - Names that folders must have to match the filter (see I(name)). - If unset or empty, folders with any name match the filter. elements: str type: list parent_folders: description: - Folders that must contain the folder for the folder to match the filter. - If unset or empty, folder in any folder match the filter. - When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by M(vmware.vmware_rest.vcenter_folder_info). elements: str type: list session_timeout: description: - 'Timeout settings for client session. ' - 'The maximal number of seconds for the whole operation including connection establishment, request sending and response. ' - The default value is 300s. type: float version_added: 2.1.0 type: aliases: - filter_type choices: - DATACENTER - DATASTORE - HOST - NETWORK - VIRTUAL_MACHINE description: - The I(type) enumerated type defines the type of a vCenter Server folder. The type of a folder determines what what kinds of children can be contained in the folder. type: str vcenter_hostname: description: - The hostname or IP address of the vSphere vCenter - If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead. required: true type: str vcenter_password: description: - The vSphere vCenter password - If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead. required: true type: str vcenter_rest_log_file: description: - 'You can use this optional parameter to set the location of a log file. ' - 'This file will be used to record the HTTP REST interaction. ' - 'The file will be stored on the host that runs the module. ' - 'If the value is not specified in the task, the value of ' - environment variable C(VMWARE_REST_LOG_FILE) will be used instead. type: str vcenter_username: description: - The vSphere vCenter username - If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead. required: true type: str vcenter_validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead. type: bool author: - Ansible Cloud Team (@ansible-collections) version_added: 0.1.0 requirements: - vSphere 7.0.3 or greater - python >= 3.6 - aiohttp notes: - Tested on vSphere 7.0.3 """ EXAMPLES = r""" - name: Build a list of all the folders vmware.vmware_rest.vcenter_folder_info: register: my_folders - name: Build a list of all the folders with the type VIRTUAL_MACHINE and called vm vmware.vmware_rest.vcenter_folder_info: filter_type: VIRTUAL_MACHINE filter_names: - vm register: my_folders """ RETURN = r""" # content generated by the update_return_section callback# task: Build a list of all the folders with the type VIRTUAL_MACHINE and called vm value: description: Build a list of all the folders with the type VIRTUAL_MACHINE and called vm returned: On success sample: - folder: group-v1002 name: vm type: VIRTUAL_MACHINE type: list """ # This structure describes the format of the data expected by the end-points PAYLOAD_FORMAT = { "list": { "query": { "datacenters": "datacenters", "folders": "folders", "names": "names", "parent_folders": "parent_folders", "type": "type", }, "body": {}, "path": {}, } } # pylint: disable=line-too-long from ansible.module_utils.basic import env_fallback try: from ansible_collections.cloud.common.plugins.module_utils.turbo.exceptions import ( EmbeddedModuleFailure, ) from ansible_collections.cloud.common.plugins.module_utils.turbo.module import ( AnsibleTurboModule as AnsibleModule, ) AnsibleModule.collection_name = "vmware.vmware_rest" except ImportError: from ansible.module_utils.basic import AnsibleModule from ansible_collections.vmware.vmware_rest.plugins.module_utils.vmware_rest import ( gen_args, open_session, session_timeout, update_changed_flag, ) def prepare_argument_spec(): argument_spec = { "vcenter_hostname": dict( type="str", required=True, fallback=(env_fallback, ["VMWARE_HOST"]), ), "vcenter_username": dict( type="str", required=True, fallback=(env_fallback, ["VMWARE_USER"]), ), "vcenter_password": dict( type="str", required=True, no_log=True, fallback=(env_fallback, ["VMWARE_PASSWORD"]), ), "vcenter_validate_certs": dict( type="bool", required=False, default=True, fallback=(env_fallback, ["VMWARE_VALIDATE_CERTS"]), ), "vcenter_rest_log_file": dict( type="str", required=False, fallback=(env_fallback, ["VMWARE_REST_LOG_FILE"]), ), "session_timeout": dict( type="float", required=False, fallback=(env_fallback, ["VMWARE_SESSION_TIMEOUT"]), ), } argument_spec["datacenters"] = { "aliases": ["filter_datacenters"], "type": "list", "elements": "str", } argument_spec["folders"] = { "aliases": ["filter_folders"], "type": "list", "elements": "str", } argument_spec["names"] = { "aliases": ["filter_names"], "type": "list", "elements": "str", } argument_spec["parent_folders"] = {"type": "list", "elements": "str"} argument_spec["type"] = { "aliases": ["filter_type"], "type": "str", "choices": ["DATACENTER", "DATASTORE", "HOST", "NETWORK", "VIRTUAL_MACHINE"], } return argument_spec async def main(): required_if = list([]) module_args = prepare_argument_spec() module = AnsibleModule( argument_spec=module_args, required_if=required_if, supports_check_mode=True ) if not module.params["vcenter_hostname"]: module.fail_json("vcenter_hostname cannot be empty") if not module.params["vcenter_username"]: module.fail_json("vcenter_username cannot be empty") if not module.params["vcenter_password"]: module.fail_json("vcenter_password cannot be empty") try: session = await open_session( vcenter_hostname=module.params["vcenter_hostname"], vcenter_username=module.params["vcenter_username"], vcenter_password=module.params["vcenter_password"], validate_certs=module.params["vcenter_validate_certs"], log_file=module.params["vcenter_rest_log_file"], ) except EmbeddedModuleFailure as err: module.fail_json(err.get_message()) result = await entry_point(module, session) module.exit_json(**result) # template: info_list_and_get_module.j2 def build_url(params): import yarl _in_query_parameters = PAYLOAD_FORMAT["list"]["query"].keys() return yarl.URL( ("https://{vcenter_hostname}" "/api/vcenter/folder").format(**params) + gen_args(params, _in_query_parameters), encoded=True, ) async def entry_point(module, session): url = build_url(module.params) async with session.get(url, **session_timeout(module.params)) as resp: _json = await resp.json() if "value" not in _json: # 7.0.2+ _json = {"value": _json} return await update_changed_flag(_json, resp.status, "get") if __name__ == "__main__": import asyncio current_loop = asyncio.new_event_loop() try: asyncio.set_event_loop(current_loop) current_loop.run_until_complete(main()) finally: current_loop.close()