ssobackup
- Organization of this page
Format
- To back up files or databases provided by SSO:
ssobackup {-all | -conf | -db} [-d backup-destination-directory]- To output the command usage:
ssobackup -h
Function
The ssobackup command backs up SSO files and databases. For details about the backup function, see 2.7.1 Backup function.
While the ssobackup command is being executed, if a daemon process related to the backup target is running, the command interrupts the daemon process. This operation prevents the daemon process from writing to the backup target during backup and secures the integrity of the backup data. The interrupted daemon process automatically resumes after the backup is completed.
The ssobackup command backs up files first and databases second. The command can also back up either files or databases. For details about backup targets, see 2.7.3 Backup targets and restore targets.
If backup data already exists in the backup destination, the command deletes the backup data and then performs the backup.
If you attempt to execute the ssobackup command while any of the commands or operations listed below are being executed, or while the status of the daemon process is being changed, the command or operation terminates abnormally. Likewise, if you execute the following commands or operations during execution of the ssobackup command, the commands or operations terminate abnormally:
ssostart, ssostop, ssobackup, ssorestore, ssodbdel, ssoauth, ssonnmsetup, startup of SSO services, stopping of SSO services, and deletion of databases from the GUI
Options
-all
Specify this option when you back up both files and databases.
-conf
Specify this option when you back up only files.
-db
Specify this option when you back up only databases.
-d backup-destination-directory
Specifies the backup destination directory. You can specify a directory name by using either an absolute path or a relative path. If the directory specified for this option does not exist, the command terminates abnormally.
If you do not specify this option, the directory to store backup data is set to $SSO_BACKUP.
If you specify this option, a ssobackup directory is created in the specified directory, and backup data is stored in the created directory.
You can specify a directory on the local disk or a shared disk connected to the network as the backup-destination directory. Note that if you specify a directory in a shared disk on the network, the backup time depends on the network performance.
-h
Outputs the command usage. This option cannot be specified together with other options.
Return values
|
0 |
Normal termination. |
|
-1 |
Execution error such as incorrect arguments |
|
-2 |
Execution error occurred during processing of startup or stop, editing of an SSO authentication user, deletion of databases, editing of the NNM information definition file, backup and restore processing, or daemon process status transition. |
Notes
The following provides notes on backup operations.
- About disk capacity:
-
The ssobackup command checks the amount of data in the backup target and the free space of the backup-destination disk before performing a backup. If the free space of the backup-destination disk is less than the amount of data in the backup target, the backup terminates abnormally. Also, if the free space of the disk becomes insufficient during backup after it is checked, the backup terminates abnormally.
Therefore, when you perform a backup, make sure that the capacity of the backup-destination disk is more than the total of the amount (size on a disk) of each backup-target directory.
To avoid an error termination due to insufficient disk space, provide space for the backup-destination disk, or change the backup-destination to a disk with enough free space and perform the backup again.
- About daemon processes and operations:
-
When you perform a backup, pay attention to the following notes on SSO daemon processes and operations. However, if you forcibly terminate a backup in progress, the following notes do not apply.
- Before backup:
-
You must close windows before backup. If you execute a daemon process from a window during backup without closing the window, no response is returned until the backup is completed.
- During backup:
-
-
During backup, all functions provided from daemon processes to be interrupted are interrupted. Interrupted functions automatically resume when the backup is completed. However, during backup of databases, the monitoring function for processes and services is not interrupted.
-
You cannot start and stop SSO during backup.
-
You cannot execute a restore during backup.
-
You cannot delete a collection database during backup.
-
You cannot concurrently perform multiple backups.
-
If you execute the following commands or connect to SSO from the SSO console during a backup, no response is returned until the backup is completed.
ssoapcom, ssocollectd, ssocolmng, ssocolset, ssocolshow, ssocolstart, ssocolstop, ssodbcheck, ssodemandrpt, ssoextractlog, ssopsset, ssopsshow, ssopsstart, ssopsstop, ssorptd
-
- Forced termination:
-
If you forcibly terminate a backup in progress, the state of the daemon process might be different before and after the backup. In such a case, use the following procedure to restore the previous state:
-
Execute the command for obtaining the state of daemon processes (ssostatus) to check the state of all daemon processes.
-
If daemon processes in PAUSING status are included in the checked daemon processes, execute the command for stopping daemon processes (ssostop) to stop all the daemon processes that are in PAUSING status. If daemon processes in PAUSING* status are included, wait until the status changes to PAUSING, and if daemon processes in RUNNING* status are included, wait until the status changes to RUNNING.
-
Execute the command for starting daemon processes (ssostart) to start the stopped daemon processes.
-
- User authentication function:
-
You cannot add and delete a user for SSO authentication during backup.