The following man pages are described in this appendix.
satadm
proxyadm
agentadm
satadm – Manipulate Enterprise Controller services
Oracle Solaris OS
/opt/SUNWxvmoc/bin/satadm -V /opt/SUNWxvmoc/bin/satadm [ -h | --help ] /opt/SUNWxvmoc/bin/satadm subcommand [ options ]
Linux OS
/opt/sun/xvmoc/bin/satadm -V /opt/sun/xvmoc/bin/satadm [ -h | --help ] /opt/sun/xvmoc/bin/satadm subcommand [ options ]
The satadm command helps to start, stop, configure and unconfigure the Enterprise Manager Ops Center Enterprise Controller services.
The following common option are supported:
-h| --help: Displays the usage synopsis for satadm.
-V| --version: Displays the version of Enterprise Manager Ops Center.
The subcommands of satadm are as follows:
Starts the Enterprise Controller services running on the host.
Stops the Enterprise Controller services running on the host.
Displays the status of the Enterprise Controller services. Displays either online or offline to the standard output and sets the exit status to reflect the Enterprise Controller service state.
Performs configuration tasks for the Enterprise Controller services. Registers the Enterprise Controller with My Oracle Support.
Performs the inverse operation of configuring the Enterprise Controller. De-registers the Enterprise Controller.
Manages the discovered asset.
Creates a backup archive of the state data of the Enterprise Controller. This command does not back up any installed software. Any running services are stopped before performing the backup, and resumed after the backup.
Restores the state data from a backup archive to a newly installed Enterprise Controller host. The restoration of an Enterprise Controller from the backup data is a two step process. If the same system is being restored as the Enterprise Controller, uninstall the current Enterprise Controller. If a new system is being used, it must have the same hostname as the original Enterprise Controller. Install the Enterprise Manager 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 Enterprise Controller. After the successful completion of this command, the Enterprise Controller will be in the same operational state that existed at the time of the backup.
The Enterprise Controller should not be unconfigured prior to attempting a restore operation. If the registration of the Enterprise Controller to My Oracle Support is invalidated with the satadm unconfigure command, then any backup archives created during the time the Enterprise Controller was registered become unusable. The Enterprise Controller will no longer be able to communicate with My Oracle Support, and the asset data shared between the Enterprise Controller and the hosted servers will lose their synchronization.
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>.
/opt/SUNWxvmoc/bin/satadm start [ -h | --help ] [ -v | --verbose ] [ -t | --temporary ] [ -w | --wait ] [ -l | --logfile<logfile>]
-w| --wait: satadm does not exit until all services have been started.
-t| --temporary: The state change is made temporary until next reboot.
/opt/SUNWxvmoc/bin/satadm stop [ -h | --help ] [ -v | --verbose ] [ -t | --temporary ] [ -w | --wait ] [ -l | --logfile<logfile>]
-w| --wait: satadm does not exit until all services have been stopped.
-t| --temporary: The state change is made temporary until next reboot.
/opt/SUNWxvmoc/bin/satadm status [ -h | --help ]
/opt/SUNWxvmoc/bin/satadm configure [ -h | --help ] [ -f | --config<config-file>] [ -p | --proxy ] [ -P | --noproxy ] [ -v | --verbose ] [ -l | --logfile<logfile>]
-f| --config<config-file>: Uses the contents of <config-file> to register the satellite with My Oracle Support.
Note - Ensure that the file permission for the configuration file properties is set to 400 as it contains the Online Account username and password. It should not be accessible to unauthorized users.
-p| --proxy: By default, enables the local control proxy after the Enterprise Controller is configured.
-P| --noproxy: The local control proxy is not enabled.
/opt/SUNWxvmoc/bin/satadm unconfigure [ -h | --help ] [ -v | --verbose ] [ -l | --logfile<logfile>]
/opt/SUNWxvmoc/bin/satadm manage-gear [ -u | --user<username>] [ -p | --password<passwordfile>] [ -t | --type<asset-type>] [ -f | --forceos ] [ -h | --help ] [ -v | --verbose ] [ -l | --logfile<logfile>]
-u | --user<username>: The username of the Enterprise Controller administrator.
-p | --password<passwordfile>: The location of the <passwordfile> on the Enterprise Controller.
-t | --type<asset-type>: The type of the asset that needs to be managed.
-f | --forceos : Bypasses the agent provisioning state and forces the OS to the managed state.
/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/tmp}}for intermediate storage needs during the backup. This temporary directory is required to hold a large quantity of data during the backup operation.
/opt/SUNWxvmoc/bin/satadm restore [ -i | --input<backup-file>] [ -c | --configdir<config-dir>] [ -d | --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.
-d | --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.
The exit status displays the status of the Enterprise Controller services. It currently displays either offline or online to the standard output. The exit status displays one of the following codes:
0 - Online
2 - Offline (only for status subcommand)
1 - Error occurred during processing
proxyadm – Manipulates Proxy Controller services
Oracle Solaris OS
/opt/SUNWxvmoc/bin/proxyadm -V /opt/SUNWxvmoc/bin/proxyadm [ -h | --help ] /opt/SUNWxvmoc/bin/proxyadm subcommand [ options ]
Linux OS
/opt/sun/xvmoc/bin/proxyadm -V /opt/sun/xvmoc/bin/proxyadm [ -h | --help ] /opt/sun/xvmoc/bin/proxyadm subcommand [ options ]
The proxyadm command helps to start, stop, configure and unconfigure the Enterprise Manager Ops Center Proxy Controller services.
The proxyadm command supports the following options:
-h| --help: Displays the usage synopsis for proxyadm.
-V: Displays the version of Enterprise Manager Ops Center.
The proxyadm command includes the following subcommands:
Starts the Proxy Controller services running on the host.
Stops the Proxy Controller services running on the host.
Displays the online or offline status of the Proxy Controller services to the standard output, and sets the exit status to reflect the Proxy Controller service state.
Performs configuration tasks for the Proxy Controller services.
You can set the following classes of configuration information:
Registering the Proxy Controller with the Enterprise Controller.
Configuring the type of DHCP server that the Proxy Controller will be running along with the parameters for that DHCP server.
Performs the inverse operation of configuring the Proxy Controller.
The following common options are supported for all the subcommands:
-h| --help: Displays the usage synopsis for that subcommand.
-v| --verbose: Displays verbose error and informational messages.
/opt/SUNWxvmoc/bin/proxyadm start [ -h | --help ] [ -v | --verbose ] [ -w | --wait ] [ -t | --temporary ] [ -l | --logfile<logfile> ]
-w| --wait: proxyadm does not exit until all the services are started.
-l| --logfile<logfile>: Captures any output from proxyadm in the logfile.
-t| --temporary: The state change is made temporary until next reboot.
/opt/SUNWxvmoc/bin/proxyadm stop [ -h | --help ] [ -v | --verbose ] [ -w | --wait ] [ -t | --temporary ] [ -l | --logfile<logfile> ]
-w| --wait: proxyadm does not exit until all the services are stopped.
-l| --logfile<logfile>: Captures any output from proxyadm in the logfile.
-t| --temporary: The state change is made temporary until next reboot.
/opt/SUNWxvmoc/bin/proxyadm status [ -h |--help ]
/opt/SUNWxvmoc/bin/proxyadm configure [ -h | --help ] [ -v | --verbose ] [ -a | --proxy-ip ] [ -s | --satellite<hostname>] [ -u | --user <username>] [ -p | --passwordfile<passwordfile>] [ -X | --proxy <hostname>[:<port>]] [ -U | --proxy-user<proxyusername>] [ -P | --proxy-passwordfile <passwordfile>] [ -D | --dhcp-server<hostname>] [ -I | --provisioning-interface<interfacename> ] [ -L | --low-ip<ip-addr>] [ -H | --high-ip<ip-addr>]
-s| --satellite<hostname>: Specifies the hostname of the Enterprise Controller to register the proxy. This requires the username and password used for the registration.
-u | --user<username>: Specifies the Enterprise Controller administrator username.
-p| --passwordfile<passwordfile>: Specifies a filename containing the password for the Enterprise Controller administrator.
The following options are optional for registering the Proxy Controller with the Enterprise Controller:
-t| --tokenfile<autoregistration_tokenfile>: Specifies a autoregistration token stored in a file. This is used as an alternative for Enterprise Controller administrator username and password.
-X| --proxy<hostname>[:<port> ]: If an HTTPS proxy is required to reach the Enterprise Controller, specify the <hostname> for that proxy. Specifying the IP port is optional.The default proxy port is 8080.
-U | --proxy-user<proxyusername>: If a proxy requires a username for authentication, use <proxyusername>.
-P | --proxy-passwordfile<password file>: Uses the password in <proxypasswordfile> for proxy authentication.
-a | --proxy-ip: Explicitly enter the IP address of the control proxy.
Be Careful - The password file should be secured to prevent unauthorized users from examining the file. The file permission should be set to 400.
/opt/SUNWxvmoc/bin/proxyadm unconfigure [ -h | --help ] [ -s | --satellite<hostname>] [ -D | --DHCP<hostname>]
Use the following option is used to unconfigure the Enterprise Controller registration:
-s| --satellite<hostname>: De-registers and unconfigures the connection between the Proxy Controller and the Enterprise Controller with which it was associated.
The exit status displays the status of the proxy services. The states currently displays either offline or online on the standard output. The exit status displays one of the following codes:
0 - Online
2 - Offline (only for status subcommand)
1 - Error occurred during processing
agentadm – to manipulate Enterprise Manager Ops Center agent services
Oracle Solaris OS
/opt/SUNWxvmoc/bin/agentadm /opt/SUNWxvmoc/bin/agentadm [ -h | --help ] /opt/SUNWxvmoc/bin/agentadm subcommand [ options ]
Linux OS
/opt/sun/xvmoc/bin/agentadm -V /opt/sun/xvmoc/bin/agentadm [ -h | --help ] /opt/sun/xvmoc/bin/agentadm subcommand [ options ]
<BASE>/bin/agentadm {-V | --version } { -K | --property-keys<file>] { -q | --quiet ] [ -v | --verbose ] [ -f | --force ] [ -n | --norefresh ] [ -o | --output-file ] [ -h | --help]
<BASE>/bin/agentadm subcommand [ options ]
The agentadm command helps to manage the Enterprise Manager Ops Center agents such as registering the agent to the proxy and unconfiguring the agents.
The following common options are supported:
-K| --property-keys<file>: The properties filename for the subcommands.
-V| --version: Displays the version number of agentadm.
-h| --help: Displays the usage synopsis for all configuration steps supported by agentadm.
-v| --verbose: Display verbose error and informational messages. Use multiple occurrences of this option to increase the verbosity level
-q| --quiet: Does not display anything and returns only the return code.
-f| --force: Ignores non critical errors during steps operations.
-n| --norefresh: Does not overwrite the existing operation.
-o| --output-file: Sends the output to the specified logfile.
The subcommands of agentadm are as follows:
Starts the Agent Controller services running on the host.
Stops the Agent Controller services running on the host.
Performs configuration tasks for the Agent Controller services.
Performs the inverse operation of configuring the Agent Controller.
Equivalent to [ -h | --help]
Starts the Agent Controller services running on the host.
<BASE>/bin/agentadm start
Stops the Agent Controller services running on the host.
<BASE>/bin/agentadm stop
The configuration step consists of:
sc-console registration of the agent to proxy.
scn-agent cacao instance creation.
uce-agent cacao instance creation.
Registration of the agent's products to the proxy.
The registration of the agent to the proxy is as follows: <BASE>/bin/agentadm configure [ -u | --user<username>] [ -p | --passwordfile<passwordfile>] [ -a | --agent-ip<IP address>][ -t | --token<tokenfilename>] [ -x | --proxy<URI>] [ -I | --non-interactive ]
-u | --user<username>: The Online Account user name.
-p | --passwordfile<passwordfile>: Filename with the Online Account credentials.
-a | --agent-ip<IP address>: Specify the IP address to be used during registration.
-t | --token<tokenfilename>: Filename containing auto registration token.
-x | --proxy<URI>: URI of the proxy to be registered.
-I | --non-interactive: Launch sc-console in non-interactive mode (without -i). Default is interactive mode.
Performs the inverse operation of configuring the agent.
<BASE>/bin/agentadm unconfigure