Chat now with support
Chat with Support

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

Navigate to the directory <foglight_agent_mgr_home>/bin.
Where foglight_agent_mgr_home refers to the installation directory of the Foglight Agent Manager, either its installation directory on a monitored host, or the home directory of the Foglight Agent Manager that comes embedded with the Foglight Management Server.
If you want to use the command prompt, open a Command Prompt window (Windows®) or terminal window (UNIX® or Linux®), and navigate to the appropriate directory.

From here, you can proceed to Starting or Stopping the Foglight Agent Manager .

Starting or Stopping the Foglight Agent Manager

The fglam command provides the command-line interface to the Foglight Agent Manager process. It 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 Agent Manager classpath
fglam [-s|--start|-Dquest.debug-debug_level] [-q|--stop] [-w|--wait]
[-i|--install-service] [-r|--remove-service] [-b|--start-service]
[-j|--jvm-argument JVM_options] [-m|--javavm java_path] [JVM_option]
[-p|--classpath class_path] [-v|--version] [-h|--help] [-t|--thread-dump]
[-u|--support-bundle] [-l|--location [state_directory]] [--check-connection]
[--create-state] [[-C|--configure] [--headless|--silent] [--spid SPID_path]
[--fms url={http|https}://host:port [proxy={http|https}://host:port
proxy-user=USERNAME proxy-pass=PASSWORD proxy-ntlm-domain=DOMAIN]
[--deletefms url={http|https}://host:port] [--deleteallfms] [--detectha]]
[ssl-allow-self-signed={true|false}] [ssl-cert-common-name=CERTCOMMONNAME]
[compressed] [address=ip_address] [--noservice]
[--host-display-name host_name] [--reset-host-id]]
[--set-global-debug-level level] [--add-debug-level package_name.=level]
[--remove-debug-level package.] [--heap-dump file_name|--heap-dump-all
file_name] [--add-certificate alias=path_to_certificate_file]
[--delete-certificate alias] [--list-certificates] [[--downstream
"<port=<port>,key-password=<password>>[,<host=<host>,type=<https|http>,
host=<host>,size=Small|Medium|Large|Huge|Maximum>]"]|[--deletedownstream <port>]|
[--deletealldownstream]] [--no-start-on-exit]
fglam [-s|--start|-Dquest.debug-debug_level] [-q|--stop] [-w|--wait]
[-j|--jvm-argument JVM_options] [-m|--javavm java_path] [JVM_option]
[-p|--classpath class_path] [-v|--version] [-h|--help] [-t|--thread-dump]
[-u|--support-bundle] [-l|--location [state_directory]] [--check-connection]
[--create-state] [[-C|--configure] [--headless|--silent] [--spid SPID_path]
[--fms url={http|https}://host:port [proxy={http|https}://host:port proxy-
user=USERNAME proxy-pass=PASSWORD proxy-ntlm-domain=DOMAIN]
[--deletefms url={http|https}://host:port] [--deleteallfms] [--detectha]]
[ssl-allow-self-signed={true|false}] [ssl-cert-common-name=CERTCOMMONNAME]
[compressed] [address=ip_address] [--host-display-name host_name]
[--reset-host-id]] [--set-global-debug-level level]
[--add-debug-level package_name.=level] [--remove-debug-level package.]
[--heap-dump file_name|--heap-dump-all file_name]
[--add-certificate alias=path_to_certificate_file]
[--delete-certificate alias] [--list-certificates][[--downstream
"<port=<port>,key-password=<password>>[,<host=<host>,type=<https|http>,
host=<host>,size=Small|Medium|Large|Huge|Maximum>]"]|[--deletedownstream <port>]|
[--deletealldownstream]] [--no-start-on-exit]

add-certificate

alias=path_to_certificate_file

Adds the certificate file to the collection of trusted certificates for this Agent Manager. The certificate is trusted for all SSL connections.

add-debug-level

package_name.=level

Enables debugging for the specified package. When debugging is enabled, debug messages are written to the log. The amount of debugging depends on the specified debugging level. The level must be a positive integer number. Higher debug levels result in more detailed logging. The argument can be specified multiple times with this option.

check-connection

None

Indicates if this instance of the Foglight Agent Manager currently has an upstream connection with the Foglight Management Server.

NOTE: It can be used with the location option to query the connection status of other instances.

Along with a command output that shows the details of the connection state, this option also returns an exit code to the OS, indicating the state of the upstream connection.

The exit code can be viewed by issuing the following command:

Windows:

echo %errorlevel%

Unix:

echo $?

An exit code of zero ‘0’ indicates that the Foglight Agent Manager is successfully connected to the upstream server while a positive integer value indicates a connection disruption.

C

configure

None

Launches the Foglight Agent Manager installation and configuration interface, enabling the update of the existing configuration files.

If neither the headless nor the silent options are used, the Agent Manager Installation and Configuration dialog box appears, allowing you to configure the Foglight Agent Manager. For complete information, see the Foglight Agent Manager Installation Guide.

create-state

None

Creates a state directory and populates it with default configuration files. The process fails if the directory already exists.

deleteallfms

None

When used with --configure, this option removes all Foglight Management Server URLs from config.xml.

delete-certificate

alias

Deletes the certificate file from the collection of trusted certificates for this Agent Manager, given the certificate alias specified when it was created. The certificate is no longer trusted for any SSL connections.

deletefms

url=HTTP|HTTPS://host:port

When used with --configure, this option removes a Foglight Management Server URL from config.xml. The URL is specified as an argument, where host and port specify the host name of the machine on which the Foglight Management Server is installed, and the port number the server uses to communicate with the Foglight Agent Manager.

downstream

port=port

When used with --configure, this option creates a downstream connection.

The port argument specifies the number of the port the Agent Manager uses to listen for downstream connections.

key-password=
password

This argument specifies the password needed to access the private key contained in the keystore.

host=host

Specifies the host name to be set in the certificate.

type=http|https

Specifies the type of the supported protocol.

size=Small|
Medium|Large|
Huge|Maximum

Specifies the amounts of the disk and memory resources.

Small allocates 10 MB for the disk queue and 512 MB of memory.

deletedownstream

port=port

When used with --configure, this option deletes a downstream connection given its port number.

deletealldownstream

When used with --configure, this option deletes all downstream connections.

detectha

None

When used with --configure and --fms pointing to a Management Server that is part of a High Availability (HA) cluster, this option instructs the installer to detect and test any available Management Server peers. Any peers that fail the test should be removed from config.xml to avoid populating this file with incorrect values.

-Dquest.debug-debug_level

Runs the Foglight Agent Manager in debug mode. You can set debug_level to one of the following values:

1: No debugging
2: Minimal debugging
3: Detailed debugging

By default, this option prints the logs to the standard output. You can redirect the output to a file if required. For example: fglam -Dquest.debug=2 > debug2.log

fms

When used with --configure, the fms option can be used to specify the URL to the Foglight Management Server, using the arguments listed below.

address=ip_address

The IP address of the Foglight Agent Manager that is used to connect with the Foglight Management Server.

ssl-cert-common-name=CERTCOMMONNAME

The common name of the expected certificate.

compressed

Enables HTTP compression.

proxy=HTTP|HTTPS://host:port

The URL to the proxy server (if applicable), where host and port specify the host name of the machine on which the proxy server is installed, and the port number the proxy server uses to communicate with the Foglight Agent Manager.

proxy-ntlm-domain=DOMAIN

If proxy server is used for connection with the Foglight Management Server, domain specifies the Windows domain of the proxy server.

proxy-pass=PASSWORD

If proxy server is used for connection with the Foglight Management Server, password specifies the user password for accessing the proxy server.

proxy-user=USERNAME

If proxy server is used for connection with the Foglight Management Server, user_name specifies the user name for accessing the proxy server.

ssl-allow-self-signed=true|false

Indicates if self-signed certificates are accepted (true) or not (false).

url=HTTP|HTTPS://host:port

The URL to the Foglight Management Server, where host and port specify the host name of the machine on which the Foglight Management Server is installed, and the port number the server uses to communicate with the Foglight Agent Manager.

h

help

None

Displays a list of arguments and their descriptions.

headless

None

When used with --configure, it launches the Foglight Agent Manager installation and configuration interface on the command line. For complete information, see the Foglight Agent Manager Installation Guide.

heap-dump

file_name

Outputs a heap dump containing only live objects to a file.

heap-dump-all

file_name

Outputs a heap dump containing all objects to a file.

host-display-name

host_name

When used with --configure, it sets the Foglight Agent Manager display name. By default, the Foglight Agent Manager uses the host name that is automatically detected for the machine on which it is installed. In some cases you may need to use a different name, for example, when you need to use a different name that suits your business needs. For more information, see the Agent Manager Guide.

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:

fglam -Xdebug

-Xrunjdwp:transport=dt_socket,server=y,

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

list-certificates

None

Displays a list of certificates that are added to this Agent Manager. Certificates that are included in the JRE do not appear on the list.

l

location

state_directory

Sets the location of the state directory for this instance of the Foglight Agent Manager. A state directory contains the Foglight Agent Manager configuration files. If not provided, the command uses the default location of the state directory, <foglight_agent_mgr_home>/state.

m

javavm

java_path

Sets the path to the JVM.

no-start-on-exit

None

If you want to install the Agent Manager Windows service, or a Unix deamon, the configuration interface appears with pre-selected options, indicating that the Agent Manager will start immediately after the installation. You can force these options to appear disabled by default (and enable them, if required, during the configuration), if you start the fglam command with this option (together with --configure and -- headless):

fglam --configure ‑‑headless --no-start-on-exit

p

classpath

class_path

Adds entries to the JVM classpath.

q

stop

None

Stops the running Foglight Agent Manager process.

remove-debug-level

package_name.

Disables debugging for the specified package. When debugging is disabled, package-specific debug messages are no longer written to the log. The argument can be specified multiple times with this option.

reset-host-id

None

When used with --configure, it resets the unique ID that this Foglight Agent Manager instance uses to identify itself to the Foglight Management Server.

set-global-debug-level

level

Sets the global debugging level. When debugging is enabled, debug messages are written to the log. The amount of debugging depends on the specified debugging level. The level must be a positive integer number. Higher debug levels result in more detailed logging.

spid

SPID_path

During a silent installation, it migrates a Foglight Client to a new Foglight Agent Manager instance, given the path to the Foglight Client installation directory (SPID_path).

s

start

None

Starts the Foglight Agent Manager.

silent

None

When used with --configure, it launches the Foglight Agent Manager configuration, without user interaction, applying the default configuration values. For complete information, see the Foglight Agent Manager Installation Guide.

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.

u

support-bundle

None

Requests a support bundle from the running application.

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

b

start-service

None

Starts the Foglight Agent Manager Windows service.

i

install-service

None

Installs the Foglight Agent Manager as a Windows service.

noservice

None

When used with --configure, it prevents the Foglight Agent Manager from being installed as a Windows service.

r

remove-service

None

Stops and removes the Foglight Agent Manager Windows service.

Copyright (c) 2017 Quest Software Inc.
Client Binary Directory: C:\Quest\Foglight\fglam\client\5.8.5.8-201408261438-BETA-
active at: C:\Quest\Foglight_Agent_Manager\state\default\
in C:\Quest\Foglight_Agent_Manager\agents\HostAgents\7.3.0-7.3.0-

For information on how to deploy and activate a Foglight agent using the command-line interface, see Deploying Agent Packages and Activating or Deactivating Agent Instances , respectively.

Similarly to the previous example, if there are any active agents running on the Foglight Agent Manager, this command stops the agents’ data collection and closes their Command Prompt windows (or terminal window).

fglam

The fglam command provides the command-line interface to the Foglight Agent Manager process. It 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 Agent Manager classpath
fglam [-s|--start|-Dquest.debug-debug_level] [-q|--stop] [-w|--wait]
[-i|--install-service] [-r|--remove-service] [-b|--start-service]
[-j|--jvm-argument JVM_options] [-m|--javavm java_path] [JVM_option]
[-p|--classpath class_path] [-v|--version] [-h|--help] [-t|--thread-dump]
[-u|--support-bundle] [-l|--location [state_directory]] [--check-connection]
[--create-state] [[-C|--configure] [--headless|--silent] [--spid SPID_path]
[--fms url={http|https}://host:port [proxy={http|https}://host:port
proxy-user=USERNAME proxy-pass=PASSWORD proxy-ntlm-domain=DOMAIN]
[--deletefms url={http|https}://host:port] [--deleteallfms] [--detectha]]
[ssl-allow-self-signed={true|false}] [ssl-cert-common-name=CERTCOMMONNAME]
[compressed] [address=ip_address] [--noservice]
[--host-display-name host_name] [--reset-host-id]]
[--set-global-debug-level level] [--add-debug-level package_name.=level]
[--remove-debug-level package.] [--heap-dump file_name|--heap-dump-all
file_name] [--add-certificate alias=path_to_certificate_file]
[--delete-certificate alias] [--list-certificates] [[--downstream
"<port=<port>,key-password=<password>>[,<host=<host>,type=<https|http>,
host=<host>,size=Small|Medium|Large|Huge|Maximum>]"]|[--deletedownstream <port>]|
[--deletealldownstream]] [--no-start-on-exit]
fglam [-s|--start|-Dquest.debug-debug_level] [-q|--stop] [-w|--wait]
[-j|--jvm-argument JVM_options] [-m|--javavm java_path] [JVM_option]
[-p|--classpath class_path] [-v|--version] [-h|--help] [-t|--thread-dump]
[-u|--support-bundle] [-l|--location [state_directory]] [--check-connection]
[--create-state] [[-C|--configure] [--headless|--silent] [--spid SPID_path]
[--fms url={http|https}://host:port [proxy={http|https}://host:port proxy-
user=USERNAME proxy-pass=PASSWORD proxy-ntlm-domain=DOMAIN]
[--deletefms url={http|https}://host:port] [--deleteallfms] [--detectha]]
[ssl-allow-self-signed={true|false}] [ssl-cert-common-name=CERTCOMMONNAME]
[compressed] [address=ip_address] [--host-display-name host_name]
[--reset-host-id]] [--set-global-debug-level level]
[--add-debug-level package_name.=level] [--remove-debug-level package.]
[--heap-dump file_name|--heap-dump-all file_name]
[--add-certificate alias=path_to_certificate_file]
[--delete-certificate alias] [--list-certificates][[--downstream
"<port=<port>,key-password=<password>>[,<host=<host>,type=<https|http>,
host=<host>,size=Small|Medium|Large|Huge|Maximum>]"]|[--deletedownstream <port>]|
[--deletealldownstream]] [--no-start-on-exit]

add-certificate

alias=path_to_certificate_file

Adds the certificate file to the collection of trusted certificates for this Agent Manager. The certificate is trusted for all SSL connections.

add-debug-level

package_name.=level

Enables debugging for the specified package. When debugging is enabled, debug messages are written to the log. The amount of debugging depends on the specified debugging level. The level must be a positive integer number. Higher debug levels result in more detailed logging. The argument can be specified multiple times with this option.

check-connection

None

Indicates if this instance of the Foglight Agent Manager currently has an upstream connection with the Foglight Management Server.

NOTE: It can be used with the location option to query the connection status of other instances.

Along with a command output that shows the details of the connection state, this option also returns an exit code to the OS, indicating the state of the upstream connection.

The exit code can be viewed by issuing the following command:

Windows:

echo %errorlevel%

Unix:

echo $?

An exit code of zero ‘0’ indicates that the Foglight Agent Manager is successfully connected to the upstream server while a positive integer value indicates a connection disruption.

C

configure

None

Launches the Foglight Agent Manager installation and configuration interface, enabling the update of the existing configuration files.

If neither the headless nor the silent options are used, the Agent Manager Installation and Configuration dialog box appears, allowing you to configure the Foglight Agent Manager. For complete information, see the Foglight Agent Manager Installation Guide.

create-state

None

Creates a state directory and populates it with default configuration files. The process fails if the directory already exists.

deleteallfms

None

When used with --configure, this option removes all Foglight Management Server URLs from config.xml.

delete-certificate

alias

Deletes the certificate file from the collection of trusted certificates for this Agent Manager, given the certificate alias specified when it was created. The certificate is no longer trusted for any SSL connections.

deletefms

url=HTTP|HTTPS://host:port

When used with --configure, this option removes a Foglight Management Server URL from config.xml. The URL is specified as an argument, where host and port specify the host name of the machine on which the Foglight Management Server is installed, and the port number the server uses to communicate with the Foglight Agent Manager.

downstream

port=port

When used with --configure, this option creates a downstream connection.

The port argument specifies the number of the port the Agent Manager uses to listen for downstream connections.

key-password=
password

This argument specifies the password needed to access the private key contained in the keystore.

host=host

Specifies the host name to be set in the certificate.

type=http|https

Specifies the type of the supported protocol.

size=Small|
Medium|Large|
Huge|Maximum

Specifies the amounts of the disk and memory resources.

Small allocates 10 MB for the disk queue and 512 MB of memory.

deletedownstream

port=port

When used with --configure, this option deletes a downstream connection given its port number.

deletealldownstream

When used with --configure, this option deletes all downstream connections.

detectha

None

When used with --configure and --fms pointing to a Management Server that is part of a High Availability (HA) cluster, this option instructs the installer to detect and test any available Management Server peers. Any peers that fail the test should be removed from config.xml to avoid populating this file with incorrect values.

-Dquest.debug-debug_level

Runs the Foglight Agent Manager in debug mode. You can set debug_level to one of the following values:

1: No debugging
2: Minimal debugging
3: Detailed debugging

By default, this option prints the logs to the standard output. You can redirect the output to a file if required. For example: fglam -Dquest.debug=2 > debug2.log

fms

When used with --configure, the fms option can be used to specify the URL to the Foglight Management Server, using the arguments listed below.

address=ip_address

The IP address of the Foglight Agent Manager that is used to connect with the Foglight Management Server.

ssl-cert-common-name=CERTCOMMONNAME

The common name of the expected certificate.

compressed

Enables HTTP compression.

proxy=HTTP|HTTPS://host:port

The URL to the proxy server (if applicable), where host and port specify the host name of the machine on which the proxy server is installed, and the port number the proxy server uses to communicate with the Foglight Agent Manager.

proxy-ntlm-domain=DOMAIN

If proxy server is used for connection with the Foglight Management Server, domain specifies the Windows domain of the proxy server.

proxy-pass=PASSWORD

If proxy server is used for connection with the Foglight Management Server, password specifies the user password for accessing the proxy server.

proxy-user=USERNAME

If proxy server is used for connection with the Foglight Management Server, user_name specifies the user name for accessing the proxy server.

ssl-allow-self-signed=true|false

Indicates if self-signed certificates are accepted (true) or not (false).

url=HTTP|HTTPS://host:port

The URL to the Foglight Management Server, where host and port specify the host name of the machine on which the Foglight Management Server is installed, and the port number the server uses to communicate with the Foglight Agent Manager.

h

help

None

Displays a list of arguments and their descriptions.

headless

None

When used with --configure, it launches the Foglight Agent Manager installation and configuration interface on the command line. For complete information, see the Foglight Agent Manager Installation Guide.

heap-dump

file_name

Outputs a heap dump containing only live objects to a file.

heap-dump-all

file_name

Outputs a heap dump containing all objects to a file.

host-display-name

host_name

When used with --configure, it sets the Foglight Agent Manager display name. By default, the Foglight Agent Manager uses the host name that is automatically detected for the machine on which it is installed. In some cases you may need to use a different name, for example, when you need to use a different name that suits your business needs. For more information, see the Agent Manager Guide.

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:

fglam -Xdebug

-Xrunjdwp:transport=dt_socket,server=y,

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

list-certificates

None

Displays a list of certificates that are added to this Agent Manager. Certificates that are included in the JRE do not appear on the list.

l

location

state_directory

Sets the location of the state directory for this instance of the Foglight Agent Manager. A state directory contains the Foglight Agent Manager configuration files. If not provided, the command uses the default location of the state directory, <foglight_agent_mgr_home>/state.

m

javavm

java_path

Sets the path to the JVM.

no-start-on-exit

None

If you want to install the Agent Manager Windows service, or a Unix deamon, the configuration interface appears with pre-selected options, indicating that the Agent Manager will start immediately after the installation. You can force these options to appear disabled by default (and enable them, if required, during the configuration), if you start the fglam command with this option (together with --configure and -- headless):

fglam --configure ‑‑headless --no-start-on-exit

p

classpath

class_path

Adds entries to the JVM classpath.

q

stop

None

Stops the running Foglight Agent Manager process.

remove-debug-level

package_name.

Disables debugging for the specified package. When debugging is disabled, package-specific debug messages are no longer written to the log. The argument can be specified multiple times with this option.

reset-host-id

None

When used with --configure, it resets the unique ID that this Foglight Agent Manager instance uses to identify itself to the Foglight Management Server.

set-global-debug-level

level

Sets the global debugging level. When debugging is enabled, debug messages are written to the log. The amount of debugging depends on the specified debugging level. The level must be a positive integer number. Higher debug levels result in more detailed logging.

spid

SPID_path

During a silent installation, it migrates a Foglight Client to a new Foglight Agent Manager instance, given the path to the Foglight Client installation directory (SPID_path).

s

start

None

Starts the Foglight Agent Manager.

silent

None

When used with --configure, it launches the Foglight Agent Manager configuration, without user interaction, applying the default configuration values. For complete information, see the Foglight Agent Manager Installation Guide.

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.

u

support-bundle

None

Requests a support bundle from the running application.

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

b

start-service

None

Starts the Foglight Agent Manager Windows service.

i

install-service

None

Installs the Foglight Agent Manager as a Windows service.

noservice

None

When used with --configure, it prevents the Foglight Agent Manager from being installed as a Windows service.

r

remove-service

None

Stops and removes the Foglight Agent Manager Windows service.

Copyright (c) 2017 Quest Software Inc.
Client Binary Directory: C:\Quest\Foglight\fglam\client\5.8.5.8-201408261438-BETA-
active at: C:\Quest\Foglight_Agent_Manager\state\default\
in C:\Quest\Foglight_Agent_Manager\agents\HostAgents\7.3.0-7.3.0-

For information on how to deploy and activate a Foglight agent using the command-line interface, see Deploying Agent Packages and Activating or Deactivating Agent Instances , respectively.

Similarly to the previous example, if there are any active agents running on the Foglight Agent Manager, this command stops the agents’ data collection and closes their Command Prompt windows (or terminal window).

Creating Agent Manager Support Bundles

The support-bundle command generates an Agent Manager support bundle file. A support bundle is a compressed file that contains diagnostic data, such as Agent Manager and individual agent log files.

When you create an Agent Manager bundle, Foglight generates a ZIP files in the <foglight_home>/support/<user_name> directory on the machine on which the Management Server is running. The support bundle file name uses the following syntax:

support_bundle_FglAM_<Agent Manager host>_<Management Server host>_<user name>-<yyyy-mm-dd>-<hh-mm-ss>.zip

For example:

For details about the contents of this file, see the Administration and Configuration Help. For more information about foglight_agent_mgr_home, see Syntax Conventions .

None

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating