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

Примечание

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

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

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

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

Новая версия в 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.

Параметры

Параметр	Комментарии
access_policy строка	Политика доступа к файловой системе. Варианты: `"NATIVE"` `"UNIX"` `"WINDOWS"`
cap_unit строка	Единица измерения размера файловой системы. По умолчанию используется `GB`, если не указано другое. Варианты: `"GB"` `"TB"`
data_reduction булево	Булево значение, указывающее, включена ли компрессия. Компрессия поддерживается только для тонких файловых систем. Варианты: `false` `true`
description строка	Описание файловой системы. Описание можно удалить, передав пустую строку (“”).
filesystem_id строка	Идентификатор файловой системы. Может использоваться только для операций получения, изменения или удаления. Взаимоисключающее с filesystem_name.
filesystem_name строка	Имя файловой системы. Обязательно только для операции создания. Все операции поддерживаются через filesystem_name. Взаимоисключающее с filesystem_id.
is_thin булево	Булево значение, указывающее, является ли это тонкой файловой системой. Варианты: `false` `true`
locking_policy строка	Политики блокировки файловой системы. Эти варианты управляют тем, должны ли соблюдаться блокировки диапазона NFSv4. Варианты: `"ADVISORY"` `"MANDATORY"`
nas_server_id строка	Идентификатор сервера NAS, на котором будет размещена файловая система.
nas_server_name строка	Имя сервера NAS, на котором будет размещена файловая система.
password строка / обязательно	Пароль сервера управления Unity.
pool_id строка	Это ID пула, где будет создана файловая система. Для создания новой файловой системы необходимо указать либо pool_name, либо pool_id.
pool_name строка	Это имя пула, где будет создана файловая система. Для создания новой файловой системы необходимо указать либо pool_name, либо pool_id.
port целое число	Номер порта, через который происходит общение с сервером управления Unity. По умолчанию: `443`
quota_config словарь	Настройка управления квотами. Содержит необязательные параметры.
cap_unit строка	Единица измерения default_soft_limit и default_hard_limit. Единица измерения по умолчанию - `GB`. Варианты: `"MB"` `"GB"` `"TB"`
default_hard_limit целое число	Пороговое значение жесткого лимита для квот пользователей и деревьев. Если default_hard_limit не задан при создании файловой системы, он будет установлен по умолчанию в `0B`.
default_soft_limit целое число	Пороговое значение мягкого лимита для квот пользователей и деревьев. Если default_soft_limit не задан при создании файловой системы, он будет установлен по умолчанию в `0B`.
grace_period целое число	Срок отсрочки, установленный в настройках квот после достижения мягкого лимита. Если grace_period не задан при создании файловой системы, он будет установлен по умолчанию в `7 days`.
grace_period_unit строка	Единица измерения срока отсрочки. Единица измерения по умолчанию - `days`. Варианты: `"minutes"` `"hours"` `"days"`

END_OF_DOCUMENT_MARKER

is_user_quota_enabled boolean	Указывает, включена ли квота пользователя. Если is_user_quota_enabled не установлено при создании файловой системы, оно будет установлено по умолчанию в `false`. Параметры is_user_quota_enabled и quota_policy взаимоисключающие. Варианты: `false` `true`
quota_policy string	Политика квот, установленная в конфигурации квот. Если quota_policy не установлено при создании файловой системы, оно будет установлено по умолчанию в `FILE_SIZE`. Параметры is_user_quota_enabled и quota_policy взаимоисключающие. Варианты: `"FILE_SIZE"` `"BLOCKS"`
replication_params dictionary	Настройки, необходимые для включения или изменения репликации.
destination_pool_id string	Идентификатор пула для выделения целевой файловой системы.
destination_pool_name string	Имя пула для выделения целевой файловой системы.
new_replication_name string	Имя репликации для переименования сессии.
remote_system dictionary	Подробности удаленной системы, к которой настраивается репликация. Параметр remote_system должен быть указан, если replication_type равен `remote`.
remote_system_host string / обязательно	IP-адрес или FQDN удаленного хоста Unity unisphere.
remote_system_password string / обязательно	Пароль удаленного хоста Unity unisphere.
remote_system_port integer	Порт, на котором размещен удаленный Unity unisphere. По умолчанию: `443`
remote_system_username string / обязательно	Имя пользователя удаленного хоста Unity unisphere.
remote_system_verifycert boolean	Логическая переменная, указывающая, нужно ли проверять сертификат SSL удаленного хоста Unity unisphere. `true` — Указывает, что сертификат SSL должен быть проверен. `false` — Указывает, что сертификат SSL проверять не нужно. Варианты: `false` `true` ← (по умолчанию)
replication_mode string	Режим репликации. Это обязательное поле при создании сессии репликации. Варианты: `"synchronous"` `"asynchronous"` `"manual"`
replication_name string	Имя сессии репликации.
replication_type string	Тип репликации. Варианты: `"local"` `"remote"`
rpo integer	Максимальное время ожидания синхронизации источника и назначения LUN. Параметр rpo должен быть указан, если replication_mode равен `asynchronous`. Значение должно быть в диапазоне от `5` до `1440` для `asynchronous`, `0` для `synchronous` и `-1` для `manual`.
replication_state string	Состояние репликации. Варианты: `"enable"` `"disable"`
size integer	Размер файловой системы.
smb_properties dictionary	Дополнительные настройки для SMB. Содержит дополнительные переменные.
is_smb_notify_on_access_enabled boolean	Указывает, включены ли уведомления об изменениях структуры каталога файла. Варианты: `false` `true`

is_smb_notify_on_write_enabled boolean	Указывает, включены ли уведомления о записи файлов в файловой системе. Варианты: `false` `true`
is_smb_op_locks_enabled boolean	Указывает, включена ли функция временной блокировки файлов в файловой системе. Варианты: `false` `true`
is_smb_sync_writes_enabled boolean	Указывает, включен ли параметр синхронных записей в файловой системе. Варианты: `false` `true`
smb_notify_on_change_dir_depth integer	Целочисленная переменная, определяющая минимальный уровень каталога, на который распространяются включенные уведомления. Минимальное значение — `1`.
snap_schedule_id string	Это идентификатор существующего расписания создания моментальных снимков, которое необходимо связать с файловой системой. Это взаимно исключающее свойство с snapshot_schedule_name.
snap_schedule_name string	Это имя существующего расписания создания моментальных снимков, которое необходимо связать с файловой системой. Это взаимно исключающее свойство с snapshot_schedule_id.
state string / обязательно	Переменная состояния, определяющая, будет ли существовать файловая система или нет. Варианты: `"absent"` `"present"`
supported_protocols string	Протоколы, поддерживаемые файловой системой. Будут перезаписаны настройками сервера NAS, если сервер NAS `Multiprotocol`. Варианты: `"NFS"` `"CIFS"` `"MULTIPROTOCOL"`
tiering_policy string	Варианты политики тиеринга для распределения данных хранилища по доступным уровням в пуле. Варианты: `"AUTOTIER_HIGH"` `"AUTOTIER"` `"HIGHEST"` `"LOWEST"`
unispherehost string / обязательно	IP-адрес или FQDN сервера управления Unity.
username string / обязательно	Имя пользователя сервера управления Unity.
validate_certs псевдонимы: verifycert boolean	Логическая переменная, определяющая, нужно ли проверять сертификат SSL. `true` — Указывает, что сертификат SSL должен быть проверен. `false` — Указывает, что сертификат SSL проверять не нужно. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Create FileSystem
  dellemc.unity.filesystem:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_name: "ansible_test_fs"
    nas_server_name: "lglap761"
    pool_name: "pool_1"
    size: 5
    state: "present"

- name: Create FileSystem with quota configuration
  dellemc.unity.filesystem:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_name: "ansible_test_fs"
    nas_server_name: "lglap761"
    pool_name: "pool_1"
    size: 5
    quota_config:
      grace_period: 8
      grace_period_unit: "days"
      default_soft_limit: 10
      is_user_quota_enabled: false
    state: "present"

- name: Expand FileSystem size
  dellemc.unity.filesystem:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_name: "ansible_test_fs"
    nas_server_name: "lglap761"
    size: 10
    state: "present"

- name: Expand FileSystem size
  dellemc.unity.filesystem:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_name: "ansible_test_fs"
    nas_server_name: "lglap761"
    size: 10
    state: "present"

- name: Modify FileSystem smb_properties
  dellemc.unity.filesystem:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_name: "ansible_test_fs"
    nas_server_name: "lglap761"
    smb_properties:
      is_smb_op_locks_enabled: true
      smb_notify_on_change_dir_depth: 5
      is_smb_notify_on_access_enabled: true
    state: "present"

- name: Modify FileSystem Snap Schedule
  dellemc.unity.filesystem:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "fs_141"
    snap_schedule_id: "{{snap_schedule_id}}"
    state: "{{state_present}}"

- name: Get details of FileSystem using id
  dellemc.unity.filesystem:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "rs_405"
    state: "present"

- name: Delete a FileSystem using id
  dellemc.unity.filesystem:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "rs_405"
    state: "absent"

- name: Enable replication on the fs
  dellemc.unity.filesystem:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "rs_405"
    replication_params:
      replication_name: "test_repl"
      replication_type: "remote"
      replication_mode: "asynchronous"
      rpo: 60
      remote_system:
        remote_system_host: '0.1.2.3'
        remote_system_verifycert: false
        remote_system_username: 'username'
        remote_system_password: 'password'
      destination_pool_name: "pool_test_1"
    replication_state: "enable"
    state: "present"

- name: Modify replication on the fs
  dellemc.unity.filesystem:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "rs_405"
    replication_params:
      replication_name: "test_repl"
      new_replication_name: "test_repl_updated"
      replication_mode: "asynchronous"
      rpo: 50
    replication_state: "enable"
    state: "present"

- name: Disable replication on the fs
  dellemc.unity.filesystem:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "rs_405"
    replication_state: "disable"
    state: "present"

- name: Disable replication by specifying replication_name on the fs
  dellemc.unity.filesystem:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "rs_405"
    replication_params:
      replication_name: "test_replication"
    replication_state: "disable"
    state: "present"

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

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

Ключ	Описание
изменён логический тип	Изменился ли ресурс. Возвращается: всегда Пример: `true`
filesystem_details словарь	Подробности файловой системы. Возвращается: При существовании файловой системы Пример: {"access_policy": "AccessPolicyEnum.UNIX", "cifs_notify_on_change_dir_depth": 512, "cifs_share": null, "data_reduction_percent": 0, "data_reduction_ratio": 1.0, "data_reduction_size_saved": 0, "description": "", "existed": true, "folder_rename_policy": "FSRenamePolicyEnum.SMB_RENAME_FORBIDDEN", "format": "FSFormatEnum.UFS64", "hash": 8735427610152, "health": {"UnityHealth": {"hash": 8735427614928}}, "host_io_size": "HostIOSizeEnum.GENERAL_8K", "id": "fs_65916", "is_advanced_dedup_enabled": false, "is_cifs_notify_on_access_enabled": false, "is_cifs_notify_on_write_enabled": false, "is_cifs_op_locks_enabled": false, "is_cifs_sync_writes_enabled": false, "is_data_reduction_enabled": false, "is_read_only": false, "is_smbca": false, "is_thin_enabled": true, "locking_policy": "FSLockingPolicyEnum.MANDATORY", "metadata_size": 11274289152, "metadata_size_allocated": 4294967296, "min_size_allocated": 0, "name": "test_fs", "nas_server": {"id": "nas_18", "name": "test_nas1"}, "nfs_share": null, "per_tier_size_used": [6979321856, 0, 0], "pool": {"id": "pool_7", "name": "pool 7"}, "pool_full_policy": "ResourcePoolFullPolicyEnum.FAIL_WRITES", "quota_config": {"default_hard_limit": "0B", "default_soft_limit": "0B", "grace_period": "7.0 days", "id": "quotaconfig_171798760421_0", "is_user_quota_enabled": false, "quota_policy": "QuotaPolicyEnum.FILE_SIZE"}, "replication_sessions": {"current_transfer_est_remain_time": 0, "id": "***", "last_sync_time": "2022-05-12 11:20:38+00:00", "local_role": "ReplicationSessionReplicationRoleEnum.SOURCE", "max_time_out_of_sync": 60, "members": null, "name": "local_repl_new", "network_status": "ReplicationSessionNetworkStatusEnum.OK", "remote_system": {"UnityRemoteSystem": {"hash": 8735426929707}}, "replication_resource_type": "ReplicationEndpointResourceTypeEnum.FILESYSTEM", "src_resource_id": "res_66444", "src_status": "ReplicationSessionStatusEnum.OK", "status": "ReplicationOpStatusEnum.AUTO_SYNC_CONFIGURED", "sync_progress": 0, "sync_state": "ReplicationSessionSyncStateEnum.IDLE"}, "size_allocated": 283148288, "size_allocated_total": 4578148352, "size_preallocated": 2401173504, "size_total": 10737418240, "size_total_with_unit": "10.0 GB", "size_used": 1620312064, "snap_count": 2, "snaps_size": 21474869248, "snaps_size_allocated": 32768, "snapshots": [], "supported_protocols": "FSSupportedProtocolEnum.NFS", "tiering_policy": "TieringPolicyEnum.AUTOTIER_HIGH", "type": "FilesystemTypeEnum.FILESYSTEM"}
cifs_notify_on_change_dir_depth целое число	Указывает минимальную глубину каталога, на которую распространяются разрешённые уведомления (если таковые есть). Возвращается: успех
описание строка	Описание файловой системы. Возвращается: успех
id строка	Сгенерированный системой идентификатор файловой системы. Возвращается: успех
is_cifs_notify_on_access_enabled логический тип	Указывает, генерирует ли система уведомления при доступе пользователя к файловой системе. Возвращается: успех
is_cifs_notify_on_write_enabled логический тип	Указывает, генерирует ли система уведомления при записи в файловую систему. Возвращается: успех
is_cifs_op_locks_enabled логический тип	Указывает, включены ли опциональные блокировки файлов для файловой системы. Возвращается: успех
is_cifs_sync_writes_enabled логический тип	Указывает, включена ли опция синхронных записей CIFS для файловой системы. Возвращается: успех
is_data_reduction_enabled логический тип	Включена ли сжатие для этой файловой системы. Возвращается: успех
is_thin_enabled логический тип	Указывает, включено ли разнесение для этой файловой системы. Возвращается: успех
имя строка	Имя файловой системы. Возвращается: успех
nas_server словарь	Подробности NAS-сервера, на котором размещена данная файловая система. Возвращается: успех
id строка	Идентификатор NAS-сервера, присвоенный системой. Возвращается: успех
имя строка	Имя NAS-сервера. Возвращается: успех
пул словарь	Пул, в котором размещена файловая система. Возвращается: успех
id строка	Идентификатор пула, присвоенный системой. Возвращается: успех
имя строка	Имя хранилища пула. Возвращается: успех
quota_config словарь	Подробности конфигурации квот для созданной файловой системы. Возвращается: успех
default_hard_limit целое число	Максимальное значение квот для пользователей и каталогов. Возвращается: успех
default_soft_limit целое число	Минимальное значение квот для пользователей и каталогов. Возвращается: успех

grace_period string	Период отсрочки, установленный в настройках квот после достижения мягкого лимита. Возвращаемое значение: success
is_user_quota_enabled boolean	Указывает, включена ли квота пользователя. Возвращаемое значение: success
quota_policy string	Политика квот, установленная в настройках квот. Возвращаемое значение: success
replication_sessions dictionary	Список сессий репликации, если репликация включена. Возвращаемое значение: success
id string	Идентификатор сессии репликации Возвращаемое значение: success
name string	Имя сессии репликации Возвращаемое значение: success
remote_system dictionary	Удаленная система Возвращаемое значение: success
id string	Идентификатор удалённой системы Возвращаемое значение: success
size_total_with_unit string	Размер файловой системы с фактической единицей измерения. Возвращаемое значение: success
snap_schedule_id string	Указывает идентификатор расписания создания моментальных снимков, связанного с файловой системой. Возвращаемое значение: success
snap_schedule_name string	Указывает имя расписания создания моментальных снимков, связанного с файловой системой. Возвращаемое значение: success
snapshots list / elements=string	Список моментальных снимков этой файловой системы. Возвращаемое значение: success
id string	Идентификатор системы, присвоенный моментальному снимку файловой системы. Возвращаемое значение: success
name string	Название моментального снимка файловой системы. Возвращаемое значение: success
tiering_policy string	Примененная политика тиеринга к этой файловой системе. Возвращаемое значение: success

Авторы

Arindam Datta (@dattaarindam)
Meenakshi Dembi (@dembim)
Spandita Panigrahi (@panigs7)

Ссылки на сборки

© 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/filesystem_module.html