salt.runners.smartos_vmadm¶

Runner for SmartOS minions control vmadm

salt.runners.smartos_vmadm.get(search, one=True)¶

Return information for vms

searchstring

filter vms, see the execution module.

oneboolean

return only one vm

Note

If the search parameter does not contain an equal (=) symbol it will be assumed it will be tried as uuid, hostname, and alias.

CLI Example:

salt-run vmadm.get 91244bba-1146-e4ec-c07e-e825e0223aa9
salt-run vmadm.get search='alias=saskia'

salt.runners.smartos_vmadm.is_running(search)¶

Return true if vm is running

searchstring

filter vms, see the execution module.

Note

If the search parameter does not contain an equal (=) symbol it will be assumed it will be tried as uuid, hostname, and alias.

Note

If multiple vms are matched, the result will be true of ALL vms are running

CLI Example:

salt-run vmadm.is_running 91244bba-1146-e4ec-c07e-e825e0223aa9
salt-run vmadm.is_running search='alias=julia'

salt.runners.smartos_vmadm.list_vms(search=None, verbose=False)¶

List all vms

searchstring

filter vms, see the execution module

verboseboolean

print additional information about the vm

CLI Example:

salt-run vmadm.list
salt-run vmadm.list search='type=KVM'
salt-run vmadm.list verbose=True

salt.runners.smartos_vmadm.nodes(verbose=False)¶

List all compute nodes

verboseboolean

print additional information about the node e.g. platform version, hvm capable, ...

CLI Example:

salt-run vmadm.nodes
salt-run vmadm.nodes verbose=True

salt.runners.smartos_vmadm.reboot(search, one=True, force=False)¶

Reboot one or more vms

searchstring

filter vms, see the execution module.

oneboolean

reboot only one vm

forceboolean

force reboot, faster but no graceful shutdown

Note

If the search parameter does not contain an equal (=) symbol it will be assumed it will be tried as uuid, hostname, and alias.

CLI Example:

salt-run vmadm.reboot 91244bba-1146-e4ec-c07e-e825e0223aa9
salt-run vmadm.reboot search='alias=marije'
salt-run vmadm.reboot search='type=KVM' one=False

salt.runners.smartos_vmadm.start(search, one=True)¶

Start one or more vms

searchstring

filter vms, see the execution module.

oneboolean

start only one vm

Note

If the search parameter does not contain an equal (=) symbol it will be assumed it will be tried as uuid, hostname, and alias.

CLI Example:

salt-run vmadm.start 91244bba-1146-e4ec-c07e-e825e0223aa9
salt-run vmadm.start search='alias=jiska'
salt-run vmadm.start search='type=KVM' one=False

salt.runners.smartos_vmadm.stop(search, one=True)¶

Stop one or more vms

searchstring

filter vms, see the execution module.

oneboolean

stop only one vm

Note

If the search parameter does not contain an equal (=) symbol it will be assumed it will be tried as uuid, hostname, and alias.

CLI Example:

salt-run vmadm.stop 91244bba-1146-e4ec-c07e-e825e0223aa9
salt-run vmadm.stop search='alias=jody'
salt-run vmadm.stop search='type=KVM' one=False