Foglight 5.9.1 - Command-Line Reference Guide

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.

To get started with administrative commands:


	NOTE: This procedure continues from Getting Started with Foglight Commands .

If you want to use the fglcmd interface on a remote computer in your monitoring network, complete the following steps:

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.

Extract the contents of the fglcmd.zip file to the remote computer.

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.

•

If you want to use a Foglight Management Server command in a script, ensure that your script references the appropriate directory.

For more information about foglight_home, see Syntax Conventions .

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.


	IMPORTANT: The commands below follow the generic syntax in which forward slashes '/' are used to separate directories. On Windows platforms, instead of forward slashes '/', use back slashes ‘\’ as directory separators in file paths. For more information about the syntax conventions used in this manual, see Syntax Conventions .

Export the security certificate from the Foglight Management Server.

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.

Import the security certificate into your environment, either on the remote computer, or on the computer on which the Foglight Management Server is running.

On the computer on which you intend to use the administrative commands, open a Command Prompt window (Windows) or a terminal window (UNIX® or Linux®) and navigate to <jre_home>/bin, followed by issuing the following command:

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.


	IMPORTANT: The default keystore password for jre/lib/security/cacerts is changeit.

Issue one or more administrative commands using command prompt or a script. From here, you can issue any fglcmd commands described in the following , as required.

See also

•

Managing Agents, Cartridges, and Metrics

•

About Regular Expressions

•

Running Administrative Commands: Example

•

Looking at Scope-Specific Commands

•

Listing Administrative Commands

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.

To list agent packages:


	NOTE: This procedure continues from “Getting Started with Foglight Commands .

•

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

-allclients

A list of all available agent packages appears in the Command Prompt or terminal window. A sample of that output is similar to the following listing:

Client ID: Host1-2d2edfcc#be05acc0-6179-4878-a274-afcd5075260a

Agent Package ID: HostAgents-5.7.5.8-Host Agents

Agent Package Cartridge Name: HostAgents

Agent Package Cartridge Version: 5.7.5.8

Agent Package Version: 5.7.5.8

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

Client ID: Host2.example.com#6290d00c-8fd6-42a3-bc2a-63b0d5263645

Agent Package ID: HostAgents-5.7.5.8-Host Agents

Agent Package Cartridge Name: HostAgents

Agent Package Cartridge Version: 5.7.5.8

Agent Package Version: 5.7.5.8

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

See also

•

Managing Agents, Cartridges, and Metrics

•

About Regular Expressions

•

Getting Started with Administrative Commands

•

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 .

Table 3. Scope-specific commands
Scope		Command
Name	Description	Name	Description
agent	Manages agents and agent managers	activate	Activates one or more Foglight agent instances
		clients	Shows a list of Foglight agent manager instances
		clientupgrade	Upgrades one or more remote instances of the Foglight Agent Manager
		create	Creates one or more Foglight agent instances
		deactivate	Deactivates one or more Foglight agents
		delete	Deletes one or more Foglight agent instances
		deploy	Deploys one or more Foglight agent packages
		getlog	Retrieves a copy of an agent log file
		list	Shows a list of Foglight agent instances
		logs	Shows a list of agent log files
		packages	Shows a list of available agent packages
		setschedule	Assigns a blackout schedule to one or more Foglight agent instances
		showschedule	Shows the blackout schedule assigned to one or more Foglight agent instances.
		start	Starts the data collection for one or more Foglight agent instances
		stop	Stops the data collection for one or more Foglight agent instances
		types	Shows a list of Foglight agent types sorted by agent manager ID
cartridge	Manages cartridges	disable	Deactivates a Foglight cartridge
		enable	Activates an installed Foglight cartridge
		install	Installs a cartridge on the Foglight Management Server
		list	Lists all installed Foglight cartridges
		uninstall	Uninstalls a Foglight cartridge
license	Manages licenses	import	Installs a Foglight license
		list	Shows a list of installed Foglight licenses
		remove	Removes a Foglight license using the license serial number
schedule	Lists schedules	list	Shows a list of all Foglight schedules
script	Runs scripts	run	Runs a script
security	Manages users and groups	assigngroup	Adds or removes a user from a group
		assignrole	Adds or removes a role from a group
		creategroup	Creates a group
		createuser	Creates a user
		deletegroup	Deletes a group
		deleteuser	Deletes a user
		exportldapcfg	Exports the LDAP settings to an XML file
		importldapcfg	Imports the LDAP settings from an XML file
		list	Lists users, groups, and roles
support	Creates support bundles	bundle	Generates a support bundle file
topology	Lists and assigns blackout schedules	blackoutobject	Assigns a blackout schedule
topology	Lists and assigns blackout schedules	blackouts	Lists the blackout schedules assigned to topology objects
util	Contains utility commands	configexport	Exports the monitoring policy to an XML file
		configimport	Imports the monitoring policy from an XML file
		env	Outputs the values of server configuration parameters
		metricexport	Exports metric observations to a file using a metric query
		topologyexport	Exports the value of one or more properties of a topology object to an XML file
		uiexport	Exports a UI module to a ZIP file
		uiimport	Imports a UI module from a ZIP file
		uilist	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.

To list administrative commands:


	NOTE: This procedure continues from Getting Started with Foglight Commands .

•

At the command prompt, use the following syntax to list Foglight commands:

fglcmd connection_options -cmd commands

For complete information about the fglcmd command syntax, see Syntax in fglcmd .

For example:

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:

agent:

activate Activates an agent.

clients Shows a list of known clients.

clientupgrade Upgrades a remote client.

create Creates an instance of an agent.

deactivate Deactivates an agent.

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

See also

•

Managing Agents, Cartridges, and Metrics

•

Getting Started with Administrative Commands