Foglight 7.1.0 - Command-Line Reference Guide

fms

Running the Server in High Availability Mode

fmsha

Running the Server in High Availability Mode

The fmsha command provides a command-line interface to the Foglight Management Server process running in High Availability (HA) mode. Running Foglight in HA mode allows you to manage multiple instances of the Foglight Management Server in a JBoss® partition that supports the HA feature. For more information about the HA mode, see the Installation and Setup Guide.

This command offers a set of options that you can use to perform any of the following operations:

•

Start or stop the Foglight Management Server in HA mode

•

Install and start the Foglight Management Server in HA mode as a Windows® service

•

Stop and remove a Foglight Management Server HA Windows service

•

Configure JavaTM Virtual Machine (JVM) options and add entries to the Foglight classpath

•

Assign different names to different Foglight Management Server process launchers

•

Display version information or a list of arguments along with their descriptions

Syntax

Windows only

fmsha [-s|--start] [-q|--stop] [-w|--wait] [-n|--name process_name]

[-i|--install-service] [-r|--remove-service] [-b|--start-service]

[-j|--jvm-argument JVM_options] [-p|--classpath class_path] [-v|--version]

[-h|--help] [-t|--thread-dump] [-m|--javavm path_to_JAVA_HOME]

[JVM_option] [--set-global-debug-level debug_level]

[--add-debug-level package_1.=debug_level_1 … package_n.=debug_level_n]

[--remove-debug-level package_1. … package_n.]

Unix only

fmsha [-d|--daemon] [-s|--start] [-q|--stop] [-w|--wait]

[-m|--javavm path_to_JAVA_HOME] [JVM_option]

[--set-global-debug-level debug_level]

[--add-debug-level package_1.=debug_level_1 … package_n.=debug_level_n]

[--remove-debug-level package_1. … package_n.]


	NOTE: If you do not specify any options, fmsha uses the default option, s, and starts an instance of the Foglight™ Management Server in HA mode.

Table 2. Options and arguments

package.=debug_level

Specifies a debug level for one or more packages. Higher debug levels result in more detailed logging. For example, you can set the debug_level to one of the following values:

•

0: No debugging

•

1: Minimal debugging

•

2: Detailed debugging

The period '.' following the package name is mandatory, otherwise the package is treated as a class. The package.=debug_level argument can be specified multiple times.

help

None

Displays a list of arguments and their descriptions.

jvm-argument

JVM_options

Specifies one or more JVM options.

JVM_option

Passes an option to the JVM, prefixed with -X or -D. For example:

fmsha -Xdebug

-Xrunjdwp:transport=dt_socket,server=y,

suspend=n,address=1044 -Dquest.debug=2

javavm

path_to_JAVA_HOME

Points to the JVM for the Management Server process.

name

process_name

Specifies a unique process name for the current instance of the Foglight Management Server. Foglight uses process names to distinguish between different instances of the same process launcher.

classpath

class_path

Adds entries to the JVM classpath.

stop

None

Stops the running Foglight Management Server process.

remove-debug-level

package.

Removes a debug level associated with one or more packages. The period '.' following the package name is mandatory, otherwise the package is treated as a class. The package. argument can be specified multiple times.

start

None

Starts the Foglight Management Server.

set-global-debug-level

debug_level

Sets the global debug level. The debug_level argument must be a non-negative integer. Higher debug levels result in more detailed logging.

For example, you can set the debug_level to one of the following values:

•

0: No debugging

•

1: Minimal debugging

•

2: Detailed debugging

thread-dump

None

Requests a thread output from the running application. This option writes the output to a separate log file in the application's installation directory.

version

None

Displays the version number, copyright, build number, and the installation directory.

wait

None

When sending a shutdown command to an existing Foglight Management Server process, this option instructs the command to wait indefinitely for the process to exit before shutting it down.

Unix only

daemon

None

Starts the Foglight Management Server as a daemon process.

NOTE: Unix installations also include the following scripts for stsarting and stopping the Management Server in HA mode:

•

•

Starts the Foglight Management Server Windows service.

install-service

None

Installs the Foglight Management Server as a Windows service.

remove-service

None

Stops and removes the Foglight Management Server Windows service.

Examples

Starting the server in HA mode

C:\Quest\Foglight\bin>fmsha

8/18/23-10-16 12:06:32.632 INFO Starting Foglight Management Server with the command

bin\fms -Dfoglight.cluster.mode=true...

8/18/23-10-16 12:06:33.398 INFO Starting Foglight Management Server.

8/18/23-10-16 12:06:33.538 INFO Foglight Management Server starting up using

database host: localhost

...

Installing the server in HA mode as a Windows service

C:\Quest\Foglight\bin>fmsha -i

8/18/23-10-16 12:08:43.000 INFO [native] Foglight High Availability Management

Server (FoglightHA) service installed

Removing the server HA Windows service

C:\Quest\Foglight\bin>fmsha -r

8/18/23-10-16 12:11:24.000 INFO [native] Removed the Foglight High Availability

Management Server (FoglightHA) service installed from

'C:\Quest\Foglight'

See also

•

fms

•

remotemonitor

The remotemonitor command provides command-line interface to the Remote Monitor application. The Remote Monitor communicates with multiple instances of the Foglight Management Server running in HA mode. If a server fails to reply, the Remote Monitor logs an event and sends e-mails to the server administrator. The Remote Monitor uses a list of host names or host names and port numbers to identify High Availability servers that it communicates with. This information is stored in the <foglight_home>/config/remote_monitor.config file under the server.urls entry.

For information on how to install and configure the Remote Monitor, see Managing the Foglight Management Server ; for additional information about the Remote Monitor application, see the Installation and Setup Guide.

The remotemonitor command offers a set of options that you can use to perform any of the following operations:

•

Start or stop the Remote Monitor

•

Install and start the Remote Monitor as a Windows® service

•

Stop and remove the Remote Monitor Windows service

•

Configure JavaTM Virtual Machine (JVM) options and add entries to the Remote Monitor classpath

•

Assign different names to different Remote Monitor process launchers

•

Display version information or a list of arguments along with their descriptions

Syntax

Windows only

remotemonitor [-s|--start] [-q|--stop] [-w|--wait] [-n|--name process_name]

[-i|--install-service] [-r|--remove-service] [-b|--start-service]

[-j|--jvm-argument JVM_options] [-p|--classpath class_path] [-v|--version]

[-h|--help] [-t|--thread-dump] [JVM_option]

Unix only

remotemonitor [-s|--start] [-q|--stop] [-w|--wait] [-n|--name process_name]

[-j|--jvm-argument JVM_options] [-p|--classpath class_path] [-v|--version]

[-h|--help] [-t|--thread-dump] [JVM_option]


	NOTE: If you do not specify any options, remotemonitor uses the default option, s, and starts an instance of the Remote Monitor utility.

Table 3. Options and arguments
Options		Argument	Description
Unix and Windows
h	help	None	Displays a list of arguments and their descriptions.
j	jvm-argument	JVM_options	Specifies one or more Java Virtual Machine (JVM) options.
JVM_option			Passes an option to the JVM, prefixed with -X or -D. For example: remotemonitor -Xdebug -Xrunjdwp:transport=dt_socket,server=y, suspend=n,address=1044 -Dquest.debug=2
n	name	process_name	Specifies a unique process name for the current instance of the Foglight™ Management Server. Foglight uses process names to distinguish between different instances of the same process launcher.
p	classpath	class_path	Adds entries to the JVM classpath.
q	stop	None	Stops the running Foglight Management Server process.
s	start	None	Starts the Foglight Management Server.
t	thread-dump	None	Requests a thread output from the running application. This option writes the output to a separate log file in the application's installation directory.
v	version	None	Displays the version number, copyright, build number, and the installation directory.
w	wait	None	When sending a shutdown command to an existing Foglight Management Server process, this option instructs the command to wait indefinitely for the process to exit before shutting it down.
Windows only
b	start-service	None	Starts the Foglight Management Server Windows service.
i	install-service	None	Installs the Foglight Management Server as a Windows service.
r	remove-service	None	Stops and removes the Foglight Management Server Windows service.