Installation options for the AdminApp object
You can specify the following installation options for the AdminApp object.
- appname
- Specifies the name of the application. The default is the display name of the application.
- BackendIdSelection
- Specifies the backend ID for the enterprise bean jar modules that have container managed persistence (CMP) beans. An enterprise bean jar module can support multiple backend configurations as specified using the Application Assembly Tool.
Use this option to change the backend ID during installation. This option is not available in an edit command.
Example usage:
$AdminApp install c:/myapp.ear {-BackendIdSelection {{Annuity20EJB Annuity20EJB.jar,META-INF/ejb-jar.xml DB2UDBNT_V72_1}}}- BindJndiForEJBMessageBinding
- Binds enterprise beans to listener port names.
Ensure each message-driven enterprise bean in your application or module is bound to a listener port name. Use this option to provide missing data or update a task.
Example usage:
$AdminApp install c:/myapp.ear {-BindJndiForEJBMessageBinding {{mymdb myMDB mymdb.jar,META-INF/ejb-jar.xml myMDBListenPort}}}Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.- BindJndiForEJBNonMessageBinding
- Binds enterprise beans to Java Naming and Directory Interface (JNDI) names.
Ensure each non message-driven enterprise bean in your application or module is bound to a JNDI name. Use this option to provide missing data or update a task.
Example usage:
$AdminApp install c:/myapp.ear {-BindJndiForEJBNonMessageBinding {{"Increment Bean Jar" Inc Increment.jar,META-INF/ejb-jar.xml IncBean}}}Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.- cell
- Specifies the cell name for the AdminApp object installation functions.
- cluster
- Specifies the cluster name for the AdminApp object installation functions.
Note: This option only applies to a Network Deployment environment.
- contextroot
- Specifies the context root you use when installing a stand-alone WAR file.
- CorrectOracleIsolationLevel
- Specifies the isolation level for the Oracle type provider. Use this option to provide missing data or update a task.
Example usage:
$AdminApp install c:/myapp.ear {-CorrectOracleIsolationLevel {{AsyncSender jms/MyQueueConnectionFactory jms/Resource1 2}}The last field of each entry specifies the isolation level. Valid isolation level values are 2 or 4.Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.
- CorrectUseSystemIdentity
- Replaces RunAs System to RunAs Roles.
The enterprise beans you install contain RunAs system identity. You can optionally change this identity to a RunAs role. Use this option to provide missing data or update a task.
Example usage:
$AdminApp install c:/myapp.ear {-CorrectUseSystemIdentity {{Inc "Increment Bean Jar" Increment.jar,META-INF/ejb-jar.xml getValue() RunAsUser2 user2 password2} {Inc "Increment Bean Jar" Increment.jar,META-INF/ejb-jar.xml Increment() RunAsUser2 user2 password2}}}Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.- DataSourceFor10CMPBeans
- Specifies optional data sources for individual 1.x container managed persistence (CMP) beans.
Mapping a specific data source to a CMP bean overrides the default data source for the module that contains the enterprise bean. Use this option to provide missing data or update a task.
Example usage:
$AdminApp install c:/myapp.ear {-DataSourceFor10CMPBeans {{"Increment Bean Jar" Inc Increment.jar,META-INF/ejb-jar.xml jdbc/SampleDataSource user1 password1}}}Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.- DataSourceFor20CMPBeans
- Specifies optional data sources for individual 2.x container managed persistence (CMP) beans.
Mapping a specific data source to a CMP bean overrides the default data source for the module that contains the enterprise bean. Use this option to provide missing data or update a task.
Example usage:
$AdminApp install c:/myapp.ear {-DataSourceFor20CMPBeans {{CustomerEjbJar CustomerEJB customreEjb.jar,META-INF/ejb-jar.xml ejb/customerEjb "per connection factory"} {SupplierEjbJar supplierEjb supplierEjb.jar,META-INF/ejb-jar.xml ejb/supplierEjb container}}}The last field in each entry of this task specifies the value for resource authorization. Valid values for resource authorization are per connection factory or container.Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.
- DataSourceFor10EJBModules
- Specifies the default data source for the enterprise bean module that contains 1.x container managed persistence (CMP) beans. Use this option to provide missing data or update a task.
Example usage:
$AdminApp install c:/myapp.ear {-DataSourceFor10EJBModules {{"Increment Bean Jar" Increment.jar,META-INF/ejb-jar.xml jdbc/SampleDataSource user1 password1}}}Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.- DataSourceFor20EJBModules
- Specifies the default data source for the enterprise bean 2.x module that contains 2.x container managed persistence (CMP) beans. Use this option to provide missing data or update a task.
Example usage:
$AdminApp install c:/myapp.ear {-DataSourceFor20CMPBeans {{CustomerEjbJar CustomerEJB customreEjb.jar,META-INF/ejb-jar.xml ejb/customerEjb "per connection factory"} {SupplierEjbJar supplierEjb supplierEjb.jar,META-INF/ejb-jar.xml ejb/supplierEjb container}}}The last field in each entry of this task specifies the value for resource authorization. Valid values for resource authorization is per connection factory or container.Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.
- defaultbinding.cf.jndi
- Specifies the Java Naming and Directory Interface (JNDI) name for the default connection factory
- defaultbinding.cf.resauth
- Specifies the RESAUTH for the connection factory.
- defaultbinding.datasource.jndi
- Specifies the Java Naming and Directory Interface (JNDI) name for the default datasource.
- defaultbinding.datasource.password
- Specifies the password for the default datasource.
- defaultbinding.datasource.username
- Specifies the user name for the default datasource.
- defaultbinding.ejbjndi.prefix
- Specifies the prefix for the enterprise bean Java Naming and Directory Interface (JNDI) name.
- defaultbinding.force
- Specifies that the default bindings should override the current bindings.
- defaultbinding.strategy.file
- Specifies a custom default bindings strategy file.
- defaultbinding.virtual.host
- Specifies the default name for a virtual host.
- depl.extension.reg
- Specifies the location of the properties file for deployment extensions.
- deployejb
- Specifies to run EJBDeploy during installation. This option does not require a value.
The default value is nodeployejb.
- deployejb.classpath
- Specifies an extra class path for EJBDeploy.
- deployejb.dbschema
- Specifies the database schema for EJBDeploy.
- deployejb.dbtype
- Specifies the database type for EJBDeploy.
Possible values include the following:
CLOUDSCAPE_V5 DB2UDB_V72 DB2UDBOS390_V6 DB2UDBISERIES INFORMIX_V73 INFORMIX_V93 MSSQLSERVER_V7 MSSQLSERVER_2000 ORACLE_V8 ORACLE_V9I SYBASE_V1200For a list of current supported database vendor types, run ejbdeploy -?.
- deployejb.rmic
- Specifies extra RMIC options to use for EJBDeploy.
- deployws
- Specifies to deploy WebServices during installation. This option does not require a value.
The default value is: nodeployws.
- deployws.classpath
- Specifies the extra classpath to use when you deploy WebServices.
- deployws.jardirs
- Specifies the extra extension directories to use when you deploy WebServices.
- distributeApp
- Specifies that the application management component distributes application binaries. This option does not require a value.
This is the default setting.
- EnsureMethodProtectionFor10EJB
- Selects method protections for unprotected methods of 1.x enterprise beans. Specify to leave the method as unprotected, or assign protection which denies all access. Use this option to provide missing data or update to a task.
Example usage:
$AdminApp install c:/myapp.ear {-EnsureMethodProtectionFor10EJB {{"Increment EJB Module" IncrementEJBBean.jar,META-INF/ejb-jar.xml ""} {"Timeout EJB Module" TimeoutEJBBean.jar,META-INF/ejb-jar.xml methodProtection.denyAllPermission}}}The last field in each entry of this task specifies the value of the protection. Valid protection values include: methodProtection.denyAllPermission. You can also leave the value blank if you want the method to remain unprotected.Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.
- EnsureMethodProtectionFor20EJB
- Selects method protections for unprotected methods of 2.x enterprise beans. Specify to assign a security role to the unprotected method, add the method to the exclude list, or mark the method as unchecked. You can assign multiple roles for a method by separating roles names with commas. Use this option to provide missing data or update to a task.
Example usage:
$AdminApp install c:/myapp.ear {-EnsureMethodProtectionFor20EJB {{CustmerEjbJar customerEjb.jar,META-INF/ejb-jar.xml methodProtection.uncheck} {SupplierEjbJar supplierEjb.jar,META-INF/ejb-jar.xml methodProtection.exclude}}}The last field in each entry of this task specifies the value of the protection. Valid protection values include: methodProtection.uncheck, methodProtection.exclude, or a list of security roles separated by commas.Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.
- installdir
- Specifies the directory to place the application binaries.
- MapModulesToServers
- Specifies the application server where you want to install modules that are contained in your application. You can install modules on the same server, or disperse them among several servers. Use this option to provide missing data or update to a task.
Example usage:
$AdminApp install c:/myapp.ear {-MapModulesToServers {{"Increment Bean Jar" Increment.jar,META-INF/ejb-jar.xml WebSphere:cell=mycell,node=mynode,server=server1} {"Default Application" default_app.war,WEB-INF/web.xml WebSphere:cell=mycell,node=mynode,server=server1} {"Examples Application" examples.war,WEB-INF/web.xml WebSphere:cell=mycell,node=mynode,server=server1}}}Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.
- MapEJBRefToEJB
- Maps enterprise Java references to enterprise beans. You must map each enterprise bean reference defined in your application to an enterprise bean. Use this option to provide missing data or update to a task.
Example usage:
$AdminApp install c:/myapp.ear {-MapEJBRefToEJB {{"Examples Application" "" examples.war,WEB-INF/web.xml BeenThereBean com.ibm.websphere.beenthere.BeenThere IncBean}}}Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.
- MapResEnvRefToRes
- Maps resource environment references to resources. You must map each resource environment reference defined in your application to a resource. Use this option to provide missing data or update to a task.
Example usage:
$AdminApp install c:/myapp.ear {-MapResEnvRefToRes {{AsyncSender AsyncSender asyncSenderEjb.jar,META-INF/ejb-jar.xml jms/ASYNC_SENDER_QUEUE javax.jms.Queue jms/Resource2}}}Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.
- MapResRefToEJB
- Maps resource references to resources. You must map each resource reference defined in your application to a resource. Use this option to provide missing data or update to a task.
Example usage:
$AdminApp install c:/myapp.ear {-MapResRefToEJB {{AsyncSender AsyncSender asyncSenderEjb.jar,META-INF/ejb-jar.xml jms/MyQueueConnectionFactory javax.jms.QueueConnectionFactory jms/Resource1} {"Catalog Component" TheCatalog catalogEjb.jar,META-INF/ejb-jar.xml jdbc/CatalogDataSource javax.sql.DataSource jdbc/Resource2}}}Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.
- MapRolesToUsers
- Maps users to roles. You must map each role defined in the application or module to a user or group from the domain user registry. You can specify multiple users or groups for a single role by separating them with a |. Use this option to provide missing data or update to a task.
Example usage:
$AdminApp install c:/myapp.ear {-MapRolesToUsers {{"All Role" No Yes "" ""} {"Every Role" Yes No "" ""} {DenyAllRole No No user1 group1}}}Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.
- MapRunAsRolesToUsers
- Maps RunAs Roles to users. The enterprise beans you install contain predefined RunAs roles. Enterprise beans that need to run as a particular role for recognition while interacting with another enterprise bean use RunAs roles. Use this option to provide missing data or update to a task.
Example usage:
$AdminApp install c:/myapp.ear {-MapRunAsRolesToUsers {{UserRole user1 password1} {AdminRole administrator administrator}}}Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.
- MapWebModToVH
- Selects virtual hosts for Web modules. Specify the virtual host where you want to install the Web modules contained in your application. You can install Web modules on the same virtual host, or disperse them among several hosts. Use this option to provide missing data or update to a task.
Example usage:
$AdminApp install c:/myapp.ear {-MapWebModToVH {{"Default Application" default_app.war,WEB-INF/web.xml default_host} {"Examples Application" examples.war,WEB-INF/web.xml default_host}}}Use the taskInfo command of the AdminApp object to obtain information about the data needed for your application. You only need to provide data for rows or entries that are missing information, or those where you want to update the existing data.
- node
- Specifies the node name for the AdminApp installation functions.
- nodeployejb
- Specifies not to run EJBDeploy during installation. This option does not require a value.
This value is the default setting.
- nodeployws
- Specifies to not deploy WebServices during installation. This option does not require a value.
This value is the default setting.
- nodistributeApp
- Specifies that the application management component does not distribute application binaries. This option does not require a value.
The default setting is distributeApp.
- nopreCompileJSPs
- Specifies not to precompile JavaServer Pages files. This option does not require a value.
This is the default setting.
- nouseMetaDataFromBinary
- Specifies that the metadata used at run time, for example, deployment descriptors, bindings, extensions, and so on, come from the configuration repository. This option does not require a value.
This is the default setting. Use useMetaDataFromBinary to indicate that the metadata used at run time comes from the EAR file.
- nousedefaultbindings
- Specifies not to use default bindings for installation. This option does not require a value.
This is the default setting.
- preCompileJSPs
- Specifies to precompile JavaServer Pages files. This option does not require a value.
The default is nopreCompileJSPs.
- server
- Specifies the server name for the AdminApp installation functions.
- update
- Updates the installed application with a new version of the EAR file. This option does not require a value.
The application that is being updated, specified by the appname option, must already be installed in the WebSphere Application Server configuration. The update action merges bindings from the new version with the bindings from the old version, uninstalls the old version, and installs the new version. The binding information from new version of the EAR file is preferred over the corresponding one from the old version. If any element of binding is missing in the new version, the corresponding element from the old version is used.
- update.ignore.old
- Specifies that during the update action, bindings from the installed version of the application are ignored. This option does not require a value.
Applies only if you specify the update option.
- update.ignore.new
- Specifies that during the update action, bindings from the new version of the application are ignored. This option does not require a value.
Applies only if you specify the update option.
- useMetaDataFromBinary
- Specifies that the metadata used at run time, for example, deployment descriptors, bindings, extensions, and so on, come from the EAR file. This option does not require a value.
The default value is nouseMetaDataFromBinary which means that the metadata used at run time comes from the configuration repository.
- usedefaultbindings
- Specifies to use default bindings for installation. This option does not require a value.
The default setting is nousedefaultbindings.
- verbose
- Causes additional messages to display during installation. This option does not require a value.