Модуль purestorage.flasharray.purefa_pgsnap – управление снимками групп защиты на Pure Storage FlashArray

Примечание

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

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

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

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

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

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

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

Создание и удаление снимков групп защиты на Pure Storage FlashArray.
Восстановление реплицированных снимков на целевом массиве-реплике.
Поддержка групп защиты ActiveCluster и групп томов.

Требования

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

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.27.0	Том, созданный из снимка, будет добавлен в указанные группы защиты
api_token string	Токен API FlashArray для пользователя с правами администратора.
apply_retention boolean	Применить к снимку параметры расписания хранения Варианты: `false` ← (по умолчанию) `true`
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.
name string / обязательный	Имя исходной группы защиты.
now boolean	Нужно ли немедленно создать снимок группы защиты Варианты: `false` ← (по умолчанию) `true`
offload string	Имя целевого ресурса выгрузки, на котором находится снимок. Применяется только при удалении и окончательном удалении снимков
overwrite boolean	Указать, нужно ли перезаписать целевой том, если он уже существует. Варианты: `false` ← (по умолчанию) `true`
remote boolean	Принудительно создать снимок и немедленно отправить его на удалённые целевые ресурсы Варианты: `false` ← (по умолчанию) `true`
restore string	Восстановить указанный том из снимка группы защиты. Имя группы защиты указывать не нужно. Укажите только имя восстанавливаемого тома.
state string	Указать, должен ли существовать снимок группы защиты. Значение Copy (добавлено в версии 2.7) создаёт полную копию снимка для чтения и записи. Варианты: `"absent"` `"present"` ← (по умолчанию) `"copy"` `"rename"`
suffix string	Суффикс имени снимка. Особый случай: если указано latest, модуль выберет последний снимок, созданный в группе
target string	Том, в который нужно восстановить указанный том. Если параметр не задан, по умолчанию используется том, указанный в restore Имя нового суффикса снимка при его переименовании
throttle boolean добавлено в purestorage.flasharray 1.21.0	Если установлено значение true, создание снимка может завершиться ошибкой, если состояние массива не оптимально. Варианты: `false` ← (по умолчанию) `true`
with_default_protection boolean добавлено в purestorage.flasharray 1.27.0	Добавлять ли группы защиты контейнера по умолчанию к группам, указанным в add_to_pgs, в качестве первоначальной защиты тома, созданного из снимка. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

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

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

- name: Restore volume data from local protection group snapshot named foo.snap to volume data2
  purestorage.flasharray.purefa_pgsnap:
    name: foo
    suffix: snap
    restore: data
    target: data2
    overwrite: true
    with_default_protection: false
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy

- name: Restore remote protection group snapshot arrayA:pgname.snap.data to local copy
  purestorage.flasharray.purefa_pgsnap:
    name: arrayA:pgname
    suffix: snap
    restore: data
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy

- name: Restore AC pod  protection group snapshot pod1::pgname.snap.data to pod1::data2
  purestorage.flasharray.purefa_pgsnap:
    name: pod1::pgname
    suffix: snap
    restore: data
    target: pod1::data2
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: copy

- name: Create snapshot of existing pgroup foo with suffix and force immediate copy to remote targets
  purestorage.flasharray.purefa_pgsnap:
    name: pgname
    suffix: force
    now: true
    apply_retention: true
    remote: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete and eradicate snapshot named foo.snap on offload target bar from arrayA
  purestorage.flasharray.purefa_pgsnap:
    name: "arrayA:foo"
    suffix: snap
    offload: bar
    eradicate: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent

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

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

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

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