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

Примечание

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

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

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

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

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

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

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

Создание и удаление томов и снимков томов на массивах Pure Storage FlashArray.

Требования

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

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

Параметры

Параметр	Комментарии
api_token string	Токен API FlashArray для пользователя с правами администратора.
context string добавлено в purestorage.flasharray 1.33.0	Имя участника кластера, для которого выполняется операция. Массив, получающий запрос, должен входить в кластер, а имя контекста должно соответствовать участнику того же кластера. По умолчанию: `""`
disable_warnings boolean добавлено в purestorage.flasharray 1.29.0	Отключить предупреждения о небезопасном сертификате в журналах отладки Варианты: `false` ← (по умолчанию) `true`
eradicate boolean	Определяет, следует ли окончательно удалить снимок при удалении или оставить его в корзине. Варианты: `false` ← (по умолчанию) `true`
fa_url string	IPv4-адрес или имя узла для управления FlashArray.
ignore_repl boolean	Доступно только для Purity//FA 6.1 или более поздней версии Если значение равно true, разрешить уничтожение/окончательное удаление снимков, используемых репликацией. Если значение равно false, разрешить уничтожение/окончательное удаление снимков, не используемых репликацией. Варианты: `false` ← (по умолчанию) `true`
name string / обязательный	Имя исходного тома.
offload string	Доступно только для Purity//FA 6.1 или более поздней версии Имя целевого объекта выгрузки для снимка. Целевым объектом может быть другой FlashArray или цель выгрузки. Применимо только при создании, удалении и окончательном удалении снимков. Значение copy для параметра state не поддерживается.
overwrite boolean	Определяет, следует ли перезаписать существующий том при создании тома из снимка. Варианты: `false` ← (по умолчанию) `true`
state string	Определяет, должен ли снимок тома существовать. Варианты: `"absent"` `"copy"` `"present"` ← (по умолчанию) `"rename"`
suffix string	Суффикс имени снимка.
target string	Имя целевого тома при создании из снимка. Новое имя суффикса снимка при переименовании снимка.
throttle boolean добавлено в purestorage.flasharray 1.21.0	Если значение равно true, создание снимка может завершиться ошибкой, если состояние массива не является оптимальным. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

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

Примеры

- name: Create snapshot foo.ansible
  purestorage.flasharray.purefa_snap:
    name: foo
    suffix: ansible
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: present

- name: Create R/W clone foo_clone from snapshot foo.snap
  purestorage.flasharray.purefa_snap:
    name: foo
    suffix: snap
    target: foo_clone
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy

- name: Create R/W clone foo_clone from remote mnapshot arrayB:foo.snap
  purestorage.flasharray.purefa_snap:
    name: arrayB:foo
    suffix: snap
    target: foo_clone
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy

- name: Overwrite existing volume foo_clone with snapshot foo.snap
  purestorage.flasharray.purefa_snap:
    name: foo
    suffix: snap
    target: foo_clone
    overwrite: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy

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

- name: Rename snapshot foo.fred to foo.dave
  purestorage.flasharray.purefa_snap:
    name: foo
    suffix: fred
    target: dave
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: rename

- name: Create a remote volume snapshot on offload device arrayB
  purestorage.flasharray.purefa_snap:
    name: foo
    offload: arrayB
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete and eradicate a volume snapshot foo.1 on offload device arrayB
  purestorage.flasharray.purefa_snap:
    name: foo
    suffix: 1
    offload: arrayB
    eradicate: true
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

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

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

Ключ	Описание
suffix 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_snap_module.html