サポートと今すぐチャット
サポートとのチャット

Foglight 5.9.1 - 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 with Administrative Commands

You can issue the administrative commands on the computer running the Foglight Management Server, or on a remote computer in your network. Your Foglight installation includes a compressed file, fglcmd.zip, that contains all of the administrative commands. To get started, make sure you have the Foglight Management Server and Foglight Agent Manager running, and, if you are planning to access the administrative interface remotely, copy and extract the contents of the compressed file to your remote computer.

1
If you want to use the fglcmd interface on a remote computer in your monitoring network, complete the following steps:
a
Copy the <foglight_home>/tools/fglcmd.zip file from the computer that has a running instance of the Foglight Management Server to the remote computer, where foglight_home refers to the installation directory of the Foglight Management Server.
b
Extract the contents of the fglcmd.zip file to the remote computer.
2
Specify the directory that contains the Foglight Management Server commands, either <foglight_home>/bin or the directory on the remote computer (see Step 1), 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 the appropriate directory.
3
Foglight Management Server enables only the HTTPS port for remote access, and installs a self-signed certificate. The security certificate allows the server to communicate with a remote machine through the HTTPS protocol. If you intend to use the administrative commands either on a remote computer, or on a Foglight Management Server computer through the HTTPS protocol, you need to export the security certificate from the Foglight Management Server, and import it into your JRE environment, as described below.
On the computer on which a Foglight Management Server is running, open a Command Prompt window (Windows) or a terminal window (UNIX® or Linux®) and navigate to <foglight_home>/jre/bin, followed by issuing the following command:
keytool -exportcert -keystore foglight_home/config/tomcat.keystore
-alias tomcat -file filename -storepass nitrogen
Where filename is the name of the file in which the command stores the security certificate.
keytool -importcert -file filename -alias foglightcert
-keystore ../lib/security/cacerts -storepass changeit
Where filename is the name of the file to which you exported the security certificate in Step a.

Running Administrative Commands: Example

In this example, you will issue an administrative command that lists the agent packages that can be deployed to the Foglight Agent Manager using the packages command. The syntax of the packages command is as follows:

fglcmd connection_options -cmd agent:packages options

For more information about the command syntax, see Managing Agents, Cartridges, and Metrics .

In this example, you will issue the packages administrative command to list all Foglight Agent Manager instances and the agent packages that can be deployed to each Agent Manager instance.

In the Command Prompt window (Windows®) or the terminal window (UNIX® or Linux®), type the following command:
fglcmd -usr foglight -pwd foglight -cmd agent:packages

Looking at Scope-Specific Commands

Foglight includes a selection of commands that allow one to perform administrative tasks using a command-line interface, such as installing and deploying agents, adding or removing licenses, assigning schedules, or exporting various types of metrics. The table below lists Foglight commands in alphabetical order and identifies their scope. For more information about command scope, see Managing Agents, Cartridges, and Metrics .

Manages agents and agent managers

Activates one or more Foglight agent instances

Shows a list of Foglight agent manager instances

Upgrades one or more remote instances of the Foglight Agent Manager

Creates one or more Foglight agent instances

Deactivates one or more Foglight agents

Deletes one or more Foglight agent instances

Deploys one or more Foglight agent packages

Retrieves a copy of an agent log file

Shows a list of Foglight agent instances

Shows a list of agent log files

Shows a list of available agent packages

Assigns a blackout schedule to one or more Foglight agent instances

Shows the blackout schedule assigned to one or more Foglight agent instances.

Starts the data collection for one or more Foglight agent instances

Stops the data collection for one or more Foglight agent instances

Shows a list of Foglight agent types sorted by agent manager ID

Manages cartridges

Deactivates a Foglight cartridge

Activates an installed Foglight cartridge

Installs a cartridge on the Foglight Management Server

Lists all installed Foglight cartridges

Uninstalls a Foglight cartridge

Manages licenses

Installs a Foglight license

Shows a list of installed Foglight licenses

Removes a Foglight license using the license serial number

Lists schedules

Shows a list of all Foglight schedules

Runs scripts

Runs a script

Manages users and groups

Adds or removes a user from a group

Adds or removes a role from a group

Creates a group

Creates a user

Deletes a group

Deletes a user

Exports the LDAP settings to an XML file

Imports the LDAP settings from an XML file

Lists users, groups, and roles

Creates support bundles

Generates a support bundle file

Lists and assigns blackout schedules

Assigns a blackout schedule

Lists the blackout schedules assigned to topology objects

Contains utility commands

Exports the monitoring policy to an XML file

Imports the monitoring policy from an XML file

Outputs the values of server configuration parameters

Exports metric observations to a file using a metric query

Exports the value of one or more properties of a topology object to an XML file

Exports a UI module to a ZIP file

Imports a UI module from a ZIP file

Shows a list of deployed UI modules

Listing Administrative Commands

The fglcmd command includes an option that you can use to list all of the administrative commands and their descriptions, grouped by their respective scope.

fglcmd connection_options -cmd commands
For complete information about the fglcmd command syntax, see Syntax in fglcmd .
fglcmd -usr foglight -pwd foglight -cmd commands
A list of Foglight commands appears in the Command Prompt window (Windows®) or the terminal window (UNIX® or Linux®), grouped by the scope. Here is a portion of that output:

For complete information about fglcmd, see Logging In and Setting the Scope .

関連ドキュメント

The document was helpful.

評価を選択

I easily found the information I needed.

評価を選択