Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# TIBCO BusinessEvents Enterprise Administrator Agent Commands Reference

You can run the configuration and application management commands for BusinessEvents Enterprise Administrator Agent in the Python-based command-line interface. The python script files are at BE_HOME\teagent\cli\python.

- Configuration Management Commands (configurationMgmt.py)

- Application Management Commands (applicationsMgmt.py)

- Administrator to BusinessEvents Enterprise Administrator Agent Migration Commands (adminToAgentMigration.py)

- Arguments for Commands

## Configuration Management Commands (configurationMgmt.py)

Without SSL

The syntax for running the configurationMgmt.py python script file is:

    python configurationMgmt.py -t SERVERURL -u USERNAME -p USERPWD -gt GTIMEOUT commandnamecommandparameters

With SSL

The syntax for running the configurationMgmt.py python script file with SSL is:

    python configurationMgmt.py -ssl SSLENABLED -t SERVERURL -u USERNAME -p USERPWD -sc SERVERCERT -cc CLIENTCERT -gt GTIMEOUT commandnamecommandparameters

editMachine
Command to edit the machine details:

    editmachine [-h] -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 [-h] -m [MACHINENAMES ...]

discoverBEHomes
Command to discover BusinessEvents installation on the machine:

    discoverbehomes [-h] -m MACHINENAME [-s=SAVE]

uploadExternalJars
Command to upload an external JAR file:

    uploadexternaljars [-h] -m MACHINENAME -b BEHOME -z JARFILES

editDeployment
Command to edit an application deployment:

    editdeployment [-h] -d APPLICATIONNAME [-c CDDFILE] [-e EARFILE]

editInstance
Command to edit an application instance:

    editinstance [-h] -d APPLICATIONNAME -i INSTANCENAME [-u PU] [-m MACHINENAME] [-p JMXPORT] [-f DEPLOYMENTPATH] [-ju JMXUSER] [-jp JMXPASS] [-bh BEHOME]

saveGlobalVariable
Command to update a global variable for one or multiple instances. Only one variable can be updated at a time. Some variables cannot be updated.

    saveglobalvariable [-h] -d APPLICATIONNAME [-i [INSTANCES ...]] -n VARNAME -v VARVALUE

saveSystemProperty
Command to update or add a system property for one or multiple instances:

    savesystemproperty [-h] -d APPLICATIONNAME [-i [INSTANCES ...]] -n PROPNAME -v PROPVALUE

saveJVMProperty
Command to update JVM property for one or multiple instances:

    savejvmproperty [-h] -d APPLICATIONNAME [-i [INSTANCES ...]] -n PROPNAME -v PROPVALUE

saveBEProperty
Command to update BusinessEvents property for one or multiple instances:

    savebeproperty [-h] -d APPLICATIONNAME [-i [INSTANCES ...]] -n PROPNAME -v PROPVALUE

saveDeploymentVariables
Command to bulk upload deployment variables:

    savedeploymentvariables [-h] -d APPLICATIONNAME [-i [INSTANCES ...]] -tp TYPE -p PROPFILE

## Application Management Commands (applicationsMgmt.py)

Without SSL

The syntax for running the applicationsMgmt.py python script file is:

    python applicationsMgmt.py -t SERVERURL -u USERNAME -p USERPWD -gt GTIMEOUT commandnamecommandparameters

With SSL

The syntax for running the applicationsMgmt.py python script file with SSL is:

    python applicationsMgmt.py -ssl SSLENABLED -t SERVERURL -u USERNAME -p USERPWD -sc SERVERCERT -cc CLIENTCERT -gt GTIMEOUT commandnamecommandparameters

addMachine
Command to add a machine:

    addmachine [-h] -m MACHINENAME -i IPADDRESS -o {windows,unix,os-x} -b BEHOME –t BETRA -v BEVERSION -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 [-h] -d APPLICATIONNAME -c CDDFILE -e EARFILE

deleteDeployment
Command to delete the application:

    deletedeployment [-h] -d APPLICATIONNAME

createInstance
Command to create an instance of an application. The JMX username and password is governed by the policy in the CDD file:

    createinstance [-h] -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 the policy in the CDD file:

    copyinstance [-h] -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 [-h] -d APPLICATIONNAME [-i [INSTANCES ...]]

deploy
Command to deploy application instances based on the specified machine, processing unit, or agent class:

    deploy [-h] -d APPLICATIONNAME [-m MACHINE | -u PU | -a AGENTCLASS] [-i [INSTANCES ...]]

undeploy
Command to undeploy application instances based on the specified machine, processing unit, or agent class:

    undeploy [-h] -d APPLICATIONNAME [-m MACHINE | -u PU | -a AGENTCLASS] [-i [INSTANCES ...]]

start
Command to start application instances based on the specified machine, processing unit, or agent class:

    start [-h] -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 [-h] -d APPLICATIONNAME [-m MACHINE | -u PU | -a AGENTCLASS] [-i [INSTANCES ...]]

hotdeploy
Command to hotdeploy an application provided by the EAR file:

    hotdeploy [-h] -d APPLICATIONNAME -e EARFILE

downloadLogs
Command to download logs for multiple instances:

    downloadlogs [-h] -d APPLICATIONNAME -l DOWNLOADLOCATION -lt {be,as,td} [-i [INSTANCES ...]]

exportTeaDeployment
Command to export the application and all its components such as, CDD file, EAR file, and configuration XML file in an archive file:

    exportteadeployment [-h] -d APPLICATIONNAME -l DOWNLOADLOCATION

importTeaDeployment
Command to import an application deployment:

    importteadeployment [-h] -z ZIPFILE

hotDeployDtRt
Command to hot deploy decision table and business rules:

    hotdeploydtrt [-h] -d APPLICATIONNAME -i INSTANCENAME -o {dt,rt} -z ZIPFILE

checkStatus
Command to check the status of a machine or an application:

    checkstatus [-h] -d APPLICATIONNAME -m MACHINE [-i INSTANCENAME] [-an AGENTNAME] [-da DISPLAYALL]

docker_createdeployment
Command to create a Docker deployment:

    docker_createdeployment [-h] -d APPLICATIONNAME

docker_addmachine
Command to add a Docker machine:

    docker_addmachine [-h] -m MACHINENAME -i IPADDRESS [-o {windows,unix,os-x}] [-u USER] [-p PWD] [-s SSHPORT]

docker_createinstance
Command to create a Docker instance:

    docker_createinstance [-h] -d APPLICATIONNAME -i INSTANCENAME -m MACHINENAME -p JMXPORT [-ju JMXUSER] [-jp JMXPASS] [-u PU]

listappsandinstances
Command to list all applications and all instances of an application:

    listappsandinstances [-h] [-d APPLICATIONNAME]

uploadmastertra
Command to provide a Master Application TRA file at the application level:

    uploadmastertra [-h] -d APPLICATIONNAME -m MACHINENAME [-ul UPLOADLOCATION] [-tf TRAFILE] [-tp TRAPATH] [-td ISDELETED]

## Administrator to BusinessEvents Enterprise Administrator Agent Migration Commands (adminToAgentMigration.py)

Without SSL

The syntax for running the adminToAgentMigration.py python script file is:

    python adminToAgentMigration.py -t SERVERURL -u USERNAME -p USERPWD commandnamecommandparameters

With SSL

The syntax for running the adminToAgentMigration.py python script file with SSL is:

    python adminToAgentMigration.py -ssl SSLENABLED -t SERVERURL -u USERNAME -p USERPWD -sc SERVERCERT -cc CLIENTCERT {migrateapplications,migrateuserandroles} ...commandnamecommandparameters

migrateapplications
Command to migrate an application that is exported from TIBCO Administrator to TIBCO BusinessEvents Enterprise Administrator agent. See Exporting Application from TIBCO Administrator for more details.

    migrateapplications -z EXPORTEDZIPFILE

migrateuserandroles
Command to migrate user and role from the application that is exported from TIBCO Administrator to TIBCO BusinessEvents Enterprise Administrator agent:

    migrateuserandroles -x EXPORTEDXMLFILE

## Arguments for Commands

The following table lists the arguments provided to the BusinessEvents Enterprise Administrator Agent commands and their description. Any arguments with spaces are enclosed in double quotes, for example, `-o "OX/X,Unix/Linux Based"`.

Parameters | Description
--- | ---
`[]` | Identifies an optional parameter
`[-h]` | Help to display parameters for the current command
`-ssl SSLENABLED` | (Optional) Enable SSL for the python script execution. The values are: true false The default value is `false`.
`-sc SERVERCERT` | Path of the server SSL certificate.
`-cc CLIENTCERT` | Path of the client SSL certificate.
`-t SERVERURL` | The TIBCO Enterprise Administrator server URL If no value is provided, then the default value (http://localhost:8777) is used.
`-u USERNAME` | TIBCO Enterprise Administrator server username
`-p USERPWD` | TIBCO Enterprise Administrator server password
`-gt GTIMEOUT` | Optional parameter to set a timeout value while running the python script files. The default value is 30 seconds. Note: The maximum timeout that you can set is 120 seconds. To set a timeout greater than that, change the default value of a`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 the status of all instances and agents of a machine or application
`-m MACHINENAME` | The current machine name
`-n NEWMACHINENAME` | The new machine name after changing the 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 username 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
`-z JARFILES` | The location of the JAR file of the application
`-z ZIPFILE` | The location of the ZIP file of the application
`-i INSTANCENAME` | The current application instance name
`[-i [INSTANCES ...]]` | Identifies multiple instance names. For example, `–i instance1 ins2 ins3`.
`-n NEWINSTANCENAME` | The new application instance name after changing the current application instance name
`-u PU` | Processing unit name
`-p JMXPORT` | JMX port number
`-ju JMXUSER` | JMX username
`-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: GV BE JVM SYS
`-tp TYPE` | Type of deployment variables to be uploaded in bulk
`-p PROPFILE` | Property file that contains the deployment variables
`-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 EXPORTEDXMLFILE` | The location of the XML file of the application exported from the TIBCO Administrator.
`-z EXPORTEDZIPFILE` | The location of an 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 {dt,rt} DEPLOYTYPE` | Type of artifact to be hot deployed. The values are: `DT` - Decision table `RT` - Business rules (rule template instance)
`-l DOWNLOADLOCATION` | Download location of log files.
`-lt {be,as,td} LOGTYPE` | Type of the logs to be downloaded. The values are: `BE` - BusinessEvents logs `AS` - Legacy ActiveSpaces logs `TD` - Thread dumps
`-m MACHINE` | The current machine
`-v BEVERSION` | Version of the current TIBCO BusinessEvents installation
`-ul UPLOADLOCATION` | The location to upload the master TRA file
`-tf TRAFILE` | The master TRA file
`-tp TRAPATH` | The location of the master TRA file on the host machine
`-td ISDELETED` | Specifies whether to delete the TRA file The values are: true false The default value is `false`.

Did you find this helpful?

YesNo
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO BusinessEvents® Enterprise Edition

Copyright © 2004-2024. Cloud Software Group, Inc. All Rights Reserved.