#!/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_vm_hardware short_description: Updates the virtual hardware settings of a virtual machine. description: Updates the virtual hardware settings of a virtual machine. options: 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 state: choices: - present - upgrade default: present description: [] type: str upgrade_policy: choices: - AFTER_CLEAN_SHUTDOWN - ALWAYS - NEVER description: - The I(upgrade_policy) enumerated type defines the valid virtual hardware upgrade policies for a virtual machine. type: str upgrade_version: choices: - VMX_03 - VMX_04 - VMX_06 - VMX_07 - VMX_08 - VMX_09 - VMX_10 - VMX_11 - VMX_12 - VMX_13 - VMX_14 - VMX_15 - VMX_16 - VMX_17 - VMX_18 - VMX_19 - VMX_20 - VMX_21 description: - The I(version) enumerated type defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)). 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 version: choices: - VMX_03 - VMX_04 - VMX_06 - VMX_07 - VMX_08 - VMX_09 - VMX_10 - VMX_11 - VMX_12 - VMX_13 - VMX_14 - VMX_15 - VMX_16 - VMX_17 - VMX_18 - VMX_19 - VMX_20 - VMX_21 description: - The I(version) enumerated type defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)). type: str vm: description: - Virtual machine identifier. - The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_info). This parameter is mandatory. required: true type: str 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: Upgrade the VM hardware version vmware.vmware_rest.vcenter_vm_hardware: upgrade_policy: AFTER_CLEAN_SHUTDOWN upgrade_version: VMX_11 vm: "{{ lookup('vmware.vmware_rest.vm_moid', '/my_dc/vm/test_vm1') }}" register: _result """ RETURN = r""" # content generated by the update_return_section callback# task: Upgrade the VM hardware version id: description: moid of the resource returned: On success sample: null type: dict value: description: Upgrade the VM hardware version returned: On success sample: {} type: dict """ # This structure describes the format of the data expected by the end-points PAYLOAD_FORMAT = { "update": { "query": {}, "body": { "upgrade_policy": "upgrade_policy", "upgrade_version": "upgrade_version", }, "path": {"vm": "vm"}, }, "upgrade": {"query": {}, "body": {"version": "version"}, "path": {"vm": "vm"}}, } # pylint: disable=line-too-long from ansible.module_utils.basic import env_fallback import os if os.getenv("VMWARE_ENABLE_TURBO", False): try: 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 else: from ansible.module_utils.basic import AnsibleModule from ansible_collections.vmware.vmware_rest.plugins.module_utils.vmware_rest import ( exists, gen_args, get_subdevice_type, open_session, prepare_payload, 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["state"] = { "type": "str", "choices": ["present", "upgrade"], "default": "present", } argument_spec["upgrade_policy"] = { "type": "str", "choices": ["AFTER_CLEAN_SHUTDOWN", "ALWAYS", "NEVER"], } argument_spec["upgrade_version"] = { "type": "str", "choices": [ "VMX_03", "VMX_04", "VMX_06", "VMX_07", "VMX_08", "VMX_09", "VMX_10", "VMX_11", "VMX_12", "VMX_13", "VMX_14", "VMX_15", "VMX_16", "VMX_17", "VMX_18", "VMX_19", "VMX_20", "VMX_21", ], } argument_spec["version"] = { "type": "str", "choices": [ "VMX_03", "VMX_04", "VMX_06", "VMX_07", "VMX_08", "VMX_09", "VMX_10", "VMX_11", "VMX_12", "VMX_13", "VMX_14", "VMX_15", "VMX_16", "VMX_17", "VMX_18", "VMX_19", "VMX_20", "VMX_21", ], } argument_spec["vm"] = {"required": True, "type": "str"} 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=False ) 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 Exception as err: if hasattr(err, "get_message"): module.fail_json(err.get_message()) else: module.fail_json(str(err)) result = await entry_point(module, session) module.exit_json(**result) # template: default_module.j2 def build_url(params): return ("https://{vcenter_hostname}" "/api/vcenter/vm/{vm}/hardware").format( **params ) async def entry_point(module, session): if module.params["state"] == "present": if "_create" in globals(): operation = "create" else: operation = "update" elif module.params["state"] == "absent": operation = "delete" else: operation = module.params["state"] func = globals()["_" + operation] return await func(module.params, session) async def _update(params, session): payload = prepare_payload(params, PAYLOAD_FORMAT["update"]) _url = ("https://{vcenter_hostname}" "/api/vcenter/vm/{vm}/hardware").format( **params ) async with session.get(_url, **session_timeout(params)) as resp: _json = await resp.json() if "value" in _json: value = _json["value"] else: # 7.0.2 and greater value = _json for k, v in value.items(): if k in payload: if isinstance(payload[k], dict) and isinstance(v, dict): to_delete = True for _k in list(payload[k].keys()): if payload[k][_k] != v.get(_k): to_delete = False if to_delete: del payload[k] elif payload[k] == v: del payload[k] elif payload[k] == {}: del payload[k] if payload == {} or payload == {"spec": {}}: # Nothing has changed if "value" not in _json: # 7.0.2 _json = {"value": _json} _json["id"] = params.get("None") return await update_changed_flag(_json, resp.status, "get") async with session.patch(_url, json=payload, **session_timeout(params)) as resp: try: if resp.headers["Content-Type"] == "application/json": _json = await resp.json() except KeyError: _json = {} if "value" not in _json: # 7.0.2 _json = {"value": _json} # e.g: content_configuration if not _json and resp.status == 204: async with session.get(_url, **session_timeout(params)) as resp_get: _json_get = await resp_get.json() if _json_get: _json = _json_get _json["id"] = params.get("None") return await update_changed_flag(_json, resp.status, "update") async def _upgrade(params, session): _in_query_parameters = PAYLOAD_FORMAT["upgrade"]["query"].keys() payload = prepare_payload(params, PAYLOAD_FORMAT["upgrade"]) subdevice_type = get_subdevice_type("/api/vcenter/vm/{vm}/hardware?action=upgrade") if subdevice_type and not params[subdevice_type]: _json = await exists(params, session, build_url(params)) if _json: params[subdevice_type] = _json["id"] _url = ( "https://{vcenter_hostname}" # aa "/api/vcenter/vm/{vm}/hardware?action=upgrade" ).format(**params) + gen_args(params, _in_query_parameters) async with session.post(_url, json=payload, **session_timeout(params)) as resp: try: if resp.headers["Content-Type"] == "application/json": _json = await resp.json() except KeyError: _json = {} if "value" not in _json: # 7.0.2 _json = {"value": _json} return await update_changed_flag(_json, resp.status, "upgrade") 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()