ISE Backup Commands

Overview

Manage ISE configuration backups via the OpenAPI. Supports NFS, SFTP, and FTP repositories.

Commands

Command Description

list-repositories

List configured backup repositories

backup-status

Check status of last backup/restore operation

backup

Trigger ISE configuration backup

list-backups

List available backups in a repository

Quick Start

# Load credentials (network for ISE, storage for backup key)
eval "$(DSEC_EVAL_VERIFIED=true dsec source d000 dev/network)"
eval "$(DSEC_EVAL_VERIFIED=true dsec source d000 dev/storage)"

# Check repositories
netapi ise list-repositories

# Run backup with wait
netapi ise backup --repo synology-nfs --name "pre-migration" --wait

# Check status
netapi ise backup-status

Environment Variables

Variable Required Description

ISE_PAN_IP

Yes

ISE Primary Admin Node IP or hostname

ISE_API_USER

Yes

API username with backup privileges

ISE_API_PASS

Yes

API password

ISE_BACKUP_KEY

Recommended

Encryption key for backups (or use --key)

Encryption Key Requirements

ISE backup encryption keys must meet these requirements:

  • 8-15 characters

  • At least one uppercase letter [A-Z]

  • At least one lowercase letter [a-z]

  • At least one digit [0-9]

  • Only allowed characters: [A-Za-z0-9_#]

  • Must NOT contain: C, c, I, i, S, s, O, o

Generate a compliant key:

</dev/urandom tr -dc 'ABDEFGHJKLMNPQRTUVWXYZabdefghjklmnpqrtuvwxyz0123456789_#' | head -c 12 && echo

Repository Configuration

ISE supports these repository protocols:

  • NFS - Network File System (recommended for speed)

  • SFTP - SSH File Transfer Protocol (secure)

  • FTP - File Transfer Protocol

  • DISK - Local ISE disk (limited space)

Repositories are configured in ISE at:
Administration > System > Maintenance > Repository

See Also