Chat now with support
Chat with Support

Foglight 5.9.1 - Command-Line Reference Guide

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

blackouts

The blackouts command lists all blackouts currently assigned to topology objects. A blackout schedule defines the periods of time during which no alarms are raised for a specified object instance.

 
* 
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 .

Blackout schedules can be assigned to object instances using the blackoutobject command (see page 104).

Scope
topology
Syntax
fglcmd connection_options -cmd topology:blackouts [-query "topology_query"]
 
Table 49. Options and arguments
Option
Argument
Description

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 .

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'"
Example
C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight
-cmd topology:blackouts -query "Host where name =
'host1.example.com'"
Blackouts for objects:
d48afea1-7294-46e4-bcec-d486d20021be: Host: host1.example.com, Always
 
* 
TIP: To find out the names and IDs of the available schedules, you can issue the schedule:list command. For more information, see Listing Schedules .
See also
•
blackoutobject
•
list

Listing Schedules

list

The list command generates a list of all Foglight schedules.

Scope
schedule
Syntax
fglcmd connection_options -cmd schedule:list
 
Table 50. Options and arguments
Option
Argument
Description

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 .

Example
C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight
-cmd schedule:list
 
ID: 259833b6-d7b0-4b27-a5c4-e2e612cbf77a
Name: Frequent [Test]
Description: A schedule that runs very frequently. Primarily
used for testing.This schedule is used to trigger an activity.
As a result it does not have a significant duration.
------------------------------------
ID: 30afa315-3131-48c2-b0e8-71fea187af4e
Name: Always
Description: A schedule that includes all the time
------------------------------------
ID: 013f57d1-1e7e-4098-a7a5-2b2763364cb5
Name: First day of week
Description: Whole days Monday
------------------------------------
ID: 004c98d4-c278-4af2-81f7-4264fd30003f
Name: Daily Database Maintenance
Description: Schedule on which daily operations to rollup and
purge information in the database are performed. This schedule
is used to trigger an activity. As a result it does not have
a significant duration.
------------------------------------
ID: d7619930-807e-406e-9e6e-15ec30edc23c
Name: End of Day
Description: A schedule that runs at the end of the day. This
schedule is used to trigger an activity. As a result it does
not have a significant duration.
------------------------------------
ID: 46fc602a-8931-4907-a93b-e1c16c0fdbb5
Name: Start of Day
Description: A schedule that runs at the start of the day.
This schedule is used to trigger an activity. As a result it
does not have a significant duration.
------------------------------------
ID: eb7e213d-f14d-4d09-ba9d-2a266274d443
Name: Monthly Off Hours
Description: A schedule that runs every month off hours. This
schedule is used to trigger an activity. As a result it does
not have a significant duration.
------------------------------------
ID: 0749990a-c878-4d1d-8002-fc80b9a31bd6
Name: Beginning of the day
Description: 00:00AM of every day
------------------------------------
ID: deaf446f-bc2b-4ff5-b351-137baef609ff
Name: Quarterly Off Hours
Description: A schedule that runs at the start of every
quarter, off hours. This schedule is used to trigger an
activity. As a result it does not have a significant
duration.
------------------------------------
ID: 3e3e1877-7b55-4c7a-9a40-975bdc96f8e2
Name: First day of month
Description: Whole days the first day of every month
------------------------------------
ID: 1e698670-f5e1-449e-94ba-942a76795602
Name: Hourly
Description: A schedule that runs every hour. This schedule
is used to trigger an activity. As a result it does not have
a significant duration.
------------------------------------
ID: a74dc804-4b42-4589-be5f-0aab6ca568d3
Name: Business hours
Description: 9AM to 5PM Monday to Friday
------------------------------------
ID: d6bc50e7-0748-4356-909e-404aa7f377ef
Name: Daily Off Hours
Description: A schedule that runs every day off hours. This
schedule is used to trigger an activity. As a result it does
not have a significant duration.
------------------------------------
ID: d601fef9-dd66-4584-af72-e4660138e93e
Name: Beginning of the month
Description: 00:00AM of the first day of every month
------------------------------------
ID: ce5bcb30-c5d8-4388-89aa-8da82b8c666b
Name: Business week
Description: Whole days Monday to Friday
------------------------------------
ID: e6816241-a745-4763-84ab-77766a2b5049
Name: Beginning of the week
Description: 00:00AM of every Monday
------------------------------------
ID: 670bb364-7a3a-44ba-80b7-58419c060496
Name: Weekly Off Hours
Description: A schedule that runs every week off hours. This
schedule is used to trigger an activity. As a result it does
not have a significant duration.
------------------------------------
ID: 94e5034b-42f1-448d-8b88-291915234109
Name: Weekends
Description: Whole days Saturday and Sunday
------------------------------------

list

Listing Schedules

The list command generates a list of all Foglight schedules.

Scope
schedule
Syntax
fglcmd connection_options -cmd schedule:list
 
Table 50. Options and arguments
Option
Argument
Description

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 .

Example
C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight
-cmd schedule:list
 
ID: 259833b6-d7b0-4b27-a5c4-e2e612cbf77a
Name: Frequent [Test]
Description: A schedule that runs very frequently. Primarily
used for testing.This schedule is used to trigger an activity.
As a result it does not have a significant duration.
------------------------------------
ID: 30afa315-3131-48c2-b0e8-71fea187af4e
Name: Always
Description: A schedule that includes all the time
------------------------------------
ID: 013f57d1-1e7e-4098-a7a5-2b2763364cb5
Name: First day of week
Description: Whole days Monday
------------------------------------
ID: 004c98d4-c278-4af2-81f7-4264fd30003f
Name: Daily Database Maintenance
Description: Schedule on which daily operations to rollup and
purge information in the database are performed. This schedule
is used to trigger an activity. As a result it does not have
a significant duration.
------------------------------------
ID: d7619930-807e-406e-9e6e-15ec30edc23c
Name: End of Day
Description: A schedule that runs at the end of the day. This
schedule is used to trigger an activity. As a result it does
not have a significant duration.
------------------------------------
ID: 46fc602a-8931-4907-a93b-e1c16c0fdbb5
Name: Start of Day
Description: A schedule that runs at the start of the day.
This schedule is used to trigger an activity. As a result it
does not have a significant duration.
------------------------------------
ID: eb7e213d-f14d-4d09-ba9d-2a266274d443
Name: Monthly Off Hours
Description: A schedule that runs every month off hours. This
schedule is used to trigger an activity. As a result it does
not have a significant duration.
------------------------------------
ID: 0749990a-c878-4d1d-8002-fc80b9a31bd6
Name: Beginning of the day
Description: 00:00AM of every day
------------------------------------
ID: deaf446f-bc2b-4ff5-b351-137baef609ff
Name: Quarterly Off Hours
Description: A schedule that runs at the start of every
quarter, off hours. This schedule is used to trigger an
activity. As a result it does not have a significant
duration.
------------------------------------
ID: 3e3e1877-7b55-4c7a-9a40-975bdc96f8e2
Name: First day of month
Description: Whole days the first day of every month
------------------------------------
ID: 1e698670-f5e1-449e-94ba-942a76795602
Name: Hourly
Description: A schedule that runs every hour. This schedule
is used to trigger an activity. As a result it does not have
a significant duration.
------------------------------------
ID: a74dc804-4b42-4589-be5f-0aab6ca568d3
Name: Business hours
Description: 9AM to 5PM Monday to Friday
------------------------------------
ID: d6bc50e7-0748-4356-909e-404aa7f377ef
Name: Daily Off Hours
Description: A schedule that runs every day off hours. This
schedule is used to trigger an activity. As a result it does
not have a significant duration.
------------------------------------
ID: d601fef9-dd66-4584-af72-e4660138e93e
Name: Beginning of the month
Description: 00:00AM of the first day of every month
------------------------------------
ID: ce5bcb30-c5d8-4388-89aa-8da82b8c666b
Name: Business week
Description: Whole days Monday to Friday
------------------------------------
ID: e6816241-a745-4763-84ab-77766a2b5049
Name: Beginning of the week
Description: 00:00AM of every Monday
------------------------------------
ID: 670bb364-7a3a-44ba-80b7-58419c060496
Name: Weekly Off Hours
Description: A schedule that runs every week off hours. This
schedule is used to trigger an activity. As a result it does
not have a significant duration.
------------------------------------
ID: 94e5034b-42f1-448d-8b88-291915234109
Name: Weekends
Description: Whole days Saturday and Sunday
------------------------------------

Running Scripts

run

The run command runs a script.

Typically, this command is used to run scripts that are deployed with Foglight™ cartridges, and is used in maintenance and support tasks when required.

Scope
script
Syntax
fglcmd connection_options -cmd script:run -f file_path
 
Table 51. Options and arguments
Option
Argument
Description

f

file_path

Specifies the path and name of the script file that is to be executed.

Example
C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight
-cmd script:run -f my.script
 
* 
NOTE: If successful, this command does not generate any output in the Command Prompt window (Windows) or the terminal window (Unix or Linux).
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating