CoreStorage

warning

This API is partially documented or under construction.

Overview

Core Storage API implementation for Synology NAS.

This class provides methods to manage storage disks, pools, volumes, iSCSI LUNs, quotas, and recycle bin operations.

Methods

`storage_disk_list`

List all storage disks.

Internal API

SYNO.Core.Storage.Disk

Returns

dict[str, object] or str
List of storage disks and their status.

`storage_disk_get`

Get information for a specific disk.

Internal API

SYNO.Core.Storage.Disk

Parameters

disk_id str
The disk identifier (e.g., 'sda').

Returns

dict[str, object] or str
Disk information.

`storage_disk_fw_upgrade_get`

Get disk firmware upgrade status.

Internal API

SYNO.Core.Storage.Disk.FWUpgrade

Returns

dict[str, object] or str
Firmware upgrade availability and status.

`storage_disk_fw_upgrade_start`

Start a disk firmware upgrade.

Internal API

SYNO.Core.Storage.Disk.FWUpgrade

Parameters

disk_id str
The disk identifier to upgrade.

Returns

dict[str, object] or str
API response.

`storage_pool_list`

List all storage pools.

Internal API

SYNO.Core.Storage.Pool

Returns

dict[str, object] or str
List of storage pools.

`storage_pool_get`

Get information for a specific storage pool.

Internal API

SYNO.Core.Storage.Pool

Parameters

pool_id str
The storage pool identifier.

Returns

dict[str, object] or str
Storage pool information.

`storage_pool_set`

Update storage pool settings.

Internal API

SYNO.Core.Storage.Pool

Parameters

pool_id str
The storage pool identifier.

description str
New description for the pool.

Returns

dict[str, object] or str
API response.

`storage_volume_list`

List all storage volumes.

Internal API

SYNO.Core.Storage.Volume

Returns

dict[str, object] or str
List of storage volumes.

`storage_volume_get`

Get information for a specific volume.

Internal API

SYNO.Core.Storage.Volume

Parameters

volume_path str
The volume path (e.g., '/volume1').

Returns

dict[str, object] or str
Volume information.

`storage_volume_set`

Update volume settings.

Internal API

SYNO.Core.Storage.Volume

Parameters

volume_path str
The volume path (e.g., '/volume1').

description str
New description for the volume.

Returns

dict[str, object] or str
API response.

`iscsi_lun_list`

List all iSCSI LUNs.

Internal API

SYNO.Core.Storage.iSCSILUN

Returns

dict[str, object] or str
List of iSCSI LUNs.

`iscsi_lun_get`

Get information for a specific iSCSI LUN.

Internal API

SYNO.Core.Storage.iSCSILUN

Parameters

lun_id str
The iSCSI LUN identifier.

Returns

dict[str, object] or str
iSCSI LUN information.

`iscsi_lun_set`

Update iSCSI LUN settings.

Internal API

SYNO.Core.Storage.iSCSILUN

Parameters

lun_id str
The iSCSI LUN identifier.

name str
New name for the LUN.

description str
New description for the LUN.

Returns

dict[str, object] or str
API response.

`storage_load_info`

Get full Storage Manager overview.
Returns disk, pool, volume, enclosure and port information in a single call. This is the primary endpoint used by the Storage Manager web UI.

Internal API

SYNO.Storage.CGI.Storage

Returns

dict[str, object] or str
{"data": {"disks": [...], "detected_pools": [...], "overview_data": {...}, "ports": [...], ...}, "success": true}.

`storage_smart_scheduler_list`

List S.M.A.R.T. test schedules.

Internal API

SYNO.Storage.CGI.Smart.Scheduler

Returns

dict[str, object] or str
{"data": {"items": [...], "total": N}, "success": true}. Each item includes schedule type, frequency, and target disks.

`storage_hdd_manager_get`

Get HDD health threshold settings.
Returns S.M.A.R.T. warning thresholds for bad sectors, remaining life, and other disk health indicators.

Internal API

SYNO.Storage.CGI.HddMan

Returns

dict[str, object] or str
{"data": {"BadSctrThrEn": ..., "RemainLifeThrEn": ..., ...}, "success": true}.

`storage_spare_list`

List hot spare disks.

Internal API

SYNO.Storage.CGI.Spare

Returns

dict[str, object] or str
{"data": {"hotSpares": [...]}, "success": true}.

`quota_get`

Get quota settings for a volume.

Internal API

SYNO.Core.Quota

Parameters

volume_path str
The volume path (e.g., '/volume1').

Returns

dict[str, object] or str
Quota configuration.

`quota_list`

List quota settings for all volumes.

Internal API

SYNO.Core.Quota

Returns

dict[str, object] or str
List of quota settings.

`quota_set`

Set quota for a volume.

Internal API

SYNO.Core.Quota

Parameters

volume_path str
The volume path (e.g., '/volume1').

enabled bool
Enable or disable quota. Defaults to True.

quota_mb int
Quota size in megabytes.

Returns

dict[str, object] or str
API response.

`recycle_bin_get`

Get recycle bin settings.

Internal API

SYNO.Core.RecycleBin

Returns

dict[str, object] or str
Recycle bin configuration.

`recycle_bin_set`

Set recycle bin configuration.

Internal API

SYNO.Core.RecycleBin

Parameters

enabled bool
Enable or disable recycle bin. Defaults to True.

retention_days int
Number of days to retain deleted files.

Returns

dict[str, object] or str
API response.

`recycle_bin_clean`

Empty the recycle bin.

Internal API

SYNO.Core.RecycleBin

Parameters

share_name str
Shared folder name to clean. If None, cleans all recycle bins.

Returns

dict[str, object] or str
API response.

`recycle_bin_user_get`

Get per-user recycle bin settings.

Internal API

SYNO.Core.RecycleBin.User

Parameters

user str
The username.

Returns

dict[str, object] or str
Per-user recycle bin configuration.

`recycle_bin_user_set`

Set per-user recycle bin configuration.

Internal API

SYNO.Core.RecycleBin.User

Parameters

user str
The username.

enabled bool
Enable or disable per-user recycle bin. Defaults to True.

Returns

dict[str, object] or str
API response.

`btrfs_dedupe_check_quota`

Check storage quota usage.

Internal API

SYNO.Storage.CGI.BtrfsDedupe

Returns

dict
API response from SYNO.Storage.CGI.BtrfsDedupe.

`btrfs_dedupe_dry_run`

Run a dry-run (simulation) operation.

Internal API

SYNO.Storage.CGI.BtrfsDedupe

Returns

dict
API response from SYNO.Storage.CGI.BtrfsDedupe.

`btrfs_dedupe_get_schedule_plan`

Get the current schedule plan.

Internal API

SYNO.Storage.CGI.BtrfsDedupe

Returns

dict
API response from SYNO.Storage.CGI.BtrfsDedupe.

`btrfs_dedupe_get_status`

Get the current operational status.

Internal API

SYNO.Storage.CGI.BtrfsDedupe

Returns

dict
API response from SYNO.Storage.CGI.BtrfsDedupe.

`btrfs_dedupe_get_volume_info`

Get volume information.

Internal API

SYNO.Storage.CGI.BtrfsDedupe

Returns

dict
API response from SYNO.Storage.CGI.BtrfsDedupe.

`btrfs_dedupe_manual_dedupe`

Manually trigger data deduplication.

Internal API

SYNO.Storage.CGI.BtrfsDedupe

Returns

dict
API response from SYNO.Storage.CGI.BtrfsDedupe.

`btrfs_dedupe_rescan_quota_v2`

Rescan storage quota (version 2).

Internal API

SYNO.Storage.CGI.BtrfsDedupe

Returns

dict
API response from SYNO.Storage.CGI.BtrfsDedupe.

`btrfs_dedupe_set_reclaim_type`

Set the space reclamation type.

Internal API

SYNO.Storage.CGI.BtrfsDedupe

Returns

dict
API response from SYNO.Storage.CGI.BtrfsDedupe.

`btrfs_dedupe_set_schedule_plan`

Set or update the schedule plan.

Internal API

SYNO.Storage.CGI.BtrfsDedupe

Returns

dict
API response from SYNO.Storage.CGI.BtrfsDedupe.

`btrfs_dedupe_set_volume_schedule_config`

Configure the volume schedule.

Internal API

SYNO.Storage.CGI.BtrfsDedupe

Returns

dict
API response from SYNO.Storage.CGI.BtrfsDedupe.

`btrfs_dedupe_stop`

Stop the current operation.

Internal API

SYNO.Storage.CGI.BtrfsDedupe

Returns

dict
API response from SYNO.Storage.CGI.BtrfsDedupe.

`cache_protection_disable_passive`

Disable passive cache protection mode.

Internal API

SYNO.Storage.CGI.Cache.Protection

Returns

dict
API response from SYNO.Storage.CGI.Cache.Protection.

`cache_protection_enable_passive`

Enable passive cache protection mode.

Internal API

SYNO.Storage.CGI.Cache.Protection

Returns

dict
API response from SYNO.Storage.CGI.Cache.Protection.

`cache_protection_get_config`

Get the current configuration.

Internal API

SYNO.Storage.CGI.Cache.Protection

Returns

dict
API response from SYNO.Storage.CGI.Cache.Protection.

`cache_protection_get_status`

Get the current operational status.

Internal API

SYNO.Storage.CGI.Cache.Protection

Returns

dict
API response from SYNO.Storage.CGI.Cache.Protection.

`cache_protection_get_status_all`

Get the status of all items.

Internal API

SYNO.Storage.CGI.Cache.Protection

Returns

dict
API response from SYNO.Storage.CGI.Cache.Protection.

`cache_protection_update_config`

Update the configuration.

Internal API

SYNO.Storage.CGI.Cache.Protection

Returns

dict
API response from SYNO.Storage.CGI.Cache.Protection.

`storage_check_do_data_scrubbing`

Start a data scrubbing operation.

Internal API

SYNO.Storage.CGI.Check

Returns

dict
API response from SYNO.Storage.CGI.Check.

`storage_check_do_disk_scan`

Start a disk scan operation.

Internal API

SYNO.Storage.CGI.Check

Returns

dict
API response from SYNO.Storage.CGI.Check.

`storage_check_ignore_data_scrubbing`

Ignore/skip a data scrubbing operation.

Internal API

SYNO.Storage.CGI.Check

Returns

dict
API response from SYNO.Storage.CGI.Check.

`storage_check_is_building`

Check if the storage is currently building/rebuilding.

Internal API

SYNO.Storage.CGI.Check

Returns

dict
API response from SYNO.Storage.CGI.Check.

`storage_check_is_data_scrubbing`

Check if data scrubbing is currently running.

Internal API

SYNO.Storage.CGI.Check

Returns

dict
API response from SYNO.Storage.CGI.Check.

`storage_check_reboot_after_rebuild`

Get or configure auto-reboot after rebuild.

Internal API

SYNO.Storage.CGI.Check

Returns

dict
API response from SYNO.Storage.CGI.Check.

`storage_check_remove_ask_for_fsck`

Clear the file-system check prompt.

Internal API

SYNO.Storage.CGI.Check

Returns

dict
API response from SYNO.Storage.CGI.Check.

`storage_check_remove_ask_for_fsck_scan`

Clear the fsck scan prompt.

Internal API

SYNO.Storage.CGI.Check

Returns

dict
API response from SYNO.Storage.CGI.Check.

`storage_check_remove_ask_for_remap_scan`

Clear the remap scan prompt.

Internal API

SYNO.Storage.CGI.Check

Returns

dict
API response from SYNO.Storage.CGI.Check.

`storage_check_remove_ask_for_wcache_lost_data_scrubbing`

Clear the write-cache lost data scrubbing prompt.

Internal API

SYNO.Storage.CGI.Check

Returns

dict
API response from SYNO.Storage.CGI.Check.

`storage_check_should_ask_for_fsck_scan`

Check whether an fsck scan prompt should be shown.

Internal API

SYNO.Storage.CGI.Check

Returns

dict
API response from SYNO.Storage.CGI.Check.

`detected_pool_assemble`

Assemble/re-assemble a detected storage pool.

Internal API

SYNO.Storage.CGI.DetectedPool

Returns

dict
API response from SYNO.Storage.CGI.DetectedPool.

`detected_pool_remove`

Remove a component.

Internal API

SYNO.Storage.CGI.DetectedPool

Returns

dict
API response from SYNO.Storage.CGI.DetectedPool.

`dual_enclosure_load`

Load/retrieve all entries.

Internal API

SYNO.Storage.CGI.DualEnclosure

Returns

dict
API response from SYNO.Storage.CGI.DualEnclosure.

`enclosure_exp_fw_fail_get`

Get expansion unit firmware failure information.

Internal API

SYNO.Storage.CGI.Enclosure

Returns

dict
API response from SYNO.Storage.CGI.Enclosure.

`enclosure_exp_fw_update`

Update expansion unit firmware.

Internal API

SYNO.Storage.CGI.Enclosure

Returns

dict
API response from SYNO.Storage.CGI.Enclosure.

`enclosure_exp_fw_update_cancel_notify`

Cancel expansion unit firmware update notification.

Internal API

SYNO.Storage.CGI.Enclosure

Returns

dict
API response from SYNO.Storage.CGI.Enclosure.

`enclosure_exp_fw_update_list_get`

Get the list of available expansion unit firmware updates.

Internal API

SYNO.Storage.CGI.Enclosure

Returns

dict
API response from SYNO.Storage.CGI.Enclosure.

`enclosure_exp_fw_update_status_get`

Get the status of expansion unit firmware update.

Internal API

SYNO.Storage.CGI.Enclosure

Returns

dict
API response from SYNO.Storage.CGI.Enclosure.

`enclosure_is_exp_connected`

Check if the expansion unit is connected.

Internal API

SYNO.Storage.CGI.Enclosure

Returns

dict
API response from SYNO.Storage.CGI.Enclosure.

`enclosure_load`

Load all enclosure information.

Internal API

SYNO.Storage.CGI.Enclosure

Returns

dict
API response from SYNO.Storage.CGI.Enclosure.

`enclosure_sha_exp_fw_fail_get`

Get SHA expansion unit firmware failure information.

Internal API

SYNO.Storage.CGI.Enclosure

Returns

dict
API response from SYNO.Storage.CGI.Enclosure.

`enclosure_sha_exp_fw_update`

Update SHA expansion unit firmware.

Internal API

SYNO.Storage.CGI.Enclosure

Returns

dict
API response from SYNO.Storage.CGI.Enclosure.

`enclosure_sha_exp_fw_update_cancel_notify`

Cancel SHA expansion unit firmware update notification.

Internal API

SYNO.Storage.CGI.Enclosure

Returns

dict
API response from SYNO.Storage.CGI.Enclosure.

`enclosure_sha_exp_fw_update_list_get`

List SHA expansion unit firmware updates available.

Internal API

SYNO.Storage.CGI.Enclosure

Returns

dict
API response from SYNO.Storage.CGI.Enclosure.

`enclosure_sha_exp_fw_update_status_get`

Get SHA expansion unit firmware update status.

Internal API

SYNO.Storage.CGI.Enclosure

Returns

dict
API response from SYNO.Storage.CGI.Enclosure.

`enclosure_sha_is_exp_connected`

Check if the SHA expansion unit is connected.

Internal API

SYNO.Storage.CGI.Enclosure

Returns

dict
API response from SYNO.Storage.CGI.Enclosure.

`encryption_vault_disable`

Disable offline volume operations.

Internal API

SYNO.Storage.CGI.EncryptionKeyVault

Returns

dict
API response from SYNO.Storage.CGI.EncryptionKeyVault.

`encryption_vault_enable`

Enable the feature.

Internal API

SYNO.Storage.CGI.EncryptionKeyVault

Returns

dict
API response from SYNO.Storage.CGI.EncryptionKeyVault.

`encryption_vault_get_info`

Get flash cache information.

Internal API

SYNO.Storage.CGI.EncryptionKeyVault

Returns

dict
API response from SYNO.Storage.CGI.EncryptionKeyVault.

`encryption_vault_pack_for_ma`

Package OAuth credentials for the mail account.

Internal API

SYNO.Storage.CGI.EncryptionKeyVault

Returns

dict
API response from SYNO.Storage.CGI.EncryptionKeyVault.

`encryption_vault_repair`

Repair/recover the entity.

Internal API

SYNO.Storage.CGI.EncryptionKeyVault

Returns

dict
API response from SYNO.Storage.CGI.EncryptionKeyVault.

`encryption_vault_reset`

Reset the Taipei enclosure.

Internal API

SYNO.Storage.CGI.EncryptionKeyVault

Returns

dict
API response from SYNO.Storage.CGI.EncryptionKeyVault.

`encryption_vault_set_autounlock_key`

Set an auto-unlock key for the encryption vault.

Internal API

SYNO.Storage.CGI.EncryptionKeyVault

Returns

dict
API response from SYNO.Storage.CGI.EncryptionKeyVault.

`encryption_vault_set_for_ma`

Set the person mail account for the Mail Account service.

Internal API

SYNO.Storage.CGI.EncryptionKeyVault

Returns

dict
API response from SYNO.Storage.CGI.EncryptionKeyVault.

`encryption_vault_sync_to_passive`

Sync data to the passive enclosure.

Internal API

SYNO.Storage.CGI.EncryptionKeyVault

Returns

dict
API response from SYNO.Storage.CGI.EncryptionKeyVault.

`encryption_vault_verify_passwd`

Verify the encryption vault password.

Internal API

SYNO.Storage.CGI.EncryptionKeyVault

Returns

dict
API response from SYNO.Storage.CGI.EncryptionKeyVault.

`encryption_vault_unlock_enter_passwd`

Enter passwd.

Internal API

SYNO.Storage.CGI.EncryptionKeyVault.UnlockMode

Returns

dict
API response from SYNO.Storage.CGI.EncryptionKeyVault.UnlockMode.

`encryption_vault_unlock_get_passwd_wrong_record`

Get passwd wrong record.

Internal API

SYNO.Storage.CGI.EncryptionKeyVault.UnlockMode

Returns

dict
API response from SYNO.Storage.CGI.EncryptionKeyVault.UnlockMode.

`encryption_vault_unlock_skip_passwd`

Skip passwd.

Internal API

SYNO.Storage.CGI.EncryptionKeyVault.UnlockMode

Returns

dict
API response from SYNO.Storage.CGI.EncryptionKeyVault.UnlockMode.

`flashcache_add_drive`

Add an SSD drive to the flash cache.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_advisor_history_get`

Get the Security Advisor scan history.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_advisor_poll`

Poll for Security Advisor scan progress.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_advisor_start`

Start a Security Advisor security scan.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_advisor_stop`

Stop a running Security Advisor scan.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_check_can_create`

Check if a new user can be created.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_check_can_lock_space`

Check if deduplication space can be locked.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_check_pin_metadata_and_rec_size`

Check pinned metadata and record size settings.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_check_system_raid`

Check system RAID configuration on the pool.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_check_volume_abnormal_cant_create_cache`

Check if a volume abnormality prevents cache creation.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_configure`

Configure DSM FindMe (QuickConnect) settings.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_create_feasibility_hard_check`

Run a feasibility check for pool creation.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_enable`

Enable a flash cache.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_estimate_mem_size`

Estimate memory requirements for pool operations.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_estimate_raid_size`

Estimate the RAID size for a pool.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_is_redundancy_degraded`

Check if pool redundancy is degraded.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_remove`

Remove SSDs from a flash cache.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_remove_cancel`

Cancel a volume removal operation.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_repair`

Repair a flash cache.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_replace`

Replace SSDs in a flash cache.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_shared_cache_config_get`

Get the shared SSD cache configuration.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`flashcache_shared_cache_config_set`

Set the shared SSD cache configuration.

Internal API

SYNO.Storage.CGI.Flashcache

Returns

dict
API response from SYNO.Storage.CGI.Flashcache.

`kmip_check_loop`

Check the deduplication background loop status.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_delete_key`

Delete an encryption key from the vault.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_erase_all_data`

Erase all data on spare disks.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_get`

Get KMIP server configuration.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_get_key_list`

List all encryption keys in the vault.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_get_server_hostname`

Get the hostname of the storage server.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_get_version_info`

Get HA license version information.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_import_cert`

Import a KMIP server certificate.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_import_server_ca`

Import the KMIP server CA certificate.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_list_cert`

List KMIP client certificates.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_remove_cert`

Remove a KMIP certificate.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_renew_cert`

Renew a KMIP certificate.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_set`

Configure KMIP server settings.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_set_cert`

Set/configure a KMIP certificate.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_test_conn`

Test the KMIP server connection.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`kmip_transfer_data`

Transfer volume data to another location.

Internal API

SYNO.Storage.CGI.KMIP

Returns

dict
API response from SYNO.Storage.CGI.KMIP.

`pool_cancel_data_scrubbing`

Cancel an ongoing data scrubbing operation.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_check_fast_repair`

Check if a fast repair is possible on the pool.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_create`

Create a new storage pool on the NAS.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_data_scrubbing`

Get/set data scrubbing status for the pool.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_data_scrubbing_plain`

Run a plain data scrubbing operation (no dedupe).

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_deactivate`

Deactivate the flash cache.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_delete`

Delete an existing storage pool (destructive — all data lost).

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_edit_desc`

Edit the description of a user account.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_enum_resource`

Enumerate resources within a storage pool.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_estimate_size`

Estimate the resulting size after pool expansion.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_expand_by_add_disk`

Expand a storage pool by adding new disks.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_expand_unallocated`

Expand a pool using unallocated space.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_expand_unfinished_shr`

Resume an interrupted SHR expansion.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_get_setting`

Get the flash cache settings.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_is_disk_detected_old_info`

Check if a detected disk has old RAID information.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_migrate`

Migrate a storage pool to a different RAID type.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_pause_data_scrubbing`

Pause an ongoing data scrubbing operation.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_pre_delete_check`

Check if a pool can be safely deleted.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_reassemble`

Re-assemble a pool from detected disks.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_remove_missing_pool`

Remove a missing storage pool.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_remove_raid_sb_cache`

Remove RAID superblock cache.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_repair`

Repair a degraded storage pool.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_replace`

Replace a failing disk in a storage pool with a new one.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_set_setting`

Configure advanced storage pool settings.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`pool_update_raid_sb_cache`

Update RAID superblock cache.

Internal API

SYNO.Storage.CGI.Pool

Returns

dict
API response from SYNO.Storage.CGI.Pool.

`scrubbing_get_state`

Get the current data scrubbing state for a storage space.

Internal API

SYNO.Storage.CGI.Scrubbing

Parameters

space_id str
Storage space/volume identifier to query scrubbing state for.

Returns

dict
Scrubbing state for the specified space.

`smart_get_health_info`

Get storage health information.

Internal API

SYNO.Storage.CGI.Smart

Returns

dict
API response from SYNO.Storage.CGI.Smart.

`smart_get_latest_online_drive_db_info`

Get the latest online drive database info.

Internal API

SYNO.Storage.CGI.Smart

Returns

dict
API response from SYNO.Storage.CGI.Smart.

`smart_get_smart_info`

Get S.M.A.R.T. information for all disks.

Internal API

SYNO.Storage.CGI.Smart

Returns

dict
API response from SYNO.Storage.CGI.Smart.

`smart_list`

List all entries.

Internal API

SYNO.Storage.CGI.Smart

Returns

dict
API response from SYNO.Storage.CGI.Smart.

`smart_secure_erase`

Securely erase a disk in the pool.

Internal API

SYNO.Storage.CGI.Smart

Returns

dict
API response from SYNO.Storage.CGI.Smart.

`smart_smart_warning_get`

Get S.M.A.R.T. warning settings.

Internal API

SYNO.Storage.CGI.Smart

Returns

dict
API response from SYNO.Storage.CGI.Smart.

`smart_smart_warning_set`

Configure S.M.A.R.T. warning settings.

Internal API

SYNO.Storage.CGI.Smart

Returns

dict
API response from SYNO.Storage.CGI.Smart.

`smart_update_smartctl_db`

Update the smartctl drive database.

Internal API

SYNO.Storage.CGI.Smart

Returns

dict
API response from SYNO.Storage.CGI.Smart.

`spare_conf_get`

Get detailed information.

Internal API

SYNO.Storage.CGI.Spare.Conf

Returns

dict
API response from SYNO.Storage.CGI.Spare.Conf.

`spare_conf_set`

Set spare disk configuration.

Internal API

SYNO.Storage.CGI.Spare.Conf

Returns

dict
API response from SYNO.Storage.CGI.Spare.Conf.

`taipei_enclosure_load`

Load/retrieve all entries.

Internal API

SYNO.Storage.CGI.TaipeiEnclosure

Returns

dict
API response from SYNO.Storage.CGI.TaipeiEnclosure.

`volume_cancel_data_scrubbing`

Cancel volume data scrubbing.