Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Foglight 5.9.1 - Command-Line Reference Guide

Table of Contents

About the Command-Line Interface

Looking at Foglight Commands Getting Started with Foglight Commands

Managing the Foglight Management Server

Getting Started Running the Server in Stand-Alone Mode

fms

Running the Server in High Availability Mode

fmsha remotemonitor

See also

Starting the Embedded Database

runDB

Stopping the Embedded Database

shutdownDB

Upgrading the Database

foglight_db_upgrade

Managing Encryption Keys

keyman

Managing the Foglight Agent Manager

Getting Started Starting or Stopping the Foglight Agent Manager

fglam

Creating Agent Manager Support Bundles

Managing Agents, Cartridges, and Metrics

Understanding the Command-Line Syntax About Regular Expressions Getting Started with Administrative Commands

Running Administrative Commands: Example

Looking at Scope-Specific Commands

Listing Administrative Commands

Logging In and Setting the Scope

fglcmd

Using a Properties File to Supply Connection Information

File name and location

Listing Agent and Agent Manager Instances

clients list packages types

Upgrading the Foglight Agent Manager

clientupgrade

Deploying Agent Packages

deploy

Creating or Deleting Agent Instances

Activating or Deactivating Agent Instances

activate deactivate

Starting or Stopping Data Collection

Listing and Retrieving Log Files

Listing and Assigning Blackout Schedules to Agent Instances

showschedule setschedule

Installing or Uninstalling Cartridges

install uninstall

Enabling or Disabling Cartridges

Listing Cartridges

list

Managing Security Entities

assigngroup assignrole creategroup createuser deletegroup deleteuser exportldapcfg importldapcfg list

Managing Foglight Licenses

import list remove

Exporting or Importing a Monitoring Policy

configexport configimport

Exporting, Importing, or Listing UI Modules

uiexport uiimport uilist

Exporting Metrics and Topology

metricexport topologyexport

Looking Up Server Parameters

env

Listing and Assigning Blackout Schedules to Topology Objects

blackoutobject blackouts

Listing Schedules

list

Running Scripts

run

Creating Server Support Bundles

bundle

types

The types command shows a list of Foglight™ agent types that are available for deployment to individual Agent Managers, sorted by the Agent Manager ID.

fglcmd connection_options -cmd agent:types [-regex] [-host host_name]

[-clientname display_name] [-clientid client_ID] [-clientbuild build_ID]

[-clientversion version] [-allclients] [-upgradable {true|false}]

Table 9. Options and arguments
Option	Argument	Description
allclients	None	Indicates that all instances of the Foglight Agent Manager should be selected.
clientbuild	build_ID	An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified build ID.
clientid	client_ID	An explicit text string or a regular expression that identifies one or more instances of the Foglight Agent Manager.
clientname	display_name	An explicit text string or a regular expression that specifies one or more display devices that are running an instance of the Foglight Agent Manager.
clientversion	version	An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified version.
connection_options		Specifies the user name and password for the Foglight Management Server, as well as the machine name and port number, if necessary. Alternatively, fglcmd can retrieve this information from a user-specific properties file. For more information on how to specify connection options on the command line, see Logging In and Setting the Scope . For details on using a properties file, see Using a Properties File to Supply Connection Information .
host	host_name	An explicit text string or a regular expression that specifies one or more host names.
regex	None	Interprets the build_ID, client_ID, display_name, host_name, version, or upgradable arguments as regular expressions. For a sample regular expression used to specify a host name, see Example .
upgradable	true or false	Indicates whether one or more Foglight Agent Manager instances can (true) or cannot be upgraded (false). It can be set to a regular expression.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight

-cmd agent:types -clientname host1.example.com

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

Client Name: Host1

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

•

•

•

Upgrading the Foglight Agent Manager

The clientupgrade command can be used to upgrade one or more remote instances of the Foglight™ Agent Manager.

fglcmd connection_options -cmd agent:clientupgrade {-clientname display_name|-

clientid client_ID|-clientbuild build_ID|-clientversion version|-allclients}

[-host host_name] {{-to version [-tobuild build_id] [-regex]

[-timeout seconds] [-force]}|-list} [-upgradable {true|false}]}|

Table 10. Options and arguments
Option	Argument	Description
allclients	None	Indicates that all instances of the Foglight Agent Manager should be selected.
clientbuild	build_ID	An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified build ID.
clientid	client_ID	An explicit text string or a regular expression that identifies one or more display devices that are running an instance of the Foglight Agent Manager.
clientname	display_name	An explicit text string or a regular expression that specifies the name of one or more display devices that are running an instance of the Foglight Agent Manager.
clientversion	version	An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified version.
connection_options		Specifies the user name and password for the Foglight Management Server, as well as the machine name and port number, if necessary. Alternatively, fglcmd can retrieve this information from a user-specific properties file. For more information on how to specify connection options on the command line, see Logging In and Setting the Scope . For details on using a properties file, see Using a Properties File to Supply Connection Information .
force	None	In cases where multiple agents are selected, it indicates that the command should be performed against all selected agent installers and packages.
host	host_name	An explicit text string or a regular expression that specifies one or more host names.
list	None	Lists available upgrade versions.
regex	None	Interprets the architecture, build_ID, client_ID, display_name, host_name, name, OS_architecture, OS_name, OS_version, package_ID, pkg_OS_name, pkg_OS_version, version, or upgradable arguments as regular expressions. For a sample regular expression used to specify a host name, see Example .
timeout	seconds	Specifies the maximum time in seconds for the timeout period. If the timeout i not specified or is set to zero '0', the command waits for the upgrade to complete.
tobuild	build_ID	Specifies the build number to which the selected instances of the Foglight Agent Manager should be upgraded.
toversion	version	Specifies the version to which the selected instances of the Foglight Agent Manager should be upgraded.
upgradable	true or false	Indicates whether one or more Foglight Agent Manager instances can (true) or cannot be upgraded (false). It can be set to a regular expression.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight

-cmd agent:clientupgrade -list -allclients -upgradable true

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

Client Name: Host1

Client Version: 5.6.2.2 (5622-20111116-1616-b30)

Upgradable: true

No upgrades are available for this client at this moment

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

Client Name: Host2.example.com

Client Version: 5.6.2.2 (5622-20111115-1816-b29)

Upgradable: true

No upgrades are available for this client at this moment

clientupgrade

Upgrading the Foglight Agent Manager

The clientupgrade command can be used to upgrade one or more remote instances of the Foglight™ Agent Manager.

fglcmd connection_options -cmd agent:clientupgrade {-clientname display_name|-

clientid client_ID|-clientbuild build_ID|-clientversion version|-allclients}

[-host host_name] {{-to version [-tobuild build_id] [-regex]

[-timeout seconds] [-force]}|-list} [-upgradable {true|false}]}|

Table 10. Options and arguments
Option	Argument	Description
allclients	None	Indicates that all instances of the Foglight Agent Manager should be selected.
clientbuild	build_ID	An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified build ID.
clientid	client_ID	An explicit text string or a regular expression that identifies one or more display devices that are running an instance of the Foglight Agent Manager.
clientname	display_name	An explicit text string or a regular expression that specifies the name of one or more display devices that are running an instance of the Foglight Agent Manager.
clientversion	version	An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified version.
connection_options		Specifies the user name and password for the Foglight Management Server, as well as the machine name and port number, if necessary. Alternatively, fglcmd can retrieve this information from a user-specific properties file. For more information on how to specify connection options on the command line, see Logging In and Setting the Scope . For details on using a properties file, see Using a Properties File to Supply Connection Information .
force	None	In cases where multiple agents are selected, it indicates that the command should be performed against all selected agent installers and packages.
host	host_name	An explicit text string or a regular expression that specifies one or more host names.
list	None	Lists available upgrade versions.
regex	None	Interprets the architecture, build_ID, client_ID, display_name, host_name, name, OS_architecture, OS_name, OS_version, package_ID, pkg_OS_name, pkg_OS_version, version, or upgradable arguments as regular expressions. For a sample regular expression used to specify a host name, see Example .
timeout	seconds	Specifies the maximum time in seconds for the timeout period. If the timeout i not specified or is set to zero '0', the command waits for the upgrade to complete.
tobuild	build_ID	Specifies the build number to which the selected instances of the Foglight Agent Manager should be upgraded.
toversion	version	Specifies the version to which the selected instances of the Foglight Agent Manager should be upgraded.
upgradable	true or false	Indicates whether one or more Foglight Agent Manager instances can (true) or cannot be upgraded (false). It can be set to a regular expression.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight

-cmd agent:clientupgrade -list -allclients -upgradable true

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

Client Name: Host1

Client Version: 5.6.2.2 (5622-20111116-1616-b30)

Upgradable: true

No upgrades are available for this client at this moment

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

Client Name: Host2.example.com

Client Version: 5.6.2.2 (5622-20111115-1816-b29)

Upgradable: true

No upgrades are available for this client at this moment

Deploying Agent Packages

The deploy command deploys one or more Foglight™ agent packages.

In most cases, Foglight cartridges include one or more agent packages that are used to collect metrics from monitored hosts. You can deploy an agent package after installing the cartridge that includes that agent package on the Foglight Management Server. For information on how to install a cartridge using the fglcmd interface, see install ; to find out how to list available agent packages using fglcmd, see packages .

fglcmd connection_options -cmd agent:deploy {-packageversion version|-packageid

"package_ID"|-allpackages|-allinstallers} {-host host_name|-clientname

display_name|-clientid client_ID|-clientbuild build_ID|-clientversion

version|-allclients} [-packageos pkg_OS_name]

[-packageosversion pkg_OS_version] [-packagearch OS_architecture]

[-osversion OS_version] [-osname OS_name] [-arch architecture]

[-installerid agent_installer_ID] [-installername agent_installer_name]

[-regex] [-test] [-disable_platform_check] [-force]

[-upgradable {true|false}]

Table 11. Options and arguments
Option	Argument	Description
allclients	None	Indicates that all instances of the Foglight Agent Manager should be selected.
allinstallers	None	Indicates that all agent installers should be selected.
allpackages	None	Indicates that all agent packages should be deployed.
arch	architecture	An explicit text string or a regular expression that specifies one or more platform architectures.
clientbuild	build_ID	An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified build ID.
clientid	client_ID	An explicit text string or a regular expression that identifies one or more display devices that are running an instance of the Foglight Agent Manager.
clientname	display_name	An explicit text string or a regular expression that specifies the name of one or more display devices that are running an instance of the Foglight Agent Manager.
clientversion	version	An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified version.
connection_options		Specifies the user name and password for the Foglight Management Server, as well as the machine name and port number, if necessary. Alternatively, fglcmd can retrieve this information from a user-specific properties file. For more information on how to specify connection options on the command line, see Logging In and Setting the Scope . For details on using a properties file, see Using a Properties File to Supply Connection Information .
disable_platform_check	None	Disables automatic filtering of agent packages based on platform information provided by agent installers.
force	None	In cases where multiple agents are selected, it indicates that the command should be performed against all selected agent installers and packages.
host	host_name	An explicit text string or a regular expression that specifies one or more host names.
installerid	agent_installer_ID	Selects the agent installer with the specified ID.
installername	name	An explicit text string or a regular expression that selects one or more agent installers based on the specified name.
osname	OS_name	An explicit text string or a regular expression that specifies the name of one or more operating systems with which the agent packages are compatible
osversion	OS_version	An explicit text string or a regular expression that specifies one or more operating system versions the agent packages are compatible with.
packagearch	OS_architecture	An explicit text string or a regular expression that specifies one or more operating system architectures the agent packages are compatible with.
packageid	package_ID	An explicit text string or a regular expression that identifies one or more agent packages that are to be deployed. NOTE: This value must be enclosed in quotation marks, as indicated in the command syntax.
packageos	pkg_OS_name	An explicit text string or a regular expression that specifies the name of one or more operating systems of the agent packages that are to be deployed.
packageosversion	pkg_OS_version	An explicit text string or a regular expression that specifies one or more operating system versions of the agent packages that are to be deployed.
packageversion	version	An explicit text string or a regular expression that specifies one or more versions of the agent packages that are to be deployed.
regex	None	Interprets the architecture, build_ID, client_ID, display_name, host_name, name, OS_architecture, OS_name, OS_version, package_ID, pkg_OS_name, pkg_OS_version, version, or upgradable arguments as regular expressions. For a sample regular expression used to specify a host name, see Example .
test	None	Issues the command in test mode without deploying any agents.
upgradable	true or false	Indicates whether one or more Foglight Agent Manager instances can (true) or cannot be upgraded (false). It can be set to a regular expression.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd

agent:deploy -host Host1 -clientid Host1#be05acc0-6179-4878-a274-afcd5075260a

-packageid HostAgents-5.7.5.8-Host Agents

Successfully installed agent package "HostAgents-5.7.5.8-Host Agents" on

"Host1#be05acc0-6179-4878-a274-afcd5075260a#FglAM:Host1/be05acc0-6179-4878-

a274-afcd5075260a/installer".

•

•

•

•

•

•

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center