Chat now with support
Chat with Support

Foglight 5.9.5 - Command-Line Reference Guide

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

Looking Up Server Parameters

The env command shows the values of server configuration parameters. The parameters are specified in <foglight_home>/config/server.config. You can output the values of all configuration parameters, or use an option to specify a single parameter.

fglcmd connection_options -cmd util:env [-n parameter_name]

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 .

n

parameter_name

Specifies the name of the parameter whose value is to be retrieved. If you do not provide a parameter name, the command lists all of the configuration parameters.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd util:env -n foglight.database.port

env

The env command shows the values of server configuration parameters. The parameters are specified in <foglight_home>/config/server.config. You can output the values of all configuration parameters, or use an option to specify a single parameter.

fglcmd connection_options -cmd util:env [-n parameter_name]

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 .

n

parameter_name

Specifies the name of the parameter whose value is to be retrieved. If you do not provide a parameter name, the command lists all of the configuration parameters.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd util:env -n foglight.database.port

Listing and Assigning Blackout Schedules to Topology Objects

This describes the following commands:

These commands allow you to assign blackout periods to topology object instances, and to list them, as required. A topology object blackout is a scheduled event during which no rules analyze that object for the duration of the blackout. Topology object blackouts do not interrupt the data collection for the object to which the blackout is assigned. Blackout periods can also be assigned to agent instances. However, unlike topology object blackouts, agent blackouts prevent their data collection.

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

blackoutobject

The blackoutobject command assigns a blackout schedule to topology objects. A blackout schedule defines the periods of time during which no alarms are raised for a specified object instance. The command uses either the schedule name or its ID to assign one or more topology objects that are specified either by their IDs, or a topology query. Blacking out a topology object means that no rules analyze that object for the duration of the blackout.

This command can make use of topology queries to retrieve one or more object instances which allows you to automate blackouts (for example, cron-driven changes in blackout policies). For complete information on how to write a topology query, see the Administration and Configuration Help.

CAUTION: In addition to the features provided by the topology:blackoutobject fglcmd command, topology 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.
fglcmd connection_options -cmd topology:blackoutobject {-object object_ID | -query "topology_query"} [-remove] {-schedule schedule_ID | -schedulename schedule_name} [-inheritable] [-clear]

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 .

clear

None

Instructs Foglight to remove any schedules associated with one or more specified topology objects.

inheritable

None

Indicates that the blackout schedule you are about to assign to the selected topology object also applies to the descendents of those objects.

object

object_ID

Identifies the topology object.

query

topology_query

Contains the topology query that selects one or more topology objects. Typically, a topology query uses topology types and object names as parameters to retrieve one or more object instances. To find out more about the syntax for writing queries, see the Administration and Configuration Help.

NOTE: The query must be enclosed in quotation marks. Failing to do so can produce unexpected results.

Additionally, on Unix platforms, for query expressions that select objects of the
Host type and start with an exclamation mark ‘!’, the exclamation mark must be escaped with a back slash ‘\’. For example:

Unix
"\!Host where name like 'host1%'"

Windows
"!Host where name like 'host1'"

remove

None

Indicates that the specified schedule should be removed from one or more specified objects.

schedule

schedule_ID

Identifies the blackout schedule. To find out the ID for a schedule, use the list command. For more information, see list .

schedulename

schedule_name

Specifies the schedule name.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd topology:blackoutobject -query "Host where name ='host1.example.com'" -schedulename Always
Related Documents