salt.modules.smartos_virt

virst compatibility module for managing VMs on SmartOS

salt.modules.smartos_virt.get_macs(domain)

Return a list off MAC addresses from the named VM

CLI Example:

salt '*' virt.get_macs <domain>

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.reboot(domain)

Reboot a domain via ACPI request

CLI Example:

salt '*' virt.reboot <domain>

salt.modules.smartos_virt.setmem(domain, 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 <domain> 512

salt.modules.smartos_virt.shutdown(domain)

Send a soft shutdown signal to the named vm

CLI Example:

salt '*' virt.shutdown <domain>

salt.modules.smartos_virt.start(domain)

Start a defined domain

CLI Example:

salt '*' virt.start <domain>

salt.modules.smartos_virt.stop(domain)

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

CLI Example:

salt '*' virt.destroy <domain>

salt.modules.smartos_virt.vm_info(domain)

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

CLI Example:

salt '*' virt.vm_info <domain>

salt.modules.smartos_virt.vm_virt_type(domain)

Return VM virtualization type : OS or KVM

CLI Example:

salt '*' virt.vm_virt_type <domain>

© 2021 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.smartos_virt.html