Admin Control Panel v2.0

✎ Editing: backup-systems.yaml ← Back

backup-systems init:
  return_type: BackupSystemInitAgentResponse
  type: dict
  cli:
    users:
      - root

schema:
    force:
      type: boolean
      default: false
      help: Force reinstall Acronis client

backend:
      coerce: backup_system
      positional: true

username:
      type: string
      required: false
      nullable: true

password:
      type: string
      required: false
      nullable: true
      envvar: 'PASSWORD'

ip:
      type: ip
      required: false
      nullable: true

encryption_key:
      type: string
      required: false
      nullable: true
      envvar: 'ENCRYPTION_KEY'

apikey:
      type: string
      required: false
      envvar: 'API_KEY'

url:
      type: string
      required: false
  help: Initialize a backup backend

backup-systems list:
  return_type: BackupSystemListAgentResponse
  type: dict
  cli:
    users:
      - root
  help: Show a list of available backup backends

backup-systems extended-status:
  return_type: ExtendedBackupSystemStatusAgentResponse
  type: dict
  cli:
    users:
      - root
  help: Show verbose information about a connected backup backend

backup-systems status:
  return_type: NarrowBackupSystemStatusAgentResponse
  type: dict
  cli:
    users:
      - root
  schema:
    user:
      type: string
      nullable: true
  help: Show information about a connected backup backend

backup-systems disable:
  return_type: NullAgentResponse
  type: dict
  cli:
    users:
      - root

schema:
    backend:
      coerce: backup_system
      positional: true
    delete_backups:
      type: boolean
      default: false
  help: Disable the existing backup backend

backup-systems check:
  return_type: BackupSystemCloudlinuxCheckAgentResponse
  type: dict
  cli:
    users:
      - root

schema:
    backend:
      coerce: backup_system
      positional: true
  help: Check the payment status of the selected backup backend

Cancel