Activating or Deactivating Agent Instances
The activate command enables one or more Foglight agent instances.
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.
|
|
TIP: Some Foglight agents, such as the AIX® and HP ® system agents that come included with the OS Cartridge, require root-level privileges to run on UNIX ®. This can be accomplished by making sure that the user account used to install the Foglight Agent Manager on the monitored host does not appear in the sudo configuration file. However, if the Agent Manager does not have root-level privileges, the agents that require those privileges fall back to normal, non-root launch. Starting those agents without root privileges does not prevent them from activating and collecting data. For more information about installing the Foglight Agent Manager with root privileges, see the I nstallation and Configuration Guide. For information about the OS Cartridge, refer to the cartridge documentation. |
For information on how to create an agent instance, see create ; to find out how to deactivate an agent, see deactivate .
fglcmd connection_options -cmd agent:activate
{
-agentid agent_ID|-name agent_name|-namespace agent_namespace|-all}
[-host host_name] [
-adapter adapter_ID] [
-type agent_type]
[-deletable {
true|
false}] [
-datacollection {
true|
false}]
[-activatable {
true|
false}] [
-active {
true|
false}] [
-regex] [
-force]
|
|
|
|
|
activatable |
true or false |
Indicates whether to activate agent instances that can (true) or cannot be activated (false). |
|
active |
true or false |
Indicates whether to activate 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 activated. |
|
all |
None |
Indicates that all agent instances should be activated. |
|
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 activate Foglight agent instances that are (true) or are not collecting data (false). |
|
deletable |
true or false |
Indicates whether to activate 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 activated. |
|
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 activated. |
|
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 |
Indicates that the command should not wait for the selected agents to finish processing before activating 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:
For more information about these agents, see the Managing the Infrastructure Cartridge User and Reference Guide. |
The first command in this example, shown in Listing agents , lists agent IDs using the agent:list command with the all option set. For more information on how to list agent instances, see list .
The second command, shown in Activating an agent instance , uses an ID of an inactive agent from the output of the first command to activate an agent.
activate
The activate command enables one or more Foglight agent instances.
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.
|
|
TIP: Some Foglight agents, such as the AIX® and HP ® system agents that come included with the OS Cartridge, require root-level privileges to run on UNIX ®. This can be accomplished by making sure that the user account used to install the Foglight Agent Manager on the monitored host does not appear in the sudo configuration file. However, if the Agent Manager does not have root-level privileges, the agents that require those privileges fall back to normal, non-root launch. Starting those agents without root privileges does not prevent them from activating and collecting data. For more information about installing the Foglight Agent Manager with root privileges, see the I nstallation and Configuration Guide. For information about the OS Cartridge, refer to the cartridge documentation. |
For information on how to create an agent instance, see create ; to find out how to deactivate an agent, see deactivate .
fglcmd connection_options -cmd agent:activate
{
-agentid agent_ID|-name agent_name|-namespace agent_namespace|-all}
[-host host_name] [
-adapter adapter_ID] [
-type agent_type]
[-deletable {
true|
false}] [
-datacollection {
true|
false}]
[-activatable {
true|
false}] [
-active {
true|
false}] [
-regex] [
-force]
|
|
|
|
|
activatable |
true or false |
Indicates whether to activate agent instances that can (true) or cannot be activated (false). |
|
active |
true or false |
Indicates whether to activate 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 activated. |
|
all |
None |
Indicates that all agent instances should be activated. |
|
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 activate Foglight agent instances that are (true) or are not collecting data (false). |
|
deletable |
true or false |
Indicates whether to activate 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 activated. |
|
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 activated. |
|
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 |
Indicates that the command should not wait for the selected agents to finish processing before activating 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:
For more information about these agents, see the Managing the Infrastructure Cartridge User and Reference Guide. |
The first command in this example, shown in Listing agents , lists agent IDs using the agent:list command with the all option set. For more information on how to list agent instances, see list .
The second command, shown in Activating an agent instance , uses an ID of an inactive agent from the output of the first command to activate an agent.
deactivate
The deactivate command disables one or more Foglight agent instances.
If you want to delete an agent instance, you first stop the agent’s data collection, deactivate it, and then delete the instance.
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 deactivate command includes options and arguments, such as -datacollection true, that allow you to override that flow and agent instances that are collecting data.
For information on how to activate an agent instance using the fglcmd interface, see activate .
fglcmd connection_options -cmd agent:deactivate {
-agentid agent_ID|-name
agent_name|-namespace agent_namespace|-all} [
-host host_name]
[-adapter adapter_ID] [
-type agent_type] [
-deletable {
true|
false}]
[-datacollection {
true|
false}] [
-activatable {
true|
false}]
[-active {
true|
false}] [
-regex] [
-force]
[
-nowait]
|
|
|
|
|
activatable |
true or false |
Indicates whether to deactivate agent instances that can (true) or cannot be deactivated (false). |
|
active |
true or false |
Indicates whether to deactivate 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 deactivated. |
|
all |
None |
Indicates that all agent instances should be deactivated. |
|
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 deactivate Foglight agent instances that are (true) or are not collecting data (false). |
|
deletable |
true or false |
Indicates whether to deactivate 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 deactivated. |
|
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 deactivated. |
|
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 |
Indicates that the command should not wait for the selected agents to finish processing before deactivating 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:
For more information about these agents, see the Managing the Infrastructure Cartridge User and Reference Guide. |
Starting or Stopping Data Collection
The start command initiates data collection for one or more Foglight agent instances.
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.
You should issue this command after creating and/or activating an agent instance. For information on how to activate agent instances using the fglcmd interface, see activate .
fglcmd connection_options -cmd agent:start {
-agentid agent_ID|-name agent_name|
-namespace agent_namespace|-all} [
-host host_name]
[
-adapter adapter_ID]
[-type agent_type] [
-deletable {
true|
false}] [
-datacollection {
true|
false}]
[-activatable {
true|
false}] [
-active {
true|
false}] [
-regex] [
-force]
|
|
|
|
|
activatable |
true or false |
Indicates whether to start agent instances that can (true) or cannot be activated (false). |
|
active |
true or false |
Indicates whether to start 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 started. |
|
all |
None |
Indicates that all agent instances should be started. |
|
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 start Foglight agent instances that are (true) or are not collecting data (false). |
|
deletable |
true or false |
Indicates whether to start 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 started. |
|
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 agent instances that are to be started. |
|
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 |
Indicates that the command should not wait for the selected agents to finish processing before starting the selected Foglight agent instances. |
|
regex |
None |
Interprets the 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:
For more information about these agents, see the Managing the Infrastructure Cartridge User and Reference Guide. |
