Commands Reference Version 8.
Trademarks and Copyrights © Copyright Storix, Inc. 1999-2014 USA Storix is a registered trademark of Storix, Inc. in the USA SBAdmin is a trademark of Storix, Inc in the USA and other countries Linux is a registered trademark of Linus Torvalds. Intel, Pentium, IA32, IA64, Itanium, Celeron and IA64 are registered trademarks of Intel Corporation. AMD, Opteron, and Athlon are registered trademarks of Advanced Micro Devices.
Table of Contents General Information ................................................................................................ 4 Commands .............................................................................................................. 5 sbadmin ...................................................................................................................................................... 5 stbackup ...................................................................................
General Information Although all operations may be performed from either the SBAdmin Graphical User Interface, or the Web Interface, it is sometimes desirable to run commands at the command-line to perform certain tasks. This section lists the commands that may be run from the command line. Some commands are used on the Administrator System and others on the Client or Server system, as indicated.
Commands sbadmin Purpose: Start the SBAdmin Xwindows graphical user interface. Use on: Administrator Syntax: sbadmin [options] Options: -U username/password Specifies under which username and password sbadmin should start -G group Specifies the group sbadmin should use when starting -d display Specifies the Xserver display to use when starting About Displays version and license usage information Details: This is the command used to start the SBAdmin Xwindows graphical user interface.
stbackup Purpose: Run a backup outside of a job Use on: Administrator or Client Syntax: stbackup [options] {–t type} {–d device|directory} data {…} Options: -b --buffer bufsize Buffer size of backup data. Default is 64 Kbytes. -C, --compress level Compression level: (1) low, (2) medium, (3) high -d --device device/dir Configured backup device name or physical tape device/directory name if writing locally. For TSM backups use “API” (see “-s server”). -D --desc description Backup description.
-t -type type Specifies the type of backup to be performed.
Volume Group and Logical Volume backups are only available on Linux systems if LVM (Logical Volume Manager) is installed. Meta-disk backups are only available on Linux if meta-disk (Software RAID) support is installed. TSM Edition allows only System (-t S) backups. System Backups: When performing a System Backup (S), the data is a list of volume groups (AIX or Linux) or ZFS Pools (Solaris) to include on the backup. For AIX systems, the rootvg volume group is always included, so it need not be specified.
stbuildlabel Purpose: Rebuild a backup label that is missing or expired Use on: Administrator Syntax: stbuildlabel [options] {–d device|directory} -d device/API, --device device Tape or directory device on the server (i.e. “rmt0”). If rebuilding a label from backups written to a directory, you must also supply the –l backupid option. Options: -l, --label backupid/all The Backup ID of the backup you want to rebuild the label for or “all” backups located in the directory.
stconfigweb Purpose: Configure the SBAdmin web interface Use on: Administrator Syntax: stconfigweb [options] Options: -N --noprompt Configure the web interface in a non-interactive mode -R --remove Un-configure and remove the web interface -f --pemfile file Specify the location of the ssl.
stcheck Purpose: Check the network communication between any systems running System Backup Administrator Use on: Network or TSM Edition Administrator, Client or Server Syntax: stcheck [-a {MyIPaddress | MyHostname}] {Hostname | IPAddress} Options: -a myaddr Specifies the IP address (MyIPAddress) or hostname (MyHostname) of the local network adapter to use to contact the client or server Hostname Hostname of the client or server to contact IPAddress IP Address of the client or server to contact Details
stclient (stclient.sba for Solaris) Purpose: Configure Linux, Solaris or AIX clients. Lists configured clients and check client availability, turn on and off optional license features, configure backup preferences. Use on: Network or TSM Edition Administrator Syntax: stclient [options] client {...
If you want to also show the client availability as well as the system type, use –A with -l. This will indicate the client availability as either available or down, and will display the system (AIX, Solaris or Linux) and machine type (i386, ppc, sparc) or “unknown” if the client cannot be contacted. If no client name is provided, all clients are listed, indicating whether or not the client is currently available.
stconfigsbdev Purpose: Configure a client local tape, disk or NFS device Use on: Workstation, Network or TSM Edition Administrator Syntax: stconfigsbdev [options] device {...
-U, --undefine Unmount and undefined (nfs unconfigure only) -V, --verbose Verbose listing. (with –l) -x, --colonformat Colon format output (with –l) Details: The stconfigsbdev command is used to configure a disk, tape, or NFS share (local to a client) for system backups. By configuring a local disk, a job may be setup to use SBDIR as a backup device when creating a backup job on the Administrator. By configuring a local tape, a job may be setup to use SBTAPE as a backup device.
stconfigtsm Purpose: Configure TSM clients and servers Use on: Network or TSM Edition Administrator Syntax: stconfigtsm [options] tsmhost {...} Operations: -a --add Add or change a TSM client or server -l --list List configured TSM clients and servers -r --remove Remove TSM client(s) or server(s) General Options: -t --type type Indicate if configuring a (C)lient or (S)erver.
Details: The stconfigtsm command is used to add, remove and list TSM clients or servers configured on the Network or TSM Administrator system. This command is only valid if a TSM license is installed with the Network Edition or of TSM Edition is installed. When configuring a TSM client, you must first have configured a SBAdmin client using the stclient command and enabled TSM support for that client with the –T option. To configure a TSM Client: Only the NODEname (-N) option is required.
Note that, when removing a TSM node, you must specify the SBAdmin client name. You will be removing the TSM node information for this client, but will not remove the SBAdmin client (since you may still want to backup this client to other (non-TSM) devices). Note that you cannot remove a client or server if it is currently assigned to a backup job. You will need to edit the job settings to remove the client from the job, change the job to send the backup to a different server, or remove the backup job.
stconfigweb Purpose: Configure the SBAdmin web interface Use on: Administrator Syntax: stconfigweb [options] Options: -N --noprompt Configure the web interface in a non-interactive mode -R --remove Un-configure and remove the web interface -f --pemfile file Specify the location of the ssl.
stcopybackup Purpose: Copy an existing backup to different server, or device. Use on: Network Edition Backup Server or Workstation Edition Administrator Syntax: stcopybackup [options] { -l backupID} {-d InputDevice} {-D outputDevice} Options: -b --bufsize bufsize Buffer size to use for new backup. Default is to keep same buffer size of original backup. -d --source device Source device containing backup to copy. Specify “API” if copying from a TSM server.
Important Note: Since this command is run on a backup server, not the administrator, no backup label or history information is created for the output backup. If this information is required, you must use the Utility option to Rebuild a Backup Label from the output media, or use the struncopy command on the administrator instead. If writing the backup to a different server, the local system must have been configured as a valid client for the destination server.
stexclude Purpose: Configure backup job exclude lists. Use to list configured exclude lists, create new exclude lists, and edit existing exclude lists.
stexclude -a -C all -F “/tmp /var” newlist Changing an exclude list If an exclude list already exists, you may change it by adding or removing the applicable clients, the devices to exclude, or the files/directories to exclude.
stgroup Purpose: Add, delete or list configured groups Use on: Network or TSM Edition Administrator Syntax: stgroup [options] {group} Operations: -a --add Add or change group -r –remove Remove group -l --list List groups Options: -d –desc “description” Description of the group.
stjob Purpose: Add, delete or list configured backup jobs Use on: Administrator Syntax: stjob [options] jobid Operations: -a –add Add or change the specified job -l –list List configured jobs -r –remove Remove the specified job -n --copyto new_jobid Copy jobid to new_jobid -N --moveto new_jobid Rename jobid to new_jobid Options: -A, --altnet IP/hostname Use alternate server network -B, --bootmedia Boot media options.
-Rn, --noremove Do not remove backup job after run successfully (default) -s, --server server Server to write backup to (if Network Edition). If backup is to a TSM server, indicate “TSM@serverName”. If using either Network or TSM Edition and you want to backup a client to its own local system backup device (SBTAPE or SBDIR), specify the client name as the server also.
If the data list is not provided in the backup profile, you will need to specify it in the job settings. The data list differs depending on the type of data to backup. The following is the list of data types for each backup type: Description Volume Group Filesystem Logical volume Meta-disk File/Directory Partition ZFS Pool ZFS Volume Slice Systems Linux/AIX any Linux/AIX Linux/Solaris any Linux Solaris Solaris Solaris Data to Specify Volume Group name(s) mount point(s) (i.e.
stkeys Purpose: Create encryption keys on a client for use in encrypting and decrypting backup data.
back-tick (`). Using a text string, such as “My-Encryption-Key!” will help you to remember the key in case it is lost or changed, but will limit the range of hexadecimal characters that are generated. Note that the encryption key (or text string) that is entered must be the following number of characters, based on the encryption bits setting: Storix System Backup Administrator Bits Hex String (length) ASCII text string (length) 128 32 16 192 48 24 256 64 32 - 29 - Version 8.
stlicense Purpose: This command is used to register the software, add a feature, or list current licensing information. Use on: Administrator Syntax: stlicense [options] Operations: -t --type feature Add specified feature. (E = encryption, T = TSM support) -i --info Display licensing information -k --key key Key to be registered -r --registeredto “Register to” Name that the license key is registered to. Storix System Backup Administrator - 30 - Version 8.
stlibrary Purpose: This command is used to list, inventory and perform tape movement operations on a random tape library. Use on: Network or Workstation Edition Administrator Syntax: stlibrary [options] { vdev | libname } Operations: -c --checktape Check if tape loaded -g, --getpos List last/current tapes for each drive.
This command requires that a library is already configured. Steps to configuring a random library must be performed using the SBAdmin user interface. Refer to the SBAdmin User Guide for details. Operations which require access to the tape drive itself require that you specify the device name.
stmakeboot Purpose: Create Boot Media for booting a system to the SBAdmin System Recovery process.
-N, --nomods Linux: Do not automatically load current SCSI or network modules when booting from this media. Default is that all currently loaded modules be loaded on boot.
cdrom: This option does not write to the CDROM drive. Therefore, no CDROM is required on the system used to create the ISO. A CDROM “ISO” filesystem image will be created, which should then be “burned” to a CDROM/DVD disc. If a server is specified (with the -s option), the image will be copied to the “Directory for CLIENT CDROM/network boot images” configured on the server. disk: This option will make a Local System Backup Disk bootable.
There are a number of options which may be specified when configuring a network boot client. These are discussed in detail in the section Enable/Disable a Network Boot Client in the SBAdmin User Guide and the SBAdmin Recovery Guides. Storix System Backup Administrator - 36 - Version 8.
stprintlabel Purpose: Send a backup label to the printer, email address, or append to file Use on: Administrator Syntax: stprintlabel {-q printer | Email | File} {-b backupid | -t tapelabelid} Options: -q, --queue printer Name of print queue. If not specified, label will be sent to standard output.
stprofile Purpose: This command will be used to create new profiles based on the default (supplied) profile types. It may also be used to customize a profile assigned to a specific job.
-m, --retaindays Number of days to retain a backup before expiring -n, --retainbackups Number of backups to retain before expiring -Ry, --rawpp Include raw partitions (Linux) and slices (Solaris) on system backups -Rn, --norawpp Don’t include raw partitions (Linux) or slices (Solaris) on system backups (default) -s, --sendlab where Send backup label to defined report preference (where is file, email, or printer name) -t, --type type Backup type (see description section) -v, --verbose List all p
If using TSM Edition, only System Backups are supported. For all profile types, a data list may be specified with the “–b datalist” argument. If it is not specified, the user will be required to specify the data to backup when configuring a backup job which uses this profile. If a datalist is specified, the user will still have the option to override this default value when configuring the backup job.
stqueuejob Purpose: Add a job to the backup queue Use on: Administrator Syntax: stqueue JobID Options: NONE Details: This is a link to stqueue –A. For further reference please see stqueue. Storix System Backup Administrator - 41 - Version 8.
stqueue Purpose: Perform various operations on a backup queue, such as listing, adding and deleting jobs Use on: Administrator Syntax: stqueue [options] JobID Operations: -A, --add Indicates the specified JobID should be added to the queue -L, --list List all jobs currently in queue. Each job will be listed on one line.
Adding a Job to the Queue Use the –A option to add a pre-defined backup job to the queue. If there are jobs in the same queue, the added job will be run after all prior jobs in the same queue complete. Note, if a prior job had failed, the queue will not process any new jobs until the failed job is either restarted or removed. Refer to the Job Queues section of the SBAdmin User Guide for information on monitoring/changing the status of queues using the SBAdmin GUI or Web Interface.
stremovelabel Purpose: Remove a backup label. Also removes the associated backup if written to disk. Use On: Administrator Syntax: stremovelabel [-f] backupid Options: -f, --force If the backup label to remove is of a backup written to a directory/disk device, this flag is required to force the removal of the backup from disk. If not supplied, disk backup labels cannot be removed. If the backup was to tape device, this flag is ignored.
streport Purpose: Generate various reports Use on: Network Edition, TSM Edition, or Workstation Edition Administrator Syntax: streport -t type [options] Types: -t netinst Generate network install clients report -t expiration Generate backup expiration report -t history Generate backup history report -t restore Generate restore history report Network Install Clients Report Options: -s server Show clients configured for boot on server -n name Show clients configured for boot using boot image name
Restore History Report Options: -h type Base history on type (job or backupid) -k “opt1 opt2” History of specific options (jobid or backupid) -g Update history from server restore logs -f date History start date (MM/DD/YY) -l date History end date (MM/DD/YY) Details: The streport command is available on an Administrator and is used to generate various reports. Storix System Backup Administrator - 46 - Version 8.
strestore Purpose: List, verify or restore backup data from a local or remote device Use on: Network or TSM Edition Client or Workstation Edition Administrator Syntax: strestore [options] -d {device {–L backupid}} {-t datatype} datalist … Operations: -l, --list List contents (of specified backup type) -r, --restore Restore backup data (default) -v, --verify Verify backup data (read only) Options: -d, --device device Device containing backup data to read.
Details: The strestore command is used to list, verify or restore data from any SBAdmin backup. When restoring data, the data will be restored to the system from which the command is executed. Specify the –v flag to perform a verify of the backup by reading through the contents. Specify the -l flag to list data contained in the backup header. If the –v or -l flags are not specified, a restore of the data is assumed. The datatype must be specified using the –t flag when using the -l or -r options.
L flag followed by the Backup ID. Refer to the Backup Labels section of the SBAdmin User Guide for details on the backup IDs. If you want to restore the data to a different destination than it was originally read from, specify the –D flag followed by the destination. The destination must be appropriate the the datatype being restored. For example, logical volume data must be restored to a logical volume, and a directory name should be specified for filesystem/directory data restores.
struncopy Purpose: Copy backups between servers or devices Use on: Administrator Syntax: struncopy [options] {-d source Device} {-D destination Device} Options: -b, --bufsize bufsize Buffer size to use for new backup. Default is to keep same buffer size of original backup. -d, --source device Source device containing backup to copy. If source is a TSM server, specify “-d API” (see –s server). -D, --destination device Destination device to write new backup to.
Details: The struncopy command is used on an administrator system to copy backups from one server to another, from any backup media type to another. Any backup may be copied from device to any other device. Backups originating from different backup media may even be appended onto the same output media. When using Network Edition with TSM support, backups to TSM servers may also be copied to a local tape or directory device or to another SBAdmin server.
strunjob Purpose: Run a backup job in the foreground Use on: Administrator Syntax: strunjob JobID Details: The strunjob command will perform the backups for all clients configured for the job (referenced by JobID) just as it would when executed from the job queues. The job status information, command output and error messages, and backup label information will be saved for future viewing using the View Backup Labels from the SBAdmin GUI or Web Interface.
if a pre- backup program was set to run on the client and failed. 7 Job terminated without writing any data to the server because the backup media was either write-protected, or contained a prior backup label that could not be overwritten due to the tape overwrite/retention policy setting. 8 Warning only.
strunrest Purpose: Verify or restore data from any server to any client Use on: Administrator Syntax: strunrest [options] –f {device {–l backupid}} {-t datatype} Operations: -v, --verify Indicates verify is to be performed. If omitted, a restore is performed -c, --client client Client to restore the data to. Only used if restoring data. -d, --datalist “datalist” If datatype is specified, you should also specify the list of data to verify or restore of the specified datatype.
-t, --type datatype Specify the type of data to restore from the backup. If omitted, the entire contents of the backup will be restored. Details: The strunrest command may be used to either verify or restore the contents of a backup. This command is only run on the admin system, although the backup data may exist on any server and may be restored to any client. You must specify both the server and device to read, and the client to restore to (if restoring).
If you want to restore the data to a different destination than it was originally read from, specify the –D flag followed by the destination. The destination must be a logical volume name (i.e. “lv00”) for logical volume restores, or a directory name for all other restores. For all restores, except when restoring single filesystems, the data will be restored to the new directory relative to the original full pathname of the files.
stserver Purpose: Add, change, list or remove SBAdmin server information. For TSM servers, refer to the stconfigtsm command instead. Use on: Network and TSM Edition Administrator Syntax: stserver [options] server {...
If you want to also show the server availability as well as the system type, use –A with -l. This will indicate the server availability as either available or down, and will display the system (AIX, Solaris or Linux) and machine type (i386, ppc, sparc) or “unknown” if the server cannot be contacted. Availability is determined by whether or not the administrator system can communicate with the server. If not, you can use the stcheck command to help isolate the problem.
stuser Purpose: Add, change, list or remove SBAdmin users Use on: Administrator Syntax: stuser [options] {user} Operations: -a, --add Add or change user -r, --remove Remove the specified user -l, --list List configured users Options: -g, --group “group” Set default group -L, --level "level" Set user level (0-5) -p, --password newpass Change password -v, --verbose Verbose output (when listing) -x, --colonformat Colon-delimited output (when listing) Details: The stuser command is r
stvdev Purpose: Add, change, list or remove device definitions Use on: Network or Workstation Edition Administrator Syntax: stvdev [options] devicename {...
Details: The stvdev command is used to add, remove, change and list devices. To list currently configured devices, use the –l option. By default, only device names are shown. To show all of the attributes of a device, use the –v flag also. When adding a new device the –T option must be used to indicate the device type (either tape or directory). A tape device may be a single tape drive or multiple tape drives, each of which may be in a sequential autoloader or random tape library.
