.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-entry .. role:: ansible-option-default .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.theforeman.foreman.snapshot_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title theforeman.foreman.snapshot module -- Manage Snapshots ++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `theforeman.foreman collection `_ (version 3.4.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 :code:`ansible-galaxy collection list`. 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 ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.theforeman.foreman.snapshot_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description of Snapshot .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.snapshot_module__parameter-host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Name of related Host .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.snapshot_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Name of Snapshot .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.snapshot_module__parameter-password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable \ :literal:`FOREMAN\_PASSWORD`\ will be used instead. .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.snapshot_module__parameter-server_url: .. rst-class:: ansible-option-title **server_url** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
URL of the Foreman server. If the value is not specified in the task, the value of environment variable \ :literal:`FOREMAN\_SERVER\_URL`\ will be used instead. .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.snapshot_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
State of Snapshot .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-default-bold:`present` :ansible-option-default:`← (default)` - :ansible-option-choices-entry:`reverted` - :ansible-option-choices-entry:`absent` .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.snapshot_module__parameter-username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable \ :literal:`FOREMAN\_USERNAME`\ will be used instead. .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.snapshot_module__parameter-validate_certs: .. rst-class:: ansible-option-title **validate_certs** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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 \ :literal:`FOREMAN\_VALIDATE\_CERTS`\ will be used instead. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html
.. Attributes .. 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: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.theforeman.foreman.snapshot_module__return-entity: .. rst-class:: ansible-option-title **entity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Final state of the affected entities grouped by their type. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.snapshot_module__return-entity/snapshots: .. rst-class:: ansible-option-title **snapshots** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of snapshots. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Manisha Singhal (@Manisha15) ATIX AG .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors