Foglight 6.0.0 - Command-Line Reference Guide


	NOTE: The usr, pwd, debug, port, srv, and ssl options are used to specify connection information. Another way of specifying connection options is using a properties file, fglcmd.properties. When configured, fglcmd uses the information in that file to retrieve connection parameters which eliminates the need to specify them on the command line each time you issue an fglcmd command. For more information, see Using a Properties File to Supply Connection Information .

Table 4. Options and arguments
Option	Argument	Description
authtoken	token	Specifies the auth-token.
cmd	scope	agent	Manages agents and agent managers.
		cartridge	Manages cartridges.
		commands	Lists administrative commands.
		license	Manages licenses.
		schedule	Lists schedules.
		script	Runs scripts.
		security	Manages security entities.
		support	Creates support bundles.
		topology	Assigns blackout schedules.
		util	Contains utility commands.
debug	None	Turns the debugging on.
port	server_port	Specifies the server’s port number. The default port number is 8080 (HTTP) or 8443 (HTTPS). For more information on default port assignments, see the Administration and Configuration Help.
proxy	proxy-uri	Specifies the URI of proxy server. Three types of proxy protocols with or without authentication are supported, including HTTP, HTTPs, and SOCKS. The generic syntax is: {http\|https\|socks}://[username:password@]{proxy_server_hostname\|IP}:port
pwd	password	Specifies the password of Foglight user. NOTE: If the password argument is not provided, fglcmd prompts for the password after a command is issued.
srv	server_name	Specifies the server’s name.
srv	server_IP_address	Specifies the server’s IP address.
ssl	None	Connects to the Foglight Management Server through a secure HTTP connection (HTTPS). Unless this option is specified, fglcmd uses an HTTP connection. For information about default port numbers, see port .
usr	user_name	Specifies the user name for logging into Foglight.

Example

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:clients -host .*.corp -regex

Client ID: host1.example.com#32b1c51d-6208-435c-bdad-

2a8916ef3a89

Client Name: host1.example.com

Adapter ID: FglAM

Client Version: 6.0.0 (6.0.0-5/20/210811-0230)

Host Name: host1.example.com

OS: windows 5.1 (ia32)

See also

•

Managing Agents, Cartridges, and Metrics

•

Looking at Scope-Specific Commands

•

Running Administrative Commands: Example

•

Using a Properties File to Supply Connection Information

fglcmd

Logging In and Setting the Scope

The fglcmd command connects to the Foglight Management Server and sets the scope for the administrative command.

Syntax

fglcmd {(-usr user_name -pwd password)|-authtoken token} [-debug]

[-port server_port] [-srv {server_name|server_IP_address}] [-ssl]

[-proxy proxy_uri] -cmd {scope:command command_options|commands}


	NOTE: The usr, pwd, debug, port, srv, and ssl options are used to specify connection information. Another way of specifying connection options is using a properties file, fglcmd.properties. When configured, fglcmd uses the information in that file to retrieve connection parameters which eliminates the need to specify them on the command line each time you issue an fglcmd command. For more information, see Using a Properties File to Supply Connection Information .

Table 4. Options and arguments
Option	Argument	Description
authtoken	token	Specifies the auth-token.
cmd	scope	agent	Manages agents and agent managers.
		cartridge	Manages cartridges.
		commands	Lists administrative commands.
		license	Manages licenses.
		schedule	Lists schedules.
		script	Runs scripts.
		security	Manages security entities.
		support	Creates support bundles.
		topology	Assigns blackout schedules.
		util	Contains utility commands.
debug	None	Turns the debugging on.
port	server_port	Specifies the server’s port number. The default port number is 8080 (HTTP) or 8443 (HTTPS). For more information on default port assignments, see the Administration and Configuration Help.
proxy	proxy-uri	Specifies the URI of proxy server. Three types of proxy protocols with or without authentication are supported, including HTTP, HTTPs, and SOCKS. The generic syntax is: {http\|https\|socks}://[username:password@]{proxy_server_hostname\|IP}:port
pwd	password	Specifies the password of Foglight user. NOTE: If the password argument is not provided, fglcmd prompts for the password after a command is issued.
srv	server_name	Specifies the server’s name.
srv	server_IP_address	Specifies the server’s IP address.
ssl	None	Connects to the Foglight Management Server through a secure HTTP connection (HTTPS). Unless this option is specified, fglcmd uses an HTTP connection. For information about default port numbers, see port .
usr	user_name	Specifies the user name for logging into Foglight.

Example

C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:clients -host .*.corp -regex

Client ID: host1.example.com#32b1c51d-6208-435c-bdad-

2a8916ef3a89

Client Name: host1.example.com

Adapter ID: FglAM

Client Version: 6.0.0 (6.0.0-5/20/210811-0230)

Host Name: host1.example.com

OS: windows 5.1 (ia32)

See also

•

Managing Agents, Cartridges, and Metrics

•

Looking at Scope-Specific Commands

•

Running Administrative Commands: Example

•

Using a Properties File to Supply Connection Information

Foglight connection information, such as the user name and password, can be supplied on the command line, using a specific set of command-line options, or through a properties file. Specifying connection options in the properties file eliminates the need to type them each time you issue an fglcmd command.

This describes the required structure and location of that file. For information on specifying connection options on the command line, see Logging In and Setting the Scope .

File name and location

Unix

~/fglcmd.properties

Windows

C:\Documents and Settings\<user_name>\fglcmd.properties

Syntax

usr=user_name

pwd=password


	TIP: If you specify the password in this file, it is recommended to read-protect the properties file. For example, to read-protect a file on Unix, use the -R world option; on Windows, files can be read-protected by associating read permissions with particular users or groups.

[srv={server_name|server_IP_address}]

[port=server_port]

[debug={true|false}]

[ssl={true|false}]


	IMPORTANT: The cmd option, used to specify a specific fglcmd command, cannot be set through the properties file. This option can only be used when issuing fglcmd commands.

Table 5. Options and arguments
Option	Argument	Description
debug	true or false	Turns the debugging on (true) or off (false).
port	server_port	Specifies the server’s port number. The default port number is 8080 (HTTP) or 8443 (HTTPS). For more information on default port assignments, see the Administration and Configuration Help.
pwd	password	Specifies the password of the Foglight user. NOTE: If the password argument is not provided, fglcmd prompts for the password after a command is issued.
srv	server_name	Specifies the server’s name.
	server_IP_address	Specifies the server’s IP address.
ssl	None	Connects to the Foglight Management Server through a secure HTTP connection (HTTPS). Unless this option is specified, fglcmd uses an HTTP connection. For information about default port numbers, see port .
usr	user_name	Specifies the user name for logging into Foglight.