ArchiveIndexCreate

Creates the archive index database. If an archive index with the same [name] already exists, an error is thrown. The [name] must not contain blanks, special punctuation characters nor any special national characters. The [description] may contain any text.

ArchiveIndexRestore

Restores the Archive index database from the backup file indicated by the 'filename' property in the request headers.

ArchiveIndexAddKeys

Updates the Archive index keys and their meta attributes (supports creation of new keys). Key schema given in the request body is considered final – keys are added and deleted accordingly. Keyname must not contain blanks or exceed 15 characters. Type must be one of 'C' (character key) or 'N' (numeric key). Attributes and values for metadata must also not exceed 15 characters each.

ArchivePlanCreate

Create new plan

ArchivePlanStart

Submits one of the Archive plan operations (submit, run, verify) for execution and returns the corresponding Job ID. Headers must include “action” property. “Submit” action submits the plan for execution. In order to run an Archive plan, an archive event must be selected. This method thus selects the next planned archive event to start the archive plan. Optional “time=now” (or “time=0”) will override this scheduled execution time. "Run” action runs the archive plan immediately with an optional delete pass on the target directory/ies. "Verify" action re-runs the verify, clip generation and deletion (the post-archive tasks) of files located on the [client] computer and archived with the [jobId]. These parameters must be included in the request headers.

ArchiveSelectionCreate

Creates a new temporary Archive selection resource It is possible to immediately populate the new archive selection with files/folders and associate them with metadata key/value pairs. Paths to be added as well as their metadata can be provided in the request body or the appropriate external input and output files must be referenced in headers. Note that metadata keys must already be known in the index referenced by the Archive selection. Please use P5 GUI to add new metadata keys. Paths ending with '*' will be added recursively. Folders should end with '/' or else they will be treated as files (only the directory node will be added, which is probably not the intended result).

ArchiveSelectionStart

Submits the temporary Archive selection for execution and returns the corresponding Job ID. Optional “time=now” (or “time=0”) property overrides the scheduled execution time. This command implicitly destroys the ArchiveSelection object for the user and transfers the ownership of the internal underlying object to the job scheduler. You should not attempt to use the [ArchiveSelection] afterwards.

BackupPlanCreate

Create a new backup plan. Expects a json object in body with at least the 'description' attribute set. If any other attributes are set, the plan will be automatically updated with the given values.

BackupPlanStart

Executes either a 'Start Now' or a 'Dry Run' job for the plan. Headers must contain a valid Backup event ID as returned by GET rest/v1/backup/plans/{planID}/events/

BackupPlanEventCreate

Create a new backup event. NOTE: json body must contain at least 'pool' attribute. Optionally configures the event attributes with values given in a json body.

BackupPlanTaskCreate

Create a new backup task. Optionally configures the task attributes with values given in a json body.

B2GoServerCreate

Create a new server

B2GoServerStart

Submits the workstation backup job for execution to the server. Optional “time=now” (same as “time=0”) may be given to override plan execution time. Returns the job resource.

B2GoServerPathsCreate

Configures the list of paths for the backup operation. Any existing paths in the list are discarded. NOTE: If one of the given paths itself contains one or more spaces, that whole path must be enclosed in curly braces { and }.

B2GoWorkstationCreate

Try to establish the connection to the remote workstation, and based on its host ID, create or reuse the workstation record on the server (all request parameters except “template” are required)

ClientPing

Tests the connection to the Client indicated by the given ID. The optional “timeout=seconds” argument controls how many seconds to wait for the client response. Default timeout is 600 seconds (10 minutes).

DeviceInventory

Performs an inventory operation for the device, effectively updating the internal volume database. Returns the name of the currently loaded volume. Note that this is always a mount inventory, not a bar code inventory.

FilterCreate

Creates a new File filter and optionally configures it according to the parameters given in body.

JukeboxInventoryAndLabel

Starts either an Inventory or Label job for the Jukebox. The headers must contain "action = inventory" or "action = label" key. Inventory job effectively updates the internal volume database and returns the Job ID. For Inventory, headers may contain additional arguments: “barcode=true” (attempts a bar code inventory, instead of a default mount inventory), “startSlot=number” and “endSlot=number” (limiting the inventory job to a subset of configured Jukebox slots). Labels job labels media in the given jukebox for the given Pool, starting with slotID1, optionally including additional listed Slots. Request body must contain JSON object specifying the Pool and Slots to be used. Note that only new/empty volumes can be labeled with this command.

PoolCreate

Creates a new Media Pool resource. Headers must include “name=string” property, indicating a name for the new resource. The name of the pool may not include blanks or any special punctuation characters. If the pool name already exists in the P5 configuration, an error will be thrown. The body may optionally contain json body specifying the additional pool parameters.

VolumeInventory

Outputs a list of the files contained on the Volume into a file. Headers must contain “filename=? client:?absolute_path” argument, whereby client is the name of the P5 client where to store the file and absolute_path is the complete path to the file to hold the output. The client part is optional and defaults to 'localhost:'. The inventory command fills in the passed file with lines containing records separated by a TAB. If no <options> are given, the output file will by default contain the index paths of all the files saved by the given job <name>, one record per line. Additional <options> represent the attributes that will be output for each file in a tab-separated format. These attributes may be system attributes or any user-defined meta-data fields. Note: This command can only be applied to Archive tapes The supported system attributes are: - ppath -> the physical path of the file on the filesystem - size -> the size of the saved file - handle -> the handle as required by the RestoreSelection - btime -> the backup time of the file - mtime -> the file's modification time - ino -> the inode number of the file The index path returned by the inventory command cannot be used to access files on the file system in general. There are special cases where this might be used for this purpose, but generally it is not supported. The idea behind this info is to have an overview or idea what is being stored in the index and not to consume it in some other fashion (i.e. address the files on the file system to post-process them). In cases where files are still expected to be in the file system at the place they were at the point of archiving (for example somebody wants to delete them or otherwise post-process them) the ppath attribute may be used, which, when given on the command line, will yield the physical path as-found on the client where the file resides. Note that not all index entries have corresponding physical paths. In such cases the value will be set to the string "<empty\>".

RestoreSelectionCreate

Creates new temporary Restore selection resource. Headers must contain “client=ID” property. Optionally, headers may contain “relocate=path” property, overriding the default restore location. If this option is given, it must point to a directory on the client file system (will be created if needed). Optionally accepts a JSON formatted body defining a list of Restore entries and additional parameters. Restore entries may be given as “entries”, in which case they must include Archive entry ID (as returned by the “POST /rest/v1/archive/plans/{ID}/archiveselections” request). Optional “targetPath” property will specify the target path of the restored file. NOTE: The “relocate“ property applies to all restore selection entries and is prepended to the restore path. The “targetPath“ property applies to the single entry for which it was defined and completely defines the rest of the final path, in addition to the “relocate“ part, if given. Example: Given the original path = “/my/old/path/file1“, relocate = “/restored“ and targetPath = “/some/folder/recovered_01“, the actual path to the restored file will be “/restored/some/folder/recovered_01“. Restore entries may also be defined as “searches”, allowing P5 to automatically find and add the correct Archive entry handle. In this case, “archivePlan” property contains the Archive Plan ID and “expression” contains the search expression used to locate the records. The expression has the following generic format: [key1] [op1] [val1] && [key2] [op2] [val2] ... The [key] is the name of the key as passed during archiving of the entry (“POST /rest/v1/archive/plans/{ID}/archiveselections” or “PUT /rest/v1/archive/plans/{ID}/archiveselections/{ID}”) The [op] is the logical operation applied to the value. The [val] is the value associated with the key. The following logical operations are supported: "==" key equals the value "*=" key starts with value Example: {author *= marco && state == italy} When searching for files or folders by filename, the key/value “name” must be used. Example: {name == myfile.pdf} or {name *= 'my file'} When entering expressions, please put curly braces around the complete expression. Values in expressions can be enclosed in single quotes, in case the value contains one or more blanks, it must be enclosed in single quotes. NOTE: Only entries that are located on "known" or "accessible" volumes are reported. If an entry is found in the index but is located on "inaccessible" volume (volume is disabled, not currently mounted in some tape drive or not found in any known media changer), it is not included in the selection.

RestoreSelectionSubmit

Submits the indicated Restore selection for execution and returns corresponding Job ID. The execution is started immediately, unless the optional “time=[time as "%a %b %d %H:%M:%S %Z %Y"]” property is included in the headers.

SyncPlanStart

Executes the Synchronize plan Start or Run operation, depending on the “action” property specified in the headers. Returns the corresponding Job ID. Headers must include “action=run” or “action=submit”. 'Submit' action submits the plan for execution. The headers may include optional “time=now” (or “time=0”) which will override scheduled execution time. Plan must be configured for auto-start since API just overrides the scheduled starting time. This command cannot be used to start a plan which is not set to auto-start or which does not have any events configured. 'Run' action runs the plan immediately. The headers may include optional “delete=true” which will trigger the additional delete pass on the target directory. Note: In order to run a Synchronize plan, a Synchronize event must be selected. This method implicitly selects the next planned event to start the plan.

SyncSelectionCreate

Create a new sync selection

SyncSelectionStart

Submits the indicated Synchronize plan for execution and returns corresponding Job ID. Header may include optional “time=now” (or “time=0”) which will override the scheduled execution time.