Commands

IBM® Spectrum Symphony includes commands that help you configure and use the software.

egoconfig
The command to set host configuration, join a host to the cluster, set the list of primary candidates and the failover priority, and add hosts to or remove hosts from the ManagementHosts resource groups.
egocontrol
Starts EGO on a remote Linux® host in the cluster. Use the egocontrol command to start EGO on Linux hosts only when you do not want the egosh command to run as the root user in your cluster.
egoinstallfixes
The command to install, roll back, and query information about fixes to your IBM Spectrum Symphony installation on Linux (including a IBM Spectrum Symphony-IBM Spectrum LSF® cluster on Linux).
egoremoverc
The command to prevent automatic startup of EGO on a Linux host. The egoremoverc.sh script supports the init daemon process, which starts as soon as your system starts and continues running until it is shut down.
egoremovesystemd
Prevents automatic startup of EGO on a Linux host. The egoremovesystemd.sh script supports the systemd daemon process, which starts processes in parallel, and reduces the boot time and computational overhead.
egosetrc
The command to configure automatic startup of EGO on a Linux host. The egosetrc.sh script supports the init daemon process, which starts as soon as your system starts and continues running until it is shut down. (IBM Spectrum Symphony also provides the egosetsystemd.sh script, which supports the systemd daemon process, which starts processes in parallel, and reduces the boot time and computational overhead.) Depending on your system, use either egosetrc.sh or egosetsystemd.sh.
egosetsudoers
The command that creates the /etc/ego.sudoers file to determine accounts with root privileges on the Linux host within a cluster.
egosetsystemd
Configures automatic startup of EGO on a Linux host. The egosetsystemd.sh script supports the systemd daemon process, which starts processes in parallel, and reduces the boot time and computational overhead. (IBM Spectrum Symphony also provides the egosetrc.sh script, which supports the init daemon process, which starts as soon as your system starts and continues running until it is shut down.) Depending on your system, use either egosetsystemd.sh or egosetrc.sh.
egosh
The command that launches the administrative command interface to EGO.
egoshutdown
The command to shut down a cluster.
egostartup
The command to start all EGO components of a cluster.
egoupgrade
The command to perform a rolling upgrade of IBM Spectrum Symphony clusters and hosts up one supported product version for your chosen operating system.
egoyarn
The command to submit YARN workload when Apache Hadoop YARN is integrated with IBM Spectrum Symphony.
gridsync
This command is only applicable to IBM Spectrum Symphony Advanced Edition. It synchronizes collections of files or directories (data sets) from a source (client) to target hosts across a cluster.
mrsh
The command to submit MapReduce jobs. The MapReduce framework is supported on IBM Spectrum Symphony Advanced Edition on Linux; however, you can run MapReduce jobs in an IBM Spectrum Symphony Developer Edition environment, and you can submit MapReduce jobs from IBM Spectrum Symphony Developer Edition to IBM Spectrum Symphony Advanced Edition.
pversions for Linux
The command to display version information for IBM Spectrum Computing family products or components installed on your local Linux host. ( To run this command on a Windows host, see the pversions command for Windows instead.) To see the components installed on the entire cluster, use the egosh component list command, or the System & Services > Software Components page within the cluster management console.
pversions for Windows
The command to display version information for IBM Spectrum Computing family products or components installed on your local Windows host. (To run this command on a Linux host, see the pversions command for Linux instead.) To see the components installed on the entire cluster, use the egosh component list command, or the System & Services > Software Components page within the cluster management console.
rfa
The command to transfer files between hosts.
rsdeploy
The command to deploy and remove packages, such as middleware, upgrade, file, or binary packages.
soamcontrol
The command to control applications and sessions.
soamdeploy
The command to deploy, remove, and display information about service packages for consumers.
soamlog
The command to dynamically change the log level for IBM Spectrum Symphony components.
soamlogoff
The command that ends the login session with IBM Spectrum Symphony.
soamlogon
The command to log the user on to IBM Spectrum Symphony for a specific time period.
soammigrate
The command to migrate the SSM (session manager) for an application.
soammod
The command to modify session and task priorities to enable high priority workload to finish faster.
soamreg
The command to register an application or update the application profile of a registered application.
soamshutdown
In IBM Spectrum Symphony Developer Edition only, this command immediately shuts down IBM Spectrum Symphony processes on the local host.
soamstartup
In IBM Spectrum Symphony Developer Edition only, this command starts IBM Spectrum Symphony processes on the local host.
soamswitch
Windows only. This command resets the system environment for the application client: connecting to an IBM Spectrum Symphony Developer Edition cluster from the IBM Spectrum Symphony Developer Edition installation environment; connecting to an IBM Spectrum Symphony cluster from the IBM Spectrum Symphony Developer Edition installation environment; or connecting to an IBM Spectrum Symphony cluster using the IBM Spectrum Symphony installation environment.
soamunreg
The command to unregister an application and delete the application profile, preventing more sessions from being started for this application.
soamview
The command to display information about applications, sessions, and tasks, and display the application profile.
symexec
The symexec command supports the running of remote execution tasks using the IBM Spectrum Symphony infrastructure. An execution task is a child process executed by an IBM Spectrum Symphony service instance using a command line specified by an IBM Spectrum Symphony client.
symping
This command sends workload to a cluster to test and verify that IBM Spectrum Symphony components are working and responsive.

Parent topic: Reference