#!/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_vmtemplate_libraryitems short_description: Creates a library item in content library from a virtual machine description: Creates a library item in content library from a virtual machine. This operation creates a library item in content library whose content is a virtual machine template created from the source virtual machine, using the supplied create specification. The virtual machine template is stored in a newly created library item. options: description: description: - Description of the deployed virtual machine. - If unset, the deployed virtual machine has the same description as the source library item. type: str disk_storage: description: - Storage specification for the deployed virtual machine's disks. - 'If both I(disk_storage_overrides) and I(disk_storage) are unset, the deployed virtual machine''s disks are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item. ' - ' If I(disk_storage_overrides) is unset and I(disk_storage) is specified, all of the deployed virtual machine''s disks are created with the storage spec specified by I(disk_storage). ' - '' - ' If I(disk_storage_overrides) is specified and I(disk_storage) is unset, disks with identifiers that are not in I(disk_storage_overrides) are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item. ' - '' - ' If both I(disk_storage_overrides) and I(disk_storage) are specified, disks with identifiers that are not in I(disk_storage_overrides) are created with the storage spec specified by I(disk_storage).' - 'Valid attributes are:' - ' - C(datastore) (str): Identifier for the datastore associated the deployed virtual machine''s disk.' - 'This field is currently required. ' - ' If I(storage_policy) is also specified and is incompatible with the I(datastore), then the disk will be flagged as being out of compliance with the specified storage policy.' - '' - When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by M(vmware.vmware_rest.vcenter_datastore_info). (['deploy', 'present']) - ' - C(storage_policy) (dict): Storage policy for the deployed virtual machine''s disk.' - If unset, I(datastore) must be specified and the deployed virtual machine's disk is created with the default storage policy associated with the I(datastore). (['deploy', 'present']) - ' - Accepted keys:' - ' - type (string): Policy type for a virtual machine template''s disk.' - 'Accepted value for this field:' - ' - C(USE_SPECIFIED_POLICY)' - ' - policy (string): Identifier for the storage policy to use.' - This field is optional and it is only relevant when the value of I(type) is USE_SPECIFIED_POLICY. - 'When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by M(vmware.vmware_rest.vcenter_storage_policies_info). ' type: dict disk_storage_overrides: description: - Storage specification for individual disks in the deployed virtual machine. This is specified as a mapping between disk identifiers in the source virtual machine template contained in the library item and their storage specifications. - 'If both I(disk_storage_overrides) and I(disk_storage) are unset, the deployed virtual machine''s disks are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item. ' - ' If I(disk_storage_overrides) is unset and I(disk_storage) is specified, all of the deployed virtual machine''s disks are created with the storage spec specified by I(disk_storage). ' - '' - ' If I(disk_storage_overrides) is specified and I(disk_storage) is unset, disks with identifiers that are not in I(disk_storage_overrides) are created with the same storage spec as the corresponding disks in the source virtual machine template contained in the library item. ' - '' - ' If both I(disk_storage_overrides) and I(disk_storage) are specified, disks with identifiers that are not in I(disk_storage_overrides) are created with the storage spec specified by I(disk_storage). ' - '' - 'When clients pass a value of this structure as a parameter, the key in the field map must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_hardware_disk). ' type: dict guest_customization: description: - Guest customization spec to apply to the deployed virtual machine. - If unset, the guest operating system is not customized after deployment. - 'Valid attributes are:' - ' - C(name) (str): Name of the customization specification.' - If unset, no guest customization is performed. (['deploy']) type: dict hardware_customization: description: - Hardware customization spec which specifies updates to the deployed virtual machine. - If unset, the deployed virtual machine has the same hardware configuration as the source virtual machine template contained in the library item. - 'Valid attributes are:' - ' - C(nics) (dict): Map of Ethernet network adapters to update.' - If unset, all Ethernet adapters will remain connected to the same network as they were in the source virtual machine template. An Ethernet adapter with a MacAddressType of MANUAL will not change. An Ethernet adapter with a MacAddressType of GENERATED or ASSIGNED will receive a new address. - When clients pass a value of this structure as a parameter, the key in the field map must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_hardware_ethernet). (['deploy']) - ' - C(disks_to_remove) (list): Idenfiers of disks to remove from the deployed virtual machine.' - If unset, all disks will be copied. - 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_vm_hardware_disk). (['deploy']) - ' - C(disks_to_update) (dict): Disk update specification for individual disks in the deployed virtual machine.' - If unset, disks in the deployed virtual machine will have the same settings as the corresponding disks in the source virtual machine template contained in the library item. - When clients pass a value of this structure as a parameter, the key in the field map must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_hardware_disk). (['deploy']) - ' - C(cpu_update) (dict): CPU update specification for the deployed virtual machine.' - If {@term.unset}, the deployed virtual machine has the same CPU settings as the source virtual machine template contained in the library item. (['deploy']) - ' - Accepted keys:' - ' - num_cpus (integer): Number of virtual processors in the deployed virtual machine.' - If {@term.unset}, the deployed virtual machine has the same CPU count as the source virtual machine template contained in the library item. - ' - num_cores_per_socket (integer): Number of cores among which to distribute CPUs in the deployed virtual machine.' - If {@term.unset}, the deployed virtual machine has the same number of cores per socket as the source virtual machine template contained in the library item. - ' - C(memory_update) (dict): Memory update specification for the deployed virtual machine.' - If {@term.unset}, the deployed virtual machine has the same memory settings as the source virtual machine template contained in the library item. (['deploy']) - ' - Accepted keys:' - ' - memory (integer): Size of a virtual machine''s memory in MB.' - If {@term.unset}, the deployed virtual machine has the same memory size as the source virtual machine template. type: dict library: description: - Identifier of the library in which the new library item should be created. - When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by M(vmware.vmware_rest.content_library_info). Required with I(state=['present']) type: str name: description: - Name of the deployed virtual machine. This parameter is mandatory. required: true type: str placement: description: - Information used to place the deployed virtual machine. - 'This field is currently required. In the future, if this field is unset, the system will use the values from the source virtual machine template contained in the library item. ' - ' If specified, each field will be used for placement. If the fields result in disjoint placement, the operation will fail. If the fields along with the placement values of the source virtual machine template result in disjoint placement, the operation will fail.' - 'Valid attributes are:' - ' - C(folder) (str): Virtual machine folder into which the deployed virtual machine should be placed.' - 'This field is currently required. ' - ' If unset, the system will attempt to choose a suitable folder for the virtual machine; if a folder cannot be chosen, the virtual machine deployment operation will fail. ' - '' - When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by M(vmware.vmware_rest.vcenter_folder_info). (['deploy', 'present']) - ' - C(resource_pool) (str): Resource pool into which the deployed virtual machine should be placed.' - If unset, the system will attempt to choose a suitable resource pool for the virtual machine; if a resource pool cannot be chosen, the virtual machine deployment operation will fail. - When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by M(vmware.vmware_rest.vcenter_resourcepool_info). (['deploy', 'present']) - ' - C(host) (str): Host onto which the virtual machine should be placed. If I(host) and I(resource_pool) are both specified, I(resource_pool) must belong to I(host). If I(host) and I(cluster) are both specified, I(host) must be a member of I(cluster).' - This field may be unset if I(resource_pool) or I(cluster) is specified. If unset, the system will attempt to choose a suitable host for the virtual machine; if a host cannot be chosen, the virtual machine deployment operation will fail. - When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by M(vmware.vmware_rest.vcenter_host_info). (['deploy', 'present']) - ' - C(cluster) (str): Cluster onto which the deployed virtual machine should be placed. If I(cluster) and I(resource_pool) are both specified, I(resource_pool) must belong to I(cluster). If I(cluster) and I(host) are both specified, I(host) must be a member of I(cluster).' - If I(resource_pool) or I(host) is specified, it is recommended that this field be unset. - When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by M(vmware.vmware_rest.vcenter_cluster_info). (['deploy', 'present']) type: dict powered_on: description: - Specifies whether the deployed virtual machine should be powered on after deployment. - If unset, the virtual machine will not be powered on after deployment. type: bool 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 source_vm: description: - Identifier of the source virtual machine to create the library item from. - When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_info). Required with I(state=['present']) type: str state: choices: - deploy - present default: present description: [] type: str template_library_item: description: - identifier of the content library item containing the source virtual machine template to be deployed. - The parameter must be the id of a resource returned by M(vmware.vmware_rest.content_library_item_info). Required with I(state=['deploy']) 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 vm_home_storage: description: - Storage location for the virtual machine template's configuration and log files. - If unset, the virtual machine template's configuration and log files are placed on the default storage backing associated with the library specified by I() - 'Valid attributes are:' - ' - C(datastore) (str): Identifier of the datastore for the deployed virtual machine''s configuration and log files.' - 'This field is currently required. ' - ' When I(storage_policy) is also specified and is incompatible with the I(datastore), then the deployed virtual machine will be flagged as being out of compliance with the specified storage policy.' - '' - When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by M(vmware.vmware_rest.vcenter_datastore_info). (['deploy', 'present']) - ' - C(storage_policy) (dict): Storage policy for the deployed virtual machine''s configuration and log files.' - If unset, I(datastore) must be specified and the deployed virtual machine's configuration and log files are created with the default storage policy associated with the I(datastore). (['deploy', 'present']) - ' - Accepted keys:' - ' - type (string): Policy type for the virtual machine template''s configuration and log files.' - 'Accepted value for this field:' - ' - C(USE_SPECIFIED_POLICY)' - ' - policy (string): Identifier for the storage policy to use.' - This field is optional and it is only relevant when the value of I(type) is USE_SPECIFIED_POLICY. - 'When clients pass a value of this structure as a parameter, the field must be the id of a resource returned by M(vmware.vmware_rest.vcenter_storage_policies_info). ' type: dict author: - Ansible Cloud Team (@ansible-collections) version_added: 2.2.0 requirements: - vSphere 7.0.3 or greater - python >= 3.6 - aiohttp notes: - Tested on vSphere 7.0.3 """ EXAMPLES = r""" - name: Create a VM vmware.vmware_rest.vcenter_vm: placement: cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" name: test_vm1 guest_OS: RHEL_7_64 hardware_version: VMX_11 memory: hot_add_enabled: true size_MiB: 1024 register: my_vm - name: Create a content library based on a DataStore vmware.vmware_rest.content_locallibrary: name: my_library_on_datastore description: automated publish_info: published: true authentication_method: NONE storage_backings: - datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}" type: DATASTORE state: present register: nfs_lib - name: Create a VM template on the library vmware.vmware_rest.vcenter_vmtemplate_libraryitems: name: golden-template library: '{{ nfs_lib.id }}' source_vm: '{{ my_vm.id }}' placement: cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" register: mylib_item - name: Deploy a new VM based on the template vmware.vmware_rest.vcenter_vmtemplate_libraryitems: name: vm-from-template library: '{{ nfs_lib.id }}' template_library_item: '{{ mylib_item.id }}' placement: cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}" folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}" resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}" state: deploy register: my_new_vm """ RETURN = r""" # content generated by the update_return_section callback# task: Create a VM template on the library id: description: moid of the resource returned: On success sample: 9c6df1f5-faba-490c-a8e6-edb72f787ab8 type: str value: description: Create a VM template on the library returned: On success sample: cpu: cores_per_socket: 1 count: 1 disks: '16000': capacity: 32000000000 disk_storage: datastore: datastore-3036 guest_OS: RHEL_7_64 memory: size_MiB: 1024 nics: {} vm_home_storage: datastore: datastore-3036 vm_template: vm-77006 type: dict """ # This structure describes the format of the data expected by the end-points PAYLOAD_FORMAT = { "create": { "query": {}, "body": { "description": "description", "disk_storage": "disk_storage", "disk_storage_overrides": "disk_storage_overrides", "library": "library", "name": "name", "placement": "placement", "source_vm": "source_vm", "vm_home_storage": "vm_home_storage", }, "path": {}, }, "deploy": { "query": {}, "body": { "description": "description", "disk_storage": "disk_storage", "disk_storage_overrides": "disk_storage_overrides", "guest_customization": "guest_customization", "hardware_customization": "hardware_customization", "name": "name", "placement": "placement", "powered_on": "powered_on", "vm_home_storage": "vm_home_storage", }, "path": {"template_library_item": "template_library_item"}, }, } # 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 ( exists, gen_args, get_device_info, 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["description"] = {"type": "str"} argument_spec["disk_storage"] = {"type": "dict"} argument_spec["disk_storage_overrides"] = {"type": "dict"} argument_spec["guest_customization"] = {"type": "dict"} argument_spec["hardware_customization"] = {"type": "dict"} argument_spec["library"] = {"type": "str"} argument_spec["name"] = {"required": True, "type": "str"} argument_spec["placement"] = {"type": "dict"} argument_spec["powered_on"] = {"type": "bool"} argument_spec["source_vm"] = {"type": "str"} argument_spec["state"] = { "type": "str", "choices": ["deploy", "present"], "default": "present", } argument_spec["template_library_item"] = {"type": "str"} argument_spec["vm_home_storage"] = {"type": "dict"} 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: default_module.j2 def build_url(params): return ( "https://{vcenter_hostname}" "/api/vcenter/vm-template/library-items" ).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 _create(params, session): lookup_url = "https://{vcenter_hostname}/api/content/library/item?library_id={library}".format( **params ) per_id_url = "https://{vcenter_hostname}/api/content/library/item".format(**params) uniquity_keys = ["name"] comp_func = None _json = None if params["template_library_item"]: _json = await get_device_info( session, build_url(params), params["template_library_item"] ) if not _json and (uniquity_keys or comp_func): _json = await exists( params, session, url=lookup_url, uniquity_keys=uniquity_keys, per_id_url=per_id_url, comp_func=comp_func, ) if _json: if "value" not in _json: # 7.0.2+ _json = {"value": _json} if "_update" in globals(): params["template_library_item"] = _json["id"] return await globals()["_update"](params, session) extra_info_url = "https://{vcenter_hostname}/api/vcenter/vm-template/library-items/{id}".format( **params, id=_json["id"] ) async with session.get(extra_info_url) as resp: if resp.status == 200: extra_json = await resp.json() for k, v in extra_json.items(): _json["value"][k] = v return await update_changed_flag(_json, 200, "get") payload = prepare_payload(params, PAYLOAD_FORMAT["create"]) _url = ( "https://{vcenter_hostname}" "/api/vcenter/vm-template/library-items" ).format(**params) async with session.post(_url, json=payload, **session_timeout(params)) as resp: if resp.status == 500: text = await resp.text() raise EmbeddedModuleFailure( f"Request has failed: status={resp.status}, {text}" ) try: if resp.headers["Content-Type"] == "application/json": _json = await resp.json() except KeyError: _json = {} if (resp.status in [200, 201]) and "error" not in _json: if isinstance(_json, str): # 7.0.2 and greater _id = _json # TODO: fetch the object elif isinstance(_json, dict) and "value" not in _json: _id = list(_json["value"].values())[0] elif isinstance(_json, dict) and "value" in _json: _id = _json["value"] _json_device_info = await get_device_info(session, _url, _id) if _json_device_info: _json = _json_device_info return await update_changed_flag(_json, resp.status, "create") async def _deploy(params, session): _in_query_parameters = PAYLOAD_FORMAT["deploy"]["query"].keys() payload = prepare_payload(params, PAYLOAD_FORMAT["deploy"]) subdevice_type = get_subdevice_type( "/api/vcenter/vm-template/library-items/{template_library_item}?action=deploy" ) 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-template/library-items/{template_library_item}?action=deploy" ).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, "deploy") 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()