salt.modules.smartos_virt¶

Module for managing VMs on SmartOS

salt.modules.smartos_virt.create(domain)¶

Deprecated since version Boron: Use start() instead.

Start a defined domain

CLI Example:

salt '*' virt.create <domain>

salt.modules.smartos_virt.destroy(domain)¶

Deprecated since version Boron: Use stop() instead.

Power off a defined domain

CLI Example:

salt '*' virt.destroy <domain>

salt.modules.smartos_virt.get_macs(uuid)¶

Return a list off MAC addresses from the named VM

CLI Example:

salt '*' virt.get_macs <uuid>

salt.modules.smartos_virt.init(**kwargs)¶

Initialize a new VM

CLI Example:

salt '*' virt.init image_uuid='...' alias='...' [...]

salt.modules.smartos_virt.list_active_vms()¶

Return a list of uuids for active virtual machine on the minion

CLI Example:

salt '*' virt.list_active_vms

salt.modules.smartos_virt.list_domains()¶

Return a list of virtual machine names on the minion

CLI Example:

salt '*' virt.list_domains

salt.modules.smartos_virt.list_inactive_vms()¶

Return a list of uuids for inactive virtual machine on the minion

CLI Example:

salt '*' virt.list_inactive_vms

salt.modules.smartos_virt.list_vms()¶

Deprecated since version Boron: Use list_domains() instead.

List all virtual machines.

CLI Example:

salt '*' virt.list_vms <domain>

salt.modules.smartos_virt.reboot(uuid)¶

Reboot a domain via ACPI request

CLI Example:

salt '*' virt.reboot <uuid>

salt.modules.smartos_virt.setmem(uuid, memory)¶

Change the amount of memory allocated to VM. <memory> is to be specified in MB.

Note for KVM : this would require a restart of the VM.

CLI Example:

salt '*' virt.setmem <uuid> 512

salt.modules.smartos_virt.shutdown(uuid)¶

Send a soft shutdown signal to the named vm

CLI Example:

salt '*' virt.shutdown <uuid>

salt.modules.smartos_virt.start(uuid)¶

Start a defined domain

CLI Example:

salt '*' virt.start <uuid>

salt.modules.smartos_virt.stop(uuid)¶

Hard power down the virtual machine, this is equivalent to powering off the hardware.

CLI Example:

salt '*' virt.destroy <uuid>

salt.modules.smartos_virt.vm_info(uuid)¶

Return a dict with information about the specified VM on this CN

CLI Example:

salt '*' virt.vm_info <uuid>

salt.modules.smartos_virt.vm_virt_type(uuid)¶

Return VM virtualization type : OS or KVM

CLI Example:

salt '*' virt.vm_virt_type <uuid>