For AI agents: the complete documentation index is available at https://www.jumpserver.com/docs/llms.txt, the full documentation bundle is available at https://www.jumpserver.com/docs/llms-full.txt, and this page is available as Markdown at https://www.jumpserver.com/docs/features/pam/automation/backup-accounts.md.
🎉 JumpServer v5.1.1 is available. See what's new →
  • v5

    • Backup Accounts

    Enterprise Edition

    SFTP account backup requires JumpServer Enterprise Edition. Email backup is included in Community Edition.

    Request 14-day free trial

    Backup Accounts exports the secrets of the accounts that JumpServer manages so that the credentials survive accidental deletion, storage corruption, or an environment rebuild. Backups are selected by platform type, can be split between two recipients or two SFTP servers, and can run on a schedule.

    Prerequisites

    • Access to PAM > Automation > Backup Accounts with permission to view and change backup tasks.
    • For an Email backup, at least one recipient user exists and has a usable email address.
    • For an SFTP backup, an SFTP storage is configured. See Storage.

    Overview

    The page contains two tabs:

    • Account backup tasks – backup definitions and their schedule.
    • Execution history – one row per run, with trigger mode, timing, status, and log.

    Figure 1: Create account backup drawer

    Create a backup task

    1

    At the top-left of the page, select , then click PAM.

    image
    2

    Open Automation > Backup Accounts and stay on the Account backup tasks tab.

    3

    Click Create.

    4

    In the Name field, type the task name.

    5

    In the Type field, select the platform types to back up, for example host, network device, database, web, cloud service, or custom. The field is a cascading multi-select, so one task can cover several platform types.

    6

    Choose the Backup type, Email or SFTP.

    7

    Leave Password divided enabled if the key should be split. For email, select Recipient A and optionally Recipient B; for SFTP, select Receiving server A and optionally Receiving server B.

    8

    For SFTP only, set the Zip encrypt password used to encrypt the exported file.

    9

    Optionally enable Periodic and set Interval or Crontab, keep Active selected, and click Submit. Use Save & Continue to create several tasks in a row.

    Field reference

    FieldDescription
    NameRequired. Task name.
    TypePlatform types whose accounts are backed up.
    Backup typeEmail or SFTP.
    Password dividedSplits the account secret into two parts. Enabled by default.
    Recipient A / BUsers who receive the backup by email. Two recipients produce two key parts.
    Receiving server A / BSFTP storage targets. Two servers produce two key parts.
    Zip encrypt passwordPassword used to encrypt the SFTP archive. Shown for SFTP only.
    PeriodicRepeats the backup on a schedule.
    Interval / CrontabSchedule definition; crontab takes priority, and the interval defaults to 24 hours.
    ActiveEnables the task.
    CommentOptional notes.

    Figure 2: Backup task configured for SFTP delivery

    Run and maintain tasks

    Use the green run button in the row to execute a backup immediately, or open the task and use the manual execution action. The More menu provides Edit, Delete, and Duplicate; the edit drawer is titled Update account backup and supports Submit and Restore.

    Warning

    A backup run exports account secrets to the configured recipients or SFTP servers. Confirm the backup type, delivery targets, and encryption settings before running against production data, and restrict who can view the task.

    Execution history

    The Execution history tab lists task, trigger mode, start and end date, automation snapshot, status, duration, and actions. Open a row to read the log for that run.

    Note

    Execution history is populated by executed tasks. If the tab is empty, create a task and run it once.