Actions
General Information
The boom GUI provides multiple types of Actions. This Chapter describes the boom GUI functionalities of Remote Actions and Server Actions in detail.
See also Chapter Actions for more information about Actions.
Actions Overview
The boom GUI provides multiple types of Actions. This Chapter gives an overview of the available predefined boom actions. The actions are stored in different directories dependent on their type.
BOOM_AGENTS
| Action | Description |
|---|---|
| DISABLE ACTIONS (not predefined) | Disables remote actions on the agent. Use the "add action" function to add your own action. Call field: BOOM_AGENT DISABLE_ACTIONS There is no ENABLE_ACTIONS. See the agent.conf desription how to enable remote actions again. |
| Disable Policies | Disables a single or multiple policies (does not store this state to the disk) |
| Enable Policies | Enables a single or multiple policies (does not store this state to the disk) |
| Get Agent Config File | Show the current configuration settings of the Agent. |
| Get Agent ID | Returns Agent's unique ID. Do not change this field manually. It is an integer value and is created automatically during first clean start of the boom Agent. |
| Get Agent IP | Returns Agent's IP Address. |
| Get Agent Log Level | Returns the Agent's current Log Level. Default Log Level = 1. |
| Get Agent PID | Returns Agent's process id. |
| Get Agent STATUS | The "enabled" parameter shows the Agent's runtime status. In disabled mode the agent only responds to action requests from the server. |
| Get Agent version | Displays the version of the Agent's software. |
| Get Agent's ClusterNodes | Returns configured CLUSTERNODES. CLUSTERNODES - configured hostnames and IPs that can access the Agent and perform actions. |
| Get Environment (Unix) | List the Agent's environment. Only valid for Unix nodes. |
| Get Environment (Windows) | List the Agent's environment. Only valid for Windows nodes. |
| List Instrumentation (Unix) | Lists the packages (scripts, executables, configuration files) which were deployed to the agent's default packet directory %BOOM_ROOT%/spi/. |
| List Instrumentation (Windows) | Lists the packages (scripts, executables, configuration files) which were deployed to the agent's default packet directory %BOOM_ROOT%/spi/. |
| List Policies Status | Returns status of the policies in the format "xxx where xxx - 3 chars: 1st character: 'E' enabled policy, 'D' - disabled 2nd char: '-' active (not inside deactivation scheduled interval) 'D' not active (! inside deactivation scheduled interval - keeping silence) 3d char '-' PLOG not active (policy specific log) 'P' PLOG active (policy specific log) |
| Move to a new Server | Agent will be moved to a new boom server. After moving the agent sends approval request to the new server but the old server has access to perform actions. If it's necessary perform this action with the old server name to rollback. Ensure that new server has approved the request and delete agent card from the old server. Specify the new server name in the optional parameters field. |
| Remove Agent's Global Variable | Removes Agent's global variable To print a list of defined variables execute the Action with an empty optional parameters field. |
| Reset Threshold States | Flushes the threshold states for all monitors. Basically this will cause the Agent to resend indications for all monitors that exceed a threshold just as if the threshold is crossed the first time. |
| Set Agent Log Level | Sets Agent's Log Level (use 1..4). |
| Set Agent Log Limit | Sets LOGCOUNT and LOGSIZE values for logging facility of the boom Agent. LOGCOUNT - defines maximal number of logfiles LOGSIZE - defines max size in MB of each logfile |
| Set Agent's ClusterNodes | Replaces configured CLUSTERNODES. CLUSTERNODES - configured hostnames and IPs that can access the Agent and perform actions. |
| Set Agent's Global Variable | Defines a new global variable on the selected agent. A global variable can be used in any deployed policy. To print a list of defined variables execute the Action with an empty optional parameters field. |
| Set Agent->Server communication OFF | Switches the selected agent to a passive, listen only mode. The agent won't actively send any heartbeats and data to the server. The server will take over the responsibiliy to send heartbeats and poll the data from the agent. |
| Set Agent->Server communication ON | Switches the selected agent to an active mode. The agent will actively communicate with the server. The agent tries to recognize if the server is online, offline or firewalled and submits data to the server. |
| Set AgentID-based communication OFF | Instructs the selected Agent NOT to use its AgentID for the communication with the boom server. The AgentID is only necessary for NAT based environments. |
| Set AgentID-based communication ON | Instructs the selected Agent to include its ID in all communication to the boom server, so that the server can differentiate the agents behind a NAT device. |
| Set PLOG OFF | Sets policy specific logging off. Please see Policy specific logfiles |
| Set PLOG ON | Sets policy specific logging on. Please see Policy specific logfiles |
| Get Message Storm Detection settings | Use this action to check the parameter settings for Message Storm Detection. |
| Set Message Storm Detection settings | Sets the MaxMessagesPerMinute and BlockTimeMinutes parameters. For more information see chapter "Message Storm Detection" |
BOOM_Server
| Action | Description |
|---|---|
| Add License | Add a new license to the boom server. |
| Add new Source Server | |
| Get Environment | Lists the server environment. |
| Get Server Log Level | Returns the server's current loglevel. |
| Get Server PID | Returns the boom server PID. |
| Re-generate static agent packages | This action (re)generate all agent packages to List of available static packages are available under: http:// |
| Remove Source Server | Removes Source Server. |
| Reset Processing Time Calculation | Resets Max Processing Time status variable for the Statistics Calculation. |
| Set Server Log Level | Set loglevel of the BOOM Server. Use [1...4] |
HPUX
| Action | Description |
|---|---|
| Cluster Package Information | Shows which cluster packages are running on which cluster node. |
| Disk Utilization (bdf) | Shows the disk utilization on a specified HP-UX node. |
| Net Interfaces Statistics | Executes netstat -i on a specified HP-UX node. |
| SAR CPU & Swap Queue | sar -q checks the queue activity. Requires the sar (System Activity Reporter) utility. |
| SAR CPU Load | sar -u shows the CPU utilization. Requires the sar (System Activity Reporter) utility. |
| SAR Disk Activity | The output of sar -d shows various disk-related statistics. Requires the sar (System Activity Reporter) utility. |
| SAR Disk IO | Reports disk I/O and transfer rate statistics. Requires the sar (System Activity Reporter) utility. |
| SAR Process, Inode and File Table Utilization | sar -v checks the system table status. Requires the sar (System Activity Reporter) utility. |
| SAR Swap Activity | Displays the RAM memory switching and swapping activities. Requires the sar (System Activity Reporter) utility. |
| SAR System Calls | Displays process creation activity. Requires the sar (System Activity Reporter) utility. |
| Swap Utilization | Prints information about device and file system paging space. |
| Volume Groups | Displays LVM Volume Group summary and detail information. |
JMX (Java Management Extensions)
| Action | Description |
|---|---|
| Jmx check Memory | Returns memory usage for objects with type=Memory. |
| Jmx check MemoryPool (Perm Gen only) | Returns memory usages for Permanent Generation. Filtered by attribute=Name and valueMask=Perm*: ... -o java.lang:*,type=MemoryPool -a Name -v Perm* |
| Jmx check MemoryPools | Returns memory usage for MemoryPools (not filtered). ... -o java.lang:*,type=MemoryPool |
| Jmx check Servlets | ... -o *:*,j2eeType=Servlet |
LDAP-AD
| Action | Description |
|---|---|
| LDAP Add User | Adds an LDAP user to the boom server. Multiple LDAP users can be added (separated by space). Specify the new user in the optional parameters field: e.g. newuser@boomserver1.netage.de |
| LDAP Delete configuration | Will delete the LDAP configuration for a given URL. |
| LDAP Import Users | Import users from Active Directory. To limit the import to a certain group of users, add the Common Name Hierarchy as LDAP Search filter: e.g. LDAP_SEARCH_FILTER=(&(objectClass=Person)(memberof=CN=Administrators,CN=Builtin,DC=company,DC=com)) |
| LDAP List configurations | Returns a list of LDAP servers configured in the boom server. Select a boom server int the server field. |
| LDAP Reload | Reload the configured LDAP/Active Directory Server. |
| LDAP Save configuration | Will create the LDAP configuration for a given URL. Optional parameters can be: LDAP_BASE=base LDAP_USER_ATTR= LDAP_EXPIRE= |
| LDAP Test User | Test user credentials against a given LDAP URL. (!) This action makes independent direct request to the LDAP server (boom server configuration ignored). Optional parameters: LDAP_BASE=base LDAP_USER_ATTR=userAttribute |
Linux
| Action | Description |
|---|---|
| Disk Space Usage (df) | Displays free disk space for all your mounted filesystems in 1K blocks. |
| Find Apache Error Log File | Tries to locate the error log file based on the configuration in the httpd.conf file. |
| Find Files bigger than 10 MB | Find files bigger than 10 MB on the specified Linux host. |
| Find Files modified last 15 minutes | Finds all files that were modified during the last 15 minutes. |
| List BOOM Processes | List all boom processes running on the specified system. |
| Show Network Statistics | Display summary statistics for each protocol of the specified node. |
| Show Top Tasks | Display the tasks consuming most CPU. |
MAC OS X
| Action | Description |
|---|---|
| Kernel IO Statistics | Display Kernel IO Statistics on the specified host. |
| Net Errors | Display Statistics from the network devices. |
| Show launched Services | List all services that are registered with launchd. |
| Swap Pageouts | Report page-out activity (the number of pages paged out). |
| Virtual Memory Statistics | Display virtual memory statistics. |
SNMP
| Action | Description |
|---|---|
| SNMPWalk | SNMP walk implementation. |
SSH
| Action | Description |
|---|---|
| Remote SSH Command | This Action requires that the SSH Package was deployed. Allows you to execute a command on a remote host via a SSH connection. Select a node and complete the optional parameter field. e.g. boomnode.netage.de root pwd "ps -ef |grep boom" |
SunOS
| Action | Description |
|---|---|
| Disk Utilization (df) | Display the disk utilization for all mounted filesystems. Requires the sar (System Activity Reporter) utility. |
| SAR CPU & Swap Queue | sar -q checks the queue activity. Requires the sar (System Activity Reporter) utility. |
| SAR CPU Load | sar -u shows the CPU utilization. Requires the sar (System Activity Reporter) utility. |
| SAR Disk Activity | The output of sar -d shows various disk-related statistics. Requires the sar (System Activity Reporter) utility. |
| SAR IPC | sar -m checks the interprocess communication. Requires the sar (System Activity Reporter) utility. |
| SAR System Table Status | sar -v checks the system table status. Requires the sar (System Activity Reporter) utility. |
Unix
| Action | Description |
|---|---|
| List BOOM Processes | List all boom processes running on the specified system. |
| Print System Information | List basic information currently available from the system. |
| Show Free Diskspace | Shows the statistics for the available file systems. |
| Show Listening Ports | List all ports that are currently in state LISTEN. Requires the lsof utility. |
| Show Network Statistics | Shows per-protocol network statistics. |
| Show Processes | Show all processes that are running on the system. |
| Show Routing Configuration | Displays the routing table. |
| Show Top 10 busy Processes | Displays the top 10 busy processes in descending order (most busy process at the top): PID CPU% MemSize(Kb) Command Arguments |
| System Utilization | Displays the current system utilization |
Windows
| Action | Description |
|---|---|
| Available Shares | Displays information about all of the resources that are shared on the specified host. |
| Show Hostname | Displays the windows host name. |
| Show IP Configuration | Displays the IP Configuration details of all available adapters. |
| Show Network Connections | Displays all currently open network connections. |
| Show Network Statistics | Displays the ethernet statistics of the specified host. |
| Show Processes | Displays all processes that are running on the specified host. |
| Show Remotely Open Files | Displays the names of all open shared files on the specified host and the number of
file locks. You can use NET FILE to close individual files and release the locks. Use
net file |
| Show Routing Configuration | Displays the routing table of the specified host. |
| Show running Services | Displays a list of services that are currently running. |
| SMB Client Information | Displays the configuration for the Workstation service. |
| SMB Client Statistics | Displays statistics for the Workstation service. |
| SMB Server Information | Displays the configuration for the Server Service. |
| SMB Server Statistics | Displays statistics for the Server service. |
| View Sessions | Displays information about all sessions with the local computer. |
See also Chapter Actions for more information about Actions.
Action Operations
Action Groups are used to group Actions together as needed. An Action Group can contain both Remote and Server Actions, but no subfolders! All action specific functions can be found in the context menu (right-click on a list element):
| Action group context menu: | |
 |
Rename Group: Rename the selection Action Group. Import Actions: You have the possibility to import Actions from a xml file. Export Actions: This will export all Actions to a xml file. Rename Group: Rename an existing Action Group. Add Group: Create a new Action Group. Delete Group: The Action Group with all actions inside will be removed from the Action list. Add Action: A new Action will be opened in the Action Details View. All changes to to the Action specific attributes have to be saved before running the action. |
| Action context menu: | |
 |
Import Actions: You have the possibility to import Actions from a xml file. [Run: <action_name>]: This opens the Run Action Dialog (see below) from where the selected action can be executed. Edit: The Action will be opened in the Action Details View where all Action specific attributes can be changed. Add Action: Creates a new Action. This new Action will be opened in the Action Details View where all Action specific attributes can be specified. Duplicate Action: If you want to create a new Action based on an existing one. Delete Action: Deletes the selected Action from the tree. |
Action Details
The Action Details View contains all Action specific data. All changes that are made to an Actions have to be saved before executing the Action: The following attributes can be specified:
| Label | Action name |
| Call | The Action command |
| Type | Type is by default EXEC. It automatically switches to JAVA_ACTION if the "Call" field starts with "IAction" word. |
| Server Action | Flag indicates an action that can be executed on the boom server. |
| Timeout (sec) | Defines the timeout in seconds. |
| Editable Parameters | Optional call parameters. |
| Description | Description of the Action. |
| Help | Help text for the Action. |
Run Action
To execute an Action click on "Run:<action>" in the Action Context Menu or double-click on the Action itself in the Action list.
The "Run Action Dialog" opens before the Action is executed. In case of a Remote Action you have to select the boom Agent where you want to run
the Action. Any changes that are made in this dialog will not be saved! Changing the Action Details can only be done in the Action Details
View (select the "Edit" function from the context menu).
Note: 'OWNER' rights are necessary to be able to create, edit or delete an Action. To be able to execute
an Actions the user needs at least 'GUEST' rights.
Remote Action
A Remote Actions, which can be any script or executable, can be executed on any remote system where the boom Agent is installed.
Server Action
If an Action is defined as a "Server Action" it will always be executed on the boom Server. In this case no boom Agent needs to be defined in the Run Dialog.
