Commands Reference
Version 8.2
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 a nd othe r countries
Linux is a registered trademark of Linus Torvalds.
Intel, Pentium, IA32, IA64, Itani um, Cele ron an d IA64 a re regis tered t rademark s of In tel Corpo ration.
AMD, Opteron, and Athlon are registered trademarks of Advanced Micro Devices.
HP Integrity servers are regis tered tradema rks of Hewlet t-Packa rd Devel opment Compan y
IBM, AIX, Tivoli, iSeries and pSeries are registered tradem arks of Internatio nal Business Machines Co rporation.
Xwindows is a trademark of Mas sachuset ts Instit ute of Tec hnolog y.
Microsoft and Windows are registere d tradema rks of Mic rosoft Corporati on.
Macintosh and Mac OS X are registered trademarks of Apple Computer, Inc.
Oracle is a registered trademark of Or acle Co rporation,
All other company/product names and service marks may be trademarks or registered trademarks of their respective
companies.
*Encryption Software
System Backup Administrator Backup Data Encryption Feature has a cryptographic component, using Advanced
Encryption Standard (AES) "Rijndael" encryption algorithm in Cipher Block Feedback (st ream) mo de (CFB -128) , supportin g
128, 192 and 256-bit keys.
It is not for export or redistribution to any of what are called the "T-10 Terrorist States" as determined by the U.S. Department
of State. System Backup Administrator Backup Data Encryption Feature has been registered with U.S. Bureau of Information
and Security and is distributed under E xport Co ntrol Classi ficati on Numb er (E CCN) 5D 992. T his enc ryption i tem is aut horized
for export and re-export under section 742.15 ( B)(2) of the Export A dministratio n Regulations (EAR).
Storix System Backup Administrator - 2 - V ersion 8.2 Co mmands Refere nce
Table of Contents
General Information................................................................................................4
Commands ..............................................................................................................5
sbadmin...................................................................................................................................................... 5
stbackup ..................................................................................................................................................... 6
stcheck ..................................................................................................................................................... 11
stclient (stclient.sba for Solaris) ................................................................................................................ 12
stconfigsbdev............................................................................................................................................ 14
stconfigtsm................................................................................................................................................ 16
stconfigweb ............................................................................................................................................... 19
stcopybackup............................................................................................................................................ 20
stexclude .................................................................................................................................................. 22
stgroup...................................................................................................................................................... 24
stjob .......................................................................................................................................................... 25
stkeys ....................................................................................................................................................... 28
stlicense.................................................................................................................................................... 30
stlibrary..................................................................................................................................................... 31
stmakeboot............................................................................................................................................... 33
stprintlabel................................................................................................................................................ 37
stprofile..................................................................................................................................................... 38
stqueuejob................................................................................................................................................ 41
stqueue ..................................................................................................................................................... 42
stremovelabel ........................................................................................................................................... 44
streport ..................................................................................................................................................... 45
strestore.................................................................................................................................................... 47
struncopy.................................................................................................................................................. 50
strunjob..................................................................................................................................................... 52
strunrest.................................................................................................................................................... 54
stserver..................................................................................................................................................... 57
stuser........................................................................................................................................................ 59
stvdev....................................................................................................................................................... 60
Storix System Backup Administrator - 3 - V ersion 8.2 Co mmands Refere nce
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 cert ain tasks. This
section lists the commands th at may be run from t he co mmand lin e. Some c ommands ar e us ed on the
Administrator System and others on the Client or Server system, as indicated. All command specified here are
found in /usr/bin and should not be run directly fr om the soft ware instal lation di rectory (/o pt/storix/ bin or
/usr/lpp/storix/bin.
In this section, the following com mand s yntax conve ntions ar e used:
bold text in bold font is the command name or other argument typed as shown
italics replace the italicized word with a val ue ( which ma y be opt io nal)
[argument] argument is optional
{-n arg} flag -n must be supplied with a valid arg
{arg1 | arg2} either arg1 or arg2 must be supplied
-n,--arg value specify either “-n value” or “--arg value”
Unless otherwise noted, these commands may only be executed by the root user, or a user defined (by the root
user). Refer to Configuring Users section of the SBAdmin User Guide for more information.
Storix System Backup Administrator - 4 - V ersion 8.2 Co mmands Refere nce
sbadmin
Purpose:
Start the SBAdmin Xwindows gr aphical user int erface.
Use on:
Administrator
Syntax:
sbadmin [options]
Options:
Commands
Details:
-U
username/password
-G
group
-d
display
About
This is the command used to start the SBAdmin Xwindows graphical user interface. The
interface will be shown on the display indicated by the DISPLAY environment variable, if set.
When running as an account with acce ss to mor e than one co nfigur ed SBAdmi n user. The –U
flag may be used to avoid b eing pr ompt ed for t his inf ormat ion. Th e –G flag indicates under
which group sbadmin sh ould ope n. Multip le vers ions of s badmin m ay b e launc hed to
administer different groups, however only one instance per group may be run.
Refer to the SBAdmin User Guide for complete information on all functions of SBAdm in and
using the graphical user interface.
Specifies under which username and password sbadmin should start
Specifies the group sbadmin should use when starting
Specifies the Xserver display to use when starting
Displays version and lic ense us age i nformati on
Storix System Backup Administrator - 5 - V ersion 8.2 Co mmands Refere nce
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
-C, --compress
level
-d --device
device/dir
-D --desc
description
-e --eject
-h –hostperm
permission
-I --rawpp
-l --level
level
-N --raw
Buffer size of backup data. Default is 64 Kbytes.
Compression level: (1) low, (2) medium, (3) high
Configured backup device name or physical tape device/directory name if
writing locally. For TSM backups use “API” (see “-s server”).
Backup description. Any text up to 60 characters, excluding colons (:),
may be used. If the text contains s paces, surro und the entire text str ing
by double quotes.
Eject tape at end of backup
If writing to a disk file, indicates host read permission (a=any host,
h=original host only). Does not apply to tape backups.
Include raw partitions, slices and meta-disks in the backup. Applies to
System and Volume Group/Zpool backups. (Linux and Solaris only)
Incremental backup level (0-9). If not specifie d, no increment al level will
apply. Level 0 applies to System, Volume Group/Zpool, Filesystem
backups; levels 1-9 apply to Volume Group/Zpool, Filesystem backups.
Include raw logical volumes and ZFS volumes in the backup. Applies to
System and Volume Group/Zpool backups. (Linux and Solaris only)
-O --overwrite
-r --rewind
-s --server
server
Storix System Backup Administrator - 6 - V ersion 8.2 Co mmands Refere nce
Allow overwriting of another SBAdm in backup. If t his flag is not spec ified
and another backup exists on the tape, the command will fail and no data
will be written.
Rewind tape before starting backup
If backup is performed to a device on a remote server, this option
indicates the backup server name. This option only applies to client
systems in a Network Edition environment .
For TSM backups, set device to “API” an d use ser ver in th e format
“-s TSM@serverName”
-t -type type
Specifies the type of backup to be performed. This o ption is requir ed and
must be one of the following:
D File/Directory backup
F Filesystem backup
L Logical Volume backup (Linux/AIX)
M Meta-disk (meta-device) backup (Linux/Solaris)
P Raw Partition backup (Linux)
S System Backup
s Ra w Slic e Backu p (Solari s)
V Volume Group backup (Linux/AIX)
Z ZFS Pool backup (Solari s)
z ZFS Raw Volume backup (Solaris)
Details:
-T --tapelabel
tapelabel
-x --quiet
Specifies the tape label ID tapelabel should be applied to the first tape.
Applies if the backup starts at the beginnin g of the t ape.
Suppress progress indicator output
dataopt … Specify one or more elements to backup. The type of element specified
must match the type of backu p as specif ied by the –t type option.
The stbackup command is used to perform backups from the command line. These backups
run independently of the SBAdmin GUI or Web Interface. Therefore, the administrator has no
knowledge of the backup. Although the administrator is not controlling nor recording
information about the backup, the backup may later be imported into the SBAdmin Interface
using the option Rebuild (unexpire) a Backup Label. This will be necessary if you plan to use
the administrator to restore f rom these backu ps in the fut ure.
Note: Running stbackup from the command line does not communicate with the
Administrator. If you are using the admin istrator, you m ay want to create a backup job, use
either the
stqueuejob or strunjob command instead. A job will make a record of this backup,
backup label, history information, etc.
The last argument to the command, “data”, indicates the data to include on the backup. This is
dependent on the type of backup to perform, as specified with the –t option. The following
shows the backup types and the type of data to specify as the dataopt argument:
Type Description Systems Data to Specify
S System Backup any Volume Groups / Zpool name(s)
V Volume Group Linux/AIX Volume Group name(s)
F Filesystem any Filesystem mount point(s) (i.e. “/home /data”)
L Logical volume Linux/AIX Logical volume name(s) (i.e. “lv00 lv01”)
M Meta-disk Linux/Solaris Meta-disk names (i.e. “md0 md1”)
D File/Directory any Directory names (i.e. “/home/sam ..”)
P Partition Linux Raw partition names (i.e. “sda3 sdb5”)
Z ZFS Pool Solaris ZFS Pool name (i.e. “pool1”)
z ZFS Volume Solaris ZFS Volume name (i.e. “pool1/vol1”)
s Slice Solaris Disk slice name (i.e. “c0t0d0s1”)
Storix System Backup Administrator - 7 - V ersion 8.2 Co mmands Refere nce
Volume Group and Logical Volu me backu ps are only ava ilable o n Linux syste ms if
LVM (Logical Volume Mana ger) is installe d. Meta-dis k back ups ar e onl y availabl e
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. In that case, if no volume groups
are specified, only the rootvg v olume gr oup is inc luded. On Linux systems, this option only
applies if LVM is implem ented on the s yste m and ther e are v olume groups c onfig ured. If no
volume groups are specified, then no volume group data (including filesystems and raw logical
volumes) will be included on the backup. Whether AIX, Linux or Solaris, you may specify “all”
to include all available volume group (or zpo ols in the case of Solaris ) data. Note, howev er,
that raw volume data (volumes that do not include filesystems) will also be included unless you
specify the –n option.
The –l (incremental le vel) m ay be s pecifi ed to in dicate t hat onl y files which have ch anged
since the last prior leve l backup sh ould be inclu ded. Level 0 indi cates that all fil es should be
backed up and is used as a base for all subsequent incremental backup levels. Level 0 may be
specified with a System Backup t o indicate that this back up shoul d act as a f ull incr emental
from which latter incremental levels ma y be applied.
Backups may run faster when using a larg er buffer s ize (-b option) than the default of 64
Kbytes. If the tape device supports a larger than 64 Kbyte buffer, increasing this value will
often cause backups to run faster. Try buffer siz es that are a power of 2, such as 1 28K, 256K
and 512K. This value will only support up to 1024 Kbytes (1 Megabyte).
If a server is specified with t he –s option, you must have first configured the backup device
where the backup will be stored. Refer to
stserver and stvdev to configure servers and
devices.
The stbackup command will exit with a completion message and one of the following exit
codes:
0 Success
1 Backup failed
2 Pre-backup failure (no data written)
6 Non-bootable System backup created (warning - backup completed)
7 Cannot overwrite tape
9 Internal program error
11 Possible incomplete backup (warning - backup completed - verify required)
99 Killed by user (Ctrl-C)
Storix System Backup Administrator - 8 - V ersion 8.2 Co mmands Refere nce
stbuildlabel
Purpose:
Rebuild a backup label that is missing or expired
Use on:
Administrator
Syntax:
stbuildlabel [options] {–d device|directory}
Options:
Details:
-d device/API,
--device device
-l, --label backupid/all
-s --server server
-O --owner owner If backup is on a TSM server, indicate –O original API client (nodename)
-h --help
This command is used to rebuild a backup label file by reading each backup header on the
media. For backups written to t ape, this process will for ward pa st the backu p and ch eck for
additional backups and append backup information to the header file.
Backups written to disk, NFS, or TSM can also be used to recreate backup labels. All backup
files must be available when rebuilding backup labels.
For backups written to disk, you must specify the Backup ID of the backup you want to reb uild
the backup label. If you do not know or have more than one, you can specify “all” and all
backups located on the device without a label with be rebuilt.
Tape or directory device on the server (i.e. “rmt0”). If rebuilding a la bel from
backups written to a directory, you must also supply the –l backupid option.
The Backup ID of the backup you want to rebuild the label for or “all”
backups located in the dir ector y. This option is only available for
backups written to disk.
Server on which the backup devi ce is c onfigur ed. If usi ng a T SM or NFS
server, use the format “TSM@servername” or “NFS@servername”.
Show help and usage for the command
For tape backups, the stbuildlabel command will forward through the entire tape to locate all
backups. Use CTRL-C to stop the stbuildlabel command from reading through the entire tape if
you know all labels have been rebuilt.
Storix System Backup Administrator - 9 - V ersion 8.2 Co mmands Refere nce
stconfigweb
Purpose:
Configure the SBAdmi n web int erfa ce
Use on:
Administrator
Syntax:
stconfigweb [options]
Options:
-N --noprompt
-R --remove
-f --pemfile file
-P –port port
-h --help
Details:
This command is used on th e admini strator t o enabl e or disa ble the SBAdmi n Web I nterfac e.
Unless the -N or --noprompt option is used, the command is an interactive shell script that will
require user input to configure the SBA dmin-su pplied webs erver.
Configure the web interface in a non-interactive mode
Un-configure and remove the web interf ace
Specify the location of the s sl.pe mfile t o be used
Specify the port number t o run on ( defau lt is 808 0)
Show help and usage for the command
Storix System Backup Administrator - 10 - Versi on 8.2 Comma nds Ref erence
stcheck
Purpose:
Check the network communication between any systems running System Backup
Administrator
Use on:
Network or TSM Edition Administrator, Client or Ser ver
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:
This command may be used to determine communication errors. If a client or server shows as
unavailable from the SBAdmin interface, or if an error such as “Cannot contact server” occurs
during normal operations, t his comman d can help det ermine th e cause.
The following command was used to check for communications problems with an Administrator
(sales1) and a Server host (sales3). Shoul d a communicati on error occ ur, one or more
possible reasons will be listed along with the steps to check or repair the problem.
sales1.storix> stcheck sales3
Communications check for sales3
Actual name is sales3.storix
Timeout is 10 seconds
Contacting remote host...
Remote host responded:
My IP address: 192.168. 1.203
My (actual) hostname: sales3.s torix
My port numbers: 5026 and 5027
Your IP address: 192.168. 1.201
Your (resolved) hostname: sales1.s torix
Your port numbers: 58086 an d 58087
Your group name: main
Your group ID: 43239337 3a36c4c6
Your host (sales1.storix) is a valid Admin Syste m for sale s3.storix.
Host sales3.storix is a valid backup server for your group .
Host sales3.storix is a valid backup server for your host.
Storix System Backup Administrator - 11 - Versi on 8.2 Comma nds Ref erence
stclient (stclient.sba for Solaris)
Purpose:
Configure Linux, Solaris or AIX cl ients. List s configure d clients and ch eck cli ent avai labilit y,
turn on and off optional license features, configure backup preferences.
Use on:
Network or TSM Edition Ad minist rator
Syntax:
stclient <operation> [options] client {...}
Operations:
Options:
-a --add
-A --check
-r --remove
-l --list
-Ey, --enable-encryption
-En, --disable-encryption
-Ty, --enable-tsm
-Tn, --disable-tsm
-f, --force
-H, --admin-host host
-sy, --sparse
-sn, --nosparse
-ty, --atime
Add/edit client
Show availability of client(s) (defau lt all clients)
Remove client(s)
List configured clients
Enable encryption support
Disable encryption support
Enable TSM support (assumes this i s a confi gured T SM node)
Disable TSM support for this client
Remove client from backup jobs ( used with –r)
Append Admin system to system_admin_hosts file
Preserve sparse files on restor e (default)
Don’t preserve sparse file s on restor e
Preserve file access times on the backup
-tn, --noatime
-v, --verbose
Details:
The stclient command is u sed to a dd, remove and list c lients co nfigure d on the A dministr ator
System.
To list clients, use the –l option. By default, only client names are shown. If the –v option is
also provided; the client features and options will also be displayed.
Storix System Backup Administrator - 12 - Versi on 8.2 Comma nds Ref erence
Don’t preserve file access times on the backu p (default)
Show features list (used with –l)
If you want to also show the client availabi lity as well as th e system type, us e –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 clie nt cannot
be contacted. If no client name is provided, all clients are listed, indicating whether or not the
client is currently available. Availability is determined by whether or not the Network Edition
Administrator can communicate with the client. If not, you can use the stcheck command to
help isolate the problem.
TSM Clients
If this client is configured as a T SM client (i.e. t his is a T SM node t o be back ed up to a T SM
server), use the “-Ty” flag t o turn on TSM s upport. Yo u must th en use t he
command to configure the TSM clie nt opti ons.
Changing a client
If a client is currently defined, you can change specific options by specifying only that option
and its new argument. For example, to disable en crypti on for a client, use t he followin g
command:
stclient -aEn mickey
or
stserver -a --disable-encryption mickey
Removing a client
To remove a currently configured client, specify –r and the client name, such as:
stclient –r mickey
Note that if the client is currently assigned to a backup job, you may use the –f flag to have the
client removed from all backup jobs it is currently assigned to. When using the –f flag, if the
client you are removin g is the on ly client assign ed to th e job t hen the job will be r emoved. If
you do not use the –f flag, then you will need to edit the job settings to remove the client, or
remove the backup job, before r emoving th e client.
stconfigtsm
Storix System Backup Administrator - 13 - Versi on 8.2 Comma nds Ref erence
stconfigsbdev
Purpose:
Configure a client loca l tape, di sk or NF S devic e
Use on:
Workstation, Network or TSM Edition Adm inistrator
Syntax:
stconfigsbdev <operation> [options] device {...}
Operations:
Options:
-a –add
-i –import
-r –remove
-l --list
-j –eject
-b, --bootdisk
-c, --client client
-d, --disktype type
-e, --efiboot
-f, --force
-L, --label label
-p, --pptype type
-o, --opts options
Add system backup device
Import/find system backup disk (disk only)
Remove system backup device
List system backup devices
Eject configured system backup disk (disk only)
Make system backup disk bootable (disk only)
Client name
Disk storage type (P)artition, (L)VM or ZFS (disk only)
Configure disk capable of booting from UEFI (disk only)
Force import of SBDIR device (disk only)
Label to identify disk(s) within SBAdmin. (disk only)
Partition table type (“msdos” or “gpt”) (disk only)
NFS mount options (nfs only)
-n, --nfsserver server
-m, --mountpt mountpoint
-t, --type type
-v, --volsize size
-D, --redefine
-M, --remount
-N, --nfs4
Storix System Backup Administrator - 14 - Versi on 8.2 Comma nds Ref erence
NFS server name (nfs only)
System backup device mountpoint (workstation nfs only)
System backup device type (“disk”, “tape”, or “nfs”)
Maximum Volume size in MB (disk and nfs only)
Redefine NFS mount (nfs only)
Remount NFS mount (nfs only)
NFSv4 share (nfs only)
-U, --undefine
Unmount and undefined (nfs unconfigure only)
-V, --verbose
-x, --colonformat
Details:
The stconfigsbdev command is used to c onfigur e a disk , tape, or NFS sh are (l ocal to a client)
for system backups. By config uring a local disk, a j ob may be set up to us e SBDIR as a backup
device when creating a back up jo b on the Admini strator. By confi guring a local t ape, a j ob may
be setup to use SBTAPE as a backup device. By configuring a l ocal NFS share, a jo b may be
setup to use SBNFS as a backup device. By configu ring a s ystem backup dev ice, the client
does not need to be configured as a server to write backups to itself.
SBDIR applies to Network and Workstation Edition. SBNFS applies to Workstation edition.
SBTAPE applies to Network and TSM Edition. When using Net work and TSM Edition, specify
“local” as the server to access SBDIR or SBT APE devices.
Verbose listing. (with –l)
Colon format output (with –l)
Storix System Backup Administrator - 15 - Versi on 8.2 Comma nds Ref erence
stconfigtsm
Purpose:
Configure TSM clients and serv ers
Use on:
Network or TSM Edition Ad minist rator
Syntax:
stconfigtsm <operation> [options] tsmhost {...}
Operations:
-a --add
-l --list
-r --remove
General Options:
-t --type type Indicate if configurin g a (C)lient or (S)erver.
-v, --verbose
TSM Server Options:
-b,--tcpbuffsize size
-c,--compression state
-i, --tcpserveraddress addr
-n, --tcpnodelay state
-p, --tcpport port
-u, --adminuser userid
-M, --adminpass password
Add or change a TSM client or ser ver
List configured TSM clients and servers
Remove TSM client(s) or server(s)
Show features list (used with -l)
TCP Buffer size (in Kbytes)
COMPRESSIon <yes|no> (default: no)
TCPServeraddress (hostname or IP address)
TCPNodelay <yes|no> (default: no) (default: 1510)
TCPPort (default: 1500)
User ID of TSM Administrator
Password of TSM Administrator
-w, --tcpwindowsize size
-x, --passwordaccess type
TSM Client Options:
-W, --newpass password
-N, --nodename name
-P, --password password
-s, --server server Server for which to change password (with -W)
Storix System Backup Administrator - 16 - Versi on 8.2 Comma nds Ref erence
TCPWindowsize (in Kb)
PASSWORDAccess: generate or prompt (defau lt: generate)
Reset password (For PASSWORDAccess "generate")
NODEname (default: tsmhost)
PASSWORD (For PASSWORDAccess "prompt") or if changing
password (with –G)
Details:
The stconfigtsm command is used to add, remove and list TSM clients or servers configured
on the Network or TSM Administrator system. T his comm and is only valid if a TSM l icense i s
installed with the Network Edition or of TSM Edition is installed.
To configure a TSM Client:
Only the NODEname (-N) option is required. However, if this client is to back up to a TSM
server which has been configure with PASSWORDaccess “prompt”, the PASSWORD (-P) is
also required.
When configuring a TSM client, you must fir st have co nfigur ed a SBAdmin cli ent
using the stclient command and enabled TSM support for that client with the –T
option.
To change the TSM Node Pa sswo rd:
To change the node’s password on a TSM server, use the command:
stconfigtsm –P cu rrent Pas sword –G newPassword –s Server ClientName
Note that ClientName is the name of the SBAdmin client configured f or TSM sup port.
If the Server is configured for PASSWORDaccess “prompt”, the password will be changed
on the server. If configured for PASSWORDaccess “generate”, a new encrypted password
will be generated and saved on the client. For the latter, the password will not be required
when performing backups and restores of the client.
If you have multiple servers (using PASSWORDaccess “prompt”), you must perform the
command for each server.
To configure a TSM Server:
Only the TCPServeraddress (-i) and TSM administrator username and password (-u and
-U) options are required. You must supply the username of a TSM administrator configured
within TSM that has been co nfigur ed for Storage, Policy or System authority.
All other TSM server options are optional and will affect the network communication and
performance. These are dependent on the network and server settings, and you should refer
to your TSM administration guides for details on these options.
if you wish to add other TSM server options (used in the System User Configuration File
“dsm.sys” ) that are not indicated here, you can manually edit the configuration file created on
the SBAdmin administrator system created by this command. This file is
/storix/main/data/tsm/tsmser ver:serverName. Any options you add other than those
explained here will be retained when you change other options and must be manually changed
or removed as needed.
To remove a TSM Client (node) or Server:
To remove a currently config ured T SM node or T SM server, s pecif y –r and the client or TSM
server name, such as:
stconfigtsm –tC –r mickey
or
stconfigtsm –tS –r sully
Storix System Backup Administrator - 17 - Versi on 8.2 Comma nds Ref erence
Note that, when removing a T SM node, you m ust specif y 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.
Storix System Backup Administrator - 18 - Versi on 8.2 Comma nds Ref erence
stconfigweb
Purpose:
Configure the SBAdmi n web int erfa ce
Use on:
Administrator
Syntax:
stconfigweb [options]
Options:
Details:
-N --noprompt
-R --remove
-f --pemfile file
-P –port port
-h --help
This command is used on th e admini strator t o enabl e or disa ble the SBAdmi n Web I nterfac e.
Unless the -N or --noprompt option is used, the command is an interactive shell script that will
require user input to configure the SBA dmin-su pplied webs erver.
Configure the web interface in a non-interactive mode
Un-configure and remove the web interf ace
Specify the location of the s sl.pe mfile t o be used
Specify the port number t o run on ( defau lt is 808 0)
Show help and usage for the command
Storix System Backup Administrator - 19 - Versi on 8.2 Comma nds Ref erence
stcopybackup
Purpose:
Copy an existing backup to different server, or device.
Use on:
Network Edition Backup Server or Workstat ion Editio n Administrato r
Syntax:
stcopybackup [options] { -l backupID} {-d InputDevice} {-D outputDevice}
Options:
-b --bufsize
bufsize
-d --source
device
-D --destination
device
-h --hostperm
hostperm
-l --sourceid
backup ID
-L –destinationid
backup ID
-n, --startseq
startingSeqnum
-r --rewind
-S –tsmsource
server
Buffer size to use for new backup. Default is to keep same buffer size
of original backup.
Source device containing backup to copy. Specify “API” if copying
from a TSM server.
Destination device to write new backup to. Specify “API” if copying to
a TSM server.
If writing to a directory dev ice or T SM, indicat es host r ead permi ssion
(a=any host, h=original host only) . Default is “a” if co pying fr om tape,
and defaults to the original host permiss ion if copying from di rectory
device to directory device.
Backup ID to read if copying from a directory d evice or TSM server
If writing to a directory device backup and appending to an existing
backup label, specify the backup ID of the backup to append. Not
used when appending tape backups.
Beginning backup sequence number to copy from source if there are
multiple backups on the media
Rewind the output tape device before starting the copy
TSM Server name if reading from a TSM server. Specify the server in
the format “TSM@serverName”.
-s -tsmdestination
server
Details:
This command is used on the backup media server containing the original backup to copy. Any
backup may be copied from a tape or directory device to any other tape or directory device,
either on the local system or to anoth er server.
Storix System Backup Administrator - 20 - Versi on 8.2 Comma nds Ref erence
Server name if output device or directory is on a remote serv er. If
sending to a TSM server, format is “TSM @serverName”.
Important Note
: Since this command is run o n a back up server, not the adm inistr ator, no
backup label or history infor mation is create d for the o utput backu p. If this inf ormati on 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 s erver.
This command will only copy one backup at a time to th e output devic e or director y. Even if the
source device or backup label contained multiple backups, only one may be copied at one
time. You may, however, append multiple backups to the output device (or backup label if
writing to disk). To indicate which source backup to copy (from a backup label containing
multiple clients or backup jobs), use the –n seqnum option. To copy all backups from source to
destination, run this command multiple times, in creating the seqnum option by one each time.
Stacking backups to tape
When copying to a tape device, you may indicate if you want to rewind before starting the
backup and if the tape should be rewound and ejected at the end of the backup. If you do not
rewind at the start of the backup, you may append the source backup to the end of the
destination media (if the d estinat ion med ia is curr entl y at the be ginnin g of volu me. The
destination
Buffer Size
backup label will be appended with the selected source backup.
You may alter the buffer size of the backup by entering a buffer size (in Kbytes) us ing the –b
bufsize option. This is quite useful in increasing the performance of backups when writing to
different media. For example, the default 64K buffer size may be adequate when you wrote
your original disk backup file, but when copying to a high-speed tape drive, a higher buffer size
(i.e. 256K) may provide m uch gr eater b acku p performa nce. To u se the same buffe r size f or the
destination as was used for the source, do not specify a new buffer size.
Host Read Permission
If using Network or TSM Edition, and the destin ation backu p is written t o a dir ector y devic e or
TSM server, you may also change whethe r only the origi nal client host or an y host may read
the backup data by using the –h hostperm option. If copying from tape to directory/TSM, the
default is to allow all hosts (-h a) to read the backup. If c opying fr om direct ory/T SM to
directory/TSM, the default is to leave the original setting unchanged. To allow only the original
host which wrote the backup to read it, use –h h.
Storix System Backup Administrator - 21 - Versi on 8.2 Comma nds Ref erence
stexclude
Purpose:
Configure backup job exclude list s. Use to list config ured exclude l ists, create new excl ude
lists, and edit existing exclude lists.
Use on:
Administrator
Syntax:
stexclude <operation> [options] excludelistname
Operations:
Options:
Details:
-a --add
-l --list
-r --remove
-C, --Clients “clientlist”
-c, --clients “clientlist”
-D, --Devices “devicelist”
-d, --devices “devicelist”
-F, --Files “file/dirlist”
-f, --files “file/dirlist”
-v, --verbose
-x, --force
The stexclude command is used to add, remove and list exclude lists configured from the
Administrator. For details on how to apply exclude lists to backup jobs refer to the SBAdmin
User Guide.
Add new exclude list or add new contents to specifi ed exclude l ist
List configured exclude lists
Remove exclude list or remove co ntents of spec ified exclude list
Clients to apply is “clientlist” (or “all) (with -a)
Add/remove clients in “clientlist” (-a or -r)
Devices to exclude is “devicelist” (-a)
Add/remove devices in “devicelist” (-a or -r)
Files/directories to exclude is “file/dirlist” (-a)
Add/remove files/directories in “file/dirlist” (-a or -r)
List verbose (show confi guratio n) (-l)
Remove exclude list from all configured jobs (-r)
To list exclude lists, use the –l option. By default, only exclude list names are sho wn. If the –v
option is also provided, the full exclu de list config uration is al so shown.
Creating a new exclude list
To create a new exclude list you must specify which clients the exclude list applies to (or “all”),
which devices on the client s to exc lude, a nd which f iles an d/or dire ctories o n the cl ient to
exclude. For example, to create a new exclude list applicable to all clients that excludes the
/tmp and /var directores:
Storix System Backup Administrator - 22 - Versi on 8.2 Comma nds Ref erence
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 exclud e, or the files /direct ories to exc lude.
To remove a client and a directory fro m a configur ed exclude list:
stexclude -r -c mickey -f /var oldlist
To add a client, a device, and a direct ory to excl ude from an existin g exclude list:
stexclude -a -c minnie -d /dev/l v0 -f /home oldlist
To replace the excluded devices on an existing exclude list:
stexclude -a -D “/de v/lv4 /de v/lv5” oldlist
Note that you may not add and remove exclud e list contents in th e same command.
Removing an exclude list
To remove a currently configured exclude list, specify –r and the exclude list name, such as:
stexclude –r oldlist
Note that you may not remove an exclude list that is currently configured to be used by a
backup job. You may, however, use t he -x flag to force the removal of the exclude list
configuration from all backup jobs when removing the excl ude list.
Storix System Backup Administrator - 23 - Versi on 8.2 Comma nds Ref erence
stgroup
Purpose:
Add, delete or list config ured gr oups
Use on:
Network or TSM Edition Administrator
Syntax:
stgroup <operation> [options] {group}
Operations:
-a --add
-r –remove
-l --list
Options:
-d –desc “description”
-n --name name
-u --userlist “userlist”
-v, --verbose
-x, --colonformat
Details:
The stgroup command is used to add, rename or remove groups from the Administrator. This
command also updates the list of us ers with access to t his gro up.
Add or change group
Remove group
List groups
Description of the group.
Change group name to “name”
Users with access to this group
Verbose output (for list operation)
Colon-delimited output (for list operation)
Storix System Backup Administrator - 24 - Versi on 8.2 Comma nds Ref erence
stjob
Purpose:
Add, delete or list configur ed backu p jobs
Use on:
Administrator
Syntax:
stjob <operation> [options] jobid
Operations:
Options:
-a –add
-l –list
-r –remove
-n --copyto new_jobid
-N --moveto new_jobid
-A, --altnet IP/hostname
-B, --bootmedia
-b, --backupdata “data”
-c, --clients “clients” Client list to backup (if Network or TSM Edition). Required with –a
-d device/API,
--device device
Add or change the specifie d job
List configured jobs
Remove the specified job
Copy jobid to new_jobid
Rename jobid to new_jobid
Use alternate server net work
Boot media options. Either “cdrom” or “net work” can be spec ified
along with the server the boot media should be copied to. (i.e.
“cdrom server-hostname”)
Datalist to backup (overrides datalist in prof ile, if an y)
flag. Specify one or more clients when backing up to a server, or a
single client if backing up to a client local syste m backup devic e
(SBTAPE or SBDIR).
Device to write backup to. Requir ed with –a flag. If backing up to a
TSM server, indicate –d API. For TSM Edition, only API (TSM
server) or a tape device (client local tape) is allowed.
-D, --desc “description”
-e ,--schedule “string” Backup schedule in cron format. Required with –regularly or
-E, --encryption keyID
-p, --profile profile
-Ry, --remove Remove backup job after ru n succe ssfully ( with --lat er or
Storix System Backup Administrator - 25 - Versi on 8.2 Comma nds Ref erence
Backup job description (overri des descripti on in backup profil e)
–later flags.
Enable encryption with supplied encryption key ID
Backup profile name (r equir ed if ad ding a n ew jo b)
--ondemand only)
-Rn, --noremove
Do not remove backup job after r un suc cessfull y (defau lt)
-s, --server server
-Sy, --enable-snapshot
-Sn, --disable-snapshot
-v, --verbose Show detailed informati on on jo bs or nam ed jo b (with –l option)
-Vy, --enable-verify
-Vn, --disable-verify
-wr, --regularly Backup will be run regu larl y (-e schedule required)
-wl, --later Backup will be run later (-e schedule required)
-wo, --ondemand
-X, --exclude “exlist”
Details:
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.
Use snapshot backups with thi s job (if c onfigur ed)
Do not use snapshot backups with this job (def ault)
Perform auto-verify aft er successf ul bac kup
Do not perform auto-verify after backup ( default)
Backup will be run only on demand (no s chedule )
Enable and use specified exclude list na me(s) when job is r un.
The stjob command is used to add, remove, change, copy, rename and list backup jobs
configured on the Administrator system.
To list currently configured jobs, use the –l option. By default, only Job Ids are shown. To
show all of the details of a job, us e the –v flag also. This will display a paragraph of
information for each conf igur ed jo b sho wing all option s confi gured.
If you want to configure a new job, use the –a option a nd specify t he Job ID at the end of the
command. You will be required to specify a backup profile using the –p flag. If no list of data to
backup is provided in the profile, then you must also specify the –b “datalist” option. All oth er
options will be written with a default value. After adding a job, be sure to list it with the –vl
options to display the full list of s ettings.
To copy a configured ba ckup jo b use t he –n fla g, and t o rename a config ured ba ckup jo b use
the –N flag. You will need to specify the new jobid to be copied/renamed to as an argument to
each flag. Note that when you copy or rename a backup job, any changes to the backup
options that are specified on the command li ne will only b e applied to the ne w jobid.
Certain options, if not specif ied, will defau lt to a v alue c ontain ed in t he backu p profi le. T hose
include the backup description (--desc) and data li st (--datalist) flags.
NOTE: Be careful to use quotes around any argum ent to flags which cont ain multip le words.
Specifying the data list
If using TSM Edition, only System Backups are supported.
Storix System Backup Administrator - 26 - Versi on 8.2 Comma nds Ref erence
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 Systems Data to Specify
Volume Group Linux/AIX Volume Group name(s)
Filesystem any mount point(s) (i.e. “/home /data”)
Logical volume Linux/AIX Logical volume name(s) (i.e. “lv00 lv01”)
Meta-disk Linux/Solaris Meta-disk names (i.e. “md0 md1”)
File/Directory any Directory names (i.e. “/home/sam ..”)
Partition Linux Raw partition names (i.e. “sda3 sdb5”)
ZFS Pool Solaris ZFS Pool name (i.e. “pool1”)
ZFS Volume Solaris ZFS Volume name (i.e. “pool1/vol1”)
Slice Solaris Disk slice name (i.e. “c0t0d0s1”)
Scheduling a job
The default is to configure a job to run on demand (--ondem and). If a job is to be run only
once, but at a specific time, or on a regular basis, specify the --later or --regularly options
respectively. You will then be required to add the –e schedule option, where schedule is a
cron-style entry in the following format:
Minute Hour DayOfMonth Month DayOfWeek
Each of the above fields are required an d must be separat ed by a single spac e. You may
specify any number of options for each field, each separated by commas. For example:
0 17 * * 1,2,3,4,5
indicates that at 5:00 PM (minute 0 of hour 17) on ever y day of the mont h (*) of every mo nth of
the year (*), the backup should run, but only on Mo nday through Fr iday (1,2, 3,4,5).
Changing a job
If a job currently exists, you can change spec ific options b y specifyin g only that option and its
new argument. For example, to turn on auto-v erify f or jo b “myjo b1”, us e the follo wing
command:
stjob –aVy myjob1
or
stjob –a –verify myjob1
When changing a job, you may enter “none” to remove any previous values that do not require
an entry (i.e. “-D none”)
Storix System Backup Administrator - 27 - Versi on 8.2 Comma nds Ref erence
stkeys
Purpose:
Use on:
Network or TSM Edition C lient or W orkstat ion Edit ion A dministr ator
Syntax:
Operations:
Create encryption keys on a client for use in encrypting and decrypting backup data.
stkeys <operation> [options] –k Keyid
-a, --add “description”
-r, --remove “string”
-l, --list keyID
Options:
-b, --bits numbits
-f, --force
-h, --hex
-k, --key KeyID
-t, --text textkey
Details:
This command is availab le on e very c lient , and is used t o confi gure t he en crypt ion ke ys use d
in encrypting and decrypting backup data. The encryption keys are 128, 192 or 256 bits.
NOTE: This command is always us ed on th e client to confi gure t he keys in pl ace of d oing so
from the administrator application. For secur ity reasons , this prevent s any network traff ic that
might contain the encryption key itse lf.
Add a new encryption key
Remove specified keyed
List configured keys
Number of encryption bits (128, 192, 256)
Force keys to be removed with out prom ptin g (use with -r)
Encryptio n ke y i n He x (l en gt h must be at least bits/4)
Encryption Key ID (up to 20 chars)
Encryption key in ASCII text (length must be at least bits/8)
Once an encryption key is cr eated a nd used f or a back up, the s ame key MUST be us ed to
decrypt the data! If they key is changed or lost, there is no way to restore the backup data
again (and please don’t call Storix, because even they won’t be able to help you)!
The configured keys are stored in a local f ile on th e clien t, and ar e refe renced us ing o nly the
Encryption Key ID you assign to it. This prevents the need to remember the entire encryption
key, and also prevent the need to send the encryption key from one system to another when
using a Network or TSM Edition Administrator.
Encryption keys may b e specif ied eith er as a hexadec imal num ber or as a te xt string t hat the
command will convert to a hexadecimal number for you. A text string may contain any alpha or
numeric characters, as well as any punctuation characters except for quote (“), colon (:) or
Storix System Backup Administrator - 28 - Versi on 8.2 Comma nds Ref erence
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 ke y (or text str ing) that i s entered m ust be the following n umber of
characters, based on the encryption bit s setting:
Bits Hex String
(length)
ASCII text
string (length)
128 32 16
192 48 24
256 64 32
Storix System Backup Administrator - 29 - Versi on 8.2 Comma nds Ref erence
stlicense
Purpose:
Use on:
Administrator
Syntax:
Operations:
This command is used to registe r the soft ware, add a f eatur e, or list c urrent lic ensing
information.
stlicense [options]
-t --type feature
-i --info
-k --key key
-r --registered to “Register to”
Add specified feature. (E = encr yptio n, T = T SM support)
Display licensing information
Key to be registered
Name that the license key i s regi stered t o.
Storix System Backup Administrator - 30 - Versi on 8.2 Comma nds Ref erence
stlibrary
Purpose:
Use on:
Network or Workstation Edit ion Admi nistrator
Syntax:
Operations:
This command is used to li st, inv entor y and pe rform tap e moveme nt oper ations o n a rand om
tape library.
stlibrary <operations> [options] { vdev | libname }
Options:
-c --checktape
-g, --getpos
-I --inventory
-l --list
-L --load Load tape (-t) from assigned slot to assigned drive
-r --reset Reset next tape (-t) to insert in drive (-d)
-U --unload Unload tape (-t) from assi gned drive and ret urn to assi gned slot
-d, --drive
-e, --eject Eject before unloading (with -u)
-I, --inserted Indicates tape is already inserted (with –r)
-s, --server server
-t, --tape tape
Check if tape loaded
List last/current tapes for each drive.
Display library invent ory
List defined libraries
Library drive number
Server hostname (if Network Edition)
Library tape (slot ) numb er
-v, --verbose Show library configuration (with –l)
-x, --colonformat
Details:
This option may be used to check, list and perform tape library operations. You must specify
either a defined library (libname) device (vdev) with this command. If a device is specified, it
must have been configured as a random tape l ibrary. In this case, the libname will be retrieved
from the device informati on.
Storix System Backup Administrator - 31 - Versi on 8.2 Comma nds Ref erence
Colon-delimited output (with –l )
This command requires th at a li brary is alread y conf igur ed. Steps to config uring a rando m
library must be performed using the SBA dmin us er interf ace. Ref er to t he SBAd min User
Guide for details.
Operations which requir e acces s to the t ape d rive its elf re quire t hat yo u sp ecify t he dev ice
name. For instance, you can displ ay the i nventor y for a librar y by sp ecifyin g the l ibrar y name,
but to check if a tape is loaded in the library device, you must use the device name (only then
do we know the names of the ph ysic al devic es attac hed to t he libra ry).
If using the Network Edition, you must also supply the server name with the –server flag.
To check if a tape is currently loaded
in the library, use the comm and:
stlibary –c –s servername vdev
To display the tape inve ntory
on the library, use the command:
stlibrary –I libname
Set or Reset the next tape to use for b ackups/r estores
:
SBAdmin backup jobs performe d to a dev ice co nfigur ed as a t ape libr ary r equire t hat the n ext
tape to use, or the current tap e in the dr ive, b e known before t he back up begin s. SBAdm in will
then keep track of the tape that i s in the drive, or the n ext/last on e use d as the backup
progresses. If you have manually moved a tape in the library, or ejected a tape for the drive,
you must reset the current or next tape to use when the next backup or restore is performed.
To do so, use the command:
stlibrary –r –tape tapenu m –drive drivenum libname
Note that the tapenum and drivenum are num bers, starti ng with 1, which repr esent th e tape
slots and drive slots in the library. It is assumed that tapenum is in its current slot in the library
and will be moved to its drive the next t ime a ba ckup is performe d. If tapenum is already
inserted in the drive, you must add the –inserted flag.
To move tapes in the library
:
You need only specify the tapenum to move and t he dir ection (load f rom slot t o drive or
unload from drive to slot) and whether or not the t ape mu st first be ejec ted from t he driv e.
This assumes that the current positions of the tapes in the library are correct (refer to Set or
Reset next tape” above). For example:
stlibrary –Uet3 libname
or
stlibrary –Ue --tape 3 libname
The above commands will move tape number 3 from the drive to its original slot in the library
after ejecting it from the drive. If using Netw ork Editio n, add the –server option if remote. Note
that you can also specify a device name to use in p lace of the libr ary name.
Storix System Backup Administrator - 32 - Versi on 8.2 Comma nds Ref erence
stmakeboot
Purpose:
Create Boot Media for boot ing a system to the SBAd min Syste m Recovery pr ocess.
Use on:
Network or TSM Edition C lient or W orkstat ion Edit ion A dministr ator
Syntax:
stmakeboot -t tape {-d dev} [options]
stmakeboot -t disk {-d dev} [options]
stmakeboot -t cdrom {-o output_fil e} [options]
stmakeboot -t netboot {-d dev} {-l imagename} {-s bootserver} [options]
stmakeboot -t netclient -r {-c client}
Operations:
-r, --remove Remove netw ork boot c lient configur ation indic ated with –c option
Options:
(default is to add or update e xisting conf iguratio n)
-a, --hwaddr hwaddr
-A, --alt-server IP Alternate server network to use when adding network
-b, --bootloader loader
-c, --client client Name of client to add or remove network boot configuration
-C, --console console Boot console device name (i.e. tty0,ttyS0, hvc0)
-d, --device device
-e, --efi-boot
-E, --no-efi
-g, --gateway gateway Gateway IP to use on network boot client
-k, --kernel kernel
-I, --image image Name of network boot image name to create or update
Network adapter hardware address (MAC) to use when adding
network boot configuration
configuration
Linux: Bootloader to use: GRUB (default), LILO, ISOLINUX
Device name for which to cre ate a boot tape, bootabl e disk, or
AIX network boot image
Network boot on UEFI firmware (Linux x86 only)
Exclude UEFI support (default=inc lude if avail able)
AIX: Kernel type (up, mp or 64) used to create boot image
Linux: Kernel filename to use to create boot image (default is
to find kernel for matching release)
Solaris: Not applicable
-M, --multiboot image
-m, --subnet subnet Subnet mask to us e on network boot client
Storix System Backup Administrator - 33 - Versi on 8.2 Comma nds Ref erence
Linux: Multiboot image filename needed to boot kernel
-N, --nomods
Linux: Do not automatically load current SCSI or net work
modules when booting from this media. Default is that all
currently loaded modules be loaded on boot.
-o, --outfile outfile Out put cd rom ISO image filename to create or initrd i mage
name (if creating disk or initrd image for Linux)
-p, --platform platform
AIX: Platform type (rs6k, rspc, chrp) of boot image
-P, --alt-client-ip IP Alter nate cli ent IP to us e when ad ding network boot
coniguration
-R, --release release Linux: Kernel release (suffix) to use. For initrd images, there
must be a /lib/modules/release directory matching this entry. If
omitted, the release the s ystem is curre ntly booted u nder will
be used.
-s, --server server If writing a boot tape, this is the name of server on which tape
is attached. If configuring a network boot client, specify the
server only if the client will bo ot from the server using a
different IP address or hostname than the default. If creating a
cdrom or network boot image, this is the server the image will
be copied to.
-S, --includescsi Linux: Include SCSI CDROM modules (required only if booting
SCSI CDROM). This option only applies when cr eating a
CDROM ISO image.
-t, --type type
Type of boot media to create. See details below.
-z, --api APItype API software to include on boot media. Currently, only “TSM” is
supported. This option is required if you will be installing from a
backup on a TSM server.
If using TSM Edition or Network Edition and this is a TSM client and you w ill be
installing from a backup located on a TSM ser ver, you MUST incl ude the op tion
“-z TSM” at the command-line.
Details:
This command is used to create various boot media for booting to the SBAdmin System
Recovery process. Boot media types include CDROM images, network boot images, bootable
tapes or hard disks.
This command must be run on the s ystem from which the boot ima ge is to be creat ed. If
writing a tape, you may add th e –s server option to write the actu al boot i mage ont o a r emote
tape drive. If creating a CDROM or network boot image, you may add the –s server option to
copy the images onto a remote server.
Updating the boot loader on a Linux system or creating or updating an initrd image may o nly
be done on a local system. Therefore, this command must be run on the client or server
directly, if needed.
The –t option must be one of the following:
Storix System Backup Administrator - 34 - Versi on 8.2 Comma nds Ref erence
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 “bur ned” to a C DROM/DV D disc. If a server is specified ( with the -s
option), the image will be copie d to the “D irector y for CLIENT CDROM/net work boot
images” configured on the server.
disk: This option will make a Local System Backup Disk bootable. The disk to make bootable
must first have been configured as a Local System Backup Disk. Refer to the SBAdmin
User Guide for more information.
tape: Create a bootable t ape. T he tape ima ges will b e creat ed on the loca l system, but may be
written to a remote tape drive if the –s server option is specified. This option is currently
only available on IBM System p and System i systems, since they are the only supported
systems which have firmware capable of detecting and booting from tapes.
netboot: Create network boot image. You must specify a name for the image using the –l
imagename option. If the specified image already exists, it will be overwritten by the new
image. If a server is specified (with the -s option), the network boot images will be copied
to the “Directory for CLIENT CDROM/network boot images” configured on the server.
netclient: Configure or unconfigure a client for network boot. This option must be performed
on the network boot server. If configuring a network boot client, the –l imagename option
is required as well as the –c client option. The imagename specified must have first been
created using the –t netboot option in a separate stmakeboot command.
initrd-disk: For Linux, this option will create the initrd/initramfs image without updating the
boot loader. This is helpful if you want to create an initrd image and configure your boot
loader manually. You may specify the name of the image to create (with the –o option), or
SBAdmin will create one as /boot/initrd-storix-disk (where disk is the hard disk to boot
from).
If you want to create boot media for a different platform or kernel type than the current
system, you may spec ify t he –p platform and –k kernel options respectively. If you want to
create the boot image suitable for booting the local system, you do not need to specify these
options. If you specify a platform type, the device support for the specified platform must have
been installed onto the local system. Li kewise, if a differ ent kern el type is s pecifie d, the fil eset
containing the specified k ernel must also be inst alled.
On AIX, for instance, the local system is an RSPC system running under the “up”
(uniprocessor) kernel, but you want to create boot media which will boot a CHRP system with
a 64-bit kernel, specify “-p chrp –k 64”. Note that the resulting boot media will not
boot the
local system, but can be used to migrate a system back up to new hardware.
Likewise, for Linux, you may specify a specific kernel to use with the –k when creating boot
media or when updating the disk boot loader. You ma y also use the –R option to specify the
release level of the kernel to us e. In this case, the c ommand will searc h for a ker nel which
uses the specified rel ease le vel as a s uffix (i n the /boot or / yaboot d irector ies). If spec ifyi ng a
release level, there must be a matchin g modul es directl y as /lib/modules/release. If both –k
and –R are omitted, the rel ease l evel the system was bo oted under (displ ayed with “uname –
m”) will be used.
On Linux, Specify the –C option only
if you have a serial terminal attached to the f irst serial
port of the system and wish to perform the system installation us ing that displ ay. If –C is
specified, the attached terminal m ust be set to 9600 baud, 8 bits, 1 stop bit and no parity for
proper communication. Omit the –C opt ion i f you want t o perf orm the i nstallat ion usin g the
graphical console att ached t o a gra phics adapt er.
Storix System Backup Administrator - 35 - Versi on 8.2 Comma nds Ref erence
There are a number of options which ma y be specified when confi guring a net work boot client.
These are discussed in detail in the sectio n Enable/D isable a Network Bo ot Client in the
SBAdmin User Guide and the SBAdmin Recovery Guides.
Storix System Backup Administrator - 36 - Versi on 8.2 Comma nds Ref erence
stprintlabel
Purpose:
Send a backup label to the printer, email address, or append to file
Use on:
Administrator
Syntax:
stprintlabel {-q pr inter | Email | File} {-b backupid | -t tapelabelid}
Options:
Details:
-q, --queue printer
-e, Email, --email
-f, File, --file
-b, --backupid backupid
-t, --tapelabel tapelabelid
-d, --details
-o, --output
This option will format and output a backup label to the specified printer queue, email address,
or append to a file. The default is to send to standard output.
The name of the print queue, email address, or file name to append must be defined in Report
Preferences prior to choosing the option to output the backup label.
Name of print queue. If not specified, label will be sent to
standard output.
The report will be sent to the email address specified in Report
Preferences
The report will be appended to the file specified in Report
Preferences
Specifies a Backup ID if printing backup label given a backup ID.
Specifies a Tape Label ID when printing backup label given a
tape label ID
Show profile details
Show backup status/output
Specify either a backup id (-b) or tape label id (-l) for which to format and print the backup
label. Although specifying a tape label id, the entire backup label will be shown, including a list
of other tape label IDs used in the backu p.
Use the (-d) option to show the backup profile details used when the backup was run.
Use the (-o) option to show the backup status and output messages when the backup was run.
Storix System Backup Administrator - 37 - Versi on 8.2 Comma nds Ref erence
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 assigne d to a specific job.
Use on:
Administrator
Syntax:
stprofile <operation> [options] [profile {…} | {-j jobid}]
Operations:
Options:
-a, --add
-l, --list
-r, --remove
-b, --bufsize bufsize
-B, --backuppriority
-c, --compress level
-cn, --nocompress
-C, --show-custom Inc lude cust omize d job pr ofiles (wit h –l and –v flags)
-d, --data datalist
-D, --desc “description”
-ey, --eject
-en, --noeject
-h, --hostperm [host | all]
Add or change the specifie d profi le
List configured profiles
Remove the specified profi le
Buffer size in KB (default 128)
Backup process priority (0-10)
Compress backup data at spec ified c ompressi on. Vali d level i s
(1)low, (2)medium, (3)high
Do not compress backup data (default)
Backup data list (of appropriate type)
Backup description
Eject tape at end of backup job
Do not eject tape at end of backup job (default)
Backup file read permission (default=all)
-i, --incr num
-j, --job jobid
-Ly, --rawlv
-Ln, --norawdev
Storix System Backup Administrator - 38 - Versi on 8.2 Comma nds Ref erence
Incremental backup level (0-9)
Add/change/remove customized pr ofile for jo bid (m ain “profile”
will be unaffected)
Include raw LV and ZFS volume data (System/VG/Zpool
backups)
Don’t include raw LV or ZFS volume data (System/VG/Zpool
backups) (default)
-m, --retaindays
Number of days to retain a backup before expiring
-n, --retainbackups
Number of backups to retain before expiri ng
-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 t o defi ned repo rt prefer ence (where is file,
email, or printer name)
-t, --type type
Backup type (see description section)
-v, --verbose List all profile details (with –l flag)
-wy, --rewind
-wn, --norewind
--preprog progam
Rewind tape before starting backup job
Do not rewind tape at start of backup (default)
Run program on each client before backup (if Network or TSM
Edition)
--postprog program
Run program on each client after backup (if Network or TSM
Edition)
--svpreprog program
Run program on server before starting job (or l ocal system if not
Network Edition). Not used for TSM Edition.
Details:
--svpostprog program
Run program on server after all client backups (or l ocal system if
not Network Edition). Not used for TSM Edition.
--presnapprog progr am
Run program on client before creating snapshots (or local system
if not Network or TSM Edition)
--postsnapprog program
Run program on client after creating snapshots (or local s ystem if
not Network or TSM Edition)
The stprofile
command is used to add, remove, change and list backup profiles. It may also
be used to customize a defa ult prof ile for use with a parti cular job. I n that cas e, the c ustomiz ed
profile options will be used in place of the d efault profil e only for the specifie d job (no other
jobs using the default profile will be affected).
If creating a customized pro file f or a job, s pecif y the –j jobid value, where jobid is the Job ID of
a job that was already configured. In this case, you do not specify a profile name. The profile
type that is currently associated with the backup job will be used. Any options that you do not
change will be taken from the original profile. Those specified will override the values of the
original profile. The origin al profile, an d any other jobs t hat use the orig inal profil e, will be
unaffected when creating a customize d job profile.
The –t type flag is required when creating a new profile. See the table below for a list of types
and their description.
Storix System Backup Administrator - 39 - Versi on 8.2 Comma nds Ref erence
If using TSM Edition, only System Backups are supported.
For all profile types, a data list ma y be specifie d with the “–b data list” 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 profil e. If a datali st is specif ied, th e user will sti ll have t he opt ion to overri de
this default value when conf igurin g the b ackup job. T he dat alist must b e one of t he fol lowing,
based on the profile type:
Type Description Systems Data to Specify
S System Backup any Volume Group / Zpool name(s)
V Volume Group Linux/AIX Volume Group name(s)
F Filesystem any Filesystem mount point(s) (i.e. “/home /data”)
L Logical volume Linux/AIX Logical volume name(s) (i.e. “lv00 lv01”)
M Meta-disk Linux/Solaris Meta-disk names (i.e. “md0 md1”)
D File/Directory any Directory names (i.e. “/home/sam ..”)
P Partition Linux Raw partition names (i.e. “sda3 sdb5”)
Z ZFS Pool Solaris ZFS Pool name (i.e. “pool1”)
z ZFS Volume Solaris ZFS Volume name (i.e. “pool1/vol1”)
s Slice Solaris Disk slice name (i.e. “c0t0d0s1”)
Changing a profile
If a profile (or customized pr ofile) cur rent ly exists, you can c hange s pecifi c option s by
specifying only that opti on and it s new arg ument. For e xampl e, to tur n eject tape at en d of
backups for jobs using pr ofil e “mys ystem”, use t he foll owin g comm and:
stprofile –aey mysystem
or
stjob –a –eject mysystem
When adding a customized profile, or changing an existing profile, you may specify “none” to
remove the current or default value (i.e. “–preprog none”).
Storix System Backup Administrator - 40 - Versi on 8.2 Comma nds Ref erence
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 - Versi on 8.2 Comma nds Ref erence
stqueue
Purpose:
Use on:
Administrator
Syntax:
Operations:
Perform various operations on a backup queue, such as listing, adding and deleting jobs
stqueue <operation> [options] JobID
-A, --add
-L, --list
-D, --delete
-H, --hold
-K, --kill
-R, --restart
-S, --status
Options:
-d, --queuedate
date
Details:
This command provides all of the f unction s of addi ng jobs, m anipulat ing, a nd disp layin g jobs in
a backup queue. This command is particularly useful to administrators that must access the
administrator system remotel y in order t o hand le a back up job that f ailed a nd cann ot use t he
SBAdmin GUI or Web Interface.
Indicates the specified JobID should be added to the queue
List all jobs currently in queue. Each job will be list ed on one line.
Delete the specified JobI D from t he queue
Place the specified JobI D on ho ld, prev enting t his and other jo bs
submitted after it to be run until th e queue is restart ed.
Kill the specified JobI D if cur rentl y runn ing
Restart the specified JobID. Us e this if a prev ious jo b fail ed or was
placed on hold
Displays the progress indicator, command outp ut, status and error
messages for a job that is c urrentl y runnin g or has f ailed.
Queue Date (as displayed with –L flag) of the specif ic job to add,
delete, change or show. Use this option if JobID appears multiple
times in the queue to indicate the specific occ urrence of the job.
Use the –L option to list all queues. This will show the current status of each job, whether
currently running, pending, on hold, or failed.
All options except –L require a JobID. When a JobID is specified, the queue name
(server:device) is retriev ed from t he conf igur ed job i nformat ion.
Storix System Backup Administrator - 42 - Versi on 8.2 Comma nds Ref erence
Adding a Job to the Queue
Use the –A option to add a pre-defined b ackup j ob to t he queu e. If there ar e jobs in the sam e
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.
When jobs are run from the que ue and t he SBAdm in GUI or W eb Int erface i s not ru nning, no
job status messages will be reported on the screen. Status messages, in this case, will always
be reported using the Alternate Notification method (mailed to a user or appended to a text
file). The backup output and pr ogress informat ion ma y later be disp laye d after run ning th e
SBAdmin GUI or Web Interface a nd select ing th e
View Backup Status/Output options.
Note that the stqueue command will return as soon as the job is added to the queue. The exit
code of this command will be 0 if the job wa s queued suc cessfull y, or 1 if the job c ould not b e
queued (usually because the JobID supplied is invalid). If, for instance, the server for the job is
not available, the stqueue command will succeed, but the job will fail after it is executed by
the queuing system, and will remain in the queue until it is restarted or removed.
Killing a Running Job
To kill a job that is current ly ru nning, us e the –K flag. This will sent a kill signal to the backup
process. It may take some ti me for t he job to stop s ince it may be ne cessar y to c omplete t he
current operation before the proces s will die.
When a job configured to wri te to tap e
is killed, it will remain in the queue in a “failed” state,
which will prevent other jobs in the same queue from starting. Jobs that write to disk image
files will be automatically removed from the queue, since “disk” queues will allow jobs to run
simultaneously anyway.
When a job is killed, the tape drive, if used, will be rewound to prevent any other backup jobs
from being appended to an incomplete backup. If the Tape Overwrite/Retention Polic y does
not allow overwriting of current (unexpired) backups, any subsequent jobs started after
removing the failed job from the q ueue will fail with an over write pr otect ion error. If th is is th e
case, use the
stremovelabel program to expire the failed backup label. Then r estart the queue
to allow other jobs to continu e.
Removing a Job from the Qu eue
Use the –D flag to delete a job fr om the queue. Removin g a job fr om the queue will not de lete
the original job information, but only removes it from the queue. It can be resubmitted using
the –A option if desired. You cannot delete a job from the queue if it is currently running. To
delete a job already running, first kill it with the –K option.
Displaying Job Output
If a job has failed, it may be necessary to display the output messages of the backup
command to determine the ca use. To d o so, spec ify t he –S option. The progress indicator
(indicating the percentag e of b ackup dat a written t o the me dia), out put and error m essag es of
the backup command will be displayed to standard output.
If this option produces no outp ut, then the backup comm and had n ot yet start ed. If the job had
failed, it is due to a pre-backup error such as a tape over write pr otectio n error, or becaus e a
device or server was unavailable. In these cases, the message indicating the problem was
sent using the notification process d efined in th e preferences o ptions.
Storix System Backup Administrator - 43 - Versi on 8.2 Comma nds Ref erence
stremovelabel
Purpose:
Remove a backup label. Also removes the associ ated backup if written to disk.
Use On:
Administrator
Syntax:
stremovelabe l [-f] backupid
Options:
Details:
-f, --force
The stremovelabel comm and prov ides a way t o remove a back up label, and associat ed disk
backup images from the command line or from a script. If you have a routine that watches for
errors in backup status reporting, th e routin e can aut omaticall y expire the backup label
associated with the backup to allo w other backups t o be written over the sam e tape or
directory device.
Important note
restore, or install a client from this backup. If a backup has been expire d or the label histor y
has been inadvertently removed from the system, it is still possible to rebuild this information.
Refer to Rebuild (unexpire) a Backup Label from Tape in the SBAdmin User Guide for
details.
If the backup label to remove is of a backup written t o a direct ory/d isk 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.
: Once a backup label has been expired, it will not be possible to verify,
Storix System Backup Administrator - 44 - Versi on 8.2 Comma nds Ref erence
streport
Purpose:
Use on:
Syntax:
Types:
Generate various reports
Network Edition, TSM Editi on, or Wo rkstati on Edit ion Ad ministrato r
streport -t type [options]
-t netinst
-t expiration
-t history
-t restore
Network Install Clients Report Options:
-s server Show clients configured for boot on server
-n name Show clients configured fo r boot usin g boot image name
-e
Backup Expiration Report Options:
-E opt Expiration report option (all, current, specify)
-D date Expiration date (MM/DD/YY) (with –E specify)
-T
Generate network install clients repo rt
Generate backup expiration report
Generate backup history report
Generate restore history r eport
Show currently enabled clients only
Show tape labels
Backup History Report Options:
-h type Base history on type (client or job)
-k “opt1 opt2” History of specific optio ns (jobid or clientname)
-b
-f date
-l date
Storix System Backup Administrator - 45 - Versi on 8.2 Comma nds Ref erence
Include subtotals
History start date (MM/DD/YY)
History end date (MM/DD/YY)
Restore History Report Options:
-h type Base history on type (job or backupid)
-k “opt1 opt2” History of specific options (jobid or backupid)
-g
-f date
-l date
Update history from server rest ore lo gs
History start date (MM/DD/YY)
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 - Versi on 8.2 Comma nds Ref erence
strestore
Purpose:
List, verify or restore backup data from a local or r emote device
Use on:
Network or TSM Edition Clie nt or Workst ati on Editi on Ad ministrator
Syntax:
strestore <operation> [options] -d {device {–L backupid}} {-t datatype} datalist …
Operations:
Options:
-l, --list
-r, --restore
-v, - - ve r i f y
-d, --device device
-D, --dest destinat ion
-f, --showfiles
-L, --label backupid
-O --owner owner
-p, --positioned
-s, --server server
-S, --seq “seqlist”
List contents (of specified backup t ype)
Restore backup data (d efault )
Verify backup data (read only)
Device containing backup data to read. If reading from a TSM
server, specify “-d API” (see –s server).
Directory or raw device into which data should be restored.
Show filelist during verify or restore
The Backup ID of disk backup
Original TSM client (owner) of the b ackup to r ead
Indicates tape drive is at desired position
Server on which the backup device i s attached. If not use d, a
local device is assumed. This option is used only on clients in a
Network or TSM Edition environm ent. Whe n restor ing fro m a
TSM server, specify the server as “TSM@server Name”.
If verifying, you may s pec ify a l ist of b ackup sequence numbers
to verify. If restoring, you ma y spec ify o nly o ne. The d efault is
sequence number 1 if this flag is omitted.
-t, --type datat ype
datalist …
Storix System Backup Administrator - 47 - Versi on 8.2 Comma nds Ref erence
Specify the type of data to list, verify, or restore
Indicates one or more data elements of the specified datatype to
be verified or restored. You may specify “all” to indicate all data
of the corresponding datatype is to be restored.
Details:
The strestore command is used to list, verify or restore data from any SBAdmin backup.
When restoring data, the data will be restor ed to the s ystem fr om which the comma nd 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.
The type of data to list must be one of the following:
Type Description
B S ystem conf igurati on tab le
C System configuratio n files
E Enc ryption key ID
f Backup disk files (volum es)
H Header information
r Image/filelist
T Table of contents
The type of data to verify or resto re must be one of the following:
Type Description Systems Data to Specify
V Volume Group Linux/AIX Volume Group name(s)
F Filesystem any Filesystem mount point(s) (i.e. “/home /data”)
L Logical volume Linux/AIX Logical volume name(s) (i.e. “lv00 lv01”)
M Meta-disk Linux/Solaris Meta-disk names (i.e. “md0 md1”)
D File/Directory any Directory names (i.e. “/home/sam ..”)
P Partition Linux Raw partition names (i.e. “sda3 sdb5”)
Z ZFS Pool Solaris ZFS Pool name (i.e. “pool1”)
z ZFS Volume Solaris ZFS Volume name (i.e. “pool1/vol1”)
s Slice Solaris Disk slice name (i.e. “c0t0d0s1”)
You must specify the dat a lis t as sh own abov e which c orres ponds to t he dat atype yo u are
verifying or restoring. An y eleme nts of the d atalist that are mult iple words must be surro unded
by double quotes (i.e.
strestore –d st0 –tD /shared “/root/User Docs” /mail ).
Note:
Volume Group and Logical v olume rest ores are onl y availa ble on Linux s ystems if LVM
(Logical Volume Manager) is installed. Meta-disk restores are only available on Linux if metadisk (Software RAID) support is installed.
You may also specify a backup sequence number with the –S flag if there is more than one
backup stacked on the medi a. If the b ackup was created using a backup job which contain ed
multiple clients, each client backup will be a separate backup sequence number. If you
performed multiple backups to the same media without rewinding, then each new backup will
comprise a new backup sequence number. The data will be read from the backup
corresponding to the specified backup sequence number.
If the tape is already positioned to the start of the backup sequence number you wish to read,
you may also specify the –p flag in place of the –S flag to indicate that you wish to read from
the backup at the current tape position.
You may specify a device using th e –d fla g (i.e. “r mt0”). If you are r estor ing from a disk im age
backup, you must specify t he di rector y devi ce in which the backup was writte n as wel l as th e –
Storix System Backup Administrator - 48 - Versi on 8.2 Comma nds Ref erence
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 d ata to a different destinat ion than it was originally read from, specify
the –D flag followed by the dest ination. T he de stinatio n must b e appro priate t he the d atatype
being restored. For example, logical volume data must be restored to a logical volume, and a
directory name should be specified f or filesystem/d irector y data restore s. 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. For instance, the /home/roger directory, when restored
to the /tmp directory, will be restored as /tmp/home/roger. This prevents files by the same
name, but in different directories, from being restored over one another.
When restoring only a single filesystem
to a new destination, the files will be restored relative
to the original filesystem mount point. In this case, a file “/home/file1” in the /home f ilesyst em,
when restored to the /home1 directory (or filesystem), will be restored as /home1/file1. This
allows filesystem data to be move d from on e filesystem t o anot her.
The strestore command will exit with a completion message and one of the following exit
codes:
0 Successful
1 Error reading or writing backup data
2 Error occurred prior to reading or writing data
3 Completed with warnings – one or more files may not have been restored
9 Internal program error
99 Killed by user (Ctrl-C)
Storix System Backup Administrator - 49 - Versi on 8.2 Comma nds Ref erence
struncopy
Purpose:
Copy backups between servers or devices
Use on:
Administrator
Syntax:
struncopy [options] {-d source Device} {-D destination Device}
Options:
-b, --bufsize bufsize
-d, --source device
-D, --destination
device
-e, --ejectsrc
-E, --ejectdest
-h, --hostperm
hostperm
-l, --sourceid backup
ID
-n, --startseq
startingSeqnum
-N, --endseq
endingSeqnum
Buffer size to use for new backup. Default is to keep same buffer
size of original backup.
Source device containing backup to copy. If source is a TSM
server, specify “-d API” (see –s server).
Destination device to write new backup to. If destination is a
TSM server, specify “-d API” (see –S server).
Eject tape from the source device when copy is complete
Eject tape from the destination device when copy is complete
If writing to a disk file, indicates host r ead permiss ion (a=any
host, h=original host only). Default is “a” if copying from tape,
and defaults to the original host permission setting if copying
from disk to disk.
Backup ID to read if copying from a disk backup
Beginning backup sequence number to copy from source if there
are multiple backups on the media.
Ending backup sequence number to copy from source if there
are multiple backups on the media.
-r, --rewindsrc
-R, --rewinddest
-s, --sourceserver
sourceServer
-S, --destinationserver
destinationServer
Storix System Backup Administrator - 50 - Versi on 8.2 Comma nds Ref erence
Rewind the input tape device before st arti ng the co py
Rewind the output tape device before starting the copy
Server name where the source in put device or dir ectory i s
located. If reading from a TSM serv er, use t he format
“TSM@serverName”.
Server name where the destination output device or directory is
located. If writing to a TSM server, use the format
“TSM@serverName”.
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 an other S BAdmi n server. L ike wise, local or remot e
backups to SBAdmin servers may be copied to a TSM server or backups may be copied from
one TSM server to another.
When copying a disk backup , you m ust spe cify t he devi ce where t he ba ckup is st ored wit h the
–d option (use “–d API –s TSM@serverName” for TSM servers), and the backup id with the –I
backupid option. When a new backup is created (either by writing to the beginning of a tape or
writing a backup to disk), a new backup ID is generated automatically. If a backup is appended
to an existing tape backup, this backup will be appended to the same label, and therefore will
use the same backup ID as the previous backups on the tape.
By default, all backups will be copied from the source media to the destination media. This
includes all clients (if backup was made from using Network or TSM Edition and incl uded
multiple clients), or multiple jobs (if multiple jobs were appended to the source tape media).
Every Backup Label contains at least one backup sequence number, starting with 1 and
ending with the last backup written (one for each client backup appended to the same
label/media). To determine the backup sequence numbers within a backup label, use the
command:
stprintlabel –b backupID
If copying to a tape device, yo u may in dicat e if you want to rewind before starting the backup
and if the tape should be rewound and ejected at the end of the backup. If you do not
rewind
at the start of the backup, you may append the source backup to the end of the destination
media (if the destination me dia is currentl y at t he of vol ume). Th e destin ation backup label
will be appended with the selected source backup. This is commonly referred to as stacking
backups to tape.
You may alter the buffer size of the backup by entering a buffer size (in Kbytes) using t he –b
bufsize option. This is quite useful in increasing the performance of backups when writing to
different media. For example, the default 64K buffer size may be adequate when you wrote
your original disk backup file, but when copying to a high-speed tape drive, a higher buffer size
(i.e. 256K) may provide m uch gr eater b acku p performa nce. To u se the same buffe r size f or the
destination as was used for the source; do not specify a new buffer size.
If using Network or TSM Edition, and the destin ation backu p is written t o a dir ector y devic e or
TSM server, you may also change whethe r only the origi nal client host or an y host may read
the backup data by using the –h hostperm option. When copying from tape to disk, the default
is to allow all hosts (-h a) to read the backup. If cop ying from disk to disk, the default is to
leave the original setting unchanged. To allow only the original host which wrote the backup to
read it, use –h h.
You may use a device configured as a random tape library for the output
device. This is because the comman d is onl y able to tr ack the t ape posit ions of one
input
device, but not the
library at a time. Therefore, if you need to co py from a random libr ary, you will n eed to spec ify
only the tape device name as the input device. You will be prompted to change the volumes
manually on the source device, but the destination device, if a random library, will change
tapes automatically. Note that devices c onfigur ed as s equenti al autolo aders may be used for
either source or destination devic es.
Storix System Backup Administrator - 51 - Versi on 8.2 Comma nds Ref erence
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 err or messages, and b ackup label inf ormation will be saved
for future viewing using t he View Backup Labels from the SBAdm in GUI or Web I nterfac e. The
command output and error messages will also be sent to standard output and standard error,
shown on the screen by default. If you wish to save this output to a file, you may type the
command as follows:
strunjob JobID > filename 2>&1
The strunjob command will continue running until all clients in the job have been backed up or
until an error causes the command to terminate. T he command will exit with one of the
following return codes, indicating the status of t he job:
0 Job c ompleted suc cessfull y
1 Job term inated beca use a client b ackup failed. Sinc e partial d ata has been writt en to the
media, no additional client backups have been started. Failure of a client backup may
be due to a media write error or a network failure.
2 Job t erminat ed du e to an error th at occur red while savi ng the backup c ommand o utput,
status information, or label information.
3 Job terminat ed due to an error in pre-pr ocess ing tasks. This might include such things
as a backup device already in use or the backup server or network unavailable.
4 T he client b ackups comp leted, but a post-proc essing error occu rred. Thi s might incl ude
the inability to update the backup labe l or history inform ation after the back up
completes, or an error ejecting th e tape f rom the dri ve when th e job re quires t he tape to
be ejected when complete.
5 Client b ackups compl eted but a minor error occ urred in post- processi ng. Should not
affect the backup history or label, nor should it affect other jobs appended to the same
media.
6 The job completed successfully, but one or more clients in the job were not included in
the backup. The reason may be because the client or network was unavailable or
because the client could not reach the server over the network. This error will also occur
Storix System Backup Administrator - 52 - Versi on 8.2 Comma nds Ref erence
if a pre- backup program was set t o run on th e client an d faile d.
7 Job t erminat ed without writ ing an y data to th e server becaus e the b ackup me dia was
either write-protected, or cont ained a pri or backup lab el that could not be over written
due to the tape overwrite/ rete ntion poli cy setti ng.
8 War ning on ly. All cli ent back ups fai led with n on-fatal e rrors
99 The command terminated because the process was killed (SIGINT or Control-C)
When running the strunjob command at the command line, the status mes sage of th e jobs will
not be reported using the backup status reporting method defined in the S BAdmin
Preferences. The only exception is when previous backup labels are expired based on the
backup overwrite/retent ion pol icy def ined.
Storix System Backup Administrator - 53 - Versi on 8.2 Comma nds Ref erence
strunrest
Purpose:
Use on:
Administrator
Syntax:
Operations:
Verify or restore data from any server to any client
strunrest <operation> [options] –f {device {–l backupid}} {-t datatype}
Options:
-v, - - ve r i f y
-c, --client
client
-d, --datalist
“datalist”
-D, -destination
destination
-f, --device
device
-l, --backupid
backupid
-p, --curseq
curSeqnum
-P, -showprogress
Indicates verify is to be performed. If omitted, a restore is performed
Client to restore the data to. Only used if restori ng data.
If datatype is specified, you should also specify the list of data to verify
or restore of the specified datatype. If this argument is omitted, then all
data of the specified dat atyp e will be verified or restored.
Destination raw device or director y to restore data.
Tape or directory device on the server (i.e. “rmt0”). If r estoring fr om a
directory device, you must also supply the –l backupid option. If backup
is to a TSM server, indicate –f API (see –s server).
The Backup ID of the backup to restore if rest oring fr om a dis k back up.
Not used if restoring from tape device.
If the tape is already positioned at the beginning of a specific backup,
you may specif y the current sequence number of that backup to
prevent rewinding and re- for warding of th e tape.
Indicates the progress indicator should be shown, displaying the
progress of the verify or re store. T he pro gress in dicator is sent to
standard error.
-s, --server
server
-S, --seq
“seqlist”
Storix System Backup Administrator - 54 - Versi on 8.2 Comma nds Ref erence
Server on which the backup devi ce is c onfigur ed. If usi ng a T SM
server, use the format “TSM@serverName ”.
If verifying from tape device, you may specify a list of backup sequence
numbers to verify. If restoring, you may specify only one. The default is
sequence number 1 if this flag is omitted. Display the backup label for a
list of backup sequence numbers on the tape.
Details:
-t, --type
datatype
Specify the type of data to rest ore from t he back up. If omitt ed, the
entire contents of the backup will be rest ored.
The strunrest comma nd may be used to eith er verify or restor e the contents of a bac kup. 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 are restoring from a disk backup, and the b ackup was creat ed with read permi ssion only
by the original client from which the backup was made, only the original client may be restored
to. This is to prevent the backup f ile from b eing re ad by oth er hosts. Howev er, if yo u wish to
change the permission of th e backup f ile t o allo w it to be rest ored t o a differ ent host, use t he
option Change Read Permission of a Disk Backup as described in the SBAdmin User Guide.
Note that the datatype and datalist arguments must correspond. For instance, if you select to
restore a filesystem (-t F), then you must sup ply a list of files ystems t o restor e (“/home /tmp”)
as they are defined on the backup. If any of the files ystems suppl ied do not exist on the
backup, no restore will take place. Note also that you must surround multiple restore options
with double quotes. The different datatyp es are as follo ws:
Type Description Systems Data to Specify
V Volume Group Linux/AIX Volume Group name(s)
F Filesystem any Filesystem mount point(s) (i.e. “/home /data”)
L Logical volume Linux/AIX Logical volume name(s) (i.e. “lv00 lv01”)
M Meta-disk Linux/Solaris Meta-disk names (i.e. “md0 md1”)
D File/Directory any Directory names (i.e. “/home/sam ..”)
P Partition Linux Raw partition names (i.e. “sda3 sdb5”)
Z ZFS Pool Solaris ZFS Pool name (i.e. “pool1”)
z ZFS Volume Solaris ZFS Volume name (i.e. “pool1/vol1”)
s Slice Solaris Disk slice name (i.e. “c0t0d0s1”)
You may also specify a sequence list (seqlist) using the –S flag if there is more than one
backup stacked on the medi a. If the b ackup was created using a backup job which contain ed
multiple clients, each client backup will be a separate backup sequence number. If you
performed multiple backup s to the same m edia without r ewindi ng, then e ach ne w backup will
comprise a new backup sequence number. When verifying backups, you may specify one or
more sequence numbers, surrounded by double-quotes. When restoring data, you may specify
only one backup sequence number. The data will be read from the backup, or backups,
corresponding to the specified backup sequence number list.
Important note: If you are restoring a volume group or filesystem from an increme ntal
backup
level 0 and you do not specify a datalist to rest ore, then all fil es will b e restor ed. If the
incremental level is 0, all fil es curr ently in t he corr espond ing file systems will be r emove d
before the restore takes place. T his is t o ensure t hat the filesyst em, when c omplete d, will
contain ONLY the files that existed when the backup was created. If you do not want to
remove existing files before r estor ing, the n you s hould not restor e a f ilesyste m or volu me
group. Instead, select “directory” as the data type (-t D), then specify the list of direct ories t o
restore.
If you supply both the –L and –P flags, you should redirect either standard output or standard
error to a file. Otherwise, both will be sh own on t he scree n and t he progres s indic ator data will
be intermixed with the file list.
Storix System Backup Administrator - 55 - Versi on 8.2 Comma nds Ref erence
If you want to restore the d ata to a different destinat ion than it was originally read from, specify
the –D flag followed by the destin ation. T he de stinatio n must b e a logica l volume name ( i.e.
“lv00”) for logical volume restores, or a di rectory name for all other resto res. For all restor es,
except when restoring single filesystems, the data will be restored to the new directory relative
to the original full pathname of the files. For instance, the /home/roger directory, when restored
to the /tmp directory, will be restored as /tmp/home/roger. This prevents files by the same
name, but in different directories, from being restored over one another.
When restoring only a single filesystem
to a new destination, the files will be restored relative
to the original filesystem mount point. In this case, a file “/home/file1” in the /home f ilesyst em,
when restored to the /home1 directory (or filesystem), will be restored as /home1/file1. This
allows filesystem data to be move d from on e filesystem t o anot her.
The strunrest command will exit with a completion message and one of the following exit
codes:
0 Success
1 Failed verifying or r estor ing data
9 Internal program error
99 Killed by user (Ctrl-C)
101 The strunrest command failed after verify/restore started
102 Syntax error calling the strunrest command
103 The strunrest command failed with an error prior to verify/restore starting
Storix System Backup Administrator - 56 - Versi on 8.2 Comma nds Ref erence
stserver
Purpose:
Use on:
Network and TSM Edition Administrator
Syntax:
Operations:
Add, change, list or remove SBAdmin server information. For TSM servers, refer to the
stconfigtsm command instead.
stserver <operation> [options] server {...}
Options:
-a, --add
-A, --check Show server availability (when –l is used)
-r, --remove
-l, --list
-B, --bootdir directory
-c, --adminlist “admins”
-C, --admin “hostname/IP”
-d, --defaultdevs
-D, --showdevs
-f, --force
-g, --grouplist “groups”
-n, --altnet “hostname/IP”
-O, --other-clients “clients”
Add or change the specified server
Remove the specified server
List configured servers
Directory for client CDROM ISO and network boot images
Admin systems which may backup t o this s erver
Controlling Admin with aut horit y over t his server
Create default backup directory devices when adding new
server
Include device list (with –v)
Force removal of server c onfigur ation
Groups which may backup to this server
Alternate networks to be used on this serv er
Optional clients with access to all groups
-v, --verbose
Details:
The stserver command is used to add, remove, change and list servers configured on the
Network and TSM Edition Administrator.
To list currently configured servers, use the –l option. By default, only server names are
shown. To show all of the attribut es of a s erver, use the –v flag also.
Storix System Backup Administrator - 57 - Versi on 8.2 Comma nds Ref erence
Show verbose listing of servers ( with –l flag)
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 serv er cannot
be contacted. Availabilit y is d etermined b y whether or n ot the adm inistrat or syst em can
communicate with the server. If not, you can use the stcheck command to help isol ate t he
problem.
If you want to configure a new server, use the –a option a nd specify t he server name at the
end of the command. All attributes will be set to their default values (or none) unless explicitly
set. After adding a server, list it with t he –vl options to display the full list of settings.
NOTE: Be careful to use quotes around any argument to fla gs which contai n multiple words.
Changing a server
If a server currently exists, you can change specific options by specifying only that option and
its new argument. For example, t o config ure th e alter nate network, us e the fol lowing
command:
stserver –an 192.168.1.1 buserver
or
stserver –a –altnet 192.168.1.1 buserver
When changing the configuration, or to remove any default options, you may enter “none” for
options which require an argument.
Removing a server
To remove a currently configured server, specify –r and the server name, such as:
stserver –r buserver
Note that you cannot remove a server if it is current ly assign ed to a backup job. Also, when
removing a server, all devices which may have been configured for th at server wil l also be
deleted.
Storix System Backup Administrator - 58 - Versi on 8.2 Comma nds Ref erence
stuser
Purpose:
Use on:
Administrator
Syntax:
Operations:
Add, change, list or remove SBAdmin users
stuser <operation> [options] {user}
Options:
Details:
-a, --add
-r, --remove
-l, --list
-g, --group “group”
-L, --level "level"
-p, --password newpass
-v, --verbose
-x, --colonformat
The stuser command is run on the Administrator to add, remove, or change role-based user
accounts. This only affects SBAdmin users a nd is not associate d with the system us ers.
Add or change user
Remove the specified user
List configured users
Set default group
Set user level (0-5)
Change password
Verbose output (when listing)
Colon-delimited output ( when list ing)
Storix System Backup Administrator - 59 - Versi on 8.2 Comma nds Ref erence
stvdev
Purpose:
Use on:
Network or Workstation Edit ion Admi nistrator
Syntax:
Operations:
Add, change, list or remove device definitions
stvdev <operation> [options] devicename {...}
Options:
-a, --add
-r, --remove
-l, --list
-d, --devices “devices”
-D, --desc "description"
-L, --library libname
-m, --maxvolsize size
-N, --nolib
-R, --randomlib
-S, --seqloader
-s, --server server
-t, --type type
-uy, --sysbu
Add or change the selected device
Remove the specified device
List configured devices
List of devices
Device description (or "default ")
Random library name
Maximum file size to use in MB (0=unlimited)
Device is not a library or autoloader (default)
Device is a random tape library
Device is a sequential autoloader
Server name on which device exists (if Network Edition)
Device type: S=sequential, P=parallel, M=multi-copy
Allow system backup to directory(s)
-un, --nosysbu
-oy, --otherbu
-on, --nootherbu
-T, --devtype type
-v, --verbose Show all configuration (for use wit h –l flag)
Storix System Backup Administrator - 60 - Versi on 8.2 Comma nds Ref erence
Do not allow System backups to directory(s)
Allow non-system backups to directory(s)
Do not allow non-system backups to directory(s)
Device type: (t=Tape, d=director y)
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 att ribut es of a d evice, 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. The “–t type” option must be specified when
adding a new tape device. The type ma y be one of the foll owing:
S (sequential) – tapes are written to sequentially (one drive at a time)
P (parallel) – tape s are writ ten to in para llel (d ata is st riped across dr ives)
C (multi-copy) – sam e data is written to a ll tapes c oncurr ently (m irrored )
A directory device ma y cont ain a singl e dir ector y, or d irector ies th at are m ounte d on mu ltiple
disks. The -uy and –oy flags may only be used with directory devices.
You should refer to the SBAdmin User Guide for complete details on the types of devices and
library options .
If the device you are configuring represents a random tape library, you must specify the “–
library libname” option. The libname is the name of a tape library previousl y def ined us ing the
SBAdmin interface.
Changing a device
If a device currently exists, you can change specific options by specifying only that option and
its new argument. For example, to change the list of tape devices contained in the device
named “vdev0”, use the following c ommand:
stvdev –a –Tt –tS –d “st0 st1” vdev0
NOTE: Be careful to use quotes around any argum ent to flags which cont ain multip le words.
When changing the configuration, or to remove any default options, you may enter “none” for
options which require an argument (i.e. “--desc none”).
Remo vi n g a d evice
To remove a currently configured device, specify –r and the vdev name name, such as:
stvdev –r vdev0
Note that you cannot remove a device name that is currently assigned to a backup job.
Storix System Backup Administrator - 61 - Versi on 8.2 Comma nds Ref erence
Loading...