salt.states.virt module¶

Manage virt¶

For the key certificate this state uses the external pillar in the master to call for the generation and signing of certificates for systems running libvirt:

libvirt_keys:
  virt.keys

salt.states.virt.keys(name, basepath='/etc/pki', **kwargs)¶

Manage libvirt keys.

name

The name variable used to track the execution

basepath

Defaults to /etc/pki, this is the root location used for libvirt keys on the hypervisor

The following parameters are optional:

country

The country that the certificate should use. Defaults to US.

New in version 2018.3.0.

state

The state that the certificate should use. Defaults to Utah.

New in version 2018.3.0.

locality

The locality that the certificate should use. Defaults to Salt Lake City.

New in version 2018.3.0.

organization

The organization that the certificate should use. Defaults to Salted.

New in version 2018.3.0.

expiration_days

The number of days that the certificate should be valid for. Defaults to 365 days (1 year)

New in version 2018.3.0.

salt.states.virt.powered_off(name)¶

Stops a VM by power off.

New in version 2016.3.0.

domain_name:
  virt.stopped

salt.states.virt.rebooted(name)¶

Reboots VMs

New in version 2016.3.0.

Parameters

name --

Returns

salt.states.virt.reverted(name, snapshot=None, cleanup=False)¶

Deprecated since version 2016.3.0.

Reverts to the particular snapshot.

New in version 2016.3.0.

domain_name:
  virt.reverted:
    - cleanup: True

domain_name_1:
  virt.reverted:
    - snapshot: snapshot_name
    - cleanup: False

salt.states.virt.running(name, **kwargs)¶

Starts an existing guest, or defines and starts a new VM with specified arguments.

New in version 2016.3.0.

domain_name:
  virt.running

domain_name:
  virt.running:
    - cpu: 2
    - mem: 2048
    - eth0_mac: 00:00:6a:53:00:e3

salt.states.virt.saved(name, suffix=None)¶

Deprecated since version 2016.3.0: Use snapshot() instead.

Takes a snapshot of a particular VM or by a UNIX-style wildcard.

New in version 2016.3.0.

domain_name:
  virt.saved:
    - suffix: periodic

domain*:
  virt.saved:
    - suffix: periodic

salt.states.virt.snapshot(name, suffix=None)¶

Takes a snapshot of a particular VM or by a UNIX-style wildcard.

New in version 2016.3.0.

domain_name:
  virt.snapshot:
    - suffix: periodic

domain*:
  virt.snapshot:
    - suffix: periodic

salt.states.virt.stopped(name)¶

Stops a VM by shutting it down nicely.

New in version 2016.3.0.

domain_name:
  virt.stopped

salt.states.virt.unpowered(name)¶

Deprecated since version 2016.3.0: Use powered_off() instead.

Stops a VM by power off.

New in version 2016.3.0.

domain_name:
  virt.stopped