TIBCO BusinessEvents Enterprise Administrator Agent Commands Reference
You can execute the configuration and application management commands for BusinessEvents Enterprise Administrator Agent in the Python-based command-line interface. The python script files are located at BE_HOME\teagent\cli\python.
Configuration Management Commands (configurationMgmt.py)
Without SSL
The syntax for executing the configurationMgmt.py python script file is:
python configurationMgmt.py -t SERVERURL -u USERNAME -p USERPWD -gt GLOBAL_TIMEOUT commandnamecommandparameters
With SSL
The syntax for executing the configurationMgmt.py python script file with SSL is:
python configurationMgmt.py -ssl true -t SERVERURL -u USERNAME -p USERPWD -sc SERVER_CERTIFICATE_PATH -cc CLIENT_CERTIFICATE_PATH -gt GLOBAL_TIMEOUT commandnamecommandparameters
editmachine -m MACHINENAME [-n NEWMACHINENAME] [-i IPADDRESS] [-o {"windows", "unix", "os-x"}] [-b BEHOME] [-t BETRA] [-u USER] [-p PWD] [-s= SSHPORT] [-f DEPLOYMENTPATH]
deletemachine -m MACHINENAME
discoverbehomes -m MACHINENAME [-s=SAVE]
uploadexternaljars -m MACHINENAME -b BEHOME -z JARFILES
editdeployment -d APPLICATIONNAME [-c CDDFILE] [-e EARFILE]
editinstance -d APPLICATIONNAME -i INSTANCENAME [-u PU] [-m MACHINENAME] [-p JMXPORT] [-f DEPLOYMENTPATH] [-ju JMXUSER] [-jp JMXPASS]
saveglobalvariable -d APPLICATIONNAME [-i [INSTANCES [INSTANCES ...]]] -n VARNAME -v VARVALUE
savesystemproperty -d APPLICATIONNAME [-i [INSTANCES [INSTANCES ...]]] -n PROPNAME -v PROPVALUE
savejvmproperty -d APPLICATIONNAME [-i [INSTANCES [INSTANCES ...]]] –n PROPNAME -v PROPVALUE
savebeproperty -d APPLICATIONNAME [-i [INSTANCES [INSTANCES ...]]] –n PROPNAME -v PROPVALUE
savedeploymentvariables -d APPLICATIONNAME [-i [INSTANCES [INSTANCES ...]]] -tp VARTYPE -p PROPERTY_FILE_PATH
Application Management Commands (applicationsMgmt.py)
Without SSL
The syntax for executing the applicationsMgmt.py python script file is:
python applicationsMgmt.py -t SERVERURL -u USERNAME -p USERPWD -gt GLOBAL_TIMEOUT commandnamecommandparameters
With SSL
The syntax for executing the applicationsMgmt.py python script file with SSL is:
python applicationsMgmt.py -ssl true -t SERVERURL -u USERNAME -p USERPWD -sc SERVER_CERTIFICATE_PATH -cc CLIENT_CERTIFICATE_PATH -gt GLOBAL_TIMEOUT commandnamecommandparameters
addmachine -m MACHINENAME -i IPADDRESS -o {"windows", "unix", "os-x"} -b BEHOME –t BETRA -u USER -p PWD -s=SSHPORT -f DEPLOYMENTPATH [-abh ADDBEHOME]
createdeployment -d APPLICATIONNAME -c CDDFILE -e EARFILE
deletedeployment -d APPLICATIONNAME
createinstance -d APPLICATIONNAME -i INSTANCENAME -u PU -m MACHINENAME -p JMXPORT [-f DEPLOYMENTPATH] [-ju JMXUSER] [-jp JMXPASS] [-bh BEHOME]
copyinstance -d APPLICATIONNAME -i INSTANCENAME -n NEWINSTANCENAME -u PU -m MACHINENAME -p JMXPORT -f DEPLOYMENTPATH [-ju JMXUSER] [-jp JMXPASS] [-bh BEHOME]
deleteinstance -d APPLICATIONNAME -i INSTANCENAME
deploy -d APPLICATIONNAME [-m MACHINE | -u PU | -a AGENTCLASS] [-i [INSTANCES [INSTANCES ...]]]
undeploy -d APPLICATIONNAME [-m MACHINE | -u PU | -a AGENTCLASS] [-i [INSTANCES [INSTANCES ...]]]
start -d APPLICATIONNAME [-m MACHINE | -u PU | -a AGENTCLASS] [-i [INSTANCES [INSTANCES ...]]]
stop -d APPLICATIONNAME [-m MACHINE | -u PU | -a AGENTCLASS] [-i [INSTANCES [INSTANCES ...]]]
hotdeploy -d APPLICATIONNAME -e EARFILE
downloadlogs -d APPLICATIONNAME -l DOWNLOADLOCATION -lt LOGTYPE(BE | AS | TD) [-i [INSTANCES [INSTANCES ...]]
exportteadeployment -d APPLICATIONNAME -l DOWNLOADLOCATION
importteadeployment -z ZIPFILE
hotdeploydtrt -d APPLICATIONNAME -i INSTANCENAME -o DEPLOYTYPE (DT | RT) -z ZIPFILE
checkstatus -d APPLICATIONNAME -m MACHINE [-i INSTANCENAME] [-an AGENTNAME] [-da DISPLAYALL]
Administrator to BusinessEvents Enterprise Administrator Agent Migration Commands (adminToAgentMigration.py)
Without SSL
The syntax for executing the adminToAgentMigration.py python script file is:
python adminToAgentMigration.py -t SERVERURL -u USERNAME -p USERPWD commandnamecommandparameters
With SSL
The syntax for executing the adminToAgentMigration.py python script file with SSL is:
python adminToAgentMigration.py -ssl true -t SERVERURL -u USERNAME -p USERPWD -sc SERVER_CERTIFICATE_PATH -cc CLIENT_CERTIFICATE_PATH commandnamecommandparameters
migrateapplications -z EXPORTED_ZIP_FILE_PATH
migrateuserandroles -x EXPORTED_XML_FILE_PATH
Arguments for Commands
The following table lists the arguments provided to the BusinessEvents Enterprise Administrator Agent commands and their description. Any argument with spaces are enclosed in double quotes, for example,
-o "OX/X,Unix/Linux Based"
.
Parameters | Description |
---|---|
[]
|
Identifies an optional parameter |
-ssl
|
(Optional) Enable SSL for the python script execution. The values are:
The default value is
|
-sc SERVER_CERTIFICATE_PATH
|
Path of the server SSL certificate. |
-cc CLIENT_CERTIFICATE_PATH
|
Path of the client SSL certificate. |
-t SERVERURL
|
The TIBCO Enterprise Administrator server URL
If no value is provided then default value (http://localhost:8777) is used. |
-u USERNAME
|
TIBCO Enterprise Administrator server user name |
-p USERPWD
|
TIBCO Enterprise Administrator server password |
-gt GLOBAL_TIMEOUT
|
Optional parameter to set a timeout value while executing the python script files. Default value is 30 seconds.
Note: The maximum timeout you can set is 120 seconds. To set a timeout greater than that, change the default value of
tea.agents.request-timeout property in the TIBCO Enterprise Administrator server configuration file (tea.conf).
|
-a AGENTCLASS
|
Agent class |
-an AGENTNAME
|
Agent name |
-da DISPLAYALL
|
Displays status of all instances and agent of a machine or application |
-m MACHINENAME
|
The current machine name |
-n NEWMACHINENAME
|
The new machine name after changing current machine name |
-i IPADDRESS
|
The IP address of the machine |
-o {"windows", "unix", "os-x"}
|
Type of the operating system of the machine |
-b BEHOME
|
The location where TIBCO BusinessEvents is installed |
-t BETRA
|
The location of the be-engine.tra file |
-u USER
|
The username for the machine. |
-p PWD
|
The password for the user name of the machine |
-s SSHPORT
|
The SSH port number |
-f DEPLOYMENTPATH
|
The deployment path location |
-d APPLICATIONNAME
|
The application name |
-c CDDFILE
|
The location of the CDD file of the application |
-e EARFILE
|
The location of the EAR file of the application |
-i INSTANCENAME
|
The application instance name |
[-i [INSTANCES [INSTANCES ...]]]
|
Identifies multiple instance names. For example,
–i instance1 ins2 ins3 .
|
-u PU
|
Processing unit name |
-p JMXPORT
|
JMX port number |
-ju JMXUSER
|
JMX user name |
-jp JMXPASS
|
JMX password |
-n VARNAME
|
Global variable name. |
-v VARVALUE
|
Global variable value |
-tp VARTYPE
|
Type of variable that needs to be updated.
Possible values are as follows:
|
-n PROPNAME
|
System, BusinessEvents, or JVM property name |
-v PROPVALUE
|
System, BusinessEvents, or JVM property value |
-p PROPERTY_FILE_PATH
|
The location of the property file that contains the deployment variables.
Note: One type of property file must contain only one type of deployment variables.
|
-x EXPORTED_XML_FILE_PATH
|
The location of the XML file of the application exported from TIBCO Administrator. |
-z EXPORTED_ZIP_FILE_PATH
|
The location of external archive file (ZIP or JAR). |
-bh BEHOME
|
TIBCO BusinessEvents installation location |
-abh ADDBEHOME
|
Additional TIBCO BusinessEvents installation location if multiple TIBCO BusinessEvents installations are present. |
-s SAVE
|
Save the location of BusinessEvents installation for the machine. |
-o DEPLOYTYPE
|
Type of artifact to be hot deployed. The values are:
|
-l DOWNLOADLOCATION
|
Download location of log files. |
-lt LOGTYPE
|
Type of the logs to be downloaded. The values are:
|