vcf_vim_vm

Execution module for VM clone + create + reconfigure (SOAP).

saltext.vcf.modules.vcf_vim_vm.clone(source, name, folder=None, datastore=None, host=None, resource_pool=None, cluster=None, template=False, power_on=False, cpu_count=None, memory_mb=None, annotation=None, profile=None)

Clone source VM/template into a new VM named name.

CLI Example:

salt '*' vcf_vim_vm.clone tmpl-rhel9 web-01 folder=group-v3 datastore=datastore-13 cluster=domain-c9 power_on=true

saltext.vcf.modules.vcf_vim_vm.create(name, folder, datastore, cpu_count=1, memory_mb=1024, guest_id='otherGuest64', cluster=None, host=None, resource_pool=None, annotation='', profile=None)

Create a bare VM (no disks, no NICs).

CLI Example:

salt '*' vcf_vim_vm.create blank-vm group-v3 datastore-13 cluster=domain-c9 cpu_count=2 memory_mb=4096

saltext.vcf.modules.vcf_vim_vm.reconfigure(vm, cpu_count=None, cores_per_socket=None, memory_mb=None, annotation=None, advanced_settings=None, profile=None)

Adjust VM hardware/metadata. Only non-None fields are touched.

CLI Example:

salt '*' vcf_vim_vm.reconfigure vm-100 cpu_count=4 memory_mb=8192

saltext.vcf.modules.vcf_vim_vm.get_advanced_settings(vm, profile=None)

Return VM extraConfig as a flat dict.

CLI Example:

salt '*' vcf_vim_vm.get_advanced_settings vm-100

saltext.vcf.modules.vcf_vim_vm.destroy(vm, profile=None)

Power off (if needed) and destroy the VM.

CLI Example:

salt '*' vcf_vim_vm.destroy vm-100

saltext.vcf.modules.vcf_vim_vm.mark_as_template(vm, profile=None)

Convert a VM into a template.

CLI Example:

salt '*' vcf_vim_vm.mark_as_template vm-100

saltext.vcf.modules.vcf_vim_vm.mark_as_virtual_machine(template, resource_pool, host=None, profile=None)

Convert a template back into a VM.

CLI Example:

salt '*' vcf_vim_vm.mark_as_virtual_machine tmpl-rhel9 resgroup-c9

saltext.vcf.modules.vcf_vim_vm.instant_clone(source, name, folder=None, datastore=None, host=None, resource_pool=None, extra_config=None, profile=None)

Instant-clone a running source VM into a new VM named name.

CLI Example:

salt '*' vcf_vim_vm.instant_clone <source> <name>

saltext.vcf.modules.vcf_vim_vm.move_to_folder(vm, folder, profile=None)

Reparent vm under folder.

CLI Example:

salt '*' vcf_vim_vm.move_to_folder <vm> <folder>

saltext.vcf.modules.vcf_vim_vm.register(vmx_path, name, folder, resource_pool=None, cluster=None, host=None, as_template=False, profile=None)

Register an existing .vmx file as a new VM in inventory.

CLI Example:

salt '*' vcf_vim_vm.register '[ds1] vm/vm.vmx' <name> <folder> cluster=<cluster>

saltext.vcf.modules.vcf_vim_vm.unregister(vm, profile=None)

Remove a VM from inventory without deleting its files.

CLI Example:

salt '*' vcf_vim_vm.unregister <vm>