.. Document meta :orphan: .. Anchors .. _ansible_collections.theforeman.foreman.snapshot_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title theforeman.foreman.snapshot -- Manage Snapshots +++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `theforeman.foreman collection `_ (version 2.1.2). To install it use: :code:`ansible-galaxy collection install theforeman.foreman`. To use it in a playbook, specify: :code:`theforeman.foreman.snapshot`. .. version_added .. versionadded:: 1.0.0 of theforeman.foreman .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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 .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - requests .. Options Parameters ---------- .. raw:: html
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
    Choices:
  • present ←
  • reverted
  • absent
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
    Choices:
  • no
  • yes ←
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.

.. Notes .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
entity
dictionary
success
Final state of the affected entities grouped by their type.

 
snapshots
list / elements=dictionary
success
List of snapshots.



.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Manisha Singhal (@Manisha15) ATIX AG .. Parsing errors