Foglight 6.1.0 - Command-Line Reference Guide

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 .

Scope

agent

Syntax

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}]

Table 19. 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 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.

Example

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\6.1.0\WindowsAgent\Monitor@Host1_2011- 11-21_151519_001.log -f AgentA.log


	NOTE: If successful, this command does not generate any output.

See also

•

logs

Listing and Assigning Blackout Schedules to Agent Instances

This describes the following commands:

•

showschedule

•

setschedule

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.


	TIP: Blackout periods prevent the data collection for the agent instance to which the blackout is assigned. Unlike agent blackouts, topology object blackouts prevent any rules from analyzing that object, without interrupting their data collection. For more information about topology object blackouts, see Listing and Assigning Blackout Schedules to Agent Instances .

Scope

agent

Syntax

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]

Table 20. Options and arguments

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 .

NOTE: On Unix systems, enclose the regular expression in quotation marks. Failing to do so can produce unpredictable results. On Windows, the quotation marks are optional.

type

agent_type

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

•

WindowsAgent

•

UnixAgent

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

Example

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:showschedule -active true

Status: Active/Collecting data

Blackout Schedules:

[none]

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

ID: 5

Host: Host2.example.com

Name: Monitor@Host2.example.com

Type: WindowsAgent

Status: Active/Not collecting data

Blackout Schedules:

Nov 21, 2011 5:17:00 PM - Nov 22, 2011 6:17:00 PM (id: 05915e12-07a5-452

a-9d14-27b84bf45960) [in effect at the moment]

Nov 21, 2011 5:17:00 PM - Nov 22, 2011 6:17:00 PM (id: 3734e17a-7201-429

c-9468-1af63b413e53) [in effect at the moment]

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

See also

•

setschedule

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


	TIP: Blackout periods prevent the data collection for the agent instance to which the blackout is assigned. Unlike agent blackouts, topology object blackouts prevent any rules from analyzing that object, without interrupting their data collection. For more information about topology object blackouts, see Listing and Assigning Blackout Schedules to Agent Instances .

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


	CAUTION: In addition to the features provided by the agent:setschedule fglcmd command, agent blackouts can also be configured using the Blackout Configuration dashboard in the browser interface. However, the mechanism for creating blackouts using this other method is independent. It is not recommended to use both methods on the same Foglight Management Server. If you choose to use the command line for creating blackouts, delete all blackouts created with the Blackout Configuration dashboard before using the command line. If you want to switch from the command line to the Blackout Configuration dashboard, use the conversion script to convert the existing blackouts created with the command line. This way all blackouts can be managed in one location. For more information about the conversion script, see the Foglight Upgrade Guide.