Source:SBC CLI

From SEPsesam
Revision as of 12:04, 23 November 2016 by Sta (talk | contribs)

Copyright © SEP AG 1999-2024. All rights reserved.

Any form of reproduction of the contents or parts of this manual is allowed only with the express written permission from SEP AG. When compiling and designing user documentation SEP AG uses great diligence and attempts to deliver accurate and correct information. However, SEP AG cannot issue a guarantee for the contents of this manual.

Draft.png WORK IN PROGRESS
This article is in the initial stage and may be updated, replaced or deleted at any time. It is inappropriate to use this document as reference material as it is a work in progress and should be treated as such.
Docs latest icon.png Welcome to the latest SEP sesam documentation version 4.4.3. For previous documentation version(s), check documentation archive.


Overview

The SEP sesam SBC (sesam backup client) collects and consolidates the backup data on the client system, and delivers it to STPD. During a restore, SBC receives the required data and restores it to the target system. The SBC module can be controlled directly without other SEP modules by using SBC CLI (command line interface).

SBC CLI is used to back up and restore data locally on the host. You can set SBC options in the backup task properties: Click the Options tab and under the Additional call arguments (Expert options) in the Save options field, specify the required options. The available SBC options depend on the selected backup type, OS and platform.

Command conventions

The parameters for a command are order-dependent and might include mandatory and optional values, or keyword choices.

| vertical bar
Separates the choices between two or more options or arguments.
[ ] square brackets
Indicates optional values.
< > less than and greater than symbols
Encloses variables that require values.

SBC CLI usage

sbc -b|r|g|p|k|h [-a <DB_options>][-C <control_host>] [-d <device>]
                [-f <list_source>] [-F <data_format>] [-i <saveset_info>]
                [-j <job_name>] [-l <level>] [-L <control_target>]
                [-n <segment>[:<offset>:<size>]] [-o {options}]
                [-O <STOR/RETR_direct>] [-P <PID>] [-R <restore_target>]
                [-s <saveset_spec>] [-S <storage_node>] [-t <tape_spec>]
                [-T <since_time>] [-x <exclude_regexp>] [-X <exclude_list>]
                [-v 0|1|2|3|4|5|6]

Commands

There are six main commands that define what action can be performed by SBC. Another set of options can be used to further define the way the command is performed. The main commands are:

sbc -b|r|g|p|k|h

–b (backup)

Backup uses space delimited arguments to specify what will be backed up. These arguments may contain full item names or file patterns.

-b <backup_source1> [<backup_source2> ...] |

–r (restore)

Restore uses space delimited arguments to specify what will be restored. These arguments may contain full item names or file patterns. See also SEP sesam restore with SBC from virtual disk and SEP sesam restore with SBC from tape.

-r <restore_source1> [<restore_source2> ...] |

–g (get)

Get operation switch transfers the specified file from SEP sesam Server work directory to local directory. File is received as is, without any formatting. If local file is not specified, the remote file name is used. 
-g <remote_file> [<local_file>] |

–p (put)

Put operation switch transfers the specified file to SEP sesam Server work directory. File is sent as is, without any formatting. If remote file is not specified, the local file name is used.

-p <local_file> [<remote_file>] |

–k (kill)

Kill operation switch sends signal to the SBC process (incl. all child processes).

-k [-l 1|2|9] -s <saveset_spec>

–h (help)

Displays abbreviated usage syntax and a list of options you can use with the sbc command.

-h

Options

–a

Backup type specific argument that may be passed to the underlying library. The -a <DB_options> are forwarded to the related database module , e.g., to Lotus Notes. [-a <DB_options>]

–C

Specifies control host – SEP sesam Server.

-C <control_host>

–d

Specifies the target/source device or directory for the operation.

-d <device>

–f

Specifies the list of items to process.

-f <list_source>
Information sign.png Note
The -f <list_source> option overrides the backup source specified in the backup task. For example, creating a backup task with source (c:\x) and specifying an SBC option -f g:\dat2 will back up only the data from dat2 while ignoring the directory c:\x, which was specified as a backup source.

See also

SEP Sesam CLI exampleSEP sesam GUI