Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved

Chapter 2 Getting Started : Other Options

Other Options
In addition to the -export and -deploy options, the AppManage utility allows you to use:
-upload to upload an application into an administration domain without configuring the application’s deployment options.
-config to upload an application along with its deployment configuration file, which defines the application’s configuration options, but not deploy the application.
-undeploy to undeploy an application.
-delete to remove an application from an administration domain.
-start or -stop to start or stop a service or process configured under an application.
-override to use global variable values defined in the EAR file, instead of those defined in the original deployment configuration file when redeploying.
-min to generate only XML tags for options you have changed.
-max to export a template deployment configuration file with every possible setting included.
-template to generate a deployment configuration file in template format.
-password to prompt for a password that is used to encrypt or decrypt sensitive data in the deployment configuration file.
-passwordFile to use a password file to encrypt or decrypt sensitive data in the deployment configuration file.
-MoveAppData to change the transport setting for a given application.
-truncate to truncate the application deployment revision.
-desc to specify a description for the deployed application.
-serialize to deploy service instances one at a time instead of in parallel.
-exportDeployed to export the configuration for the last successful deployment rather than what is currently being modified and will be used for the next deployment.
-upload Option
You can use the AppManage utility to upload an EAR file into an administration domain. Specifying the -upload option is identical to importing an EAR in the TIBCO Administrator GUI. The application is loaded, but no deployment options are specified and the application is not deployed.
AppManage -upload -ear c:\ears\timer_wait.ear -user admin -pw admin           -domain tp002
-config Option
You can upload an EAR file and a deployment configuration file into an administration domain and not deploy the application. The -config option uploads the EAR file and the deployment configuration file, but does not deploy the application. You can omit the -ear option if the EAR file is already loaded in the domain.
AppManage -config -ear c:\ears\timer_wait.ear -deployConfig c:\ears\deployments\timer_wait.xml -app timer_wait -user admin -pw admin -domain tp002
-undeploy Option
You can undeploy an application using a command line similar to the following. The application will remain in the domain, but in an undeployed state.
AppManage -undeploy -app timer_wait -domain tp001 -user admin -pw admin
-delete Option
You can remove an application from an administration domain. If the application is deployed, you can undeploy and delete the application in one operation using the -force option. An error is returned if you attempt to delete a deployed application without specifying the -force option.
AppManage -delete -app timer_wait -user admin -pw admin -domain tp001 -force
-start Option
You can use the AppManage utility to start an application and all its associated processes, or use the utility to start just one service. The -service tag takes the name of a service. Each service contains a name. For example, if there is a TIBCO BusinessWorks service element <bw name="BW Processes.par"> in a deployment configuration file, -service takes the value "BW Processes.par".
AppManage -start -app myApp -user a -pw a -domain test
AppManage -start -app myApp -service "BW Processes.par" -user a -pw
a -domain test"
In the case where -binding is provided without -service, all services in the application are started.
AppManage -start -app myApp -binding
ActiveDatabaseAdapterConfiguration -user a -pw a -domain test
-stop Option
You can use the AppManage utility to stop an application and all its associated processes, or use the utility to stop just one service. The -binding tag takes the name of a binding. Each binding contains a name. For example, if there is a binding element <binding name="BW Processes"> in a deployment configuration file, -binding takes the value "BW Processes".
AppManage -stop -app myApp -user a -pw a -domain test
AppManage -stop -app myApp -service
ActiveDatabaseAdapterConfiguration.aar -user a -pw a -domain test
AppManage -stop -app myApp -service "BW Processes.par" -binding
"BW Processes" -user a -pw a -domain test
-breaklock Option
You can use the AppManage utility to break the lock held on the application by other users. This will result in loosing uncommitted changes by the other users.
–override Option
This option is only applicable when a deployment configuration file already exists. That is, you are redeploying with a changed archive file.
By default, a newly generated deployment configuration file preserves the value in the original deployment config file. Use this option with the -export option to create a deployment configuration file that uses the values defined for global variables in the archive file, rather than the values defined for global variables in the original deployment configuration file.
AppManage -export -ear c:\ears\deployment\filenotify.ear
                  -deployconfig c:\ears\deployments\filenotify.xml
                  -out c:\ears\deployments\filenotify-changed.xml                   -override
-min Option
Use this option with the -export and -ear options to create a small deployment configuration file that only includes XML tags for options you have changed in the EAR file. XML tags are not generated for default options that have values, which have not been changed from their defaults. Options for which XML tags are not generated will use default values.
-max Option
Use this option with the -export option to create a deployment configuration file that includes all possible XML tags. For example:
appmanage -export -app SendMsg -domain tp041 -user admin -pw admin
-out c:\temp\sendmsg.xml -max
-template Option
Use this option with the -export option to create a deployment configuration file that includes XML tags for all options. Certain options, such as machine tags will include values defined within percent (%%) characters that can be searched for and replaced. For example:
<bindings>
   <binding name="">
      <machine>%%demo2sub.aar-machine%%</machine>
      <product>
         <type>adb</type>
         <version/>
         <location/>
      </product>
      <description/>
      <contact/>
   </binding>
</bindings>
-password Option
Use this option with the -export option to encrypt sensitive data in the exported deployment configuration file. You will be prompted to enter an encryption password. For example:
AppManage -export -out c:\ears\deployments\timer_wait.xml -app           timer_wait -user admin -pw admin -domain tp002 -password
Also use this option with the -deploy or -config option to upload a deployment configuration file whose sensitive data is encrypted with your custom password. You will be prompted to enter the encryption password that you specified when generating the deployment configuration file. For example:
AppManage -config -ear c:\ears\timer_wait.ear -deployConfig c:\ears\deployments\timer_wait.xml -app timer_wait -user admin -pw admin -domain tp002 -password
-passwordFile Option
Use this option with the -export option to encrypt sensitive data in the exported deployment configuration file using a properties file. The properties file contains the password encrypted using the obfuscate utility (Refer to TIBCO Runtime Agent Installation for more information about Obfuscate Utility). For example:
AppManage -export -out c:\ears\deployments\timer_wait.xml -app timer_wait -user admin -pw admin -domain tp002 -passwordFile c:\my_password.txt
Also use this option with the -deploy or -config option to upload a deployment configuration file whose sensitive data is encrypted with your custom password. To use this option, you must provide a properties file which contains the password encrypted using the obfuscate utility when generating the deployment configuration file. For example:
AppManage -config -ear c:\ears\timer_wait.ear -deployConfig c:\ears\deployments\timer_wait.xml -app timer_wait -user admin -pw     admin -domain tp002 -passwordFile c:\my_password.txt
-moveAppData Option
This option allows you to change the transport setting for a given application. It is similar to the -batchMoveAppData option, but operates against a single application. If the application is within a directory, use a forward slash (/) to separate it from the application name. For an overview of this option, see , Changing the Transport for Applications.
The -deployconfig option can be used to configure the application with a given XML file.
The following example shows how to change the transport setting for an application from rv (Rendezvous) to local.
AppManage -moveAppData -app SendMsg -user admin -pw admin -domain tp041 -local
-truncate Option
With this option you can remove unwanted revisions of an application. Note that this option does not change the value of Max Deployment Revision for your application. The following example truncates the application’s revision history.
AppManage -truncate -app <app> -domain <domain> -user <user> -pw <password>] [-cred <cred>]
-serialize Option
If this option is used, then deployment will be done to one machine at a time. Without this, deployment is done simultaneously to all machines with service instances for the application being deployed.
When deployment is being done to multiple machines and there are contention issues, the use of this flag can alleviate them and greatly speedup the overall deployment process.
Contention issues can be identified by deployment taking many minutes, but not using significant amounts of CPU time on the admin server or target machines.
The following example shows how to use this option in a domain.
AppManage -deploy -app myApp -user user1 -pw user1 -domain test -serialize
-exportDeployed Option
This option is to be used with -export or -batchExport option. If -exportDeployed is specified, the active deployed configuration is exported. If not, then the current configuration changes that would be picked up by the next deployment are what is exported. If the application is in undeployed status, but was deployed earlier, the last deployed configuration is exported. If the application has never been deployed, the current configuration is exported just as if the flag was not specified.
When used with -export:
AppManage -export -app <app> -domain <domain> -out <uri> [-user <user> -pw <password>] [-cred <cred>] [-template] [-min] [-genEar] [-ear <archive>] [-exportDeployed]
When used with -batchExport:
AppManage -batchExport -domain <domain> -user <userName> -pw <password> [-cred <cred>] -dir <dir> [-template] [-min] [-noear] [-exportDeployed]

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved