Tchater maintenant avec le support
Tchattez avec un ingénieur du support

Foglight 7.1.0 - Command-Line Reference Guide

About the Command-Line Interface Managing the Foglight Management Server Managing the Foglight Agent Manager Managing Agents, Cartridges, and Metrics

Getting Started

To get started, make sure the Foglight Management Server is running, and, if you are planning to access the server commands remotely, copy and extract the contents of the remotemonitor.zip file to your remote computer.

For more information about the Remote Monitor, see remotemonitor .

1
Copy the <foglight_home>/tools/remotemonitor.zip file from the computer that has a running instance of the Foglight Management Server to the remote computer.
2
Extract the contents of the remotemonitor.zip file to a directory on the remote computer. For example, if you want to run the Remote Monitor on a Foglight Agent Manager computer, extract the remotemonitor.zip file to the <foglight_agent_mgr_home>/bin directory.
3
Reference the directory that contains the Foglight Management Server commands, either <foglight_home>/bin or <foglight_agent_mgr_home>/bin, by completing one of the following steps:
If you want to use the command prompt, open a Command Prompt window (Windows®) or a terminal window (UNIX® or Linux®) and navigate to <foglight_home>/bin or <foglight_agent_mgr_home>/bin as required.
For more information about foglight_home and foglight_agent_mgr_home, see Syntax Conventions .

From here, you can proceed to any of the following procedures as required:

Running the Server in Stand-Alone Mode

The fms command provides command-line interface to the Foglight Management Server process. It offers a set of options that allow you to perform any of the following operations as required:

Configure JavaTM Virtual Machine (JVM) options and add entries to the Foglight classpath
fms [-s|--start|-Dquest.debug=debug_level] [-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] [-m|--javavm path_to_JAVA_HOME]
[--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.]
fms [-d|--daemon] [-s|--start|-Dquest.debug=debug_level] [-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] [-m|--javavm path_to_JAVA_HOME]
[--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.]

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.

h

help

None

Displays a list of arguments and their descriptions.

-Dquest.debug=debug_level

Runs the Foglight Management Server in debug mode. For example, you can set the debug_level to one of the following values:

0: No debugging
1: Minimal debugging
2: Detailed debugging

By default, this option outputs the logs to the standard output. You can redirect the output to a file if required. For example:

fms -Dquest.debug=3 > debug3.log

j

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:

fms -Xdebug

-Xrunjdwp:transport=dt_socket,server=y,

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

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 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.

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

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.

d

daemon

None

Starts the Foglight Management Server as a daemon process.

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.

C:\Quest\Foglight\bin>fms -s

fms

The fms command provides command-line interface to the Foglight Management Server process. It offers a set of options that allow you to perform any of the following operations as required:

Configure JavaTM Virtual Machine (JVM) options and add entries to the Foglight classpath
fms [-s|--start|-Dquest.debug=debug_level] [-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] [-m|--javavm path_to_JAVA_HOME]
[--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.]
fms [-d|--daemon] [-s|--start|-Dquest.debug=debug_level] [-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] [-m|--javavm path_to_JAVA_HOME]
[--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.]

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.

h

help

None

Displays a list of arguments and their descriptions.

-Dquest.debug=debug_level

Runs the Foglight Management Server in debug mode. For example, you can set the debug_level to one of the following values:

0: No debugging
1: Minimal debugging
2: Detailed debugging

By default, this option outputs the logs to the standard output. You can redirect the output to a file if required. For example:

fms -Dquest.debug=3 > debug3.log

j

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:

fms -Xdebug

-Xrunjdwp:transport=dt_socket,server=y,

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

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 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.

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

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.

d

daemon

None

Starts the Foglight Management Server as a daemon process.

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.

C:\Quest\Foglight\bin>fms -s

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:

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]
[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] [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.]

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.

h

help

None

Displays a list of arguments and their descriptions.

j

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

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 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.

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

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.

d

daemon

None

Starts the Foglight Management Server as a daemon process.

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.

'C:\Quest\Foglight'
Documents connexes

The document was helpful.

Sélectionner une évaluation

I easily found the information I needed.

Sélectionner une évaluation