Модуль dellemc.unity.snapshot – Управление снимками на системе хранения Unity

Примечание

Этот модуль является частью коллекции dellemc.unity (версия 2.0.0).

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

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

Для использования в плейбуке укажите: dellemc.unity.snapshot.

Добавлена в dellemc.unity 1.1.0

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

Обзор

Управление снимками на системе хранения Unity включает создание снимка, удаление снимка, обновление снимка, получение снимка, привязку хоста и отвязку хоста.

Требования

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

Устройство хранения Dell Unity версии 5.1 или выше.
Ansible-core 2.14 или выше.
Python 3.9, 3.10 или 3.11.
Storops Python SDK 1.2.11.

Параметры

Параметр	Комментарии
auto_delete boolean	Этот параметр указывает, автоматически удаляется снимок или нет. Если установлено значение `true`, снимок будет удален в соответствии с политикой автоматического удаления пула. Если установлено значение (false), снимок не будет автоматически удален в соответствии с политикой автоматического удаления пула. Параметр auto_delete не может быть установлен в `true`, если указано значение expiry_time. Если при создании не указаны ни auto_delete, ни expiry_time, то снимок будет создан с auto_delete, установленным в `true`. После установки expiry_time снимок не может быть назначен политике автоматического удаления. Варианты: `false` `true`
cg_name string	Имя группы согласованности, для которой создается снимок. Для создания снимка требуется либо vol_name, либо cg_name. Не требуется для других операций.
description string	Дополнительная информация о снимке может быть предоставлена с помощью этого параметра.
expiry_time string	Этот параметр используется для указания даты и времени, после которого снимок будет удален. Время должно быть указано в часовом поясе UTC. Формат: “MM/DD/YYYY HH:MM”. Год должен быть указан четырьмя цифрами.
host_id string	Идентификатор хоста. Для сопоставления или отмены сопоставления снимка с хостом требуется либо host_name, либо host_id. Снимок может быть присоединен к нескольким хостам.
host_name string	Имя хоста. Для сопоставления или отмены сопоставления снимка с хостом требуется либо host_name, либо host_id. Снимок может быть присоединен к нескольким хостам.
host_state string	Параметр host_state используется для указания наличия хоста для снимка. Требуется при сопоставлении или отмене сопоставления снимка с хостом. Варианты: `"mapped"` `"unmapped"`
new_snapshot_name string	Новое имя для снимка.
password string / required	Пароль сервера управления Unity.
port integer	Номер порта, через который осуществляется связь с сервером управления Unity. Значение по умолчанию: `443`
snapshot_id string	Идентификатор снимка. Для всех операций, кроме создания, требуется либо snapshot_name, либо snapshot_id.
snapshot_name string	Имя снимка. Обязательный параметр для создания снимка. Для всех остальных операций требуется либо snapshot_name, либо snapshot_id.
state string / required	Параметр state используется для указания наличия снимка. Варианты: `"absent"` `"present"`
unispherehost string / required	IP-адрес или FQDN сервера управления Unity.
username string / required	Имя пользователя сервера управления Unity.
validate_certs aliases: verifycert boolean	Логическая переменная, указывающая, следует ли проверять SSL-сертификат. `true` - Указывает, что SSL-сертификат должен быть проверен. `false` - Указывает, что SSL-сертификат не должен быть проверен. Варианты: `false` `true` ← (default)
vol_name string	Имя тома, для которого создается снимок. Для создания снимка требуется либо vol_name, либо cg_name. Не требуется для других операций.

Примечания

Примечание

check_mode не поддерживается.
Модули, присутствующие в этой коллекции под названием ‘dellemc.unity’, созданы для поддержки платформы хранения данных Dell Unity.

Примеры

- name: Create a Snapshot for a CG
  dellemc.unity.snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    cg_name: "{{cg_name}}"
    snapshot_name: "{{cg_snapshot_name}}"
    description: "{{description}}"
    auto_delete: false
    state: "present"

- name: Create a Snapshot for a volume with Host attached
  dellemc.unity.snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    vol_name: "{{vol_name}}"
    snapshot_name: "{{vol_snapshot_name}}"
    description: "{{description}}"
    expiry_time: "04/15/2025 16:30"
    host_name: "{{host_name}}"
    host_state: "mapped"
    state: "present"

- name: Unmap a host for a Snapshot
  dellemc.unity.snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    snapshot_name: "{{vol_snapshot_name}}"
    host_name: "{{host_name}}"
    host_state: "unmapped"
    state: "present"

- name: Map snapshot to a host
  dellemc.unity.snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    port: "{{port}}"
    snapshot_name: "{{vol_snapshot_name}}"
    host_name: "{{host_name}}"
    host_state: "mapped"
    state: "present"

- name: Update attributes of a Snapshot for a volume
  dellemc.unity.snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "{{vol_snapshot_name}}"
    new_snapshot_name: "{{new_snapshot_name}}"
    description: "{{new_description}}"
    host_name: "{{host_name}}"
    host_state: "unmapped"
    state: "present"

- name: Delete Snapshot of CG
  dellemc.unity.snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "{{cg_snapshot_name}}"
    state: "absent"

Значения возврата

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

Ключ	Описание
changed boolean	Изменилось ли ресурс. Возвращается: всегда Пример: `true`
snapshot_details dictionary	Подробности о снимке. Возвращается: При существовании снимка Пример: {"access_type": null, "attached_wwn": null, "creation_time": "2022-10-21 08:20:25.803000+00:00", "creator_schedule": null, "creator_type": "SnapCreatorTypeEnum.USER_CUSTOM", "creator_user": {"id": "user_admin"}, "description": "Test snap creation", "existed": true, "expiration_time": null, "hash": 8756689457056, "hosts_list": [], "id": "85899355291", "io_limit_policy": null, "is_auto_delete": true, "is_modifiable": false, "is_modified": false, "is_read_only": true, "is_system_snap": false, "last_writable_time": null, "lun": null, "name": "ansible_snap_cg_1_1", "parent_snap": null, "size": null, "snap_group": null, "state": "SnapStateEnum.READY", "storage_resource_id": "res_95", "storage_resource_name": "CG_ansible_test_2_new"}
expiration_time string	Дата и время, после которых снимок истечет. Возвращается: успех
hosts_list dictionary	Содержит имя и идентификатор связанных хостов. Возвращается: успех
id string	Уникальный идентификатор экземпляра снимка. Возвращается: успех
is_auto_delete string	Дополнительная информация о снимке. Возвращается: успех
name string	Имя снимка. Возвращается: успех
storage_resource_id string	Идентификатор хранилищного ресурса, для которого существует снимок. Возвращается: успех
storage_resource_name string	Имя хранилищного ресурса, для которого существует снимок. Возвращается: успех

Авторы

P Srinivas Rao (@srinivas-rao5)

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

© 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/dellemc/unity/snapshot_module.html