brightcomputing.installer100.vm_archive (23.9.313+gite4f1f01) — module

Install collection

Install with ansible-galaxy collection install brightcomputing.installer100:==23.9.313+gite4f1f01

Add to requirements.yml

  collections:
    - name: brightcomputing.installer100
      version: 23.9.313+gite4f1f01

Description

An Ansible module that creates a base tar out of the running target machine.

The output tar is stored on the target machine.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create a tar archive from a running vm
  brightcomputing.installer100.vm_archive:
    os_family: RedHat
    dest: /root/RHEL7u9.tar.gz

Scanned by Steampunk Spotter

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

- name: Create a tarball from a running vm with extra custom excludes
  brightcomputing.installer100.vm_archive:
    os_family: Debian
    dest: /root/UBUNTU1804.tar.gz
    extra_excludes:
      - /isos

Scanned by Steampunk Spotter

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

- name: Create a tarball from a running vm with extra custom tar parameters.
  brightcomputing.installer100.vm_archive:
    os_family: RedHat
    dest: /root/RHEL7u9.tar.gz
    tar_extra_opts: --verify

Inputs

    
dest:
    description:
    - Path to a location on the target machine where the tar archive will be stored.
    required: true
    type: path

os_family:
    choices:
    - RedHat
    - Debian
    description:
    - The Linux distribution ansible OS family
    required: true
    type: str

extra_excludes:
    default: []
    description:
    - Optional extra path to add to the exclude list for the tar command.
    elements: str
    required: false
    type: list

tar_extra_opts:
    default: ''
    description:
    - Optional tar CLI arguments to use when creating the tar archive.
    required: false
    type: str

ignore_file_changed:
    default: false
    description:
    - If set to true and tar reported only errors related to 'file changed as we read
      it', ignore the command non zero exit code.
    required: false
    type: bool