Xopero Centrally managed backup solution. CLI application

Transcription

1 Xopero Centrally managed backup solution CLI application Update:

2 TABLE OF CONTENT Introduction... 2 Symbols used in this document... 2 Definition... 2 Configuration... 2 Needed parameters... 3 Additional parameters... 3 Commands... 3 Create configuration file... 3 Encryption key initialization... 3 Encryption key/account reset... 4 Get account info... 4 Set file version limit... 4 Get file version limit... 4 Get hosts limit... 4 Get hosts list... 4 Add new host... 4 Change host name... 5 Delete host from account... 5 Get projects list... 5 Backup... 5 Backup briefcase... 6 Delete... 7 Dir... 7 Long file version format... 8 Short format file version... 9 Restore Get version info

3 INTRODUCTION These modifications make it possible to access the Opero Client software from the command line. The following actions will be implemented: addhost, backup, backupbriefcase, createconfig, delete, deletehost, dir, gethostslimit, gethostslist, getversion, getversionslimit, initkeytype, renamehost, resetaccount, restore, setversionslimit. These actions will be described in more detail in the following paragraphs. For all actions applies that a successful action is indicated by means of exit code 0. In all other cases a status code of 1 will be used. Symbols used in this document -- parameter <parameter> - required parameter, [--parameter <parameter>] additional parameter, non-required. Definition User a base system unit which represents a single account/person in the system. The user is identified by his login. Host a single computer on which the Opero application runs. It imposes the consistency in the directory structure in the backup processes and when restoring the data for different computers. Number of hosts is limited according to the product. Briefcase disk space where user files are stored. This data are encrypted with briefcase key. The contents of this directory are synchronized on each of the computer of one user where the Opero application is installed. Backup projects the projects represent the files that were archived by the user using Opero Backup application. The files are differentiated based on the host that performed the backup. All projects are encrypted, each with the same key (default or user-defined). CONFIGURATION The command line client does not need any configuration for it to function properly. All necessary information required to complete a given action is supplied via command line options. The default values for options otherwise configurable via the full Opero client should be such that these are satisfactory in the majority of installations. The command line client is able to read default values from a configuration file. When used, this configuration file is expected to reside in one of the following folders: $HOME/.backup_cli.conf /etc/backup_cli.conf Path to configuration file can be indicated by parameter config If the command line client detects a configuration file in one of the aforementioned folders, it will load and process the contents of this configuration file before processing the command line options. If an error is found in the configuration file, the command line client will issue an error message describing which value, setting or option is causing the error and terminate with an exit value of 1. 2

4 Opero Command Line application requires Java 1.5 or newer. If using command line application in Windows, it is recommended to do it from PowerShell. Needed parameters Below parameters are required for each command. --login <login> User login. --password <password> User password. The network address of the Opero Server specified as server= --server <address> The network address and port of the Xopero server specified as: server= for HTTP connection, server= for HTTPS connection Additional parameters Below parameter is additional and can be used for each command. [--help] Command help. [--config <path>] Path to config file. [--cache-dir <path>] Path to cache directory. [--log-dir <path>] Path to log directory. COMMANDS Create configuration file Creates a new configuration file. --path <path> Path to save file to. Default is 'backup_cli.conf' in user home directory. Encryption key initialization Initializes new encryption key for user account. 3

5 [--key <key>] Encryption key is initialized with user private key. Default is DEFAULT encryption key (generated automatically). Encryption key/account reset Resets user encryption key/account. After using it all user data and host have been deleted. To use this user account again it is required to initialize new encryption key. [--no-confirm] Action will not need confirmation. Get account info Gets info about: license type, hosts limit, capacity, used space... Set file version limit Sets limit of file versions that are stored on backup servers. --limit <number> File versions limit. Default is 30. Get file version limit Gets limit of file versions that are stored on backup server. Get hosts limit Gets hosts limit available for user. Get hosts list Gets list of all hosts that are assigned to user account. Add new host Adds new host under the user account (if host limit is not reached). 4

6 --host-name <name> New host name. Change host name Changes given host name. Host must exists and be assigned to given user account. --old-host-name <name> --host-name <name> [--virtual] [--no-confirm] Current host name that has to be changed. New host name. If used operates on virtual hosts. Action will not need confirmation. Delete host from account Deletes host and all its data from user account. Parameter --host-name <name> [--no-confirm] Host name that has to be deleted. Action will not need confirmation. Get projects list Gets list of all projects in host. Parameter [--host-name <name>] Host name that has to be deleted. Default is current host. Backup Performs a backup. --path <path1, path2, > This argument specifies a list of files and/or directories to be backed up. Multiple paths are separated with ','. It is the user s responsibility to properly quote any file 5

7 [--host-name <name>] [--project-name <name>] [--recursive] [--backup-method <method>] [--path-separator <separator>] [--key <key>] or folder name containing embedded whitespace or other special characters. If the optional --recursive option is specified, all specified folders will be backed up recursively. The use of relative paths is allowed and will be treated properly by the agent (this means that the agent will fully resolve any relative path into the correct absolute path and automatically compress any redundant path components). Host name to which files will be added. This host must be firstly added to user account by command addhost. Default is current host. Project name to which files will be added. Default is 'commandline'. This argument specifies to set backup as recursive. Specifies backup method for files: REGULAR DIFFERENTIAL INCREMENTAL. Default is automatic. Path separator of files and/or directories list. Default is ','. User encryption key used to encrypt a stored files. Required if user defined his own encryption key (not default). Output This command will print, during and after backup, list of backed up files, one line for each file (the full path will be shown). Backup briefcase Sends files to briefcase. --path <path1, path2, > This argument specifies a list of files and/or directories to be backed up. Multiple paths are separated with ','. It is the user s responsibility to properly quote any file or folder name containing embedded whitespace or other special characters. If the optional --recursive option is specified, all specified folders will be backed up recursively. The use of relative paths is allowed and will be treated properly by the agent (this means that the agent will fully 6

8 [--recursive] [--briefcase-dir <directory>] [--path-separator <path>] resolve any relative path into the correct absolute path and automatically compress any redundant path components). This argument specifies to set backup as recursive. Specifies the directory in briefcase where files will be uploaded. If it is not given files are sent to main briefcase directory. Path separator of files and/or directories list. Default is ','. Output This command will print, during and after file sending, list of sent files, one line for each file (the full path will be shown). Delete Deletes files and directories that were sent to backup server. [--host-name <name>] [--project-name <name> [--path <path1, path2, >] [--version <GUID1, > ] [--date <YYYY-MM-DD hh:mm:ss>] [--recursive] [--no-confirm] Output Host name from which files have to be deleted. Default is current host. Project name from which files have to be deleted. Default refers to all project from given host. Paths of files and directories that have to be deleted. The name should contain the full path where the directory or file is located. Multiple files and/or folders are separated with ','. It is specifying which file versions hat to be deleted. Multiple versions are separated with,. If it is not given all version will be deleted. Paths/versions created after this date will not be included. This argument specifies to delete files recursively from directory. If it is not given subdirectories and their files will not be deleted, only files in given folder. Action will not need confirmation. As output, the delete command will print the list of deleted files or folders on standard output, one line for each file (the full path will be shown). Dir Commands shows directories or file version stored on backup servers. 7

9 [--host-name <name>] [--project-name <name> [--path <path>] [--date <YYYY-MM-DD hh:mm:ss>] [--recursive] [--long-format] Host name from which files have to be shown. Default is current host. Project name from which files have to be shown. Default refers to all project from given host. Path to file or directory that has to be shown. If it is path to file then prints file versions. Paths/versions created after this date will not be included. Shows all directories that are under give path or all file version if in path file is given. Use long format for displayed data. Long file version format The long file version displays the results in the following format: type path backup method date modified GUID date created size in bytes description The type indicator possible values : F - File D - Directory The backup method indicator possible values: R - Regular P - Partial D - Differential I - Incremental For a single-directory listing, the name tag only contains the name of a file or directory and not contains the path. For a recursive directory listing the name contains the relative full path. The size of a file will be displayed in bytes. The date created and date modified display the date when a file has been created or modified. The date format for files is YYYY-MM-DD hh:mm:ss. The GUID defines the file version. Examples The request to display the 'opero_agent\client' directory for briefcase: 8

10 With --recursive option: For file versions: Short format file version The short version displays the results in the following format: <type> <name> The type indicator possible values: F - File D - Directory For a single-directory listing, the name tag only contains the name of a file or directory and not contains the path. For a recursive directory listing the name contains the relative full path. 9

11 Restore Restores files from backup servers. [--host-name <name>] Host name from which files have to be restored. Default is current host. [--project-name <name> Project name from which files have to be restored. Default refers to all project from given host. Paths to directories that have to be restored. It is [--path <path1, path2, >] possible to type there a file that we want to display versions. If empty then main folder will be select by default. [--version <GUID1, GUID2, > Filer versions id that has to be downloaded. If it will be given then paths parameter will be missed. [--date <YYYY-MM-DD hh:mm:ss>] Paths/versions created after this date will not be included. [--recursive] Restores all directories that are under given path. Local directory where files will be downloaded. If not [--restore-dir <dir>] specified files will be downloaded to current directory. User encryption key used to decrypt a downloaded [--key] files. Required if user defined his own encryption key (not default). [--overwrite] Specifies overwrite mode: ASK YES NO. Default is ASK. [--maxthreads <number>] Maximum number of threads to use. Default is 8. Output As output, the restore command prints the list of restored files and folders on standard output, one line for each file (the full path is displayed). Get version info Returns version number. 10