Foglight 5.9.2 - Command-Line Reference Guide

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.

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.

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.

TIP: Blackout periods do not interrupt the data collection for the object to which the blackout is assigned. Unlike topology object blackouts, agent blackouts prevent their data collection. For more information about agent blackouts, see Listing and Assigning Blackout Schedules to Agent Instances .

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.

TIP: To find out the names and IDs of the available schedules, prior to issuing topology:blackoutobject, you can use the schedule:list command. For more information, see Listing Schedules .