Spec-Zone.ru › Ansible

Модуль purestorage.flasharray.purefa_volume – управление томами на массивах Pure Storage FlashArray

Примечание

Этот модуль входит в коллекцию purestorage.flasharray (версия 1.42.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: purestorage.flasharray.purefa_volume.

Добавлено в purestorage.flasharray 1.0.0

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

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

  • Создание, удаление тома или увеличение его емкости на массиве Pure Storage FlashArray.

Требования

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

  • python >= 3.3
  • purestorage >= 1.19
  • py-pure-client >= 1.26.0
  • netaddr
  • requests
  • pycountry
  • urllib3

Параметры

Параметр

Комментарии

add_to_pgs

list / elements=string

добавлено в purestorage.flasharray 1.14.0

При создании новый том будет добавлен в указанные группы защиты.

api_token

string

Токен API FlashArray для пользователя с привилегиями администратора.

bw_qos

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

string

Ограничение пропускной способности тома в единицах M или G. M задает МБ/с, G — ГБ/с. Чтобы сбросить существующее значение QoS, укажите 0 (ноль).

context

string

добавлено в purestorage.flasharray 1.33.0

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

Массив, получающий запрос, должен быть участником флота, а имя контекста должно соответствовать участнику того же флота.

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

count

integer

Количество томов, создаваемых при массовом создании.

Поддерживается только в Purity//FA v6.0.0 и более поздних версиях.

digits

integer

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

Поддерживается только в Purity//FA v6.0.0 и более поздних версиях.

Диапазон — от 1 до 10.

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

disable_warnings

boolean

добавлено в purestorage.flasharray 1.29.0

Отключить предупреждения о небезопасном сертификате в журналах отладки.

Варианты:

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

eradicate

boolean

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

Варианты:

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

fa_url

string

IPv4-адрес или имя хоста для управления FlashArray.

iops_qos

string

Ограничение IOPS для тома — укажите значение, K или M; K означает 1000, M — 1000000. Чтобы сбросить существующее значение IOPS, укажите 0 (ноль).

move

string

Переместить том в под или группу томов либо из них.

Укажите имя пода или группы томов, в которую нужно переместить том.

Имена подов и групп томов в массиве должны быть уникальными.

Чтобы переместить том в локальный массив, укажите local.

Эта операция не является идемпотентной — используйте ignore_errors в плейбуке.

name

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

Имя тома.

Том можно создать в поде, используя синтаксис POD_NAME::VOLUME_NAME.

Том можно создать в группе томов, используя синтаксис VG_NAME/VOLUME_NAME.

Поддержка нескольких томов доступна начиная с Purity//FA 6.0.0. ***ПРИМЕЧАНИЕ*** Ручное удаление или безвозвратное удаление отдельных томов, созданных в режиме массового создания, приведет к нарушению идемпотентности.

Поддержка нескольких томов предусмотрена только для создания томов.

overwrite

boolean

Указывает, следует ли перезаписать целевой том, если он уже существует.

Варианты:

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

pgroup

string

добавлено в purestorage.flasharray 1.8.0

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

Применимо только при создании тома или томов.

Начиная с Purity//FA 6.3.4 заменено параметром add_to_pgs.

priority_operator

string

добавлено в purestorage.flasharray 1.13.0

Оператор настройки приоритета DMM.

Варианты:

  • "="
  • "+"
  • "-"

priority_value

integer

добавлено в purestorage.flasharray 1.13.0

Значение настройки приоритета DMM.

Варианты:

  • -10
  • 0
  • 10

promotion_state

string

добавлено в purestorage.flasharray 1.16.0

Повысить или понизить уровень тома, чтобы он начал или перестал принимать запросы на запись.

Варианты:

  • "promoted"
  • "demoted"

rename

string

Новое имя указанного тома.

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

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

size

string

Размер тома в единицах M, G, T или P.

start

integer

Начальный номер индекса при массовом создании томов.

Поддерживается только в Purity//FA v6.0.0 и более поздних версиях.

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

state

string

Указывает, должен ли том существовать.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

suffix

string

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

Имена томов формируются по шаблону <name>#I<suffix>, где # — заполнитель для индекса тома. См. соответствующие описания.

Поддерживается только в Purity//FA v6.0.0 и более поздних версиях.

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

target

string

Имя целевого тома, если выполняется копирование.

with_default_protection

boolean

добавлено в purestorage.flasharray 1.14.0

Добавлять ли группы защиты контейнера по умолчанию к группам, указанным в add_to_pgs, в качестве первоначальной защиты нового тома.

Варианты:

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

Примечания

Примечание

  • Для этого модуля необходимы библиотеки Python purestorage и py-pure-client.
  • Для некоторых модулей могут потребоваться дополнительные библиотеки Python.
  • Если аргументы fa_url и api_token не переданы непосредственно модулю, необходимо задать переменные окружения PUREFA_URL и PUREFA_API.

Примеры

- name: Create new volume named foo with a QoS limit
  purestorage.flasharray.purefa_volume:
    name: foo
    size: 1T
    bw_qos: 58M
    iops_qos: 23K
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Create new volume named foo with a DMM priority (Purity//FA 6.1.2+)
  purestorage.flasharray.purefa_volume:
    name: foo
    size: 1T
    priority_operator: +
    priority_value: 10
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Create new volume named foo in protection group pg1 (this cannot be used with context)
  purestorage.flasharray.purefa_volume:
    name: foo
    pgroup: pg1
    size: 1T
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Create 10 volumes with index starting at 10 but padded with 3 digits
  purestorage.flasharray.purefa_volume:
    name: foo
    size: 1T
    suffix: bar
    count: 10
    start: 10
    digits: 3
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Extend the size of an existing volume named foo
  purestorage.flasharray.purefa_volume:
    name: foo
    size: 2T
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Delete and eradicate volume named foo
  purestorage.flasharray.purefa_volume:
    name: foo
    eradicate: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

- name: Create clone of volume bar named foo
  purestorage.flasharray.purefa_volume:
    name: foo
    target: bar
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Overwrite volume bar with volume foo
  purestorage.flasharray.purefa_volume:
    name: foo
    target: bar
    overwrite: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Clear volume QoS from volume foo
  purestorage.flasharray.purefa_volume:
    name: foo
    bw_qos: 0
    iops_qos: 0
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Move local volume foo from local array to pod bar
  purestorage.flasharray.purefa_volume:
    name: foo
    move: bar
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Move volume foo in pod bar to local array
  purestorage.flasharray.purefa_volume:
    name: bar::foo
    move: local
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Move volume foo in pod bar to vgroup fin
  purestorage.flasharray.purefa_volume:
    name: bar::foo
    move: fin
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

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

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

Ключ

Описание

volume

dictionary

Словарь с описанием измененного тома. При различных действиях возвращаются только некоторые из перечисленных ниже атрибутов.

Возвращается: при успешном выполнении

bandwidth_limit

integer

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

Возвращается: при успешном выполнении

created

string

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

Возвращается: при успешном выполнении

Пример: "2019-03-13T22:49:24Z"

iops_limit

integer

Ограничение IOPS тома.

Возвращается: при успешном выполнении

name

string

Имя тома.

Возвращается: при успешном выполнении

nvme_nguid

string

Глобально уникальный идентификатор пространства имен NVMe тома.

Возвращается: при успешном выполнении

Пример: "eui.00cd6b99ef25864724a937c5000be684"

page83_naa

string

Каноническое имя NAA тома.

Возвращается: при успешном выполнении

Пример: "naa.624a9370361019ecace43db3000120a4"

priority_operator

string

Оператор настройки приоритета DMM.

Возвращается: при успешном выполнении

priority_value

integer

Значение настройки приоритета DMM.

Возвращается: при успешном выполнении

serial

string

Серийный номер тома.

Возвращается: при успешном выполнении

Пример: "361019ECACE43D83000120A4"

size

integer

Размер тома в байтах.

Возвращается: при успешном выполнении

source

string

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

Возвращается: при успешном выполнении

Авторы

  • Команда Ansible Pure Storage (@sdodsley)

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

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

© 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/purestorage/flasharray/purefa_volume_module.html

Spec-Zone.ru

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