Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

Foglight 5.9.7 - Command-Line Reference Guide

Table of Contents

About the Command-Line Interface

Looking at Foglight Commands Getting Started with Foglight Commands

Managing the Foglight Management Server

Getting Started Running the Server in Stand-Alone Mode

fms

Running the Server in High Availability Mode

fmsha remotemonitor

See also

Starting the Embedded Database

runDB

Stopping the Embedded Database

shutdownDB

Upgrading the Database

foglight_db_upgrade

Managing Encryption Keys

keyman

Managing the Foglight Agent Manager

Getting Started Starting or Stopping the Foglight Agent Manager

fglam

Creating Agent Manager Support Bundles

Managing Agents, Cartridges, and Metrics

Understanding the Command-Line Syntax About Regular Expressions Getting Started with Administrative Commands

Running Administrative Commands: Example

Looking at Scope-Specific Commands

Listing Administrative Commands

Logging In and Setting the Scope

fglcmd

Using a Properties File to Supply Connection Information

File name and location

Listing Agent and Agent Manager Instances

clients list packages types

Upgrading the Foglight Agent Manager

clientupgrade

Deploying Agent Packages

deploy

Creating or Deleting Agent Instances

Activating or Deactivating Agent Instances

activate deactivate

Starting or Stopping Data Collection

Listing and Retrieving Log Files

Listing and Assigning Blackout Schedules to Agent Instances

showschedule setschedule

Installing or Uninstalling Cartridges

install uninstall

Enabling or Disabling Cartridges

Listing Cartridges

list

Managing Security Entities

assigngroup assignrole creategroup createuser deletegroup deleteuser exportldapcfg importldapcfg list

Managing Foglight Licenses

import list remove

Exporting or Importing a Monitoring Policy

configexport configimport

Exporting, Importing, or Listing UI Modules

uiexport uiimport uilist

Exporting Metrics and Topology

metricexport topologyexport

Looking Up Server Parameters

env

Listing and Assigning Blackout Schedules to Topology Objects

blackoutobject blackouts

Listing Schedules

list

Running Scripts

run

Creating Server Support Bundles

bundle

importldapcfg

The importldapcfg command imports LDAP settings to Foglight. The source of the import is an XML file that has been previously exported with the exportldapcfg command. LDAP settings enable access to users whose account information is stored in an external system. For more information about the LDAP settings in Foglight, see the Administration and Configuration Help.


	TIP: LDAP settings can be configured using the Configure Directory Services dashboard of the Administration module in the browser interface. For more information, see the Administration and Configuration Help.

fglcmd connection_options -cmd security:importldapcfg -f file_path>

Table 34. 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 .
f	file_path	Specifies the path and name of the LDAP settings file that is to be installed. Specifies the path and name of the XML file containing the LDAP settings that is to be imported.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd security:importldapcfg -f ldap.xml


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

•

list

The list command lists users, groups, and/or roles, and indicates their relationships, as specified by a combination of the available options.


	TIP: A user can belong to one or more groups while each group can have one or more roles. Belonging to a group provides the users with access to all of the roles that are assigned to that group. For complete information about the security principles in Foglight, see the Administration and Configuration Help.

fglcmd connection_options -cmd security:list [-g] [-r] [-u] [-v]

Table 35. 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 .
g	None	Lists all groups that exist in Foglight.
r	None	Lists all roles that exist in Foglight.
u	None	Lists all users that exist in Foglight.
v	None	For each listed entity (user, group, and/or role), this option shows its relationships with other entity types (user, group, and/or role). For example, when listing users using the u option, this option also list the groups and roles associated with each user.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd security:list -u -g -r -v

Name: foglight, External?: false, Status: A

[G] Cartridge Developers

[G] Foglight Security Administrators

[G] Foglight Administrators

[R] Console User

[R] Cartridge Developer

[R] General Access

[R] Dashboard User

[R] Advanced Operator

[R] Dashboard Designer

[R] Administrator

Name: Foglight Administrators, External?: false

[R] Dashboard Designer

[R] Administrator

[R] Dashboard User

[R] General Access

[R] Console User

[R] Advanced Operator

Name: Foglight Operators, External?: false

[R] Console User

Name: Foglight Security Administrators, External?: false

Name: Cartridge Developers, External?: false

[R] Cartridge Developer

[R] Console User

Name: Dashboard Designer, Type: T

[G] Foglight Administrators

Name: Security, Type: T

[G] Foglight Security Administrators

Name: Administrator, Type: T

[G] Foglight Administrators

Name: Cartridge Developer, Type: T

[G] Cartridge Developers

Name: Console User, Type: T

[G] Foglight Operators

[G] Cartridge Developers

[G] Foglight Administrators

Name: Dashboard User, Type: T

[G] Foglight Administrators

Name: General Access, Type: T

[G] Foglight Administrators

Name: Advanced Operator, Type: T

[G] Foglight Administrators

Name: Operator, Type: T

[G] Foglight Operators

[G] Foglight Administrators

Managing Foglight Licenses

Foglight allows you to access only those product features that are defined in your license file, and in some cases, during a specific time period. Your Foglight environment requires a license for the server and a license for each cartridge that is license-protected. Some Foglight cartridges are license-protected, while others do not require a license.

You can install any cartridges, regardless of whether they are listed in your Foglight license. Installing a license-protected cartridge without adding its license results in that cartridge being disabled by default. This describes the fglcmd commands that you can use to manage Foglight licenses. For more information about the licensing capabilities, see the Administration and Configuration Help.

import

The import command installs a Foglight license. Use it to install a Foglight license file whose name and location are specified by the argument.

For information on how to remove a license using the fglcmd interface, see remove .

fglcmd connection_options -cmd license:import -f <file_path>

Table 36. 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 .
f	file_path	Specifies the path and file name of the license file that is to be installed.

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd license:import -f ..\license\foglight.license


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

•

•

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center