theforeman.foreman.snapshot – Manage Snapshots
Note
This plugin is part of the theforeman.foreman collection (version 1.5.1).
To install it use: ansible-galaxy collection install theforeman.foreman.
To use it in a playbook, specify: theforeman.foreman.snapshot.
New in version 1.0.0: of theforeman.foreman
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
- See: https://github.com/ATIX-AG/foreman_snapshot_management
Requirements
The below requirements are needed on the host that executes this module.
- requests
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.
If the value is not specified in the task, the value of environment variable FOREMAN_PASSWORD will be used instead.
|
|
| server_url
string / required
|
URL of the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_SERVER_URL will be used instead.
|
|
| state
string
|
|
State of Snapshot
|
| username
string / required
|
Username accessing the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_USERNAME will be used instead.
|
|
| validate_certs
boolean
|
|
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 FOREMAN_VALIDATE_CERTS will be used instead.
|
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 | Returned | Description | |
|---|---|---|---|
| entity
dictionary
|
success |
Final state of the affected entities grouped by their type.
|
|
| snapshots
list / elements=dictionary
|
success |
List of snapshots.
|
|
Authors
- Manisha Singhal (@Manisha15) ATIX AG
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/snapshot_module.html