Chat now with support
与支持团队交流

Foglight 5.9.5 - Command-Line Reference Guide

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

About the Command-Line Interface

This Command-Line Reference Guide provides information about the Foglight® command-line interface. You can use Foglight commands to interface with different components of your monitoring environment instead of the browser interface.

This guide is intended for Foglight System Administrators who are new to Foglight can find information about syntax conventions along with an overview of all Foglight commands in the first chapter of this guide. The following chapters contain reference information about specific commands, such as the Foglight Management Server and Foglight Agent Manager commands. Advanced users can find information about the fglcmd interface in the last chapter. The last chapter contains information about the commands that provide administrative-level commands. Read this chapter to find out how to deploy and create agents, install and activate cartridges, manage licenses, and do many other administrative tasks from the command line.

This manual describes the commands that come with your Foglight installation and allow you to access different components in your monitoring environment without having to use the standard graphical interface such as the Administration dashboards. This can be useful in situations when you need to either automate your business logic by writing scripts, or use regular expressions to select multiple entities where applicable.

This manual employs a set of conventions that are used in the command syntax. You should review them before getting started with the manual in order to successfully make use of Foglight commands in your monitoring environment. The syntax conventions are as follows:

<foglight_home> is a placeholder that represents the path to the Foglight Management Server installation.
<foglight_agent_mgr_home> is a placeholder that represents the path to the Foglight Agent Manager installation. This can be the location of the Foglight Agent Manager installation on a monitored host, or the home directory of the Foglight Agent Manager that comes embedded with the Foglight Management Server. For example:

Looking at Foglight Commands

Foglight provides a number of commands that you can use to manage different components in your monitoring environment. The commands reside in the following directories of your Foglight Agent Manager or Foglight Management Server installation.

<foglight_home>/bin: Contains commands that manage the Foglight Management Server and administer agents, cartridges, metrics, and other entities. For more information about these commands, see Managing the Foglight Management Server and Managing Agents, Cartridges, and Metrics .
<foglight_home>/tools: Contains the Remote Monitor utility as well as the administrative commands in ZIP files. For more information about the Remote Monitor, see the Foglight Installation and Setup Guide; for information on the Remote Monitor command syntax, see remotemonitor .
<foglight_agent_mgr_home>/bin: Contains commands that manage the Foglight Agent Manager. For more information, see Managing the Foglight Agent Manager .

For more information about the <foglight_home> and <foglight_agent_mgr_home> placeholders, see Syntax Conventions .

The following table lists Foglight commands.

fms

Provides command-line interface to the Foglight Management Server process

fmsha

Provides command-line interface to the Foglight Management Server process running in High Availability (HA) mode

remotemonitor

Provides command-line interface to the Remote Monitor application

foglight_db_upgrade

Verifies the database version and upgrades it to a higher version if necessary

runDB

Starts the embedded database

shutdownDB

Stops the embedded database

keyman

Provides an interface that lets you change, add, or delete encryption keys, or generate application tokens

fglam

Provides command-line interface to the Foglight Agent Manager

support-bundle

Generates Agent Manager support bundles

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

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

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

import

Installs a Foglight license

list

Shows a list of installed Foglight licenses

remove

Removes a Foglight license using the license serial number

blackoutobject

Assigns a blackout schedule to topology objects

blackouts

Lists the blackout schedules assigned to topology objects

bundle

Generates a support bundle file

configexport

Exports the monitoring policy to an XML file

configimport

Imports the monitoring policy

env

Outputs the values of server configuration parameters

metricexport

Exports metric observations to a file using a metric query

list

Shows a list of all Foglight schedules

run

Runs a script

topologyexport

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

uiexport

Exports a UI module into a ZIP file

uiimport

Imports a UI module from a ZIP file

uilist

Shows a list of deployed UI modules

Getting Started with Foglight Commands

NOTE: These instructions describe a simple configuration in which the Foglight Management Server and the Foglight Agent Manager are installed on the same platform.
3
Ensure that your JAVA_HOME system variable points to the location of JRE that comes with Foglight. For more information about the JRE version, see the appropriate Installation and Setup Guide.
For example, on Windows® platforms, you can start the Foglight Management Server by choosing Start > Programs > Quest > Foglight 5.9.x > Start Foglight.
To start the Foglight Agent Manager, issue the fglam command. The fglam command can found in the <foglight_agent_mgr_home>/bin directory. For complete information about the fglam command, see fglam .
<foglight_home>/logs/ManagementServer_date_time_file_ID.log
<foglight_agent_mgr_home>/state/default/logs/FglAM_date_time_file_ID.log
date and time are the date and time the Foglight Management Server or Foglight Agent Manager were started
file_ID identifies the log file
For information about foglight_home and foglight_agent_mgr_home, see Syntax Conventions .
b
If you do not find any indicators as to why the agent is not collecting data, refer to the Release Notes and Administration and Configuration Help for more information.

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

Managing the Foglight Management Server

Foglight offers a set of commands that allow you to perform server-related operations through the command-line interface. You can use these commands to perform a variety of tasks, such as start or stop the Foglight Management Server, run or upgrade the database, or manage encryption keys.

The majority of server-specific commands access the server directly. As such, you can only issue them on the computer that is running an instance of the Foglight Management Server. One exception is the Remote Monitor utility that you can use to communicates with multiple instances of the Foglight Management Server running in High Availability (HA) mode. For more information about running the Foglight Management Server running in HA mode, see fmsha .

Your Foglight installation includes a compressed file, <foglight_home>/tools/remotemonitor.zip, that contains the Remote Monitor utility. If required, you can extract the contents of that file to a remote computer in your Foglight network and run the Remote Monitor utility from that computer, as described in To get started with Foglight Management Server commands: . For information about the location of foglight_home, see Syntax Conventions .

自助服务工具
知识库
通知和警报
产品支持
下载软件
技术说明文件
用户论坛
视频教程
联系我们
获得许可 帮助
技术支持
查看全部
相关文档