theforeman.foreman.snapshot module – Manage Snapshots
Note
This module is part of the theforeman.foreman collection (version 3.7.0).
You might already have this collection installed if you are using the ansible
package.
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 theforeman.foreman
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: theforeman.foreman.snapshot
.
New in theforeman.foreman 1.0.0
Synopsis
Manage 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
Requirements
The below requirements are needed on the host that executes this module.
requests
Parameters
Parameter |
Comments |
---|---|
Description of Snapshot |
|
Name of related Host |
|
Option to add RAM (only available for VMWare compute-resource) Choices:
|
|
Name of Snapshot |
|
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
URL of the Foreman server. If the value is not specified in the task, the value of environment variable |
|
State of Snapshot Choices:
|
|
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
Whether or not to verify the TLS certificates of the Foreman server. If the value is not specified in the task, the value of environment variable Choices:
|
Examples
- name: "Create a Snapshot"
theforeman.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"
theforeman.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"
theforeman.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"
theforeman.foreman.snapshot:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
name: "snapshot_before_software_upgrade"
host: "server.example.com"
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Final state of the affected entities grouped by their type. Returned: success |
|
List of snapshots. Returned: success |