Satellite Administration |
 Sun xVM Ops Center 1.1 Home Man Pages |
Name
satadm - Manipulate satellite services
Synopsis
Solaris OS
/opt/SUNWxvmoc/bin/satadm -V
/opt/SUNWxvmoc/bin/satadm [ -h | --help ]
/opt/SUNWxvmoc/bin/satadm subcommand [ options ]
RHEL 5.0 Linux OS
/opt/sun/xvmoc/bin/satadm -V
/opt/sun/xvmoc/bin/satadm [ -h | --help ]
/opt/sun/xvmoc/bin/satadm subcommand [ options ]
Description
The satadm command helps to start, stop, configure and unconfigure the xVM Ops Center satellite services.
Options
The following common option are supported:
-h | --help: Displays the usage svnopsis for satadm.
-V | --version: Displays the version of Sun xVM Ops Center.
Subcommands
The subcommands of satadm are as follows:
start
Starts the satellite services running on the host.
stop
Stops the satellite services running on the host.
status
Displays the status of the satellite services. Displays either online or offline to the standard output and sets the exit status to reflect the satellite service state.
configure
Performs configuration tasks for the satellite services. Registers the satellite with the Sun hosted server.
unconfigure
Performs the inverse operation of configuring the satellite. De-registers the satellite from the Sun hosted server.
register-gear
Registers all discovered gear with all appropriate modules.
backup
Creates a backup archive of the state data of the satellite. This command does not back up any installed software. Any running satellite services are stopped before performing the backup, and resumed after the backup.
restore
Restores the state data from a backup archive to a newly installed satellite host. The restoration of a satellite from the backup data is a two step process. The host should not be installed with no xVM Ops Center satellite software. This host should have the same hostname as the original satellite. Install the Sun xVM Ops Center software on the host, but do not perform the post-install configuration. Execute this restore subcommand to restore the state data on the satellite host. After the successful completion of this command, the satellite will be in the same operational state that existed at the time of the backup.
The satellite should not be unconfigured prior to attempting a restore operation. If the registration of the satellite to the Sun hosted server is invalidated with the satadm unconfigure command, then any backup archives created during the time the satellite was registered become unusable. The satellite will no longer be able to communicate with the Sun Hosted server, and the asset data shared between the satellite and the hosted servers will lose their synchronization.
Subcommand options
Common options for all subcommands:
-h | --help: Displays the usage synopsis for the subcommand.
-v | --verbose: Displays verbose error and informational messages.
-l | --logfile <logfile>: Captures any output from satadm in the <logfile>.
start
/opt/SUNWxvmoc/bin/satadm start [ -h | --help ] [ -v | --verbose ] [ -w | --wait ] [ -l | --logfile <logfile> ]
-w | --wait: satadm does not exit until all services have been started.
stop
/opt/SUNWxvmoc/bin/satadm stop [ -h | --help ] [ -v | --verbose ] [ -w | --wait ] [ -l | --logfile <logfile> ]
-w | --wait: satadm does not exit until all services have been stopped.
status
/opt/SUNWxvmoc/bin/satadm status [ -h | --help ]
configure
/opt/SUNWxvmoc/bin/satadm configure [ -h | --help ] [ -f | --config <config-file> ] [ -v | --verbose ] [ -l | --logfile <logfile> ]
-f | --config <config-file>: Uses the contents of <config-file> to register the satellite with the Sun hosted server.
 | Be Careful Ensure that the file permission for the configuration file properties is set to 400 as it contains the Sun Online Account (SOA) username and password. It should not be accessible to unauthorized users. |
unconfigure
/opt/SUNWxvmoc/bin/satadm unconfigure [ -h | --help ] [ -v | --verbose ] [ -l | --logfile <logfile> ]
register-gear
/opt/SUNWxvmoc/bin/satadm register-gear [ -h | --help ] [ -v | --verbose ] [ -l | --logfile <logfile> ]
backup
/opt/SUNWxvmoc/bin/satadm backup [ -o | --output <backup-file> } [ -t | --tag <tag> ] [ -d | --description <description> ] [ -c | --configdir <config-dir> ] [ -T | --tempdir <temp-dir> ] [ -h | --help ] [ -v | --verbose ] [ -l | --logfile <logfile> ]
-o | --output <backup-file>: Stores the backup archive in tar format in <backup-file>.
-t | --tag <tag>: Stores the string <tag> as a property of the backup archive which will be displayed by restore operation when referencing the <backup-file>.
-d | --description <description>: Stores the string <description> as a descriptive property of the backup archive (the description is informational and it is displayed during restore operation).
-c | --configdir <config-dir>:<config-dir> is an alternative collection of backup modules when performing the backup. satadm backup is modular in design and executes a set of backup tasks in the configuration directory. This option provides a means to use an alternate set of modules to produce a backup archive in a specialized way.
-T | --tempdir <temp-dir>: Uses <temp-dir> instead of the temporary directory in /var/tmpfor intermediate storage needs during the backup. This temporary directory is required to hold a large quantity of data during the backup operation.
restore
/opt/SUNWxvmoc/bin/satadm restore [ -i | --input <backup-file> ] [ -c | --configdir <config-dir> ] [ -T | --tempdir <temp-dir> ] [ -h | --help ] [ -v | --verbose ] [ -l | --logfile <logfile> ]
-i | --input <backup-file>: Restores state data from <backup-file> which is the archive created by satadm backup operation.
-c | --configdir <config-dir>: <config-dir> is an alternative collection of restore modules when performing the backup. satadm restore is modular in design and executes a set of restore tasks in the configuration directory. This option provides a means to use an alternate set of modules to restore a backup archive in a specialized way.
-T | --tempdir <temp-dir>: Uses <temp-dir> instead of the temporary directory in /var/tmp for intermediate storage needs during the restore. This temporary directory is required to hold a large quantity of data during the restore operation.
Exit status
The exit status displays the status of the satellite services. It currently displays either offline or online to the standard output. The exit status displays the following code for different status:
Exit Code Status
0 Online
2 Offline (only for status subcommand)
1 Error occurred during processing