Модуль theforeman.foreman.snapshot_info — Получение информации о моментальных снимках Foreman

Примечание

Этот модуль является частью коллекции theforeman.foreman (версия 4.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля требуется дополнительное программное обеспечение. Подробности см. в разделе Требования.

Для использования в книге задач укажите: theforeman.foreman.snapshot_info.

Добавлена в theforeman.foreman 3.8.0

Обзор
Требования
Параметры
Атрибуты
Примеры
Значения возврата

Обзор

Получение информации о моментальных снимках Foreman

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

requests

Параметры

Параметр	Комментарии
host строка / обязательно	Имя связанного хоста
location строка	Метка расположения для сужения поиска.
name строка	Имя ресурса, для которого требуется получить информацию. Взаимоисключающий с search.
organization строка	Имя организации для сужения поиска.
password строка / обязательно	Пароль пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_PASSWORD`.
search строка	Запрос поиска. Если None, и name не задано, возвращаются все ресурсы. Взаимоисключающий с name.
server_url строка / обязательно	URL сервера Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_SERVER_URL`.
username строка / обязательно	Имя пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_USERNAME`.
validate_certs логическое	Подтверждать ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме check_mode и возвращать прогноз изменений состояния без изменения сущности
diff_mode	Поддержка: полная	Вернёт подробности о внесённых изменениях (или, возможно, требуемых изменениях в check_mode) при использовании режима diff

Примеры

- 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"

Значения возврата

Общие значения возврата описаны здесь, следующие — поля, уникальные для этого модуля:

Ключ	Описание
snapshot список / элементы=словарь	Подробности о первом найденном моментальном снимке с заданным именем. Возвращается: при успехе и при указании name
snapshots список / элементы=словарь	Список всех моментальных снимков и их подробностей для хоста. Возвращается: при успехе и при указании search

Авторы

Manisha Singhal (@Manisha15) ATIX AG

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/theforeman/foreman/snapshot_info_module.html