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

Примечание

Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.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

Параметры

Параметр	Комментарии
ca_path path	Файл в формате PEM, содержащий сертификат центра сертификации для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_CA_PATH`.
host string / обязательный	Имя связанного узла
location string	Метка местоположения, по которому ограничивается поиск.
name string	Имя ресурса, сведения о котором нужно получить. Несовместим с параметром search.
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organization string	Имя организации, по которой ограничивается поиск.
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_PASSWORD`.
search string	Используемый поисковый запрос Если значение равно None и параметр name не задан, будут возвращены все ресурсы. Несовместим с параметром name.
server_url string / обязательный	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_SERVER_URL`.
use_gssapi boolean	Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos с аутентификацией Negotiate. Требуется установленная библиотека Python requests-gssapi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
username string	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs boolean	Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- 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 list / elements=dictionary	Подробные сведения о первом найденном снимке с указанным именем Возвращается: при успешном выполнении, если передан параметр name
snapshots list / elements=dictionary	Список всех снимков узла и сведения о них Возвращается: при успешном выполнении, если передан параметр search

Авторы

Manisha Singhal (@Manisha15), ATIX AG

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

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