The syntax of all Tivoli® Storage FlashCopy® Manager commands are listed.
See Password administration for more information about the fcmcli -f password command.
fcmcli command >>-fcmcli-- -f password-----------------------------------------> >--+------------------------------------------------------------------+->< +- -p--profile--+--------------------------+--+------------------+-+ | | .-,--------------------. | '-:master-password-' | | | V | | | | '---section--:--password-+-' | | .-,--------------------. | | V | | '- -b--password-file----section--:--password-+--master-password----'
See Management agent: acsd for more information about the acsd command.
acsd management agent >>-acsd--+-------------------+--+----------------+--------------> '- -p--acsd-profile-' '- -c--acsd-port-' >--+---------------------+--+--------------------+--+-----+-----> '- -r--acs-repository-' '- -d--acs-directory-' '- -t-' >--+--------------------+---------------------------------------> '- -b--password-file-' >--+----------------------------------------------------------------------------+->< '- -a--administration-assistant-server--+----------------------------------+-' '-:--administration-assistant-port-'
Syntax for obtaining version or help information:
acsd command help >>-acsd--+-----+--+-----+-------------------------------------->< '- -v-' '- -h-'
See Generic device agent: acsgen for more information about the acsgen command.
acsgen generic device agent >>-acsgen--+--------------+-------------------------------------> '- -p--profile-' >--+--------------------------------------+---------------------> '- -c--acsd-hostname--+--------------+-' '-:--acsd-port-' >--+---------------------------------+--------------------------> '- -s--device-class,device-classN-' >--+--------------------+--+---------------+--+-----+-----------> '- -l--acs-directory-' '- -H--hostname-' '- -D-' >--+-----+--+-----+-------------------------------------------->< '- -M-' '- -t-'
See Query managed capacity (fcmcli -f used_capacity) for more information about the fcmcli -f used_capacity command.
fcmcli -f used_capacity -p profile [-c]
See User interface for Oracle: acsora for more information about the acsora command.
acsora [-p profile] -f <function> [-B backupID] [-F] [-s <DEVICE_CLASS>]
where <function> is one of:
backup
restore
delete
inquire
inquire_detail
See Snapshot Object Manager for Oracle - acsutil for more information about the acsutil command.
acsutil [-p <profile>]
See BR*TOOLS - User interface for Oracle in an SAP environment for more information about the backint command.
backint [-p profile]
-f <function>
-t <backup_type>
[-F]
See Offload agent: tsm4acs for more information about the fcmcli command.
fcmcli command >>-fcmcli--+--------------+------function-clause----------------> '- -p--profile-' >--+---------------------------------------+--------------------> '- -c--acsd_hostname--+---------------+-' '- :--acsd_port-' >--+--------------------+--+-----+--+-----+--+-----+------------> '- -l--acs-directory-' '- -D-' '- -t-' '- -K-' >--+--------------------+--+--------------------+---------------> '- -d--database-name-' '- -i--instance-name-' >--+----------------+--+---------------------------+------------> '- -B--backup ID-' '- -P--partition_group_name-' >--+----------------------------+--+------------------------+-->< '- -N--partition_number_list-' '- -S--TSM_BACKUP=yes|no-'
The values for the function-clause parameter are described in the following sections.
In a DB2® environment, the installation of Tivoli Storage FlashCopy Manager enables the offload function that otherwise is not available.
The following functions are supported by the fcmcli command option -f 'function':
fcmcli command functions >>- -f tape_backup--+--------------------+----------------------> '- -d--database-name-' >--+--------------------+--+----------------------------+-------> '- -i--instance name-' '- -N--partition_number_list-' >--+-----+----------------------------------------------------->< '- -K-'
The functions mount, unmount, or tape_backup cannot run in parallel on the same backup server.
The function 'update_status' is supported by the fcmcli command:
function-clause: Update FlashCopy backup status >>- -f update_status---- -d--database-name----------------------> >---- -i--instance-name------ -B--backup ID---------------------> >---- -S--TSM_BACKUP=yes|no------------------------------------><
fcmcli command >>-fcmcli--+--------------+------function-clause----------------> '- -p--profile-' >--+---------------------------------------+--------------------> '- -c--acsd_hostname--+---------------+-' '- :--acsd_port-' >--+--------------------+--+-----+--+-----+--+-----+----------->< '- -l--acs-directory-' '- -t-' '- -v-' '- -h-'Where:
The return code of the fcmcli command is 0 if it finishes the request without an error or if there were no candidates for the request. Return code 1 indicates one or more minor issues occurred that are not critical but can be checked to prevent major issues later. Return code 2 indicates that an error occurred during the command execution.
The following functions are supported by the fcmcli command option -f function for a FlashCopy restore of DB2 with a partition group:
-f restore function-clause >>- -f restore-- -B--backup ID-- -P--partition_group_name-------> >---- -d--database-name----+--------------------+-------------->< '- -i--instance-name-'Where:
The following functions are supported by the fcmcli command option -f 'function' for FlashCopy inquire and delete of DB2 snapshots:
-f inquire and -f inquire_detail function-clauses >>---+- -f inquire--------+----+----------------+--+-----+------> '- -f inquire_detail-' '- -B--backup ID-' '- -F-' >--+--------------------+-------------------------------------->< '- -i--instance-name-'
The following functions are supported by the fcmcli command option -f 'function' for IBM® Tivoli Storage FlashCopy Manager for Custom Applications backups of custom applications:
fcmcli command functions >>- -f backup--+------------------+-----------------------------> '- -I--infile-name-' >--+------------------------+--+-------------------------+------> '- -E--pre-flash-command-' '- -Q--post-flash-command-' >--+-------------------+--------------------------------------->< '- -s--DEVICE_CLASS-'
The following functions are supported by the fcmcli command option -f 'function' for FlashCopy restores, inquire, and delete of custom applications:
fcmcli command functions >>--- -f restore----+------------------+--+----------------+--->< '- -I--infile-name-' '- -B--backup ID-'
fcmcli command functions >>---+- -f inquire--------+----+----------------+--+-----+----->< +- -f inquire_detail-+ '- -B--backup ID-' '- -F-' '- -f delete---------'
The following functions are supported by the fcmcli command option -f function for FlashCopy backups of DB2 HADR databases:
fcmcli command functions >>- -f backup_db2standby--+------------------------+------------> '- -E--pre-flash-command-' >--+-------------------------+--------------------------------->< '- -Q--post-flash-command-'Where:
The -f backup_db2standby function operates like the fcmcli -f backup function. However, instead of requesting the user to specify a list of files for backup, this command retrieves this information from the active DB2 instance. It is important that the names of the files and file systems from the active DB2 database (HADR primary) match the names of files and file systems of the standby server (HADR secondary). The editable sample preflash and postflash command files assist you to shut down and restart the DB2 standby server (HADR secondary). This action creates a consistent backup image.
The following figure illustrates the workflow that is executed from this command.
The following functions are supported by the fcmcli command option -f function for FlashCopy restore, inquire, and delete of DB2 HADR databases:
fcmcli command >>---+- -f restore_db2standby-----------------+---------------->< +- -f inquire_db2standby--+-----+--------+ | '- -F-' | +- -f inquire_detail_db2standby--+-----+-+ | '- -F-' | '- -f delete_db2standby--+-----+---------' '- -F-'
The following functions are supported by the fcmcli command option -f 'function' for FlashCopy cloning operations:
>>---+- -f create_clone--+-----+---------+----------------------> | '- -F-' | +- -f refresh_clone--+-----+--------+ | '- -F-' | +- -f preproc_clone-----------------+ +- -f postproc_clone----------------+ +- -f inquire_clone--+-----+--------+ | '- -F-' | +- -f inquire_detail_clone--+-----+-+ | '- -F-' | '- -f delete_clone--+-----+---------' '- -F-' >---- -C--clone-database-name------ -u--clone-database-user-----> >--+-------------------------------+--+---------------+---------> '- -d--production-database-name-' '- -B--clone ID-' >--+-------------------------------------------+----------------> '- -X--preprocessing-configuration-filename-' >--+--------------------------------------------+-------------->< '- -Y--postprocessing-configuration-filename-'