vcf_vcenter_vm

Execution module for vCenter VMs.

saltext.vcf.modules.vcf_vcenter_vm.list_(profile=None)

List VMs known to vCenter.

CLI Example:

salt '*' vcf_vcenter_vm.list_

saltext.vcf.modules.vcf_vcenter_vm.get(vm, profile=None)

Return details for a single VM by id.

CLI Example:

salt '*' vcf_vcenter_vm.get <vm>

saltext.vcf.modules.vcf_vcenter_vm.power_on(vm, profile=None)

Power on a VM.

CLI Example:

salt '*' vcf_vcenter_vm.power_on <vm>

saltext.vcf.modules.vcf_vcenter_vm.power_off(vm, profile=None)

Power off a VM (hard stop).

CLI Example:

salt '*' vcf_vcenter_vm.power_off <vm>

saltext.vcf.modules.vcf_vcenter_vm.reset(vm, profile=None)

Reset a VM (hard reset).

CLI Example:

salt '*' vcf_vcenter_vm.reset <vm>

saltext.vcf.modules.vcf_vcenter_vm.search(power_states=None, names=None, hosts=None, clusters=None, folders=None, datacenters=None, resource_pools=None, vms=None, profile=None)

Server-side VM filtering.

Pass any combination of power_states, names, hosts, clusters, folders, datacenters, resource_pools, vms as lists. Returns the same shape as list_().

CLI Example:

salt '*' vcf_vcenter_vm.search power_states='[POWERED_ON]'

saltext.vcf.modules.vcf_vcenter_vm.tree(profile=None)

Return a nested {datacenter: {clusters: {cluster: {hosts: {host: {vms: [...]}}}}}} map.

CLI Example:

salt '*' vcf_vcenter_vm.tree

saltext.vcf.modules.vcf_vcenter_vm.summary(profile=None)

Aggregate counts: total, by_power_state, by_cpu_count, total_memory_MiB.

CLI Example:

salt '*' vcf_vcenter_vm.summary