Foglight 6.0.0 - Command-Line Reference Guide

Table 6. Options and arguments
Option	Argument	Description
allclients	None	Indicates that all instances of the Foglight Agent Manager should be listed.
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 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 .
host	host_name	An explicit text string or a regular expression that specifies the name of one or more hosts that are running an instance of the Foglight Agent Manager.
regex	None	Interprets the client_ID, diplay_name, host_name, or upgradable arguments as regular expressions. For a sample regular expression used to specify a host name, see the 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.

Example

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:clients -host ".*.corp" -regex

Client ID: host1.example.com#32b1c51d-6208-435c-bdad-2a8916ef3a89

Client Name: host1.example.com

Adapter ID: FglAM

Client Version: 6.0.0 (6.0.0-5/20/210811-0230)

Host Name: host1.example.com

OS: windows 5.1 (ia32)

For complete information about the regular expression syntax, see About Regular Expressions .

•

•

•

clients

Listing Agent and Agent Manager Instances

The clients command shows a list of Foglight Agent Manager instances.

Scope

agent

Syntax

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

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

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

Table 6. Options and arguments
Option	Argument	Description
allclients	None	Indicates that all instances of the Foglight Agent Manager should be listed.
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 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 .
host	host_name	An explicit text string or a regular expression that specifies the name of one or more hosts that are running an instance of the Foglight Agent Manager.
regex	None	Interprets the client_ID, diplay_name, host_name, or upgradable arguments as regular expressions. For a sample regular expression used to specify a host name, see the 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.

Example

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:clients -host ".*.corp" -regex

Client ID: host1.example.com#32b1c51d-6208-435c-bdad-2a8916ef3a89

Client Name: host1.example.com

Adapter ID: FglAM

Client Version: 6.0.0 (6.0.0-5/20/210811-0230)

Host Name: host1.example.com

OS: windows 5.1 (ia32)

For complete information about the regular expression syntax, see About Regular Expressions .

•

•

•

list

The list command shows a list of Foglight agent instances.

Scope

agent

Syntax

fglcmd connection_options -cmd agent:list [-agentid agent_ID] [-regex]

[-adapter adapter_ID] [-host host_name] [-deletable {true|false}]

[-name agent_name] [-namespace agent_namespace]

[-datacollection {true|false}] [-all] [-type agent_type]

[-activatable {true|false}] [-active {true|false}]

Table 7. Options and arguments

true or false

Indicates whether to list agent instances that can (true) or cannot be activated (false).

active

true or false

Indicates whether to list agent instances that are active (true) or inactive (false).

adapter

adapter_ID

An explicit text string or a regular expression that identifies one or more Foglight™ adapters.

agentid

agent_ID

Identifies an instance of a Foglight agent that is to be listed.

all

None

Indicates that all agent instances should be listed.

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 .

datacollection

true or false

Indicates whether to list Foglight agent instances for which the data collection is (true) or is not enabled (false).

deletable

true or false

Indicates whether to list Foglight agent instances that can (true) or cannot be deleted (false).

host

host_name

An explicit text string or a regular expression that specifies the name of one or more hosts that are running an instance of a Foglight agent.

name

agent_name

An explicit text string or a regular expression that specifies the name of one or more Foglight agent instances that are to be listed.

namespace

agent_namespace

An explicit text string or a regular expression that specifies the name of one or more Foglight agent instances in the specified name space.

regex

None

Interprets the adapter_ID, agent_name, agent_namespace, agent_type, or host_name arguments as regular expressions.

For a sample regular expression used to specify a host name, see Example .

type

agent_type

An explicit text string or a regular expression that specifies one or more Foglight agent types.

The selection of available agent types depends on the collection of deployed cartridges. For example, a basic Foglight Management Server installation that includes the Cartridge for Infrastructure can two different agent types:

•

WindowsAgent

•

UnixAgent

For more information about these agents, see the Managing the Infrastructure Cartridge User and Reference Guide.

Example

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

-cmd agent:list -host Host1 -active true

Version: 6.0.0 (Build: 6.0.0-20111116-1426-b43)

Adapter ID: FglAM

Status: Active/Collecting data

Health State: OK

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

•

•

•

packages

The packages command shows a list of available agent packages.

Scope

agent

Syntax

fglcmd connection_options -cmd agent:packages [-packageosversion OS_version]

[-regex] [-host host_name] [-clientname display_name]

[-packageversion version] [-arch architecture] [-packageid "pkg_ID"]

[-allclients] [-allpackages] [-allinstallers] [-osversion OS_version]

[-packagearch OS_architecture] [-clientid client_ID] [-clientbuild build_ID]

[-clientversion client_version] [-packageos OS_name] [-osname OS_name]

[-installername name] [-upgradable {true|false}] [-disable_platform_check]

Table 8. 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 listed.
arch	architecture	An explicit text string or a regular expression that specifies the platform architecture.
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	client_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.
host	host_name	An explicit text string or a regular expression that specifies one or more host names.
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 the version of one or more operating systems with which the agent packages are compatible.
packagearch	OS_architecture	An explicit text string or a regular expression that specifies one or more operating system architectures with which the agent packages are compatible.
packageid	pkg_ID	An explicit text string or a regular expression that identifies one or more packages. 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 selected.
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 selected.
packageversion	version	An explicit text string or a regular expression that specifies one or more package versions.
regex	None	Interprets the architecture, build_ID, client_ID, client_version, display_name, host_name, name, OS_architecture, OS_name, OS_version, pkg_ID, pkg_OS_name, pkg_OS_version, version, or upgradable arguments as regular expressions. For a sample regular expression, 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.