Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

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

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

Требования

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

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

Параметры

Параметр

Комментарии

allow_multiple_mappings

boolean

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

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

Допустимые значения:

  • false
  • true

auto_snap_remove_type

string

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

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

Если имя или идентификатор политики создания снимков переданы как пустое значение, для 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

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

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

IP-адрес или полное доменное имя узла PowerFlex.

password

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

Пароль узла PowerFlex.

port

integer

Номер порта для обмена данными с узлом PowerFlex.

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

protection_domain_id

string

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

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

Взаимоисключающий параметр с protection_domain_name.

protection_domain_name

string

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

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

Взаимоисключающий параметр с protection_domain_id.

sdc

list / элементы=dictionary

Задаёт параметры SDC.

access_mode

string

Задаёт режим доступа для всех подключений тома.

Допустимые значения:

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

bandwidth_limit

integer

Ограничение пропускной способности сети тома.

Значение необходимо указывать кратным 1024 Кбит/с.

Чтобы снять ограничение, укажите 0.

iops_limit

integer

Ограничение количества операций ввода-вывода в секунду для тома.

Минимальное ограничение 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

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

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

snapshot_policy_name

string

Имя политики создания снимков.

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

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 Cache.

Допустимые значения:

  • 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/powerflex/volume_module.html

Spec-Zone.ru

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