Модуль dellemc.unity.filesystem_snapshot — управление снимками файловой системы в системе хранения Unity

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: dellemc.unity.filesystem_snapshot.

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

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

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

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

Требования

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

Устройство Dell Unity Storage версии 5.3 или более поздней.
Ansible-core версии 2.17 или более поздней.
Python 3.11, 3.12 или 3.13.
Storops Python SDK 1.2.12.

Параметры

Параметр	Комментарии
auto_delete логический	Этот параметр указывает, следует ли автоматически удалять снимок файловой системы. Если задано значение `true`, срок действия снимка файловой системы истечет в соответствии с политикой автоматического удаления пула. Если задано значение `false`, снимок файловой системы не будет автоматически удален в соответствии с политикой автоматического удаления пула. Параметру auto_delete нельзя задать значение `true`, если указан параметр expiry_time. Если при создании не указаны ни auto_delete, ни expiry_time, снимок файловой системы будет создан со значением auto_delete `true`. После установки значения expiry_time снимок файловой системы нельзя назначить политике автоматического удаления. Допустимые значения: `false` `true`
description строка	С помощью этого параметра можно указать дополнительную информацию о снимке файловой системы. Описание можно удалить, передав пустую строку.
expiry_time строка	Этот параметр задает дату и время истечения срока действия снимка файловой системы. Время необходимо указывать в часовом поясе UTC. Формат: «MM/DD/YYYY HH:MM». Год должен состоять из 4 цифр.
filesystem_id строка	Идентификатор файловой системы, для которой создается снимок. Для создания снимка файловой системы необходимо указать либо filesystem_id, либо filesystem_name. Для других операций не требуется.
filesystem_name строка	Имя файловой системы, для которой создается снимок. Для создания снимка файловой системы необходимо указать либо filesystem_name, либо filesystem_id. Для других операций не требуется.
fs_access_type строка	Тип доступа к снимку файловой системы. Требуется только при создании снимка файловой системы. Если не указано, тип доступа снимка будет `Checkpoint`. Допустимые значения: `"Checkpoint"` `"Protocol"`
nas_server_id строка	Идентификатор NAS-сервера, на котором создана файловая система. Для создания снимка файловой системы необходимо указать либо filesystem_id, либо filesystem_name. Для других операций не требуется.
nas_server_name строка	Имя NAS-сервера, на котором создана файловая система. Для создания снимка файловой системы необходимо указать либо nas_server_name, либо nas_server_id. Для других операций не требуется.
password строка / обязательный	Пароль сервера управления Unity.
port целое число	Номер порта, через который осуществляется связь с сервером управления Unity. По умолчанию: `443`
snapshot_id строка	При создании snapshot_id генерируется автоматически. Для всех остальных операций необходимо указать либо snapshot_id, либо snapshot_name.
snapshot_name строка	Имя снимка файловой системы. Обязательный параметр для создания снимка файловой системы. Для всех остальных операций необходимо указать либо snapshot_name, либо snapshot_id.
state строка / обязательный	Параметр state указывает, должен ли существовать снимок файловой системы. Допустимые значения: `"absent"` `"present"`
unispherehost строка / обязательный	IP-адрес или полное доменное имя сервера управления Unity.
username строка / обязательный	Имя пользователя сервера управления Unity.
validate_certs псевдонимы: verifycert логический	Логическая переменная, указывающая, нужно ли проверять SSL-сертификат. `true` — указывает, что SSL-сертификат необходимо проверить. `false` — указывает, что SSL-сертификат проверять не нужно. Допустимые значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

Снимок файловой системы нельзя удалить, если для него имеется общий ресурс NFS или SMB.
Режим check_mode не поддерживается.
Модули этой коллекции под названием «dellemc.unity» предназначены для поддержки платформы хранения Dell Unity.

Примеры

- name: Create Filesystem Snapshot
  filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "ansible_test_FS_snap"
    filesystem_name: "ansible_test_FS"
    nas_server_name: "lglad069"
    description: "Created using playbook"
    auto_delete: true
    fs_access_type: "Protocol"
    state: "present"

- name: Create Filesystem Snapshot with expiry time
  filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "ansible_test_FS_snap_1"
    filesystem_name: "ansible_test_FS_1"
    nas_server_name: "lglad069"
    description: "Created using playbook"
    expiry_time: "04/15/2021 2:30"
    fs_access_type: "Protocol"
    state: "present"

- name: Get Filesystem Snapshot Details using Name
  filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "ansible_test_FS_snap"
    state: "present"

- name: Get Filesystem Snapshot Details using ID
  filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_id: "10008000403"
    state: "present"

- name: Update Filesystem Snapshot attributes
  filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "ansible_test_FS_snap"
    description: "Description updated"
    auto_delete: false
    expiry_time: "04/15/2021 5:30"
    state: "present"

- name: Update Filesystem Snapshot attributes using ID
  filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_id: "10008000403"
    expiry_time: "04/18/2021 8:30"
    state: "present"

- name: Delete Filesystem Snapshot using Name
  filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_name: "ansible_test_FS_snap"
    state: "absent"

- name: Delete Filesystem Snapshot using ID
  filesystem_snapshot:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    snapshot_id: "10008000403"
    state: "absent"

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

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

Ключ	Описание
changed логический	Изменился ли ресурс. Возвращается: всегда Пример: `true`
filesystem_snapshot_details словарь	Сведения о снимке файловой системы. Возвращается: если снимок файловой системы существует Пример: {"access_type": "FilesystemSnapAccessTypeEnum.CHECKPOINT", "attached_wwn": null, "creation_time": "2022-10-21 04:42:53.951000+00:00", "creator_schedule": null, "creator_type": "SnapCreatorTypeEnum.USER_CUSTOM", "creator_user": {"id": "user_admin"}, "description": "Created using playbook", "existed": true, "expiration_time": null, "filesystem_id": "fs_137", "filesystem_name": "test", "hash": 8739894572587, "host_access": null, "id": "171798721695", "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": "test_FS_snap_1", "nas_server_id": "nas_1", "nas_server_name": "lglad072", "parent_snap": null, "size": 107374182400, "snap_group": null, "state": "SnapStateEnum.READY"}
access_type строка	Тип доступа к снимку файловой системы. Возвращается: при успешном выполнении
attached_wwn строка	Сведения о подключенном WWN. Возвращается: при успешном выполнении
creation_time строка	Время создания снимка файловой системы. Возвращается: при успешном выполнении
creator_schedule строка	Расписание создания снимка файловой системы. Возвращается: при успешном выполнении
creator_type строка	Тип создателя снимка файловой системы. Возвращается: при успешном выполнении
creator_user строка	Пользователь, создавший снимок файловой системы. Возвращается: при успешном выполнении
description строка	Описание снимка файловой системы. Возвращается: при успешном выполнении
expiration_time строка	Дата и время истечения срока действия снимка файловой системы. Возвращается: при успешном выполнении
filesystem_id строка	Идентификатор файловой системы, снимок которой существует. Возвращается: при успешном выполнении
filesystem_name строка	Имя файловой системы, снимок которой существует. Возвращается: при успешном выполнении
id строка	Уникальный идентификатор экземпляра снимка файловой системы. Возвращается: при успешном выполнении
is_auto_delete логический	Указывает, удаляется ли снимок файловой системы автоматически. Возвращается: при успешном выполнении
name строка	Имя снимка файловой системы. Возвращается: при успешном выполнении
nas_server_id строка	Идентификатор NAS-сервера, на котором находится файловая система. Возвращается: при успешном выполнении
nas_server_name строка	Имя NAS-сервера, на котором находится файловая система. Возвращается: при успешном выполнении
size целое число	Размер снимка файловой системы. Возвращается: при успешном выполнении

Авторы

Rajshree Khare (@kharer5)

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

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