theko2fi.multipass.multipass_vm_purge module – Purge all deleted Multipass virtual machines permanently

Note

This module is part of the theko2fi.multipass collection (version 0.3.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install theko2fi.multipass.

To use it in a playbook, specify: theko2fi.multipass.multipass_vm_purge.

New in theko2fi.multipass 0.2.0

Synopsis

  • Purge all deleted Multipass instances permanently, including all their data.

  • This will destroy all the traces of the virtual machine, and cannot be undone.

  • Performs the same function as the multipass purge CLI subcommand.

Examples

- name: Purge all the deleted virtual machines
  theko2fi.multipass.multipass_vm_purge:


# Purge and show the result
- name: Purge all the deleted virtual machines
  theko2fi.multipass.multipass_vm_purge:
  register: result

- name: Display the list of purged virtual machines
  debug:
    var: result.vm_purged

# If you would like to purge a specific VM, use the theko2fi.multipass.multipass_vm module instead

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

vm_purged

list / elements=dictionary

List of purged virtual machines.

Returned: always

Sample: [{"ipv4": [], "name": "ansible-multipass-vm-cbc2f266", "release": "Not Available", "state": "Deleted"}]

Authors

  • Kenneth KOFFI (@theko2fi)