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 commandname commandparameters
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 commandname commandparameters
- editMachine
- Command to edit the machine details:
editmachine -m MACHINENAME [-n NEWMACHINENAME] [-i IPADDRESS] [-o {"windows", "unix", "os-x"}] [-b BEHOME] [-t BETRA] [-u USER] [-p PWD] [-s= SSHPORT] [-f DEPLOYMENTPATH]
- editDeployment
- Command to edit an application deployment:
editdeployment -d APPLICATIONNAME [-c CDDFILE] [-e EARFILE]
- editInstance
- Command to edit an application instance:
editinstance -d APPLICATIONNAME -i INSTANCENAME [-u PU] [-m MACHINENAME] [-p JMXPORT] [-f DEPLOYMENTPATH] [-ju JMXUSER] [-jp JMXPASS]
- saveGlobalVariable
- Command to update global variable for one or multiple instances. Only one variable is allowed to be updated at a time. Some variables cannot be updated.
saveglobalvariable -d APPLICATIONNAME [-i [INSTANCES [INSTANCES ...]]] -n VARNAME -v VARVALUE
- saveSystemProperty
- Command to update or add a system property for one or multiple instances:
savesystemproperty -d APPLICATIONNAME [-i [INSTANCES [INSTANCES ...]]] -n PROPNAME -v PROPVALUE
- saveJVMProperty
- Command to update JVM property for one or multiple instances:
savejvmproperty -d APPLICATIONNAME [-i [INSTANCES [INSTANCES ...]]] –n PROPNAME -v PROPVALUE
- saveBEProperty
- Command to update BusinessEvents property for one or multiple instances:
savebeproperty -d APPLICATIONNAME [-i [INSTANCES [INSTANCES ...]]] –n PROPNAME -v PROPVALUE
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 commandname commandparameters
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 commandname commandparameters
- addMachine
- Command to add a new machine:
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
- Command to create a new application using the specified CDD and EAR files:
createdeployment -d APPLICATIONNAME -c CDDFILE -e EARFILE
- importDeployment
- Command to import an application using the specified CDD, EAR, and site topology files:
importdeployment -d APPLICATIONNAME -c CDDFILE -e EARFILE -s=STFILE
- deleteDeployment
- Command to delete the application:
deletedeployment -d APPLICATIONNAME
- createInstance
- Command to create a new instance of an application. The JMX username and password is governed by policy in the CDD file:
createinstance -d APPLICATIONNAME -i INSTANCENAME -u PU -m MACHINENAME -p JMXPORT [-f DEPLOYMENTPATH] [-ju JMXUSER] [-jp JMXPASS] [-bh BEHOME]
- copyInstance
- Command to copy an existing instance of an application. The JMX username and password is governed by policy in the CDD file:
copyinstance -d APPLICATIONNAME -i INSTANCENAME -n NEWINSTANCENAME -u PU -m MACHINENAME -p JMXPORT -f DEPLOYMENTPATH [-ju JMXUSER] [-jp JMXPASS] [-bh BEHOME]
- deleteInstance
- Command to delete an instance:
deleteinstance -d APPLICATIONNAME -i INSTANCENAME
- deploy
- Command to deploy application instances based on the specified machine, processing unit, or agent class:
deploy -d APPLICATIONNAME [-m MACHINE | -u PU | -a AGENTCLASS] [-i [INSTANCES [INSTANCES ...]]]
- undeploy
- Command to undeploy application instances based on the specified machine, processing unit, or agent class:
undeploy -d APPLICATIONNAME [-m MACHINE | -u PU | -a AGENTCLASS] [-i [INSTANCES [INSTANCES ...]]]
- start
- Command to start application instances based on the specified machine, processing unit, or agent class:
start -d APPLICATIONNAME [-m MACHINE | -u PU | -a AGENTCLASS] [-i [INSTANCES [INSTANCES ...]]]
- stop
- Command to stop application instances based on the specified machine, processing unit, or agent class:
stop -d APPLICATIONNAME [-m MACHINE | -u PU | -a AGENTCLASS] [-i [INSTANCES [INSTANCES ...]]]
- hotdeploy
- Command to hotdeploy an application provided by the EAR file:
hotdeploy -d APPLICATIONNAME -e EARFILE
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 commandname commandparameters
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 commandname commandparameters
- migrateapplications
- Command to migrate application, that is exported from TIBCO Administrator, to TIBCO BusinessEvents Enterprise Administrator agent. See
Exporting Application from TIBCO Administrator for more details.
migrateapplications -z EXPORTED_ZIP_FILE_PATH
- migrateuserandroles
- Command to migrate user and role from the application, that is exported from TIBCO Administrator, to TIBCO BusinessEvents Enterprise Administrator agent:
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".
[] | Identifies an optional parameter |
-ssl | (Optional) Enable SSL for the python script execution. The values are:
The default value is false. |
-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 |
-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 |
-n PROPNAME | System, BusinessEvents, or JVM property name |
-v PROPVALUE | System, BusinessEvents, or JVM property value |
-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 the .zip file of the application exported from TIBCO Administrator. See Exporting Application from TIBCO Administrator for more details. |
-bh BEHOME | TIBCO BusinessEvents installation location |
-abh ADDBEHOME | Additional TIBCO BusinessEvents installation location if multiple TIBCO BusinessEvents installations are present. |
Copyright © TIBCO Software Inc. All rights reserved.