purestorage.flasharray.purefa_volume – Управление томами на FlashArray Pure Storage

Примечание

Этот плагин входит в коллекцию purestorage.flasharray (версия 1.5.1).

Для его установки используйте: ansible-galaxy collection install purestorage.flasharray.

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

Новое в версии 1.0.0: of purestorage.flasharray

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

Описание

Создание, удаление или расширение емкости тома на Pure Storage FlashArray.

Требования

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

python >= 2.7
purestorage >= 1.19
py-pure-client >= 1.6.0
netaddr
requests

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_token строка		Токен API FlashArray для пользователя с правами администратора.
bw_qos строка		Предел пропускной способности для тома в единицах М или Г. М установит значение в Мбит/с, Г установит значение в Гбит/с. Для очистки существующего параметра QoS используйте 0 (ноль). псевдонимы: qos
count целое число		Количество томов, которые нужно создать при создании нескольких томов. Поддерживается только с Purity//FA v6.0.0 и выше.
digits целое число	Значение по умолчанию: 1	Количество цифр для использования при создании нескольких томов. Это позволит дополнить индекс нулями по мере необходимости. Поддерживается только с Purity//FA v6.0.0 и выше. Диапазон значений от 1 до 10
eradicate логическое значение	Варианты: нет ← да	Определяет, нужно ли уничтожить том при удалении или оставить в корзине.
fa_url строка		IP-адрес или имя хоста FlashArray управления IPv4.
iops_qos строка		Предел IOPs для тома – используйте значение или К или М. К означает 1000, М означает 1000000. Для очистки существующего параметра IOPs используйте 0 (ноль).
move строка		Перемещение тома в и из подсети или группы виртуальных томов. Укажите имя подсети или группы виртуальных томов, в которые нужно переместить том. Имена подсети и группы виртуальных томов должны быть уникальными в массиве. Для перемещения в локальный массив укажите `local` Этот параметр не идемпотентен – используйте `ignore_errors` в книге задач.
name строка / обязательный параметр		Имя тома. Том может быть создан в подсети с таким синтаксисом: POD_NAME::VOLUME_NAME. Том может быть создан в группе томов с таким синтаксисом: VG_NAME/VOLUME_NAME. Поддержка нескольких томов доступна с Purity//FA 6.0.0 *ПРИМЕЧАНИЕ* Ручное удаление или уничтожение отдельных томов, созданных с использованием нескольких томов, приведет к тому, что идемпотентность будет нарушена. Поддержка нескольких томов существует только для создания томов.
overwrite логическое значение	Варианты: нет ← да	Определяет, нужно ли перезаписывать целевой том, если он уже существует.
rename строка		Значение для переименования указанного тома. Переименование применяется только к контейнеру, в котором находится текущий том. Нет необходимости указывать имя подсети или группы виртуальных томов, так как это подразумевается.
size строка		Размер тома в единицах М, Г, Т или П.
start целое число	Значение по умолчанию: 0	Номер, с которого нужно начать индекс при создании нескольких томов. Поддерживается только с Purity//FA v6.0.0 и выше.
state строка	Варианты: absent present ←	Определяет, должен ли существовать том или нет.
suffix строка		Строка-суффикс, если требуется, для создания нескольких томов. Имена томов будут формироваться как <name>#I<suffix>, где # – заполнитель для индекса тома. См. соответствующие описания. Поддерживается только с Purity//FA v6.0.0 и выше.
target строка		Имя целевого тома, если копируется.

Примечания

Примечание

Для работы этого модуля требуется библиотека Python purestorage
Необходимо установить переменные среды PUREFA_URL и PUREFA_API, если аргументы fa_url и api_token не передаются в модуль напрямую.

Примеры

- name: Create new volume named foo with a QoS limit
  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 in pod bar
  purefa_volume:
    name: bar::foo
    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
  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
  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
  purefa_volume:
    name: foo
    eradicate: yes
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

- name: Create clone of volume bar named foo
  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
  purefa_volume:
    name: foo
    target: bar
    overwrite: yes
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Clear volume QoS from volume foo
  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
  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
  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
  purefa_volume:
    name: bar::foo
    move: fin
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

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

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

Ключ		Возвращается	Описание
volume словарь		успех	Словарь, описывающий измененный том. Только некоторые атрибуты ниже будут возвращены с различными действиями.
	bandwidth_limit целое число	успех	Предел пропускной способности тома в байтах/с
	created строка	успех	Время создания тома Пример: 2019-03-13T22:49:24Z
	iops_limit целое число	успех	Предел IOPs для тома
	name строка	успех	Имя тома
	serial строка	успех	Серийный номер тома Пример: 361019ECACE43D83000120A4
	size целое число	успех	Размер тома в байтах
	source строка	успех	Имя тома исходного тома, используемого для копирования тома

Авторы

Команда Ansible Pure Storage (@sdodsley) <pure-ansible-team@purestorage.com>

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/purestorage/flasharray/purefa_volume_module.html