synology_apm.sdk.models.backup_server module

BackupServer data model.

class synology_apm.sdk.models.backup_server.BackupServer(backup_server_id, namespace, server_type, name, hostname, model, system_version, status, is_updating, serial, storage_total_bytes, storage_used_bytes, logical_backup_data_bytes, physical_backup_data_bytes, role=None, description='', tiering_plan_name=None, tiering_plan_destination=None, tiering_status=None)

Bases: object

A backup server in the APM cluster (ActiveProtect Appliance or NAS).

Variables:

  • backup_server_id (str) – Unique backup server identifier.

  • namespace (str) – Namespace of this server (matches workload.namespace).

  • server_type (synology_apm.sdk.enums.BackupServerType) – Hardware type — DP (ActiveProtect Appliance) or NAS.

  • name (str) – Display name.

  • hostname (str) – IP address or hostname.

  • model (str) – Device model (e.g. “DP320”).

  • system_version (str | None) – System version string for DP servers (e.g. “APM 1.2-71845”). None for NAS servers.

  • status (synology_apm.sdk.enums.ServerStatus) – Server health status.

  • is_updating (bool) – True when a firmware update is in progress.

  • serial (str) – Serial number.

  • storage_total_bytes (int | None) – Total storage capacity in bytes. None when data is unavailable.

  • storage_used_bytes (int | None) – Total disk space used in bytes. None when data is unavailable.

  • logical_backup_data_bytes (int | None) – Logical backup data size in bytes (before dedup/compression). None when data is unavailable.

  • physical_backup_data_bytes (int | None) – Physical storage occupied by backup data in bytes (after dedup/compression). None when data is unavailable.

  • role (synology_apm.sdk.enums.BackupServerRole | None) – Cluster role of this server. PRIMARY = Primary Management Server; SECONDARY = Secondary Management Server; None = regular backup server.

  • description (str) – Administrator-supplied description for the server. Empty string when not set.

  • tiering_plan_name (str | None) – Name of the tiering plan applied to this server. None when no plan is assigned.

  • tiering_plan_destination (synology_apm.sdk.models.location.LocationInfo | None) – Remote storage destination of the tiering plan. None when no plan is assigned or destination details are unavailable.

  • tiering_status (synology_apm.sdk.models.tiering_plan.TieringStatus | None) – Current tiering operation status for this server. None when no plan is assigned or status is unavailable.

backup_server_id: str
namespace: str
server_type: BackupServerType
name: str
hostname: str
model: str
system_version: str | None
status: ServerStatus
is_updating: bool
serial: str
storage_total_bytes: int | None
storage_used_bytes: int | None
logical_backup_data_bytes: int | None
physical_backup_data_bytes: int | None
role: BackupServerRole | None = None
description: str = ''
tiering_plan_name: str | None = None
tiering_plan_destination: LocationInfo | None = None
tiering_status: TieringStatus | None = None
property storage_usage_pct: float

Storage usage percentage (float 0–100). Returns 0.0 when storage data is unavailable or total is 0.

property backup_data_reduction_bytes: int | None

Data reduction achieved by dedup/compression in bytes. Returns None when unavailable; minimum is 0.

property backup_data_reduction_ratio: float

Data reduction ratio as a percentage (float 0–100). Returns 0.0 when unavailable or logical size is 0.