Модуль theforeman.foreman.snapshot — Управление снимками

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: theforeman.foreman.snapshot.

Новая функция в theforeman.foreman 1.0.0

Описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Описание

Управление снимками для сущностей хостов
Этот модуль может создавать, обновлять, отменять и удалять снимки
Этот модуль требует настройки плагина foreman_snapshot_management на сервере
См.: https://github.com/ATIX-AG/foreman_snapshot_management

Псевдонимы: foreman_snapshot

Требования

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

requests

Параметры

Параметр	Комментарии
description строка	Описание снимка
host строка / обязательно	Имя связанного хоста
id строка	Идентификатор снимка
include_ram логическое значение	Опция добавления ОЗУ (доступна только для виртуальных машин VMware) Варианты: `false` `true`
name строка / обязательно	Имя снимка
password строка / обязательно	Пароль пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_PASSWORD`.
server_url строка / обязательно	URL сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_SERVER_URL`.
state строка	Состояние снимка Варианты: `"present"` ← (по умолчанию) `"reverted"` `"absent"` `"new_snapshot"`
username строка / обязательно	Имя пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs логическое значение	Проверять ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- 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: "Create Snapshots with same name"
  theforeman.foreman.snapshot:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "snapshot_before_software_upgrade"
    host: "server.example.com"
    state: new_snapshot

- 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: "Update a Snapshot with same name"
  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
    id: "snapshot-id"

- 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

Возвращаемые значения

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

Ключ	Описание
entity словарь	Конечное состояние затронутых сущностей, сгруппированных по типу. Возвращается: success
snapshots список / элементы=словарь	Список снимков. Возвращается: success

Авторы

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_module.html