vcf_vim_vm_power

Execution module for VM power lifecycle (A4).

saltext.vcf.modules.vcf_vim_vm_power.get_power_state(vm, profile=None)[source]

Return poweredOn / poweredOff / suspended.

CLI Example:

salt '*' vcf_vim_vm_power.get_power_state <vm-name-or-moid>
saltext.vcf.modules.vcf_vim_vm_power.power_on(vm, host=None, profile=None)[source]

Hard power-on.

CLI Example:

salt '*' vcf_vim_vm_power.power_on <vm>
saltext.vcf.modules.vcf_vim_vm_power.power_off(vm, profile=None)[source]

Hard power-off.

CLI Example:

salt '*' vcf_vim_vm_power.power_off <vm>
saltext.vcf.modules.vcf_vim_vm_power.shutdown_guest(vm, profile=None)[source]

Graceful ACPI shutdown via VMware Tools.

CLI Example:

salt '*' vcf_vim_vm_power.shutdown_guest <vm>
saltext.vcf.modules.vcf_vim_vm_power.reboot_guest(vm, profile=None)[source]

Graceful reboot via VMware Tools.

CLI Example:

salt '*' vcf_vim_vm_power.reboot_guest <vm>
saltext.vcf.modules.vcf_vim_vm_power.standby_guest(vm, profile=None)[source]

Standby/suspend via VMware Tools.

CLI Example:

salt '*' vcf_vim_vm_power.standby_guest <vm>
saltext.vcf.modules.vcf_vim_vm_power.reset(vm, profile=None)[source]

Hard reset.

CLI Example:

salt '*' vcf_vim_vm_power.reset <vm>
saltext.vcf.modules.vcf_vim_vm_power.suspend(vm, profile=None)[source]

Suspend to disk.

CLI Example:

salt '*' vcf_vim_vm_power.suspend <vm>
saltext.vcf.modules.vcf_vim_vm_power.get_tools_status(vm, profile=None)[source]

Return VMware Tools status snapshot.

CLI Example:

salt '*' vcf_vim_vm_power.get_tools_status <vm>
saltext.vcf.modules.vcf_vim_vm_power.upgrade_tools(vm, installer_options='', profile=None)[source]

Upgrade VMware Tools in-guest.

CLI Example:

salt '*' vcf_vim_vm_power.upgrade_tools <vm>
saltext.vcf.modules.vcf_vim_vm_power.mount_tools_installer(vm, profile=None)[source]

Attach the VMware Tools installer CD-ROM.

CLI Example:

salt '*' vcf_vim_vm_power.mount_tools_installer <vm>
saltext.vcf.modules.vcf_vim_vm_power.unmount_tools_installer(vm, profile=None)[source]

Detach the VMware Tools installer CD-ROM.

CLI Example:

salt '*' vcf_vim_vm_power.unmount_tools_installer <vm>