Chat now with support
Chat with Support

Foglight 7.1.0 - Command-Line Reference Guide

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

getlog

The getlog command retrieves a copy of an agent’s log file. This command is useful in situations when you do not have access to the installation directory of the Foglight Management Server.

For information on how to get a list of log files using the fglcmd interface, see logs .

fglcmd connection_options -cmd agent:getlog -log log_file_name -f file_path
[-host host_name] [-clientname display_name] [-clientid client_ID]
[-clientbuild build_ID] [-clientversion version] [-allclients] [-regex]
[-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 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 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 .

f

file_path

Specifies the path and name of the destination file.

host

host_name

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

log

log_file_name

Specifies the path and name of the log file that is to be retrieved.

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:getlog -clientid Host1#be05acc0-6179-4878-a274-afcd5075260a -log ..fglam\state\default\logs\HostAgents\7.1.0\WindowsAgent\Monitor@Host1_2011- 11-21_151519_001.log -f AgentA.log

Listing and Assigning Blackout Schedules to Agent Instances

This describes the following commands:

These commands allow you to assign blackout periods to agent instances, and to list them, as required. An agent blackout is a scheduled event during which the agent does not collect data for set intervals. Blackout periods can also be assigned to topology objects. However, unlike agent blackouts, topology object blackouts do not interrupt the data collection for the object to which the blackout is assigned. Blacking out a topology object simply means that no rules analyze that object for the duration of the blackout.

For more information about the commands for assigning blackouts to agent instances, and listing them, as required, see Listing and Assigning Blackout Schedules to Topology Objects .

showschedule

The showchedule command shows the blackout schedule assigned to one or more Foglight agent instances.

fglcmd connection_options -cmd agent:showschedule {-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]

activatable

true or false

Indicates whether to select agent instances that can (true) or cannot be deactivated (false).

active

true or false

Indicates whether to select 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 whose blackout schedule is to be set.

all

None

Indicates that all agent instances should be selected.

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

deletable

true or false

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

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 one or more Foglight agents whose blackout schedule is to be set.

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:

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:showschedule -active true

setschedule

The setschedule command assigns a blackout schedule to one or more Foglight agent instances.

For information on how to get a list of blackout schedules assigned to agent instances files using the fglcmd interface, see showschedule .

fglcmd connection_options -cmd agent:setschedule {-agentid agent_ID|-name
agent_name|-namespace agent_namespace|-all} {-schedulename schedule_name|
-scheduleid schedule_ID -none [-remove]} [-host host_name]
[-adapter adapter_ID] [-type agent_type] [-deletable {true|false}]
[-datacollection {true|false}] [-activatable {true|false}]
[-active {true|false}] [-regex] [-force]

activatable

true or false

Indicates whether to select agent instances that can (true) or cannot be deactivated (false).

active

true or false

Indicates whether to select 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 whose blackout schedule is to be set.

all

None

Indicates that all agent instances should be selected.

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

deletable

true or false

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

force

None

In cases where multiple agents are selected, it indicates that the command should be performed against all selected agent instances.

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 one or more Foglight agents whose blackout schedule is to be set.

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.

none

None

Dissociates all schedules from one more selected 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 .

remove

None

Indicates that the specified schedule should be removed from one or more selected agent instances.

scheduleid

schedule_ID

Identifies a schedule that is to be assigned to one or more Foglight agent instances.

schedulename

schedule_name

Specifies a schedule name. You can use any of the following values:

NOTE: If you choose a schedule name that contains spaces, such as Start Of Day, enclose it in quotation marks.

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 Operating Systems can offer a number of different agent types. 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:setschedule -agentid 10 -schedulename "Start of Day"
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating