theforeman.foreman.snapshot_info module – Fetch information about Foreman Snapshots

Note

This module is part of the theforeman.foreman collection (version 3.11.0).

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_info.

New in theforeman.foreman 3.8.0

Synopsis

• Fetch information about Foreman Snapshots

Requirements

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

• requests

Parameters

Parameter	Comments
host string / required	Name of related Host
location string	Label of the Location to scope the search for.
name string	Name of the resource to fetch information for. Mutually exclusive with search.
organization string	Name of the Organization to scope the search for.
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.
search string	Search query to use If None, and name is not set, all resources are returned. Mutually exclusive with name.
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.
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. Choices: false true ← (default)

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying the entity
diff_mode	Support: full	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

Examples

- name: "Show all snapshots for a host"
  theforeman.foreman.snapshot_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    host: "server.example.com"

- name: "Show a snapshot"
  theforeman.foreman.snapshot_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    host: "server.example.com"
    search: "name=ansible"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
snapshot list / elements=dictionary	Details about the first found snapshot with searched name Returned: success and name was passed
snapshots list / elements=dictionary	List of all snapshots and their details for a host Returned: success and search was passed

Authors

• Manisha Singhal (@Manisha15) ATIX AG

Collection links

Issue Tracker Homepage Repository (Sources)