Chat now with support
Chat with Support

Foglight for Virtualization Enterprise Edition 8.9 - Command-Line Reference Guide

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

uilist

The uilist command shows a list of deployed UI modules. Each UI module is a collection of Foglight operational elements such as views, dashboards, and other resources.

fglcmd connection_options -cmd util:uilist

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 .

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd util:uilist

Exporting Metrics and Topology

The metricexport command exports metric observations to a file using a metric query. String and metric observations that exist in Foglight can be retrieved with this command for automation and analysis. This command writes its output using a CSV or XML format and takes an observation query as a parameter.

fglcmd connection_options -cmd util:metricexport -output_format {xml|csv} -metric_query query -f file_path

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 file into which the results of the query are to be exported.

NOTE: When specifying the file name, use XML or CSV as the file extension, depending on the setting of the output_format option.

metric_query

query

Contains the metric query. Typically, a metric query specifies topology and object names and collection periods as parameters to retrieve metric observations. For full syntax information, see the Administration and Configuration Help.

output_format

xml or csv

Defines the output format of the file the query is to be exported into: XML or CSV.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd util:metricexport -output_format csv -metric_query "Utilization from System_Table for 1 hour" -f my_metric_query.csv

The above command creates a CSV file showing the value of the Utilization metric for all known System_Table objects that were collected in the past hour. The content of the generated CSV file are similar to the information in the following table:

a307df8f-63e9-4b65-a6d6-a50524a5544b

21:58.0

26:58.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

26:59.0

31:59.0

300000

1

2

2

2

2

4

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

32:00.0

37:00.0

300000

1

2

2

2

2

4

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

37:00.0

42:00.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

42:01.0

47:01.0

300000

1

2

2

2

2

4

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

47:02.0

52:02.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

52:02.0

57:02.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

57:03.0

02:03.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

02:03.0

07:03.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

07:04.0

12:04.0

300000

1

4

4

4

4

16

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

12:05.0

17:05.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

17:05.0

22:05.0

300000

1

8

8

8

8

64

0

ac205363-863b-478b-b6b7-97e1a444e76a

33:12.0

38:12.0

300000

1

1

1

1

1

1

0

ac205363-863b-478b-b6b7-97e1a444e76a

38:12.0

43:12.0

300000

1

1

1

1

1

1

0

ac205363-863b-478b-b6b7-97e1a444e76a

43:13.0

48:13.0

300000

1

2

2

2

2

4

0

ac205363-863b-478b-b6b7-97e1a444e76a

48:13.0

53:13.0

300000

1

1

1

1

1

1

0

ac205363-863b-478b-b6b7-97e1a444e76a

53:14.0

58:14.0

300000

1

2

2

2

2

4

0

ac205363-863b-478b-b6b7-97e1a444e76a

58:15.0

03:15.0

300000

1

1

1

1

1

1

0

ac205363-863b-478b-b6b7-97e1a444e76a

03:15.0

08:15.0

300000

1

1

1

1

1

1

0

ac205363-863b-478b-b6b7-97e1a444e76a

08:16.0

13:16.0

300000

1

4

4

4

4

16

0

ac205363-863b-478b-b6b7-97e1a444e76a

13:16.0

18:16.0

300000

1

3

3

3

3

9

0

ac205363-863b-478b-b6b7-97e1a444e76a

18:17.0

23:17.0

300000

1

6

6

6

6

36

0

metricexport

The metricexport command exports metric observations to a file using a metric query. String and metric observations that exist in Foglight can be retrieved with this command for automation and analysis. This command writes its output using a CSV or XML format and takes an observation query as a parameter.

fglcmd connection_options -cmd util:metricexport -output_format {xml|csv} -metric_query query -f file_path

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 file into which the results of the query are to be exported.

NOTE: When specifying the file name, use XML or CSV as the file extension, depending on the setting of the output_format option.

metric_query

query

Contains the metric query. Typically, a metric query specifies topology and object names and collection periods as parameters to retrieve metric observations. For full syntax information, see the Administration and Configuration Help.

output_format

xml or csv

Defines the output format of the file the query is to be exported into: XML or CSV.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd util:metricexport -output_format csv -metric_query "Utilization from System_Table for 1 hour" -f my_metric_query.csv

The above command creates a CSV file showing the value of the Utilization metric for all known System_Table objects that were collected in the past hour. The content of the generated CSV file are similar to the information in the following table:

a307df8f-63e9-4b65-a6d6-a50524a5544b

21:58.0

26:58.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

26:59.0

31:59.0

300000

1

2

2

2

2

4

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

32:00.0

37:00.0

300000

1

2

2

2

2

4

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

37:00.0

42:00.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

42:01.0

47:01.0

300000

1

2

2

2

2

4

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

47:02.0

52:02.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

52:02.0

57:02.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

57:03.0

02:03.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

02:03.0

07:03.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

07:04.0

12:04.0

300000

1

4

4

4

4

16

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

12:05.0

17:05.0

300000

1

1

1

1

1

1

0

a307df8f-63e9-4b65-a6d6-a50524a5544b

17:05.0

22:05.0

300000

1

8

8

8

8

64

0

ac205363-863b-478b-b6b7-97e1a444e76a

33:12.0

38:12.0

300000

1

1

1

1

1

1

0

ac205363-863b-478b-b6b7-97e1a444e76a

38:12.0

43:12.0

300000

1

1

1

1

1

1

0

ac205363-863b-478b-b6b7-97e1a444e76a

43:13.0

48:13.0

300000

1

2

2

2

2

4

0

ac205363-863b-478b-b6b7-97e1a444e76a

48:13.0

53:13.0

300000

1

1

1

1

1

1

0

ac205363-863b-478b-b6b7-97e1a444e76a

53:14.0

58:14.0

300000

1

2

2

2

2

4

0

ac205363-863b-478b-b6b7-97e1a444e76a

58:15.0

03:15.0

300000

1

1

1

1

1

1

0

ac205363-863b-478b-b6b7-97e1a444e76a

03:15.0

08:15.0

300000

1

1

1

1

1

1

0

ac205363-863b-478b-b6b7-97e1a444e76a

08:16.0

13:16.0

300000

1

4

4

4

4

16

0

ac205363-863b-478b-b6b7-97e1a444e76a

13:16.0

18:16.0

300000

1

3

3

3

3

9

0

ac205363-863b-478b-b6b7-97e1a444e76a

18:17.0

23:17.0

300000

1

6

6

6

6

36

0

topologyexport

The topologyexport command exports the value of one or more properties of a topology object to an XML file. Given a topology query, the property name, and the path and name of the output file, this command generates an XML file containing the value of the specified property. For complete information on how to write a topology query, see the Administration and Configuration Help.

fglcmd connection_options -cmd util:topologyexport -property_names properties
-topology_query "query" -f file_path

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 file into which the results of the query are to be exported.

NOTE: When specifying the file name, use XML as the file extension.

property_names

properties

Contains one or more property names, separated by commas.

topology_query

"query"

Contains the topology query. Typically, a topology query specifies topology and object names as parameters to retrieve one or more object instances.

The query argument must be enclosed in double quotes. Any variables in the query must be enclosed in single quotes.

For example: "Windows_Host where name='host1'"

To learn more about the query syntax , see the Administration and Configuration Help.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd util:topologyexport -f host1_alarm_count.xml -topology_query "Windows_Host where name='host1'" -property_names alarmTotalCount

The above command generates an XML file showing the value of the alarmTotalCount property for a particular Windows® host. The content of the generated XML file is similar to the following listing:

<property name="lastUpdated" value="7/3/19-01-02 17:29:14.929"/>
Related Documents