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

Примечание

Этот модуль входит в коллекцию dellemc.unity (версия 2.1.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.3 или более поздней.
Ansible-core версии 2.17 или более поздней.
Python 3.11, 3.12 или 3.13.
Python SDK Storops 1.2.12.

Параметры

Параметр	Комментарии
access_policy string	Политика доступа к файловой системе. Возможные значения: `"NATIVE"` `"UNIX"` `"WINDOWS"`
cap_unit string	Единица измерения размера файловой системы. Если не указана, по умолчанию используется `GB`. Возможные значения: `"GB"` `"TB"`
data_reduction boolean	Логическая переменная, указывающая, следует ли включить сжатие. Сжатие поддерживается только для тонкой файловой системы. Возможные значения: `false` `true`
description string	Описание файловой системы. Описание можно удалить, передав пустую строку («»).
filesystem_id string	Идентификатор файловой системы. Можно использовать только для операций получения, изменения или удаления. Несовместим с параметром filesystem_name.
filesystem_name string	Имя файловой системы. Обязательно только для операции создания. Все операции поддерживаются при использовании параметра filesystem_name. Несовместим с параметром filesystem_id.
is_thin boolean	Логическая переменная, указывающая, является ли файловая система тонкой. Возможные значения: `false` `true`
locking_policy string	Политики блокировки файловой системы. Эти политики определяют, должны ли соблюдаться диапазонные блокировки NFSv4. Возможные значения: `"ADVISORY"` `"MANDATORY"`
nas_server_id string	Идентификатор NAS-сервера, на котором будет размещена файловая система.
nas_server_name string	Имя NAS-сервера, на котором будет размещена файловая система.
password string / обязательный	Пароль сервера управления Unity.
pool_id string	Идентификатор пула, в котором будет создана файловая система. Для создания файловой системы необходимо указать либо pool_name, либо pool_id.
pool_name string	Имя пула, в котором будет создана файловая система. Для создания файловой системы необходимо указать либо pool_name, либо pool_id.
port integer	Номер порта для обмена данными с сервером управления Unity. По умолчанию: `443`
quota_config dictionary	Настройки управления квотами. Содержит необязательные параметры.
cap_unit string	Единица измерения размера параметров default_soft_limit и default_hard_limit. По умолчанию используется единица `GB`. Возможные значения: `"MB"` `"GB"` `"TB"`
default_hard_limit integer	Жесткий лимит по умолчанию для квот пользователей и каталогов. Если при создании файловой системы параметр default_hard_limit не задан, по умолчанию ему будет присвоено значение `0B`.
default_soft_limit integer	Мягкий лимит по умолчанию для квот пользователей и каталогов. Если при создании файловой системы параметр default_soft_limit не задан, по умолчанию ему будет присвоено значение `0B`.
grace_period integer	Льготный период, задаваемый в конфигурации квот после достижения мягкого лимита. Если при создании файловой системы параметр grace_period не задан, по умолчанию ему будет присвоено значение `7 days`.
grace_period_unit string	Единица измерения льготного периода. По умолчанию используется единица `days`. Возможные значения: `"minutes"` `"hours"` `"days"`
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
  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
  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
  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
  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
  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
  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
  filesystem:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "rs_405"
    state: "present"

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

- name: Enable replication on the fs
  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
  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
  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
  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"

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

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

Ключ	Описание
changed boolean	Изменился ли ресурс. Возвращается: всегда Пример: `true`
filesystem_details dictionary	Сведения о файловой системе. Возвращается: если файловая система существует Пример: {"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 integer	Указывает самый нижний уровень каталога, для которого применяются включенные уведомления, если таковые имеются. Возвращается: при успешном выполнении
description string	Описание файловой системы. Возвращается: при успешном выполнении
id string	Идентификатор, присвоенный файловой системе системой. Возвращается: при успешном выполнении
is_cifs_notify_on_access_enabled boolean	Указывает, создает ли система уведомление при обращении пользователя к файловой системе. Возвращается: при успешном выполнении
is_cifs_notify_on_write_enabled boolean	Указывает, создает ли система уведомление при записи в файловую систему. Возвращается: при успешном выполнении
is_cifs_op_locks_enabled boolean	Указывает, включены ли для файловой системы оппортунистические блокировки файлов. Возвращается: при успешном выполнении
is_cifs_sync_writes_enabled boolean	Указывает, включен ли для файловой системы параметр синхронной записи CIFS. Возвращается: при успешном выполнении
is_data_reduction_enabled boolean	Включено ли сжатие для этой файловой системы. Возвращается: при успешном выполнении
is_thin_enabled boolean	Указывает, включено ли для этой файловой системы тонкое выделение ресурсов. Возвращается: при успешном выполнении
name string	Имя файловой системы. Возвращается: при успешном выполнении
nas_server dictionary	Сведения о NAS-сервере, на котором размещена эта файловая система. Возвращается: при успешном выполнении
id string	Системный идентификатор, присвоенный NAS-серверу. Возвращается: при успешном выполнении
name string	Имя NAS-сервера. Возвращается: при успешном выполнении
pool dictionary	Пул, в котором выделена эта файловая система. Возвращается: при успешном выполнении
id string	Системный идентификатор, присвоенный пулу. Возвращается: при успешном выполнении
name string	Имя пула хранения. Возвращается: при успешном выполнении
quota_config dictionary	Сведения о конфигурации квот созданной файловой системы. Возвращается: при успешном выполнении
default_hard_limit integer	Ограничение по умолчанию для жесткого лимита пользовательских квот и квот каталогов. Возвращается: при успешном выполнении
default_soft_limit integer	Ограничение по умолчанию для мягкого лимита пользовательских квот и квот каталогов. Возвращается: при успешном выполнении
grace_period string	Льготный период, заданный в конфигурации квот после достижения мягкого лимита. Возвращается: при успешном выполнении
is_user_quota_enabled boolean	Указывает, включена ли пользовательская квота. Возвращается: при успешном выполнении
quota_policy string	Политика квот, заданная в конфигурации квот. Возвращается: при успешном выполнении
replication_sessions dictionary	Список сеансов репликации, если репликация включена. Возвращается: при успешном выполнении
id string	Идентификатор сеанса репликации Возвращается: при успешном выполнении
name string	Имя сеанса репликации Возвращается: при успешном выполнении
remote_system dictionary	Удаленная система Возвращается: при успешном выполнении
id string	Идентификатор удаленной системы Возвращается: при успешном выполнении
size_total_with_unit string	Размер файловой системы с фактической единицей измерения. Возвращается: при успешном выполнении
snap_schedule_id string	Указывает идентификатор расписания создания снимков, связанного с файловой системой. Возвращается: при успешном выполнении
snap_schedule_name string	Указывает имя расписания создания снимков, связанного с файловой системой. Возвращается: при успешном выполнении
snapshots list / elements=string	Список снимков этой файловой системы. Возвращается: при успешном выполнении
id string	Системный идентификатор, присвоенный снимку файловой системы. Возвращается: при успешном выполнении
name string	Имя снимка файловой системы. Возвращается: при успешном выполнении
tiering_policy string	Политика распределения по уровням хранения, примененная к этой файловой системе. Возвращается: при успешном выполнении

Авторы

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

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

© 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_module.html