Модуль dellemc.unity.snapshot — управление снимками в системе хранения Unity

Примечание

Этот модуль входит в коллекцию dellemc.unity (версия 2.1.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: dellemc.unity.snapshot.

Добавлено в dellemc.unity 1.1.0

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

Обзор

Управление снимками в системе хранения Unity включает создание, удаление и обновление снимков, получение сведений о них, подключение и отключение хостов.

Требования

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

Устройство Dell Unity Storage версии 5.3 или более поздней.
Ansible-core версии 2.17 или более поздней.
Python 3.11, 3.12 или 3.13.
Python SDK Storops 1.2.12.

Параметры

Параметр	Комментарии
auto_delete boolean	Этот параметр указывает, будет ли снимок удалён автоматически. Если задано значение `true`, срок действия снимка истечёт согласно политике автоматического удаления пула. Если задано значение (false), снимок не будет автоматически удалён согласно политике автоматического удаления пула. Если задан параметр expiry_time, параметру auto_delete нельзя присвоить значение `true`. Если при создании не указаны ни auto_delete, ни expiry_time, снимок будет создан со значением `true` для параметра auto_delete. После установки параметра expiry_time снимок нельзя назначить политике автоматического удаления. Варианты: `false` `true`
cg_name string	Имя группы согласованности, для которой создаётся снимок. Для создания снимка необходимо указать либо vol_name, либо cg_name. Для других операций не требуется.
description string	С помощью этого параметра можно указать дополнительную информацию о снимке.
expiry_time string	Этот параметр задаёт дату и время истечения срока действия снимка. Время необходимо указывать в часовом поясе UTC. Формат: «MM/DD/YYYY HH:MM». Год должен содержать 4 цифры.
host_id string	Идентификатор хоста. Для подключения снимка к хосту или отключения снимка от хоста необходимо указать либо host_name, либо host_id. Снимок можно подключить к нескольким хостам.
host_name string	Имя хоста. Для подключения снимка к хосту или отключения снимка от хоста необходимо указать либо host_name, либо host_id. Снимок можно подключить к нескольким хостам.
host_state string	Параметр host_state указывает, должен ли хост быть подключён к снимку. Он требуется при подключении снимка к хосту или отключении снимка от хоста. Варианты: `"mapped"` `"unmapped"`
new_snapshot_name string	Новое имя снимка.
password string / обязательный	Пароль сервера управления Unity.
port integer	Номер порта, используемого для связи с сервером управления Unity. По умолчанию: `443`
snapshot_id string	Идентификатор снимка. Для всех операций, кроме создания, необходимо указать либо snapshot_name, либо snapshot_id.
snapshot_name string	Имя снимка. Обязательный параметр для создания снимка. Для всех остальных операций необходимо указать либо snapshot_name, либо snapshot_id.
state string / обязательный	Параметр state указывает, должен ли снимок существовать. Варианты: `"absent"` `"present"`
unispherehost string / обязательный	IP-адрес или полное доменное имя (FQDN) сервера управления Unity.
username string / обязательный	Имя пользователя сервера управления Unity.
validate_certs псевдонимы: verifycert boolean	Логическая переменная, указывающая, нужно ли проверять сертификат SSL. `true` — указывает, что сертификат SSL необходимо проверить. `false` — указывает, что сертификат SSL проверять не нужно. Варианты: `false` `true` ← (по умолчанию)
vol_name string	Имя тома, для которого создаётся снимок. Для создания снимка необходимо указать либо vol_name, либо cg_name. Для других операций не требуется.

Примечания

Примечание

Режим check_mode не поддерживается.
Модули этой коллекции с именем «dellemc.unity» предназначены для работы с платформой хранения Dell Unity.

Примеры

- name: Create a Snapshot for a CG
  snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    cg_name: "{{cg_name}}"
    snapshot_name: "{{cg_snapshot_name}}"
    description: "{{description}}"
    auto_delete: false
    state: "present"

- name: Create a Snapshot for a volume with Host attached
  snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    vol_name: "{{vol_name}}"
    snapshot_name: "{{vol_snapshot_name}}"
    description: "{{description}}"
    expiry_time: "04/15/2025 16:30"
    host_name: "{{host_name}}"
    host_state: "mapped"
    state: "present"

- name: Unmap a host for a Snapshot
  snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    snapshot_name: "{{vol_snapshot_name}}"
    host_name: "{{host_name}}"
    host_state: "unmapped"
    state: "present"

- name: Map snapshot to a host
  snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    snapshot_name: "{{vol_snapshot_name}}"
    host_name: "{{host_name}}"
    host_state: "mapped"
    state: "present"

- name: Update attributes of a Snapshot for a volume
  snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "{{vol_snapshot_name}}"
    new_snapshot_name: "{{new_snapshot_name}}"
    description: "{{new_description}}"
    host_name: "{{host_name}}"
    host_state: "unmapped"
    state: "present"

- name: Delete Snapshot of CG
  snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "{{cg_snapshot_name}}"
    state: "absent"

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

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

Ключ	Описание
changed boolean	Изменился ли ресурс. Возвращается: всегда Пример: `true`
snapshot_details dictionary	Сведения о снимке. Возвращается: если снимок существует Пример: {"access_type": null, "attached_wwn": null, "creation_time": "2022-10-21 08:20:25.803000+00:00", "creator_schedule": null, "creator_type": "SnapCreatorTypeEnum.USER_CUSTOM", "creator_user": {"id": "user_admin"}, "description": "Test snap creation", "existed": true, "expiration_time": null, "hash": 8756689457056, "hosts_list": [], "id": "85899355291", "io_limit_policy": null, "is_auto_delete": true, "is_modifiable": false, "is_modified": false, "is_read_only": true, "is_system_snap": false, "last_writable_time": null, "lun": null, "name": "ansible_snap_cg_1_1", "parent_snap": null, "size": null, "snap_group": null, "state": "SnapStateEnum.READY", "storage_resource_id": "res_95", "storage_resource_name": "CG_ansible_test_2_new"}
expiration_time string	Дата и время истечения срока действия снимка. Возвращается: при успешном выполнении
hosts_list dictionary	Содержит имена и идентификаторы связанных хостов. Возвращается: при успешном выполнении
id string	Уникальный идентификатор экземпляра снимка. Возвращается: при успешном выполнении
is_auto_delete string	Дополнительная информация, указанная для снимка. Возвращается: при успешном выполнении
name string	Имя снимка. Возвращается: при успешном выполнении
storage_resource_id string	Идентификатор ресурса хранения, для которого существует снимок. Возвращается: при успешном выполнении
storage_resource_name string	Имя ресурса хранения, для которого существует снимок. Возвращается: при успешном выполнении

Авторы

P Srinivas Rao (@srinivas-rao5)

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

© 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/dellemc/unity/snapshot_module.html