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

Примечание

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

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

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

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

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

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

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

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

Требования

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

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

Параметры

Параметр	Комментарии
allow_multiple_mappings boolean	Указывает, разрешено ли создавать несколько подключений. Варианты: `false` `true`
cap_unit string	Единица измерения размера тома. Если не указана, используется `GB`. Варианты: `"GB"` `"TB"`
desired_retention integer	Срок хранения снимка. Если при создании значение desired_retention не указано, снимок будет создан с неограниченным сроком хранения. Максимальный поддерживаемый срок хранения — 31 день.
hostname псевдонимы: gateway_host string / обязательный	IP-адрес или полное доменное имя узла PowerFlex.
password string / обязательный	Пароль узла PowerFlex.
port integer	Номер порта для обмена данными с узлом PowerFlex. По умолчанию: `443`
read_only boolean	Указывает, будет ли созданный том-снимок доступен для чтения и записи или только для чтения. Если задано значение `true`, снимок создается с доступом только для чтения. Если задано значение `false`, снимок создается с доступом для чтения и записи. Варианты: `false` `true`
remove_mode string	Режим удаления снимка. Если не указан, используется `ONLY_ME`. Варианты: `"ONLY_ME"` `"INCLUDING_DESCENDANTS"`
retention_unit string	Единица измерения срока хранения. Если не указана, используется `hours`. Варианты: `"hours"` `"days"`
sdc list / элементы=dictionary	Задает параметры SDC.
access_mode string	Задает режим доступа для всех подключений снимка. Варианты: `"READ_WRITE"` `"READ_ONLY"` `"NO_ACCESS"`
bandwidth_limit integer	Ограничение пропускной способности сети для снимка. Значение необходимо указывать кратным 1024 Кбит/с. Чтобы не задавать ограничение, укажите 0.
iops_limit integer	Ограничение IOPS для снимка. Минимальное ограничение IOPS — 11; чтобы не задавать ограничение, укажите 0.
sdc_id string	Идентификатор SDC. Укажите один из параметров: sdc_name, sdc_id или sdc_ip. Не может использоваться одновременно с sdc_name и sdc_ip.
sdc_ip string	IP-адрес SDC. Укажите один из параметров: sdc_name, sdc_id или sdc_ip. Не может использоваться одновременно с sdc_id и sdc_ip.
sdc_name string	Имя SDC. Укажите один из параметров: sdc_name, sdc_id или sdc_ip. Не может использоваться одновременно с sdc_id и sdc_ip.
sdc_state string	Состояние подключения SDC. Варианты: `"mapped"` `"unmapped"`
size integer	Размер снимка.
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 не поддерживается.
Модули из коллекции «dellemc.powerflex» предназначены для поддержки платформы хранения Dell PowerFlex.

Примеры

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

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

- name: Map snapshot to SDC
  dellemc.powerflex.snapshot:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_id: "fe6cb28200000007"
    sdc:
      - sdc_ip: "198.10.xxx.xxx"
      - sdc_id: "663ac0d200000001"
    allow_multiple_mappings: true
    sdc_state: "mapped"
    state: "present"

- name: Modify the attributes of SDC mapped to snapshot
  dellemc.powerflex.snapshot:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_id: "fe6cb28200000007"
    sdc:
      - sdc_ip: "198.10.xxx.xxx"
        iops_limit: 11
        bandwidth_limit: 4096
      - sdc_id: "663ac0d200000001"
        iops_limit: 20
        bandwidth_limit: 2048
    allow_multiple_mappings: true
    sdc_state: "mapped"
    state: "present"

- name: Extend the size of snapshot
  dellemc.powerflex.snapshot:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_id: "fe6cb28200000007"
    size: 16
    state: "present"

- name: Unmap SDCs from snapshot
  dellemc.powerflex.snapshot:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_id: "fe6cb28200000007"
    sdc:
      - sdc_ip: "198.10.xxx.xxx"
      - sdc_id: "663ac0d200000001"
    sdc_state: "unmapped"
    state: "present"

- name: Rename snapshot
  dellemc.powerflex.snapshot:
    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:
    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", "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, "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, "volumeReplicationState": "UnmarkedForReplication", "volumeType": "Snapshot", "vtreeId": "6e86255c00000001"}
ancestorVolumeId string	Идентификатор корневого тома в V-дереве указанного тома. Возвращается: при успешном выполнении
ancestorVolumeName string	Имя корневого тома в V-дереве указанного тома. Возвращается: при успешном выполнении
creationTime integer	Время создания снимка. Возвращается: при успешном выполнении
id string	Идентификатор снимка. Возвращается: при успешном выполнении
mappedSdcInfo dictionary	Сведения о подключенном SDC. Возвращается: при успешном выполнении
accessMode string	Режим доступа для подключения указанного снимка. Возвращается: при успешном выполнении
limitBwInMbps integer	Ограничение пропускной способности для SDC. Возвращается: при успешном выполнении
limitIops integer	Ограничение IOPS для SDC. Возвращается: при успешном выполнении
sdcId string	Идентификатор SDC. Возвращается: при успешном выполнении
sdcIp string	IP-адрес SDC. Возвращается: при успешном выполнении
sdcName string	Имя SDC. Возвращается: при успешном выполнении
name string	Имя снимка. Возвращается: при успешном выполнении
retentionInHours integer	Срок хранения снимка в часах. Возвращается: при успешном выполнении
secureSnapshotExpTime integer	Время истечения срока действия снимка. Возвращается: при успешном выполнении
sizeInGb integer	Размер снимка. Возвращается: при успешном выполнении
sizeInKb integer	Размер снимка. Возвращается: при успешном выполнении
storagePoolId string	Идентификатор пула хранения, в котором находится снимок. Возвращается: при успешном выполнении
storagePoolName string	Имя пула хранения, в котором находится снимок. Возвращается: при успешном выполнении

Авторы

Akash Shendge (@shenda1)

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

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