synology_apm.sdk.collections.system module

SystemCollection — site-wide information queries.

class synology_apm.sdk.collections.system.SystemCollection(session, backup_servers)

Bases: object

Collection for site-wide system information.

Accessed via APMClient.get_site_info(); should not be instantiated directly.

async get_site_info()

Fetch complete APM site information.

Makes concurrent calls to retrieve license info, cluster info, storage statistics, and workload statistics; also scans all backup servers to locate the Primary and Secondary Management Servers.

Returns:

SiteInfo object containing site_uuid, external_address, port, primary_management_server (BackupServer or None), secondary_management_server (BackupServer or None), site_storage (SiteStorageStats), and workload_usage (WorkloadUsageSummary).

Raises:
Return type:

SiteInfo