Chat now with support
Chat mit Support

Foglight 5.9.8 - Command-Line Reference Guide

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

deploy

Deploying Agent Packages

The deploy command deploys one or more Foglight agent packages.

In most cases, Foglight cartridges include one or more agent packages that are used to collect metrics from monitored hosts. You can deploy an agent package after installing the cartridge that includes that agent package on the Foglight Management Server. For information on how to install a cartridge using the fglcmd interface, see install ; to find out how to list available agent packages using fglcmd, see packages .

Scope
agent
Syntax
fglcmd connection_options -cmd agent:deploy {-packageversion version|-packageid
"package_ID"|-allpackages|-allinstallers} {-host host_name|-clientname
display_name|-clientid client_ID|-clientbuild build_ID|-clientversion
version|-allclients} [-packageos pkg_OS_name]
[-packageosversion pkg_OS_version] [-packagearch OS_architecture]
[-osversion OS_version] [-osname OS_name] [-arch architecture]
[-installerid agent_installer_ID] [-installername agent_installer_name]
[-regex] [-test] [-disable_platform_check] [-force]
[-upgradable {true|false}]
 
Table 11. Options and arguments
Option
Argument
Description

allclients

None

Indicates that all instances of the Foglight Agent Manager should be selected.

allinstallers

None

Indicates that all agent installers should be selected.

allpackages

None

Indicates that all agent packages should be deployed.

arch

architecture

An explicit text string or a regular expression that specifies one or more platform architectures.

clientbuild

build_ID

An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified build ID.

clientid

client_ID

An explicit text string or a regular expression that identifies one or more display devices that are running an instance of the Foglight Agent Manager.

clientname

display_name

An explicit text string or a regular expression that specifies the name of one or more display devices that are running an instance of the Foglight Agent Manager.

clientversion

version

An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified version.

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 .

disable_platform_check

None

Disables automatic filtering of agent packages based on platform information provided by agent installers.

force

None

In cases where multiple agents are selected, it indicates that the command should be performed against all selected agent installers and packages.

host

host_name

An explicit text string or a regular expression that specifies one or more host names.

installerid

agent_installer_ID

Selects the agent installer with the specified ID.

installername

name

An explicit text string or a regular expression that selects one or more agent installers based on the specified name.

osname

OS_name

An explicit text string or a regular expression that specifies the name of one or more operating systems with which the agent packages are compatible

osversion

OS_version

An explicit text string or a regular expression that specifies one or more operating system versions the agent packages are compatible with.

packagearch

OS_architecture

An explicit text string or a regular expression that specifies one or more operating system architectures the agent packages are compatible with.

packageid

package_ID

An explicit text string or a regular expression that identifies one or more agent packages that are to be deployed.

NOTE: This value must be enclosed in quotation marks, as indicated in the command syntax.

packageos

pkg_OS_name

An explicit text string or a regular expression that specifies the name of one or more operating systems of the agent packages that are to be deployed.

packageosversion

pkg_OS_version

An explicit text string or a regular expression that specifies one or more operating system versions of the agent packages that are to be deployed.

packageversion

version

An explicit text string or a regular expression that specifies one or more versions of the agent packages that are to be deployed.

regex

None

Interprets the architecture, build_ID, client_ID, display_name, host_name, name, OS_architecture, OS_name, OS_version, package_ID, pkg_OS_name, pkg_OS_version, version, or upgradable arguments as regular expressions.

For a sample regular expression used to specify a host name, see Example .

test

None

Issues the command in test mode without deploying any agents.

upgradable

true or false

Indicates whether one or more Foglight Agent Manager instances can (true) or cannot be upgraded (false). It can be set to a regular expression.

Example
C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:deploy -host Host1 -clientid Host1#be05acc0-6179-4878-a274-afcd5075260a -packageid HostAgents-5.9.x-Host Agents
Successfully installed agent package "HostAgents-5.9.x-Host Agents" on
"Host1#be05acc0-6179-4878-a274-afcd5075260a#FglAM:Host1/be05acc0-6179-4878-
a274-afcd5075260a/installer".
See also
•
create
•
delete
•
activate
•
deactivate
•
start
•
stop

Creating or Deleting Agent Instances

create

The create command produces one or more Foglight agent instances.

You can create an agent instance after deploying the agent package on the Foglight Management Server. To create an agent instance that collects data, you first create the agent instance, activate it, and then start the data collection for that agent instance. Similarly, when you want to remove an agent instance, use a reverse order of actions: first stop the agent instance, deactivate it, and then delete it.

For information on how to deploy an agent package using the fglcmd interface, see deploy ; for information on how to delete agent instances, see delete .

Scope
agent
Syntax
fglcmd connection_options -cmd agent:create -name agent_name -type agent_type
{-clientname display_name|-clientid client_ID|-clientbuild build_ID|
-clientversion version|-allclients} [-host host_name] [-force] [-nowait]
[-regex] [-upgradable {true|false}]
 
Table 12. Options and arguments
Option
Argument
Description

allclients

None

Indicates that all instances of the Foglight Agent Manager should be selected.

clientbuild

build_ID

An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified build ID.

clientid

client_ID

An explicit text string or a regular expression that identifies one or more display devices that are running an instance of the Foglight Agent Manager.

clientname

display_name

An explicit text string or a regular expression that specifies one or more monitored hosts on which the Foglight Agent Manager is running.

clientversion

version

An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified version.

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 .

force

None

In cases where multiple agents are selected, it indicates that all selected agents should be created.

host

host_name

An explicit text string or a regular expression that specifies one or more host names.

name

agent_name

An explicit text string or a regular expression that specifies one or more agent names.

nowait

None

Prevents the command from waiting for the selected agents to finish processing before creating the selected Foglight agent instances.

regex

None

Interprets the build_ID., client_ID, display_name, host_name, version, or upgradable arguments as regular expressions.

For a sample regular expression used to specify a host name, see Example .

type

agent_type

An explicit text string or a regular expression that specifies one or more Foglight agent types.

The selection of available agent types depends on the collection of deployed cartridges. For example, a basic Foglight Management Server installation that includes the Cartridge for Infrastructure can two different agent types:

•
WindowsAgent
•
UnixAgent
NOTE: For more information about these agents, see Foglight for Infrastructure User and Reference Guide.

upgradable

true or false

Indicates whether one or more Foglight

Agent Manager instances can (true) or cannot be upgraded (false). It can be set to a regular expression.

Example
Using a regular expression to select hosts
C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:create -type Windows_System -host .*.corp -name MyAgentX -regex -force
 
* 
NOTE: If successful, this command does not generate any output.
Using a literal value to select a Foglight Agent Manager instance
C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:create -type WindowsAgent -name Agent5 -clientname Host1
 
* 
NOTE: If successful, this command does not generate any output.
See also
•
deploy
•
delete
•
activate
•
deactivate
•
start
•
stop

create

Creating or Deleting Agent Instances

The create command produces one or more Foglight agent instances.

You can create an agent instance after deploying the agent package on the Foglight Management Server. To create an agent instance that collects data, you first create the agent instance, activate it, and then start the data collection for that agent instance. Similarly, when you want to remove an agent instance, use a reverse order of actions: first stop the agent instance, deactivate it, and then delete it.

For information on how to deploy an agent package using the fglcmd interface, see deploy ; for information on how to delete agent instances, see delete .

Scope
agent
Syntax
fglcmd connection_options -cmd agent:create -name agent_name -type agent_type
{-clientname display_name|-clientid client_ID|-clientbuild build_ID|
-clientversion version|-allclients} [-host host_name] [-force] [-nowait]
[-regex] [-upgradable {true|false}]
 
Table 12. Options and arguments
Option
Argument
Description

allclients

None

Indicates that all instances of the Foglight Agent Manager should be selected.

clientbuild

build_ID

An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified build ID.

clientid

client_ID

An explicit text string or a regular expression that identifies one or more display devices that are running an instance of the Foglight Agent Manager.

clientname

display_name

An explicit text string or a regular expression that specifies one or more monitored hosts on which the Foglight Agent Manager is running.

clientversion

version

An explicit text string or a regular expression that selects one or more Foglight Agent Manager instances with the specified version.

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 .

force

None

In cases where multiple agents are selected, it indicates that all selected agents should be created.

host

host_name

An explicit text string or a regular expression that specifies one or more host names.

name

agent_name

An explicit text string or a regular expression that specifies one or more agent names.

nowait

None

Prevents the command from waiting for the selected agents to finish processing before creating the selected Foglight agent instances.

regex

None

Interprets the build_ID., client_ID, display_name, host_name, version, or upgradable arguments as regular expressions.

For a sample regular expression used to specify a host name, see Example .

type

agent_type

An explicit text string or a regular expression that specifies one or more Foglight agent types.

The selection of available agent types depends on the collection of deployed cartridges. For example, a basic Foglight Management Server installation that includes the Cartridge for Infrastructure can two different agent types:

•
WindowsAgent
•
UnixAgent
NOTE: For more information about these agents, see Foglight for Infrastructure User and Reference Guide.

upgradable

true or false

Indicates whether one or more Foglight

Agent Manager instances can (true) or cannot be upgraded (false). It can be set to a regular expression.

Example
Using a regular expression to select hosts
C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:create -type Windows_System -host .*.corp -name MyAgentX -regex -force
 
* 
NOTE: If successful, this command does not generate any output.
Using a literal value to select a Foglight Agent Manager instance
C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:create -type WindowsAgent -name Agent5 -clientname Host1
 
* 
NOTE: If successful, this command does not generate any output.
See also
•
deploy
•
delete
•
activate
•
deactivate
•
start
•
stop

delete

The delete command removes one or more Foglight agent instances.

To delete an agent instance, a typical flow of actions requires you to first stop the agent’s data collection, deactivate it, and then delete the instance. However, the delete command includes options and arguments, such as -active true and -datacollection true, that let you override that flow and delete active agent instances that are collecting data.

For information on how to deactivate an agent instance using the fglcmd interface, see deactivate .

Scope
agent
Syntax
fglcmd connection_options -cmd agent:delete {-agentid agent_ID|
-name agent_name|-namespace agent_namespace|-all} [-type agent_type]
[-host host_name] [-adapter adapter_ID] [-deletable {true|false}]
[-datacollection {true|false}] [-activatable {true|false}]
[-active {true|false}] [-regex] [-force] [-nowait]
 
Table 13. Options and arguments
Option
Argument
Description

activatable

true or false

Indicates whether to delete agent instances that can (true) or cannot be activated (false).

active

true or false

Indicates whether to delete agent instances that are active (true) or inactive (false).

adapter

adapter_ID

An explicit text string or a regular expression that identifies one or more Foglight adapters.

agentid

agent_ID

Identifies an instance of a Foglight agent that is to be deleted.

all

None

Indicates that all agent instances should be deleted.

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 .

datacollection

true or false

Indicates whether to delete Foglight agent instances that are (true) or are not collecting data (false).

deletable

true or false

Indicates whether to delete Foglight agent instances that can (true) or cannot be deleted (false).

force

None

In cases where multiple agents are selected, it indicates that all selected agents should be deleted.

host

host_name

An explicit text string or a regular expression that specifies one or more host names.

name

agent_name

An explicit text string or a regular expression that specifies the name of one or more Foglight agents that are to be deleted.

namespace

agent_namespace

An explicit text string or a regular expression that specifies the name of one or more Foglight agent instances in the specified name space.

nowait

None

Prevents the command from waiting for the selected agents to finish processing before deleting the selected Foglight agent instances.

regex

None

Interprets the adapter_ID, agent_name, agent_namespace, agent_type, or host_name arguments as regular expressions.

For a sample regular expression used to specify a host name, see Example .

type

agent_type

An explicit text string or a regular expression that specifies one or more Foglight agent types.

The selection of available agent types depends on the collection of deployed cartridges. For example, a basic Foglight Management Server installation that includes the Cartridge for Infrastructure can two different agent types:

•
WindowsAgent
•
UnixAgent

For more information about these agents, see the Managing the Infrastructure Cartridge User and Reference Guide.

Example
C:\Quest\Foglight\bin>fglcmd -usr foglight -pwd foglight -cmd agent:delete -name Agent4
 
* 
NOTE: If successful, this command does not generate any output.
See also
•
deploy
•
create
•
activate
•
deactivate
•
start
•
stop
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen