ansible.builtin.virt (v2.7.10) — module

Install Ansible via pip

Install with pip install ansible==2.7.10

Description

Manages virtual machines supported by I(libvirt).

Requirements

• python >= 2.6
• libvirt-python

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# a playbook task line:
- virt:
    name: alpha
    state: running

Inputs

    
uri:
    default: qemu:///system
    description:
    - libvirt connection uri.

xml:
    description:
    - XML document used with the define command.
    - Must be raw XML content using C(lookup). XML cannot be reference to a file.

name:
    description:
    - name of the guest VM being managed. Note that VM must be previously defined with
      xml.
    - This option is required unless I(command) is C(list_vms).

state:
    choices:
    - destroyed
    - paused
    - running
    - shutdown
    description:
    - Note that there may be some lag for state requests like C(shutdown) since these
      refer only to VM states. After starting a guest, it may not be immediately accessible.

command:
    choices:
    - create
    - define
    - destroy
    - freemem
    - get_xml
    - info
    - list_vms
    - nodeinfo
    - pause
    - shutdown
    - start
    - status
    - stop
    - undefine
    - unpause
    - virttype
    description:
    - In addition to state management, various non-idempotent commands are available.

autostart:
    description:
    - start VM at host startup.
    type: bool
    version_added: '2.3'
    version_added_collection: ansible.builtin

Outputs

list_vms:
  description: The list of vms defined on the remote system
  returned: success
  sample:
  - build.example.org
  - dev.example.org
  type: dictionary
status:
  description: The status of the VM, among running, crashed, paused and shutdown
  returned: success
  sample: success
  type: string