Getting Started
|
• |
Navigate to the directory <foglight_agent_mgr_home>/bin. |
|
• |
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 |
|
alias=path_to_certificate_file |
|||||||||
|
package_name.=level |
|||||||||
|
Indicates if this instance of the Foglight™ Agent Manager currently has an upstream connection with the Foglight Management Server. The exit code can be viewed by issuing the following command: | |||||||||
|
NOTE: The installation directory of the Foglight Agent Manager embedded on the Foglight Management Server does not include a JRE directory. When using this option to configure the embedded Foglight Agent Manager, you must also specify the path to the JVM using the javavm option. Failing to do so results in an error.
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. | |||||||||
|
NOTE: Creating and using multiple state directories on the embedded Foglight Agent Manager, running on the Foglight Management Server host, is not supported. If you want to use multiple state directories on the embedded Foglight Agent Manager, disable the embedded Foglight Agent Manager (as documented in “Automatically Running the Embedded Foglight Agent Manager” in the Foglight Agent Manager Installation Guide set) and install a separate, externally controlled Foglight Agent Manager instance. | |||||||||
|
When used with --configure, this option removes all Foglight Management Server URLs from config.xml. | |||||||||
|
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. | ||||||||
|
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= |
This argument specifies the password needed to access the private key contained in the keystore. | ||||||||
|
type=http|https |
|||||||||
|
size=Small| |
Specifies the amounts of the disk and memory resources. Small allocates 10 MB for the disk queue and 512 MB of memory. | ||||||||
|
port=port |
When used with --configure, this option deletes a downstream connection given its port number. | ||||||||
|
When used with --configure, this option deletes all downstream connections. | |||||||||
|
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:
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 | ||||||||
|
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 |
|||||||||
|
ssl-cert-common-name=CERTCOMMONNAME |
|||||||||
|
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. | ||||||||
|
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. | ||||||||
|
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. | |||||||||
|
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. | |||||||||
|
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 | |||||||||
|
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. NOTE: Creating and using multiple state directories on the embedded Foglight Agent Manager, running on the Foglight Management Server host, is not supported. If you want to use multiple state directories on the embedded Foglight Agent Manager, disable the embedded Foglight Agent Manager (as documented in “Automatically Running the Embedded Foglight Agent Manager” in the Foglight Agent Manager Installation Guide set) and install a separate, externally controlled Foglight Agent Manager instance. | |||||||||
|
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 | |||||||||
|
When used with --configure, it resets the unique ID that this Foglight Agent Manager instance uses to identify itself to the Foglight Management Server. | |||||||||
|
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. | |||||||||
|
Displays the version number, copyright, build number, and the installation directory. | |||||||||
|
When used with --configure, it prevents the Foglight Agent Manager from being installed as a Windows service. | |||||||||
|
Stops and removes the Foglight Agent Manager Windows service. | |||||||||
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.
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 |
|
alias=path_to_certificate_file |
|||||||||
|
package_name.=level |
|||||||||
|
Indicates if this instance of the Foglight™ Agent Manager currently has an upstream connection with the Foglight Management Server. The exit code can be viewed by issuing the following command: | |||||||||
|
NOTE: The installation directory of the Foglight Agent Manager embedded on the Foglight Management Server does not include a JRE directory. When using this option to configure the embedded Foglight Agent Manager, you must also specify the path to the JVM using the javavm option. Failing to do so results in an error.
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. | |||||||||
|
NOTE: Creating and using multiple state directories on the embedded Foglight Agent Manager, running on the Foglight Management Server host, is not supported. If you want to use multiple state directories on the embedded Foglight Agent Manager, disable the embedded Foglight Agent Manager (as documented in “Automatically Running the Embedded Foglight Agent Manager” in the Foglight Agent Manager Installation Guide set) and install a separate, externally controlled Foglight Agent Manager instance. | |||||||||
|
When used with --configure, this option removes all Foglight Management Server URLs from config.xml. | |||||||||
|
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. | ||||||||
|
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= |
This argument specifies the password needed to access the private key contained in the keystore. | ||||||||
|
type=http|https |
|||||||||
|
size=Small| |
Specifies the amounts of the disk and memory resources. Small allocates 10 MB for the disk queue and 512 MB of memory. | ||||||||
|
port=port |
When used with --configure, this option deletes a downstream connection given its port number. | ||||||||
|
When used with --configure, this option deletes all downstream connections. | |||||||||
|
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:
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 | ||||||||
|
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 |
|||||||||
|
ssl-cert-common-name=CERTCOMMONNAME |
|||||||||
|
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. | ||||||||
|
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. | ||||||||
|
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. | |||||||||
|
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. | |||||||||
|
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 | |||||||||
|
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. NOTE: Creating and using multiple state directories on the embedded Foglight Agent Manager, running on the Foglight Management Server host, is not supported. If you want to use multiple state directories on the embedded Foglight Agent Manager, disable the embedded Foglight Agent Manager (as documented in “Automatically Running the Embedded Foglight Agent Manager” in the Foglight Agent Manager Installation Guide set) and install a separate, externally controlled Foglight Agent Manager instance. | |||||||||
|
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 | |||||||||
|
When used with --configure, it resets the unique ID that this Foglight Agent Manager instance uses to identify itself to the Foglight Management Server. | |||||||||
|
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. | |||||||||
|
Displays the version number, copyright, build number, and the installation directory. | |||||||||
|
When used with --configure, it prevents the Foglight Agent Manager from being installed as a Windows service. | |||||||||
|
Stops and removes the Foglight Agent Manager Windows service. | |||||||||
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.
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:
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 .