A newer version of this documentation is available. Use the version menu above to view the most up-to-date release of the Greenplum 5.x documentation.


Plugin command to move a backup file to the remote storage system.


plugin_executable backup_file plugin_config_file file_to_backup


gpbackup invokes the backup_file plugin command on the master and each segment host for the file that gpbackup writes to a backup directory on local disk.

The backup_file implementation should process and move the file to the remote storage system. gpbackup does not remove the file_to_backup from the local system. Remove the file in the backup_file command, if appropriate.


The absolute path to the plugin configuration YAML file.
The absolute path to a local backup file generated by gpbackup.

Exit Code

The backup_file command must exit with a value of 0 on success, non-zero if an error occurs. In the case of a non-zero exit code, gpbackup displays the contents of stderr to the user.