Chat now with support
Chat with Support

Foglight for Virtualization Enterprise Edition 8.9 - Command-Line Reference Guide

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

start

The start command initiates data collection for one or more Foglight agent instances.

To create an agent instance that collects data, you first create the agent instance, activate it, and then start the data collection for that agent instance. Similarly, when you want to remove an agent instance, use a reverse order of actions: first stop the agent instance, deactivate it, and then delete it.

You should issue this command after creating and/or activating an agent instance. For information on how to activate agent instances using the fglcmd interface, see activate .

fglcmd connection_options -cmd agent:start {-agentid agent_ID|-name agent_name|
-namespace agent_namespace|-all} [-host host_name] [-adapter adapter_ID]
[-type agent_type] [-deletable {true|false}] [-datacollection {true|false}]
[-activatable {true|false}] [-active {true|false}] [-regex] [-force]
[-nowait]

activatable

true or false

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

active

true or false

Indicates whether to start 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 started.

all

None

Indicates that all agent instances should be started.

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 start Foglight agent instances that are (true) or are not collecting data (false).

deletable

true or false

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

force

None

In cases where multiple agents are selected, it

indicates that all selected agents should be started.

host

host_name

An explicit text string or a regular expression that specifies one or more host names.

name

agent_name

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

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.

nowait

None

Indicates that the command should not wait for the selected agents to finish processing before starting the selected Foglight agent instances.

regex

None

Interprets the 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:

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

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:start -host Host1 -active true -force

stop

The stop command terminates the data collection for one or more Foglight agent instances.

If you want to delete an agent instance, you first stop the agent’s data collection, deactivate it, and then delete the instance.

To delete an agent instance, a typical flow of actions requires you to first stop the agent’s data collection, deactivate it, and then delete the instance. However, the deactivate and delete commands that allow you to deactivate and delete agent instances, include options and arguments that let you override that flow and delete active agent instances that are collecting data without first stopping their data collection.

For information on how to start an agent’s data collection using the command line, see start .

fglcmd connection_options -cmd agent:stop {-agentid agent_ID|-name agent_name|
-namespace agent_namespace|-all} [-host host_name] [-adapter adapter_ID]
[-type agent_type] [-deletable {true|false}] [-datacollection {true|false}]
[-activatable {true|false}] [-active {true|false}] [-regex] [-force]
[-nowait]

activatable

true or false

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

active

true or false

Indicates whether to stop 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 stopped.

all

None

Indicates that all agent instances should be stopped.

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 stop Foglight agent instances that are (true) or are not collecting data (false).

deletable

true or false

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

force

None

In cases where multiple agents are selected, it indicates that all selected agents should be stopped.

host

host_name

An explicit text string or a regular expression that specifies one or more host names.

name

agent_name

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

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.

nowait

None

Indicates that the command should not wait for the selected agents to finish processing before stopping the selected Foglight agent instances.

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:

For more information about these agents, see the Foglight for Infrastructure User and Reference Guide.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:stop -agentid 15

Listing and Retrieving Log Files

The logs command shows a list of agent log files.

For information on how to retrieve a log file using the fglcmd interface, see getlog .

fglcmd connection_options -cmd agent:logs {-clientname display_name|-clientid
client_ID|-clientbuild build_ID|-clientversion version|-allclients}
[-host host_name] [-regex] [-force] [-upgradable {true|false}]

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 .

force

None

In cases where multiple client instances are selected, it indicates that all selected instances should be stopped.

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:logs -clientid Host1#be05acc0-6179-4878-a274-afcd5075260a
C:\Quest\Foglight\fglam\state\default\logs\HostAgents\5.9.x\

logs

The logs command shows a list of agent log files.

For information on how to retrieve a log file using the fglcmd interface, see getlog .

fglcmd connection_options -cmd agent:logs {-clientname display_name|-clientid
client_ID|-clientbuild build_ID|-clientversion version|-allclients}
[-host host_name] [-regex] [-force] [-upgradable {true|false}]

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 .

force

None

In cases where multiple client instances are selected, it indicates that all selected instances should be stopped.

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:logs -clientid Host1#be05acc0-6179-4878-a274-afcd5075260a
C:\Quest\Foglight\fglam\state\default\logs\HostAgents\5.9.x\
Related Documents