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 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 -gt GLOBAL_TIMEOUT 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]
- deleteMachine
- Command to delete the machine:
deletemachine -m MACHINENAME
- discoverBEHomes
- Command to discover BusinessEvents installation on the machine:
discoverbehomes -m MACHINENAME [-s=SAVE]
- uploadExternalJars
- Command to upload external JAR file:
uploadexternaljars -m MACHINENAME -b BEHOME -z JARFILES
- 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
- saveDeploymentVariables
- Command to bulk upload deployment variables:
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 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 -gt GLOBAL_TIMEOUT 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
- downloadLogs
- Command to download logs for multiple instances:
downloadlogs -d APPLICATIONNAME -l DOWNLOADLOCATION -lt LOGTYPE(BE | AS | TD) [-i [INSTANCES [INSTANCES ...]]
- exportTeaDeployment
- Command to export the application and all its components such as, CDD file, EAR file, and configuration XML file in a archive file:
exportteadeployment -d APPLICATIONNAME -l DOWNLOADLOCATION
- importTeaDeployment
- Command to import a application deployment:
importteadeployment -z ZIPFILE
- hotDeployDtRt
- Command to hot deploy decision table and business rule:
hotdeploydtrt -d APPLICATIONNAME -i INSTANCENAME -o DEPLOYTYPE (DT | RT) -z ZIPFILE
- checkStatus
- Command to check status of a machine or an application:
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 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".
Copyright © Cloud Software Group, Inc. All rights reserved.