Spec-Zone.ru › Ansible

Модуль dellemc.powerflex.volume – Управление томами на Dell PowerFlex

Примечание

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

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

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

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

Новая версия в dellemc.powerflex 1.0.0

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

Обзор

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

Требования

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

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

Параметры

Параметр

Комментарии

allow_multiple_mappings

boolean

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

Если том сопоставлен с одним SDC, то для каждого нового сопоставления необходимо передать allow_multiple_mappings со значением true.

Варианты:

  • false
  • true

auto_snap_remove_type

string

Удалить или отсоединить политику создания моментальных снимков.

Для удаления/отсоединения политики моментальных снимков необходимо передать пустое значение snapshot_policy_id/snapshot_policy_name вместе с auto_snap_remove_type.

Если имя/ID политики моментальных снимков переданы пустыми, то auto_snap_remove_type устанавливается по умолчанию в detach.

Варианты:

  • "remove"
  • "detach"

cap_unit

string

Единица измерения размера тома. По умолчанию — ‘GB’.

Варианты:

  • "GB"
  • "TB"

compression_type

string

Тип метода сжатия.

Варианты:

  • "NORMAL"
  • "NONE"

delete_snapshots

boolean

Если true, то том и все зависимые от него моментальные снимки будут удалены.

Если false, то будет удален только том.

Может быть указано только тогда, когда state равно absent.

По умолчанию false, если не указано.

Варианты:

  • false
  • true

hostname

aliases: gateway_host

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

IP-адрес или FQDN хоста PowerFlex.

password

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

Пароль хоста PowerFlex.

port

integer

Номер порта, через который происходит общение с хостом PowerFlex.

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

protection_domain_id

string

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

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

Взаимоисключающие с protection_domain_name.

protection_domain_name

string

Имя домена защиты.

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

Взаимоисключающие с protection_domain_id.

sdc

list / элементы=словарь

Указывает параметры SDC.

access_mode

string

Определите режим доступа для всех сопоставлений тома.

Варианты:

  • "READ_WRITE"
  • "READ_ONLY"
  • "NO_ACCESS"

bandwidth_limit

integer

Предел пропускной способности сети тома.

Указывайте в кратных 1024 Кбит/с.

Для установки без ограничения передайте 0.

iops_limit

integer

Предел IOPS тома.

Минимальное ограничение IOPS — 11, укажите 0 для неограниченных IOPS.

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

Размер тома.

Размер тома будет назначен как высшее кратное 8 ГБ.

snapshot_policy_id

string

Идентификатор политики моментальных снимков.

Для удаления/отсоединения политики моментальных снимков необходимо передать пустое значение snapshot_policy_id/snapshot_policy_name вместе с auto_snap_remove_type.

snapshot_policy_name

string

Имя политики моментального снимка.

Для удаления/отсоединения политики моментального снимка необходимо передать пустые значения snapshot_policy_id/snapshot_policy_name вместе с auto_snap_remove_type.

state

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

Состояние тома.

Варианты:

  • "present"
  • "absent"

storage_pool_id

string

Идентификатор хранилища.

Для создания тома требуется либо имя, либо идентификатор хранилища.

Взаимоисключающее с storage_pool_name.

storage_pool_name

string

Имя хранилища.

Для создания тома требуется либо имя, либо идентификатор хранилища.

При создании, если указано имя хранилища, то необходимо указать имя или идентификатор области защиты вместе с ним.

Взаимоисключающее с storage_pool_id.

timeout

integer

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

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

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

use_rmcache

boolean

Использовать кэш RM или нет.

Варианты:

  • false
  • true

username

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

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

validate_certs

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

boolean

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

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

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

Варианты:

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

vol_id

string

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

Все операции, кроме создания, могут быть выполнены с использованием vol_id.

Взаимоисключающее с vol_name.

vol_name

string

Имя тома.

Обязательно для операции создания.

Уникальное имя в массиве PowerFlex.

Взаимоисключающее с vol_id.

vol_new_name

string

Новое имя тома. Используется для переименования тома.

vol_type

string

Тип выделения тома.

Варианты:

  • "THICK_PROVISIONED"
  • "THIN_PROVISIONED"

Примечания

Примечание

  • check_mode не поддерживается.
  • Модули, присутствующие в коллекции под именем ‘dellemc.powerflex’, разработаны для поддержки платформы хранения Dell PowerFlex.

Примеры

- name: Create a volume
  dellemc.powerflex.volume:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    vol_name: "sample_volume"
    storage_pool_name: "pool_1"
    protection_domain_name: "pd_1"
    vol_type: "THICK_PROVISIONED"
    compression_type: "NORMAL"
    use_rmcache: true
    size: 16
    state: "present"

- name: Map a SDC to volume
  dellemc.powerflex.volume:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    vol_name: "sample_volume"
    allow_multiple_mappings: true
    sdc:
      - sdc_id: "92A304DB-EFD7-44DF-A07E-D78134CC9764"
        access_mode: "READ_WRITE"
    sdc_state: "mapped"
    state: "present"

- name: Unmap a SDC to volume
  dellemc.powerflex.volume:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    vol_name: "sample_volume"
    sdc:
      - sdc_id: "92A304DB-EFD7-44DF-A07E-D78134CC9764"
    sdc_state: "unmapped"
    state: "present"

- name: Map multiple SDCs to a volume
  dellemc.powerflex.volume:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    vol_name: "sample_volume"
    protection_domain_name: "pd_1"
    sdc:
      - sdc_id: "92A304DB-EFD7-44DF-A07E-D78134CC9764"
        access_mode: "READ_WRITE"
        bandwidth_limit: 2048
        iops_limit: 20
      - sdc_ip: "198.10.xxx.xxx"
        access_mode: "READ_ONLY"
    allow_multiple_mappings: true
    sdc_state: "mapped"
    state: "present"

- name: Get the details of the volume
  dellemc.powerflex.volume:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    vol_id: "fe6c8b7100000005"
    state: "present"

- name: Modify the details of the Volume
  dellemc.powerflex.volume:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    vol_name: "sample_volume"
    storage_pool_name: "pool_1"
    new_vol_name: "new_sample_volume"
    size: 64
    state: "present"

- name: Delete the Volume
  dellemc.powerflex.volume:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    vol_name: "sample_volume"
    delete_snapshots: false
    state: "absent"

- name: Delete the Volume and all its dependent snapshots
  dellemc.powerflex.volume:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    vol_name: "sample_volume"
    delete_snapshots: true
    state: "absent"

Значения возврата

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

Ключ

Описание

changed

boolean

Изменился ли ресурс.

Возвращается: всегда

Пример: false

volume_details

dictionary

Подробная информация о томе.

Возвращается: Если том существует

Пример: {"accessModeLimit": "ReadWrite", "ancestorVolumeId": null, "autoSnapshotGroupId": null, "compressionMethod": "Invalid", "consistencyGroupId": null, "creationTime": 1631618520, "dataLayout": "MediumGranularity", "id": "cdd883cf00000002", "links": [{"href": "/api/instances/Volume::cdd883cf00000002", "rel": "self"}, {"href": "/api/instances/Volume::cdd883cf00000002/relationships /Statistics", "rel": "/api/Volume/relationship/Statistics"}, {"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-volume-1", "notGenuineSnapshot": false, "originalExpiryTime": 0, "pairIds": null, "protectionDomainId": "9300c1f900000000", "protectionDomainName": "domain1", "replicationJournalVolume": false, "replicationTimeStamp": 0, "retentionLevels": [], "secureSnapshotExpTime": 0, "sizeInGB": 16, "sizeInKb": 16777216, "snapshotPolicyId": null, "snapshotPolicyName": null, "snapshotsList": [{"accessModeLimit": "ReadOnly", "ancestorVolumeId": "cdd883cf00000002", "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, "retentionLevels": [], "secureSnapshotExpTime": 0, "sizeInKb": 16777216, "snplIdOfAutoSnapshot": null, "snplIdOfSourceVolume": null, "storagePoolId": "e0d8f6c900000000", "timeStampIsAccurate": false, "useRmcache": false, "volumeReplicationState": "UnmarkedForReplication", "volumeType": "Snapshot", "vtreeId": "6e86255c00000001"}], "snplIdOfAutoSnapshot": null, "snplIdOfSourceVolume": null, "statistics": {"childVolumeIds": [], "descendantVolumeIds": [], "initiatorSdcId": null, "mappedSdcIds": ["c42425XXXXXX"], "numOfChildVolumes": 0, "numOfDescendantVolumes": 0, "numOfMappedSdcs": 1, "registrationKey": null, "registrationKeys": [], "replicationJournalVolume": false, "replicationState": "UnmarkedForReplication", "reservationType": "NotReserved", "rplTotalJournalCap": 0, "rplUsedJournalCap": 0, "userDataReadBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataSdcReadLatency": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataSdcTrimLatency": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataSdcWriteLatency": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataTrimBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}, "userDataWriteBwc": {"numOccured": 0, "numSeconds": 0, "totalWeightInKb": 0}}, "storagePoolId": "e0d8f6c900000000", "storagePoolName": "pool1", "timeStampIsAccurate": false, "useRmcache": false, "volumeReplicationState": "UnmarkedForReplication", "volumeType": "ThinProvisioned", "vtreeId": "6e86255c00000001"}

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

Имя тома.

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

protectionDomainId

string

Идентификатор домена защиты, в котором находится том.

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

protectionDomainName

string

Имя домена защиты, в котором находится том.

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

sizeInGb

integer

Размер тома в Гб.

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

sizeInKb

integer

Размер тома в Кб.

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

snapshotPolicyId

string

Идентификатор политики моментальных снимков, связанной с томом.

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

snapshotPolicyName

string

Имя политики моментальных снимков, связанной с томом.

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

snapshotsList

string

Список моментальных снимков, связанных с томом.

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

statistics

dictionary

Подробная статистика пула хранения.

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

numOfChildVolumes

integer

Количество дочерних томов.

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

numOfMappedSdcs

integer

Количество сопоставленных SDC тома.

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

storagePoolId

string

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

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

storagePoolName

string

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

Возвращаемое значение: успех

Авторы

  • P Srinivas Rao (@srinivas-rao5)

Ссылки на сборку

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

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

Spec-Zone.ru

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