theforeman.foreman.snapshot – Управление моментальными снимками
Примечание
Этот плагин входит в состав коллекции theforeman.foreman (версия 1.5.1).
Для его установки используйте: ansible-galaxy collection install theforeman.foreman.
Чтобы использовать его в книге задач, укажите: theforeman.foreman.snapshot.
Новый в версии 1.0.0: of theforeman.foreman
Обзор
- Управление моментальными снимками для сущностей узлов
- Этот модуль может создавать, обновлять, восстанавливать и удалять моментальные снимки
- Этот модуль требует наличия плагина foreman_snapshot_management, настроенного на сервере
- См.: https://github.com/ATIX-AG/foreman_snapshot_management
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- requests
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| description строка | Описание моментального снимка | |
| host строка / обязательно | Имя связанного узла | |
| name строка / обязательно | Имя моментального снимка | |
| password строка / обязательно | Пароль пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения FOREMAN_PASSWORD. | |
| server_url строка / обязательно | URL-адрес сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения FOREMAN_SERVER_URL. | |
| state строка |
| Состояние моментального снимка |
| username строка / обязательно | Имя пользователя, имеющего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения FOREMAN_USERNAME. | |
| validate_certs булево |
| Проверять ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения FOREMAN_VALIDATE_CERTS. |
Примеры
- 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
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| entity словарь | успех | Конечное состояние затронутых сущностей, сгруппированных по типу. | |
| snapshots список / элементы=словарь | успех | Список моментальных снимков. | |
Авторы
- Manisha Singhal (@Manisha15) ATIX AG
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/snapshot_module.html