vcf_vim_vm_devices

Execution module for niche VM virtual devices (vTPM, vGPU, video, serial).

saltext.vcf.modules.vcf_vim_vm_devices.tpm_list(vm, profile=None)

List vTPM devices on vm.

CLI Example:

salt '*' vcf_vim_vm_devices.tpm_list <vm>

saltext.vcf.modules.vcf_vim_vm_devices.tpm_add(vm, profile=None)

Add a vTPM 2.0 device to vm (must be powered off).

CLI Example:

salt '*' vcf_vim_vm_devices.tpm_add <vm>

saltext.vcf.modules.vcf_vim_vm_devices.tpm_remove(vm, profile=None)

Remove the vTPM device from vm.

CLI Example:

salt '*' vcf_vim_vm_devices.tpm_remove <vm>

saltext.vcf.modules.vcf_vim_vm_devices.vgpu_list(vm, profile=None)

List vGPU devices on vm.

CLI Example:

salt '*' vcf_vim_vm_devices.vgpu_list <vm>

saltext.vcf.modules.vcf_vim_vm_devices.vgpu_add(vm, profile_name, profile=None)

Attach a vGPU device with profile_name (e.g. grid_a100d-8c).

CLI Example:

salt '*' vcf_vim_vm_devices.vgpu_add <vm> grid_a100d-8c

saltext.vcf.modules.vcf_vim_vm_devices.vgpu_remove(vm, profile_name=None, profile=None)

Remove a vGPU device. If profile_name given, only that one.

CLI Example:

salt '*' vcf_vim_vm_devices.vgpu_remove <vm>

saltext.vcf.modules.vcf_vim_vm_devices.video_get(vm, profile=None)

Return the VM’s video card config.

CLI Example:

salt '*' vcf_vim_vm_devices.video_get <vm>

saltext.vcf.modules.vcf_vim_vm_devices.video_update(vm, video_ram_size_kb=None, num_displays=None, enable_3d_support=None, graphics_memory_size_kb=None, profile=None)

Update the VM’s video card.

CLI Example:

salt '*' vcf_vim_vm_devices.video_update <vm> num_displays=2

saltext.vcf.modules.vcf_vim_vm_devices.serial_list(vm, profile=None)

List serial ports on vm.

CLI Example:

salt '*' vcf_vim_vm_devices.serial_list <vm>

saltext.vcf.modules.vcf_vim_vm_devices.serial_add(vm, backing='network', uri=None, direction='server', file_path=None, profile=None)

Add a serial port.

CLI Example:

salt '*' vcf_vim_vm_devices.serial_add <vm> backing=network uri=tcp://0.0.0.0:9000

saltext.vcf.modules.vcf_vim_vm_devices.serial_remove(vm, key=None, profile=None)

Remove a serial port by key, or the first one if key is None.

CLI Example:

salt '*' vcf_vim_vm_devices.serial_remove <vm>

saltext.vcf.modules.vcf_vim_vm_devices.usb_controllers_list(vm, profile=None)

List USB controller devices on vm.

CLI Example:

salt '*' vcf_vim_vm_devices.usb_controllers_list <vm>

saltext.vcf.modules.vcf_vim_vm_devices.usb_controllers_remove(vm, profile=None)

Remove all USB controller devices from vm.

CLI Example:

salt '*' vcf_vim_vm_devices.usb_controllers_remove <vm>

saltext.vcf.modules.vcf_vim_vm_devices.list_vms_with_usb_controllers(profile=None)

List every VM in the inventory that has a USB controller device.

CLI Example:

salt '*' vcf_vim_vm_devices.list_vms_with_usb_controllers