Модуль dellemc.powerflex.snapshot_v2 — управление снимками в Dell PowerFlex

Примечание

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

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

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

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

Добавлено в dellemc.powerflex 3.0.0

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

Краткое описание

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

Требования

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

Система хранения Dell PowerFlex версии 5.0 или более поздней.
PyPowerFlex 2.0.0

Параметры

Параметр	Комментарии
desired_retention integer	Срок хранения снимка. Если при создании параметр desired_retention не указан, снимок будет создан с неограниченным сроком хранения. Максимальный поддерживаемый срок хранения — 31 день.
hostname псевдонимы: gateway_host string / обязательный	IP-адрес или полное доменное имя хоста PowerFlex.
password string / обязательный	Пароль хоста PowerFlex.
port integer	Номер порта для связи с хостом PowerFlex. По умолчанию: `443`
remove_mode string	Режим удаления снимка. Если не указан, по умолчанию используется `ONLY_ME`. Варианты: `"ONLY_ME"` `"INCLUDING_DESCENDANTS"`
retention_unit string	Единица измерения срока хранения. Если не указана, по умолчанию используется `hours`. Варианты: `"hours"` `"days"`
snapshot_id string	Идентификатор снимка.
snapshot_name string	Имя снимка. Обязателен для операции создания. Для любой операции укажите snapshot_name или snapshot_id (но не оба параметра одновременно).
snapshot_new_name string	Новое имя снимка. Используется для переименования снимка.
state string	Состояние снимка. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Время, по истечении которого соединение будет разорвано. Указывается в секундах. По умолчанию: `120`
username string / обязательный	Имя пользователя хоста PowerFlex.
validate_certs псевдонимы: verifycert boolean	Логическая переменная, указывающая, следует ли проверять SSL-сертификат. `true` — означает, что SSL-сертификат необходимо проверить. `false` — означает, что SSL-сертификат проверять не нужно. Варианты: `false` `true` ← (по умолчанию)
vol_id string	Идентификатор тома.
vol_name string	Имя тома, для которого будет создан снимок. При создании снимка укажите либо vol_name, либо vol_id.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Выполняет задачу для проверки без выполнения действий на целевом компьютере.
diff_mode	Поддержка: полная	Выполняет задачу, чтобы сообщить о внесённых или планируемых изменениях.

Примечания

Примечание

Начиная с PowerFlex 5.0.0 снимки доступны только для чтения.
Модули коллекции «dellemc.powerflex» предназначены для поддержки платформы хранения Dell PowerFlex.

Примеры

- name: Create snapshot
  dellemc.powerflex.snapshot_v2:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "ansible_snapshot"
    vol_name: "ansible_volume"
    desired_retention: 2
    state: "present"

- name: Get snapshot details using snapshot id
  dellemc.powerflex.snapshot_v2:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_id: "fe6cb28200000007"
    state: "present"

- name: Rename snapshot
  dellemc.powerflex.snapshot_v2:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_id: "fe6cb28200000007"
    snapshot_new_name: "ansible_renamed_snapshot_10"
    state: "present"

- name: Delete snapshot
  dellemc.powerflex.snapshot_v2:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_id: "fe6cb28200000007"
    remove_mode: "ONLY_ME"
    state: "absent"

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

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

Ключ	Описание
changed boolean	Изменился ли ресурс. Возвращается: всегда Пример: `false`
snapshot_details dictionary	Сведения о снимке. Возвращается: если снимок существует Пример: {"accessModeLimit": "ReadOnly", "ancestorVolumeId": "cdd883cf00000002", "ancestorVolumeName": "ansible-volume-1", "autoSnapshotGroupId": null, "compressionMethod": "Invalid", "consistencyGroupId": "22f1e80c00000001", "creationTime": 1631619229, "dataLayout": "MediumGranularity", "genType": "EC", "id": "cdd883d000000004", "links": [{"href": "/api/instances/Volume::cdd883d000000004", "rel": "self"}, {"href": "/api/instances/Volume::cdd883d000000004/relationships /Statistics", "rel": "/api/Volume/relationship/Statistics"}, {"href": "/api/instances/Volume::cdd883cf00000002", "rel": "/api/parent/relationship/ancestorVolumeId"}, {"href": "/api/instances/VTree::6e86255c00000001", "rel": "/api/parent/relationship/vtreeId"}, {"href": "/api/instances/StoragePool::e0d8f6c900000000", "rel": "/api/parent/relationship/storagePoolId"}], "lockedAutoSnapshot": false, "lockedAutoSnapshotMarkedForRemoval": false, "managedBy": "ScaleIO", "mappedSdcInfo": null, "name": "ansible_vol_snap_1", "notGenuineSnapshot": false, "nsid": 23, "originalExpiryTime": 0, "pairIds": null, "replicationJournalVolume": false, "replicationTimeStamp": 0, "retentionInHours": 0, "retentionLevels": [], "secureSnapshotExpTime": 0, "sizeInGb": 16, "sizeInKb": 16777216, "snplIdOfAutoSnapshot": null, "snplIdOfSourceVolume": null, "storagePoolId": "e0d8f6c900000000", "storagePoolName": "pool1", "timeStampIsAccurate": false, "useRmcache": false, "volumeClass": "defaultclass", "volumeReplicationState": "UnmarkedForReplication", "volumeType": "Snapshot", "vtreeId": "6e86255c00000001"}
ancestorVolumeId string	Идентификатор корневого тома указанного V-Tree. Возвращается: при успешном выполнении
ancestorVolumeName string	Имя корневого тома указанного V-Tree. Возвращается: при успешном выполнении
creationTime integer	Время создания снимка. Возвращается: при успешном выполнении
id string	Идентификатор снимка. Возвращается: при успешном выполнении
name string	Имя снимка. Возвращается: при успешном выполнении
retentionInHours integer	Срок хранения снимка в часах. Возвращается: при успешном выполнении
secureSnapshotExpTime integer	Время истечения срока действия снимка. Возвращается: при успешном выполнении
sizeInGb integer	Размер снимка. Возвращается: при успешном выполнении
sizeInKb integer	Размер снимка. Возвращается: при успешном выполнении
storagePoolId string	Идентификатор пула хранения, в котором находится снимок. Возвращается: при успешном выполнении
storagePoolName string	Имя пула хранения, в котором находится снимок. Возвращается: при успешном выполнении

Авторы

Yuhao Liu (@RayLiu7)

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

© 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/powerflex/snapshot_v2_module.html