Command Line Interface

boom comes with a comprehensive command line interface in form of the java library boom_cli.jar. You can start right away by checking the available command and options by having a look at the help/usage of the command line interface via:

java -jar boom_cli.jar -h



boom CLI Usage

java
-jar boom_cli.jar -h (prints usage)
java
-jar boom_cli.jar [-s <server>] [-x <outputseparator>] -u <user> -p <password> [-fs <conffile>] \
-c <command> [-cc <option>] [-a <argument1>] [-a <argument2>] ...
java
-jar boom_cli.jar -f <conffile> [-x <outputseparator>] -c <command> [-cc <option>] [-a <argument1>] [-a <argument2>] ...


Create Configuration File

java -jar boom_cli.jar [-s ] -u  -p  -fs boom_cli.cfg
DESCRIPTION
Generates a configuration file with stored connection parameters.

EXAMPLES
java -jar boom_cli.jar -u user -p password -fs boom_cli.cfg
java -jar boom_cli.jar -s servername.domain.com:23022 -u user -p password -fs boom_cli.cfg


GETNODEGROUPS

java -jar boom_cli.jar -f <conffile> -c GETNODEGROUPS -cc <option> [-a <argument1>] [-a <argument2>] ...
DESCRIPTION
Checks if a NodeGroup contains a specified Node.

COMMAND
-c "GETNODEGROUPS"

OPTION
-cc "print"|"list"|"listnames"|"listpaths"|"checkname"|"checkpath" (required)

print:print file nodeGroups.xml (arguments ignored)
list: list all NodeGroup names and their path (arguments ignored)
listnames:list all NodeGroup names only (arguments ignored)
listpaths:list all NodeGroup paths (arguments ignored)
checkname:check if NodeGroup does exist (Result code: indicates the number of not found NodeGroups)
checkpath:check if NodeGroup path does exist (Result code: indicates the number of not found NodeGroups)

ARGUMENTS
-a NodeGroup name(s) - for checkname option
-a path(s) - for checkpath option

EXAMPLES
Check if the NodeGroups "group01" and "group02" do exist:
java -jar boom_cli.jar -f boom_cli.cfg -c GETNODEGROUPS -cc checkname -a group01 -a group02
Check if NodeGroup path exist: 
java -jar boom_cli.jar -f boom_cli.cfg -c GETNODEGROUPS -cc checkpath -a /root/_Groups/TEstMY
Check if short (without /root/_Group) NodeGroup path exist: 
java -jar boom_cli.jar -f boom_cli.cfg -c GETNODEGROUPS -cc checkpath -a /TEstMY
Print nodegroups.xml file: 
java -jar boom_cli.jar -f boom_cli.cfg -c GETNODEGROUPS -cc print
Prints paths and names of all existing NodeGroups: 
java -jar boom_cli.jar -f boom_cli.cfg -c GETNODEGROUPS -cc list
Prints names of all existing NodeGroups: 
java -jar boom_cli.jar -f boom_cli.cfg -c GETNODEGROUPS -cc listnames
Prints paths of all existing NodeGroups: 
java -jar boom_cli.jar -f boom_cli.cfg -c GETNODEGROUPS -cc listpaths


GETAGENTCARDS

java -jar boom_cli.jar -f <conffile> -c GETAGENTCARDS [-cc ngname [-a "NodeGroup name1"] [-a "NodeGroup name2"]...]
DESCRIPTION
Prints agent list. Columns are Agent_ID, hostname, IP, OS.

COMMAND
-c "GETAGENTCARDS"

OPTION
-cc "ngname"|"ngpath"|"agtid" (option requires at least one argument specified.)

ARGUMENTS
-a "NodeGroup name"|"NodeGroup path" (depends on option specified)

EXAMPLES
List all agents that belong to the given NodeGroup: 
java -jar boom_cli.jar -f boom_cli.cfg -c GETAGENTCARDS
List agents for the specified NodeGroups: 
java -jar boom_cli.jar -f boom_cli.cfg -c GETAGENTCARDS -cc ngname -a group01 -a group02
List agents for the specified NodeGroup paths: 
java -jar boom_cli.jar -f boom_cli.cfg -c GETAGENTCARDS -cc ngpath -a "/root/_Groups/TEstMY" -a "/root/_Groups/WWW"
List agents for the specified AgentIDs: 
java -jar boom_cli.jar -f boom_cli.cfg -c GETAGENTCARDS -cc agtid -a 6ff38d81-9e79-4cb6-9571-a7e2622f3297 -a 8lk38d81-9e79-c5b6-9571-a7e4892f3034


CHECK_NG4AGENT

java -jar boom_cli.jar -f <conffile> -c CHECK_NG4AGENT -cc "NodeGroup name" -a <agentID1> [-a <agentID2>] ...
DESCRIPTION
This command checks if given NodeGroup contains the specified Agent(s).
Result code indicates count of Agents not linked to given NodeGroup

COMMAND
-c "CHECK_NG4AGENT"

OPTION
-cc "NodeGroup name" (required)

ARGUMENTS
-a Agent_ID(s) (at least one argument must be specified)

EXAMPLES
Check if the NodeGroup "Group01" contains the given agent: 
java -jar boom_cli.jar -f boom_cli.cfg -c CHECK_NG4AGENT -cc Group01 -a 6ff38d81-9e79-4cb6-9571-a7e2622f3297


CHECK_NGPATH4AGENT

java -jar boom_cli.jar -f <conffile> -c CHECK_NGPATH4AGENT -cc "NodeGroup path" -a <agentID1> [-a <agentID2>] ...
DESCRIPTION
This command checks if given NodeGroup contains the specified Agent(s).
Result code indicates count of Agents not linked to given NodeGroup

COMMAND
-c "CHECK_NGPATH4AGENT"

OPTION
-cc "NodeGroup path" (at least one argument must be specified)

ARGUMENTS
-a Agent_ID(s)

EXAMPLES
Check if the NodeGroup "Group01" contains the given agent: 
java -jar boom_cli.jar -f boom_cli.cfg -c CHECK_NGPATH4AGENT -cc /root/_Groups/TEstMY -a 6ff38d81-9e79-4cb6-9571-a7e2622f3297


GETPOLICIES

java -jar boom_cli.jar -f <conffile> -c CLI_GETPOLICIES -cc <option> [-a <argument1>] [-a <argument2>] ...
DESCRIPTION
Print Policy list.

COMMAND
-c "GETPOLICIES"

OPTION
-cc "print"|"list"|"listnames"|"listpaths"|"checkname"|"checkpath" (required)

print: print file policyGroups.xml
list: list Policy names with path, type and version
listnames:list Policy names only
listpaths:ist Policy paths only
checkname:check if Policy does exist
checkpath:check if Policy path does exist

ARGUMENTS
-a "name"|"path"

EXAMPLES
java -jar boom_cli.jar -f boom_cli.cfg -c GETPOLICIES -cc list
java -jar boom_cli.jar -f boom_cli.cfg -c GETPOLICIES -cc listnames
java -jar boom_cli.jar -f boom_cli.cfg -c GETPOLICIES -cc listpath
java -jar boom_cli.jar -f boom_cli.cfg -c GETPOLICIES -cc checkname -a BOOM_Ping -a JMX_Memory
java -jar boom_cli.jar -f boom_cli.cfg -c GETPOLICIES -cc checkpath -a BOOM/BOOM_Ping -a BOOM/Linux/linuxOSMPI_Disk_usage


IMPORT_POLICIES

java -jar boom_cli.jar -f <conffile> -c IMPORT_POLICIES [-cc force] -a <SourceDirectory">
DESCRIPTION
Import one ore more Policies.

COMMAND
-c "IMPORT_POLICIES"

OPTION
-cc "force"

force: In case of a version conflict, the Policy will be imported with a higher version.
Without this option all Policies with version conflicts will be ignored.

ARGUMENTS
-a Local directory that contains all Policy files for import.

EXAMPLES
java -jar boom_cli.jar -f boom_cli.cfg -c IMPORT_POLICIES -cc forceImport -a Policies/toImport


EXPORT_POLICIES

java -jar boom_cli.jar -f <conffile> -c EXPORT_POLICIES -cc policy -a <ExportDirectory"> -a <PolicyType"> -a <PolicyName"> [-a <argument4> -a <argument5>] ...
java -jar boom_cli.jar -f <conffile> -c EXPORT_POLICIES -cc group -a <ExportDirectory"> -a <PolicyGroupPath">
DESCRIPTION
Export one ore more Policies to xml formatted files.

COMMAND
-c "EXPORT_POLICIES"

OPTION
-cc "policy"|"group"

policy: Export single Policies
group: Export all policies inside the given Policy Group

ARGUMENTS
-a (1) Arguments for the option "-cc policy":

1.arg: export directory.
all further arguments must be a pair of type and name:
2.arg: Policy type (mon|msg)
3.arg:Policy name
...
(2) Arguments for the option "group":
1.arg:export directory.
2.arg:PolicyGroup with path.

EXAMPLES
java -jar boom_cli.jar -f boom_cli.cfg -c EXPORT_POLICIES -cc policy -a Policies01/export -a mon -a BOOM_Ping -a msg -a hpuxOSMPI_Syslogs
java -jar boom_cli.jar -f boom_cli.cfg -c EXPORT_POLICIES -cc group -a Policies01/export -a BOOM/Agentless/


CREATE_PACKAGE

java -jar boom_cli.jar -f <conffile> -c CREATE_PACKAGE -a <PackageName1">
DESCRIPTION
Create Binary Package!

COMMAND
-c "CREATE_PACKAGE"

ARGUMENTS
-a Package Name

EXAMPLES
java -jar boom_cli.jar -f boom_cli.cfg -c CREATE_PACKAGE -a package01


PUT_FILE

java -jar boom_cli.jar -f <conffile> -c PUT_FILE -cc <packageName> -a <argument1>
DESCRIPTION
Upload file to a binary package. If specified file exist, it will be replaced

COMMAND
-c "PUT_FILE"

OPTION
-c "BinaryPackage name" (required)

ARGUMENTS
-a Local file path (at least one argument must be specified)

EXAMPLES
java -jar boom_cli.jar -f boom_cli.cfg -c PUT_FILE -cc package01 -a myFile1.dat


CREATE_FILE

java -jar boom_cli.jar -f <conffile> -c PUT_FILE -cc <packageName> -a <argument1>
DESCRIPTION
Creates and uploads a new file on the server. If specified file exist, upload will be canceled.

COMMAND
-c "PUT_FILE"

OPTION
-c "BinaryPackage name" (required)

ARGUMENTS
-a Local file path (at least one argument must be specified)

EXAMPLES
java -jar boom_cli.jar -f boom_cli.cfg -c PUT_FILE -cc package01 -a myFile1.dat


DEPLOY

java -jar boom_cli.jar -f <conffile> -c DEPLOY [-cc <Agent_ID>] [-a <argument1>] [-a <argument2>] ...
DESCRIPTION
Deploy policies, binary packages or assignments

COMMAND
-c "DEPLOY"

OPTION
-cc Agent_ID (required)

ARGUMENTS
-a Pair of 2 arguments:

1.arg: object type (available types are mon|msg|asn|pkg
2.arg: object name

EXAMPLES
Deploy Assignment and Policy to the given Agent:
java -jar boom_cli.jar -f boom_cli.cfg -c DEPLOY -cc 6ff38d81-9e79-4cb6-9571-a7e2622f3297 -a asn -a BOOM -a mon -a BOOM_Ping


UNDEPLOY

java -jar boom_cli.jar -f <conffile> -c UNDEPLOY -cc <Agent_ID> -a <type> -a <name> [-a <argument3>] [-a <argument4>] ...
DESCRIPTION
Undeploy policies, binary packages or assignments

COMMAND
-c "UNDEPLOY"

OPTION
-cc Agent_ID (required)

ARGUMENTS
-a Pair of 2 arguments:

The first two arguments are required!
1.arg: object type (available types are mon|msg|asn|pkg
2.arg: object name


EXAMPLES
Undeploy Assignment and Policy to the given Agent:
java -jar boom_cli.jar -f boom_cli.cfg -c UNDEPLOY -cc 6ff38d81-9e79-4cb6-9571-a7e2622f3297 -a asn -a BOOM -a mon -a BOOM_Ping


GETAGENTID

java -jar boom_cli.jar -f <conffile> -c GETAGENTID -cc "AgentHostname"
DESCRIPTION
This command returns Agent ID(s) for the specified Agent hostname. COMMAND
-c "GETAGENTID"

OPTION
-cc AgentHostname (required)

EXAMPLES
java -jar boom_cli.jar -f boom_cli.cfg -c GETAGENTID -cc linuxserver01


PUSH_PACKAGE

java -jar boom_cli.jar -f <conffile> -c PUSH_PACKAGE -cc <packageName>
DESCRIPTION
Upload package to all PROXY slave servers

COMMAND
-c "PUSH_PACKAGE"

OPTION
-c "BinaryPackage name" (required)

EXAMPLES
java -jar boom_cli.jar -f boom_cli.cfg -c PUSH_PACKAGE -cc package01


LIST_PACKAGES

java -jar boom_cli.jar -f <conffile> -c LIST_PACKAGES [-cc <packageName>]
DESCRIPTION
List binary package names or content of package

COMMAND
-c "LIST_PACKAGES"

OPTION
-c "BinaryPackage name" (optional)

force: In case of a optional package name specified - prints file pathed.

EXAMPLES
java -jar boom_cli.jar -f boom_cli.cfg -c LIST_PACKAGES