Chat now with support
Chat with Support

Foglight Evolve 9.0 - High Availability Field Guide

fmsha

The fmsha command provides a command-line interface to the Management Server process running in High Availability (HA) mode. Running Foglight® in HA mode allows you to manage multiple instances of the Management Server in a JGroup partition that supports the HA feature.

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

Configure JavaTM Virtual Machine (JVM) options and add entries to the Foglight classpath
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]
[-D|-X JVM_option] [--set-global-debug-level debug_level]
[--add-debug-level package_1.=debug_level_1package_n.=debug_level_n]
[--remove-debug-level package_1.package_n.]
fmsha [-d|--daemon] [-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]
[-m|--javavm path_to_JAVA_HOME] [-D|-X JVM_option]
[--set-global-debug-level debug_level]
[--add-debug-level package_1.=debug_level_1package_n.=debug_level_n]
[--remove-debug-level package_1.package_n.]
UNIX® and Windows®

add-debug-level

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.

D

X

JVM_option

Passes an option to the JVM.

h

help

None

Displays a list of arguments and their descriptions.

j

jvm-argument

JVM_options

Specifies one or more JVM options.

m

javavm

path_to_JAVA_HOME

Points to the JVM for the Management Server process.

n

name

process_name

Specifies a unique process name for the current instance of the 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 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.

s

start

None

Starts the 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

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 Management Server process, this option instructs the command to wait indefinitely for the process to exit before shutting it down.

d

daemon

None

Starts the Management Server as a daemon process.

b

start-service

None

Starts the Management Server Windows service.

i

install-service

None

Installs the Management Server as a Windows service.

r

remove-service

None

Stops and removes the Management Server Windows service.

remotemonitor

The remotemonitor command provides command-line interface to the Remote Monitor application. The Remote Monitor communicates with multiple instances of the 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 Remote Monitor ; for additional information about the Remote Monitor application, see the Foglight Installation and Setup Guide.

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

Configure JavaTM Virtual Machine (JVM) options and add entries to the Remote Monitor classpath
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]
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]
UNIX® and Windows®

None

Displays a list of arguments and their descriptions.

JVM_options

Specifies one or more Java Virtual Machine (JVM) options.

process_name

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

class_path

Adds entries to the JVM classpath.

None

Stops the running Management Server process.

None

Starts the Management Server.

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.

None

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

None

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

None

Starts the Management Server Windows service.

None

Installs the Management Server as a Windows service.

None

Stops and removes the Management Server Windows service.

Examples

C:\Quest\Foglight\bin>remotemonitor --install-service
C:\Quest\Foglight\bin>remotemonitor --remove-service
C:\Quest\Foglight\bin>remotemonitor --version
Copyright (c) 2017 Quest Software Inc.

Configuring High Availability mode ports

The following table shows the default port assignments that are used in HA mode. The port numbers can be specified at installation time, or after the installation using the configuration parameters in the file <foglight_home>/config/server.config.

NOTE: In addition to the ports listed below, in some configurations, the Foglight® Management Server may use additional ports, such as the ports used by JGroups which is the underpinning component of Foglight HA. JGroups is a toolkit for reliable multicast communication. In a default configuration, it dynamically allocates some UDP ports for the communication between cluster members. Network traffic from those ports does not go beyond the local subnet. Therefore, no special firewall configuration is needed.

Cluster Mcast Port

Management Server

Management Server

Bidirectional between the HA Management Server Primary and Secondary servers.

Description: Cluster multicast port, used when Foglight is running in HA mode.

Configuration parameter: server.cluster.mcast_port

TCP port

Management Server

Management Server

Bidirectional between the HA Management Server Primary and Secondary servers.

Description: Port for TCP communication between two Management Servers when Foglight is running in HA mode.

NOTE: The TCP port number is not configured in the <foglight_home>/config/server.config file, like the rest of the ports described in this table. It is specified in the following line of the <foglight_home>/config/jgroups-config.xml file:

<TCPPING initial_hosts="${jgroups.bind_addr}[
7800],otherhost[7800]" …

To enable TCP communication, you must first uncomment the appropriate lines of code in the jgroups-config.xml file, as instructed in Tuning connection issues in HA implementations .

In some cases, the system may use a different port number for TCP communication, for example, if the port 7800 is unavailable due to a conflict with another application. To find out the actual TCP port number, look through the Management server logs. For example, the following log entry indicates that the current TCP port number is 3307:

 

2014-04-07 16:53:01.125 VERBOSE [main] STDOUT -

---------------------------------------------------------

GMS: address is 127.0.0.1:3307 (cluster=my-cluster-name)

---------------------------------------------------------

Configuration parameter: N/A

Related Documents