APM Python SDKΒΆ
Python SDK for Synology ActiveProtect Manager.
Installation
pip install synology-apm-sdk
Quick start
import asyncio
from synology_apm.sdk import APMClient
async def main():
async with APMClient("apm.corp.com", "admin", "password") as apm:
workloads = await apm.machine.workloads.list()
for wl in workloads:
print(wl.name, wl.status)
asyncio.run(main())
Exceptions & Enums
- synology_apm.sdk.exceptions module
APMErrorAuthenticationErrorResourceNotFoundErrorPermissionDeniedErrorNotSupportedErrorInvalidOperationErrorConnectionTimeoutErrorBackupServerDisconnectedErrorNotManagementServerErrorResourceNotReadyErrorPlanNameConflictErrorPlanInUseErrorDuplicateWorkloadErrorRemoteStorageConflictErrorRemoteStorageInUseErrorRemoteStorageEncryptionMismatchErrorRemoteStorageUnmanagedCatalogErrorAPIError
- synology_apm.sdk.enums module
WorkloadCategoryMachineWorkloadTypeM365WorkloadTypeActivityWorkloadTypeWorkloadStatTypeBackupServerTypeBackupServerRoleServerStatusRemoteStorageStatusRemoteStorageTypeBackupActivityStatusRestoreActivityStatusVersionStatusWeekDayScheduleFrequencyRetentionTypeWorkloadStatusBackupScopeM365ExportStatusFileServerTypeVerifyStatusVersionCopyStatusCopyReasonDbActionOnErrorMssqlLogSettingOracleLogSettingMachineOsTypeMachineTaskScopeHypervisorTypeLogLevelAPMActivityLogTypeRestoreType
Models
- synology_apm.sdk.models.workload module
- synology_apm.sdk.models.location module
- synology_apm.sdk.models.activity module
- synology_apm.sdk.models.protection_plan module
ProtectionScheduleGFSRetentionProtectionRetentionPolicyProtectionPlanPolicyPlanBackupCopyStatusBackupCopyPolicyBackupCopyConfigMachineVmConfigMachinePcConfigMachinePsConfigMachineDbConfigMachineBackupWindowEventTriggerConfigMachineTaskScheduleMachineTaskConfigProtectionPlanMachinePlanCreateRequestM365PlanCreateRequest
- synology_apm.sdk.models.retirement_plan module
- synology_apm.sdk.models.tiering_plan module
- synology_apm.sdk.models.version module
- synology_apm.sdk.models.backup_server module
- synology_apm.sdk.models.hypervisor module
- synology_apm.sdk.models.log module
- synology_apm.sdk.models.saas module
- synology_apm.sdk.models.m365_auto_backup_rule module
- synology_apm.sdk.models.system module
- synology_apm.sdk.models.remote_storage module
Collections
- synology_apm.sdk.collections.machine module
- synology_apm.sdk.collections.m365 module
- synology_apm.sdk.collections.m365_auto_backup_rule module
- synology_apm.sdk.collections.protection_plans module
- synology_apm.sdk.collections.retirement_plans module
- synology_apm.sdk.collections.tiering_plans module
- synology_apm.sdk.collections.activities module
- synology_apm.sdk.collections.backup_servers module
- synology_apm.sdk.collections.hypervisors module
- synology_apm.sdk.collections.logs module
- synology_apm.sdk.collections.m365_mail_export module
- synology_apm.sdk.collections.saas module
- synology_apm.sdk.collections.system module
- synology_apm.sdk.collections.remote_storages module