Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в playbook укажите: dellemc.powerflex.snapshot.

Новое в dellemc.powerflex 1.0.0

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

Описание

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

Требования

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

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

Параметры

Параметр

Комментарии

allow_multiple_mappings

boolean

Указывает, разрешить ли несколько отображений.

Варианты:

  • false
  • true

cap_unit

string

Единица измерения размера тома. По умолчанию GB, если не указано.

Варианты:

  • "GB"
  • "TB"

desired_retention

integer

Значение сохранения для моментального снимка.

Если desired_retention не указано при создании, моментальный снимок будет создан с неограниченным сроком хранения.

Максимальный поддерживаемый срок хранения — 31 день.

hostname

aliases: gateway_host

string / обязательно

IP-адрес или FQDN хоста 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 / elements=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

целое число

Время, по истечении которого соединение будет прервано.

Указывается в секундах.

По умолчанию: 120

username

строка / обязательно

Имя пользователя хоста PowerFlex.

validate_certs

псевдонимы: verifycert

булево

Булевая переменная, определяющая, нужно ли проверять сертификат SSL.

true - Указывает, что сертификат SSL должен быть проверен.

false - Указывает, что сертификат SSL проверять не нужно.

Варианты:

  • false
  • true ← (по умолчанию)

vol_id

строка

Идентификатор тома.

vol_name

строка

Имя тома, для которого будет создан снимок.

При создании снимка укажите либо 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

ID корня V-дерева указанного тома.

Возвращается: успех

ancestorVolumeName

string

Имя корня V-дерева указанного тома.

Возвращается: успех

creationTime

integer

Время создания снимка.

Возвращается: успех

id

string

ID снимка.

Возвращается: успех

mappedSdcInfo

dictionary

Подробная информация о сопоставленном SDC.

Возвращается: успех

accessMode

string

Режим доступа к сопоставлению для указанного снимка.

Возвращается: успех

limitBwInMbps

integer

Ограничение пропускной способности для SDC.

Возвращается: успех

limitIops

integer

Ограничение IOPS для SDC.

Возвращается: успех

sdcId

string

ID SDC.

Возвращается: успех

sdcIp

string

IP SDC.

Возвращается: успех

sdcName

string

Имя SDC.

Возвращается: успех

name

string

Имя снимка.

Возвращается: успех

retentionInHours

integer

Время хранения снимка в часах.

Возвращается: успех

secureSnapshotExpTime

integer

Время истечения срока действия снимка.

Возвращается: успех

sizeInGb

integer

Размер снимка.

Возвращается: успех

sizeInKb

integer

Размер снимка.

Возвращается: успех

storagePoolId

string

ID пула хранения, в котором находится снимок.

Возвращается: успех

storagePoolName

string

Имя пула хранения, в котором находится снимок.

Возвращается: успех

Авторы

  • Akash Shendge (@shenda1)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API