foreman_snapshot – Manage Foreman Snapshots

Synopsis

• Manage Foreman Snapshots for Host Entities

• This module can create, update, revert and delete snapshots

• This module requires the foreman_snapshot_management plugin set up in the server

• See: https://github.com/ATIX-AG/foreman_snapshot_management

Requirements

The below requirements are needed on the host that executes this module.

• apypie

Parameters

Parameter	Choices/Defaults	Comments
description string		Description of Snapshot
host string / required		Name of related Host
name string / required		Name of Snapshot
password string / required		Password of the user accessing the Foreman server
server_url string / required		URL of the Foreman server
state string	Choices: present ← reverted absent	State of Snapshot
username string / required		Username accessing the Foreman server
validate_certs boolean	Choices: no yes ←	Whether or not to verify the TLS certificates of the Foreman server aliases: verify_ssl

Examples

- name: "Create a Snapshot"
  foreman_snapshot:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "snapshot_before_software_upgrade"
    host: "server.example.com"
    state: present

- name: "Update a Snapshot"
  foreman_snapshot:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "snapshot_before_software_upgrade"
    host: "server.example.com"
    description: "description of snapshot"
    state: present

- name: "Revert a Snapshot"
  foreman_snapshot:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "snapshot_before_software_upgrade"
    host: "server.example.com"
    state: reverted

- name: "Delete a Snapshot"
  foreman_snapshot:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "snapshot_before_software_upgrade"
    host: "server.example.com"
    state: absent

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]

• This module is maintained by the Ansible Community. [community]

Authors

• Manisha Singhal (@Manisha15) ATIX AG

Hint

If you notice any issues in this documentation, you can edit this document to improve it.