sdpctl Reference Guide

sdpctl appliance backup

Perform backup of the appliances

Synopsis

The backup command will request a backup from the API and download them to a destination directory. The command requires the Backup API to be enabled in the Collective. In case the Backup API is not enabled when executing the backup command, you will be prompted to activate it.

There are multiple options for selecting which Appliances to backup, using flags or optional arguments. The arguments are expected to be the name of the appliance you want to take a backup of.

The default destination directory is set to be the users default downloads directory on the system. If the default destination is used, an ‘appgate’ directory will be created there if it doesn’t already exist and the backups will be downloaded to that. In case custom destination directory is specified by using the ‘–destination’ flag, the extra ‘appgate’ directory will not be created. The user also has to have write privileges on the specified directory.

For more information on the backup process, go to: https://sdphelp.appgate.com/adminguide/v5.5/backup-script.html

sdpctl appliance backup [flags]

Examples

  # Backup with no arguments or flags will prompt for appliance
  > sdpctl appliance backup
  ? Backup API is disabled on the appliance. Do you want to enable it now? Yes
  ? The passphrase to encrypt the appliance backups when the Backup API is used: <password> # only shows if Backup API is not enabled
  ? Confirm your passphrase: <password> # only shows if Backup API is not enabled
  ? select appliances to backup:  [Use arrows to move, space to select, <right> to all, <left> to none, type to filter]
  ❯ [ ]  controller
    [ ]  gateway

  # download backups to a custom directory
  > sdpctl appliance backup --destination=path/to/backup/destination

  # backup only the primary Controller using flag
  > sdpctl appliance backup --primary

  # backup all appliances
  > sdpctl appliance backup --all

  # backup using '--include' and '--exclude' flags
  > sdpctl appliance backup --include=function=controller --exclude=tag=secondary

Options

      --all                  backup all appliances in the Collective
      --current              backup the current peer Controller
  -d, --destination string   backup destination directory (default "$HOME/Downloads/appgate/backup")
  -h, --help                 help for backup
      --primary              backup the primary Controller
      --quiet                backup summary will not be printed if setting this flag
      --with strings         include extra data in backup (audit, logs)

Options inherited from parent commands

      --api-version int          Peer API version override
      --ci-mode                  Log to stderr instead of file and disable progress-bars
      --debug                    Enable debug logging
      --descending               Change the direction of sort order when using the '--order-by' flag. Using this will reverse the sort order for all keywords specified in the '--order-by' flag.
      --events-path string       send logs to unix domain socket path
  -e, --exclude stringToString   Filter appliances using a comma separated list of key-value pairs. Regex syntax is used for matching strings. Example: '--exclude name=controller,site=<site-id> etc.'.
                                 Available keywords to filter on are: name, id, tags|tag, version, hostname|host, active|activated, site|site-id, function (default [])
  -i, --include stringToString   Include appliances. Adheres to the same syntax and key-value pairs as '--exclude' (default [])
      --no-interactive           Suppress interactive prompt with auto accept
      --no-verify                Don't verify TLS on for the given command, overriding settings from config file
      --order-by strings         Order appliance lists by keywords, i.e. 'name', 'id' etc. Accepts a comma seperated list of keywords, where first mentioned has priority. Applies to the 'appliance list' and 'appliance stats' commands. (default [name])
  -p, --profile string           Profile configuration to use

SEE ALSO