Модуль purestorage.flasharray.purefa_volume — Управление томами на Pure Storage FlashArray
Примечание
Этот модуль является частью коллекции purestorage.flasharray (версия 1.31.1).
У вас может быть уже установлена эта коллекция, если вы используете пакет 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 список / элементы=строка добавлен в purestorage.flasharray 1.14.0 | При создании новый том будет добавлен в указанные группы защиты. |
api_token строка | Токен API FlashArray для пользователя с правами администратора. |
bw_qos псевдонимы: qos строка | Предел пропускной способности для тома в единицах М или Г. М установит МБ/с, Г установит ГБ/с. Для очистки существующей настройки QoS используйте 0 (ноль). |
count целое число | Количество томов, подлежащих созданию при создании нескольких томов. Поддерживается только начиная с Purity//FA v6.0.0 и выше. |
digits целое число | Количество цифр для использования при создании нескольких томов. Это позволит дополнять индексные номера нулями при необходимости. Поддерживается только начиная с Purity//FA v6.0.0 и выше. Диапазон от 1 до 10. По умолчанию: |
disable_warnings булево добавлен в purestorage.flasharray 1.29.0 | Отключить предупреждения о небезопасных сертификатах в отладочных журналах. Варианты:
|
eradicate булево | Определить, следует ли уничтожить том при удалении или оставить в корзине. Варианты:
|
fa_url строка | Управление FlashArray IPv4-адрес или имя хоста. |
iops_qos строка | Предел IOPs для тома — использовать значение или K или M. K означает 1000, M означает 1000000. Для очистки существующей настройки IOPs используйте 0 (ноль). |
move строка | Перемещение тома в подсистему или группу виртуальных томов и из неё. Укажите имя подсистемы или группы виртуальных томов, в которую нужно переместить том. Имена подсистем и групп виртуальных томов должны быть уникальными в массиве. Для перемещения в локальный массив укажите Это не идемпотентная операция — используйте |
name строка / обязательно | Имя тома. Том может быть создан в POD с помощью этого синтаксиса POD_NAME::VOLUME_NAME. Том может быть создан в группе томов с помощью этого синтаксиса VG_NAME/VOLUME_NAME. Поддержка нескольких томов доступна начиная с Purity//FA 6.0.0 ***ПРИМЕЧАНИЕ*** Ручное удаление или уничтожение отдельных томов, созданных с помощью нескольких томов, приведет к сбою идемпотентности. Поддержка нескольких томов существует только для создания томов. |
overwrite булево | Определить, следует ли перезаписать целевой том, если он уже существует. Варианты:
|
pgroup строка добавлен в purestorage.flasharray 1.8.0 | Имя существующей, не удаленной, группы защиты, к которой добавить том. Только для создания томов. Заменено в Purity//FA 6.3.4 на add_to_pgs |
priority_operator строка добавлен в purestorage.flasharray 1.13.0 | Оператор корректировки приоритета DMM. Варианты:
|
priority_value целое число добавлен в purestorage.flasharray 1.13.0 | Значение корректировки приоритета DMM. Варианты:
|
promotion_state строка добавлен в purestorage.flasharray 1.16.0 | Продвинуть или понизить уровень тома, чтобы том начал или прекратил принимать запросы на запись. Варианты:
|
rename строка | Значение для переименования указанного тома. Переименование применяется только к контейнеру, в котором находится текущий том. Нет необходимости указывать имя подсистемы или группы виртуальных томов, так как оно подразумевается. |
size строка | Размер тома в единицах М, Г, Т или П. |
start целое число | Число, с которого нужно начать индекс при создании нескольких томов. Поддерживается только начиная с Purity//FA v6.0.0 и выше. По умолчанию: |
state string | Определить, должно ли существовать том или нет. Варианты:
|
suffix string | Строка постфикса, если требуется, для создания нескольких томов. Имена томов будут сформированы как <имя>#I<постфикс>, где # является заполнитель для индекса тома. См. соответствующие описания. Поддерживается только начиная с Purity//FA v6.0.0 и выше. По умолчанию: |
target string | Имя целевого тома, если происходит копирование. |
with_default_protection boolean добавлен в purestorage.flasharray 1.14.0 | Добавить ли группы защиты контейнеров по умолчанию к тем, которые указаны в add_to_pgs, в качестве начальной защиты нового тома. Варианты:
|
Примечания
Примечание
- Для этого модуля требуются библиотеки Python
purestorageиpy-pure-client. - Для определенных модулей могут потребоваться дополнительные библиотеки Python.
- Вы должны установить переменные среды
PUREFA_URLиPUREFA_API, если аргументы fa_url и api_token не переданы в модуль напрямую.
Примеры
- 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: +
priorty_value: 10
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
state: present
- name: Create new volume named foo in pod bar in protection group pg1
purestorage.flasharray.purefa_volume:
name: bar::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 словарь | Словарь, описывающий измененный том. Только некоторые атрибуты ниже будут возвращены с различными действиями. Возвращается: успешно |
|
bandwidth_limit целое число |
Предел пропускной способности тома в байтах/сек Возвращается: успешно |
|
created строка |
Время создания тома Возвращается: успешно Пример: |
|
iops_limit целое число |
Предел IOPs тома Возвращается: успешно |
|
name строка |
Имя тома Возвращается: успешно |
|
nvme_nguid строка |
Глобально уникальный идентификатор пространства имен NVMe тома Возвращается: успешно Пример: |
|
page83_naa строка |
Каноническое имя NAA тома Возвращается: успешно Пример: |
|
priority_operator строка |
Оператор корректировки приоритета DMM Возвращается: успешно |
|
priority_value целое число |
Значение корректировки приоритета DMM Возвращается: успешно |
|
serial строка |
Серийный номер тома Возвращается: успешно Пример: |
|
size целое число |
Размер тома в байтах Возвращается: успешно |
|
source строка |
Имя тома исходного тома, используемого для копирования тома Возвращается: успешно |
Ссылки на коллекцию
© 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/purestorage/flasharray/purefa_volume_module.html