community.general.virt_pool (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Manage I(libvirt) storage pools.

Requirements

• python >= 2.6
• python-libvirt
• python-lxml

Usage examples

Scanned by Steampunk Spotter

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

# Define a new storage pool
- virt_pool:
    command: define
    name: vms
    xml: '{{ lookup("template", "pool/dir.xml.j2") }}'

Scanned by Steampunk Spotter

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

# Build a storage pool if it does not exist
- virt_pool:
    command: build
    name: vms

Scanned by Steampunk Spotter

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

# Start a storage pool
- virt_pool:
    command: create
    name: vms

Scanned by Steampunk Spotter

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

# List available pools
- virt_pool:
    command: list_pools

Scanned by Steampunk Spotter

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

# Get XML data of a specified pool
- virt_pool:
    command: get_xml
    name: vms

Scanned by Steampunk Spotter

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

# Stop a storage pool
- virt_pool:
    command: destroy
    name: vms

Scanned by Steampunk Spotter

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

# Delete a storage pool (destroys contents)
- virt_pool:
    command: delete
    name: vms

Scanned by Steampunk Spotter

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

# Undefine a storage pool
- virt_pool:
    command: undefine
    name: vms

Scanned by Steampunk Spotter

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

# Gather facts about storage pools
# Facts will be available as 'ansible_libvirt_pools'
- virt_pool:
    command: facts

Scanned by Steampunk Spotter

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

# Gather information about pools managed by 'libvirt' remotely using uri
- virt_pool:
    command: info
    uri: '{{ item }}'
  with_items: '{{ libvirt_uris }}'
  register: storage_pools

Scanned by Steampunk Spotter

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

# Ensure that a pool is active (needs to be defined and built first)
- virt_pool:
    state: active
    name: vms

Scanned by Steampunk Spotter

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

# Ensure that a pool is inactive
- virt_pool:
    state: inactive
    name: vms

Scanned by Steampunk Spotter

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

# Ensure that a given pool will be started at boot
- virt_pool:
    autostart: yes
    name: vms

Scanned by Steampunk Spotter

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

# Disable autostart for a given pool
- virt_pool:
    autostart: no
    name: vms

Inputs

    
uri:
    default: qemu:///system
    description:
    - I(libvirt) connection uri.
    required: false

xml:
    description:
    - XML document used with the define command.
    required: false

mode:
    choices:
    - new
    - repair
    - resize
    - no_overwrite
    - overwrite
    - normal
    - zeroed
    description:
    - Pass additional parameters to 'build' or 'delete' commands.
    required: false

name:
    aliases:
    - pool
    description:
    - name of the storage pool being managed. Note that pool must be previously defined
      with xml.
    required: false

state:
    choices:
    - active
    - inactive
    - present
    - absent
    - undefined
    - deleted
    description:
    - specify which state you want a storage pool to be in. If 'active', pool will be
      started. If 'present', ensure that pool is present but do not change its state;
      if it's missing, you need to specify xml argument. If 'inactive', pool will be stopped.
      If 'undefined' or 'absent', pool will be removed from I(libvirt) configuration.
      If 'deleted', pool contents will be deleted and then pool undefined.
    required: false

command:
    choices:
    - define
    - build
    - create
    - start
    - stop
    - destroy
    - delete
    - undefine
    - get_xml
    - list_pools
    - facts
    - info
    - status
    description:
    - in addition to state management, various non-idempotent commands are available.
      See examples.
    required: false

autostart:
    description:
    - Specify if a given storage pool should be started automatically on system boot.
    required: false
    type: bool