Options for the AdminApp object commands

 

+

Search Tips   |   Advanced Search

 

This article lists the available options for the...

...commands of the AdminApp object.

Use pattern matching to simplify the task of supplying required values for complex options. Pattern matching only applies to fields that are required or read only.

 

ActSpecJNDI

Bind J2C activation specifications to destination JNDI names.

Optional.

Each element of the ActSpecJNDI option consists of the following fields:

The j2c.jndiName field can be assigned a value.

The contents of the option after running default bindings include...

RARModule <rar module name>
uri <rar name>,META-INF/ra.xml
Object identifier <messageListenerType>
JNDI name null

You can only use this option if the activation specification has the Destination property defined in the ra.xml file and the introspected type of the Destination property is the following: javax.jms.Destination Use Jacl:

$AdminApp install $embeddedEar {-ActSpecJNDI {{"FVT Resource Adapter" jca15cmd.rar,META-INF/ra.xml javax.jms.MessageListener jndi5} {"FVT Resource Adapter" jca15cmd.rar,META-INF/ra.xml javax.jms.MessageListener2 jndi6}}}
Use Jacl with pattern matching:

$AdminApp install $embeddedEar {-ActSpecJNDI {{.* .*.rar,.* javax.jms.MessageListener jndi5} {.* .*.rar,.* javax.jms.MessageListener2 jndi6}}}

Use Jython:

AdminApp.install(embeddedEar, ['-ActSpecJNDI', [["FVT Resource Adapter", 'jca15cmd.rar,META-INF/ra.xml', 'javax.jms.MessageListener', 'jndi5'], ["FVT Resource Adapter", 'jca15cmd.rar,META-INF/ra.xml', 'javax.jms.MessageListener2', 'jndi6']]])

Use Jython with pattern matching:

AdminApp.install(embeddedEar, ['-ActSpecJNDI', [['.*', '.*.rar,.*', 'javax.jms.MessageListener', 'jndi5'], ['.*', '.*.rar,.*', 'javax.jms.MessageListener2', 'jndi6']]])

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update.

 

allowDispatchRemoteInclude

Enables an enterprise application to dispatch includes to resources across web modules that are in different Java virtual machines in a managed node environment through the standard request dispatcher mechanism. Use Jacl:

set deployments [$AdminConfig getid /Deployment:RRDEnabledAppname/]
set deploymentObject [$AdminConfig showAttribute $deployments deployedObject]
set rrdAttr [list allowDispatchRemoteInclude true]
set attrs [list $rrdLocalAttr]
$AdminConfig modify $deploymentObject $attrs

Using Jython:

deployments = AdminConfig.getid ('/Deployment:RRDEnabledAppname/') deploymentObject = AdminConfig.showAttribute (deployments, 'deployedObject') rrdAttr = ['allowDispatchRemoteInclude', 'true'] attrs = [rrdLocalAttr]
AdminConfig.modify (deploymentObject, attrs)

 

allowPermInFilterPolicy

Specifies to continue with the application deployment process even when the application contains policy permissions that are in the filter.policy. This option does not require a value.

 

allowServiceRemoteInclude

Enables an enterprise application to service an include request from an enterprise application with the

allowDispatchRemoteInclude
allowDispatch
Remote
Include

option set to true. Use Jacl:

set deployments [$AdminConfig getid /Deployment:RRDEnabledAppname/]
set deploymentObject [$AdminConfig showAttribute $deployments deployedObject]
set rrdAttr [list allowServiceRemoteInclude true]
set attrs [list $rrdAttr]
$AdminConfig modify $deploymentObject $attrs

Using Jython:

deployments = AdminConfig.getid ('/Deployment:RRDEnabledAppname/') deploymentObject = AdminConfig.showAttribute ('deployments', 'deployedObject') rrdAttr = ['allowServiceRemoteInclude', 'true'] attrs = [rrdAttr]
AdminConfig.modify (deploymentObject, attrs)

 

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 Java archive (JAR) modules that have container-managed persistence (CMP) beans. An enterprise bean JAR module can support multiple backend configurations as specified using an application assembly tool.

Use this option to change the backend ID during installation. Use Jacl:

$AdminApp install c:/myapp.ear {-BackendIdSelection {{Annuity20EJB Annuity20EJB.jar,META-INF/ejb-jar.xml DB2UDBNT_V72_1}}}

Use Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-BackendIdSelection {{.* Annuity20EJB.jar,.* DB2UDBNT_V72_1}}}

Use Jython:

AdminApp.install('c:/myapp.ear', '[-BackendIdSelection [[Annuity20EJB Annuity20EJB.jar,META-INF/ejb-jar.xml DB2UDBNT_V72_1]]]')

Use Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-BackendIdSelection', [['.*', 'Annuity20EJB.jar,.*', 'DB2UDBNT_V72_1']]])

 

BindJndiForEJBMessageBinding

Binds enterprise beans to listener port names or Java Naming and Directory Interface (JNDI) names. Use this option to provide missing data or update a task. Ensure each message-driven enterprise bean in your application or module is bound to a listener port name.

Each element of the BindJndiForEJBMessageBinding option consists of the following fields: EJBModule, EJB, uri, listenerPort, JNDI, jndi.dest, and actspec.auth. Some of these fields, can be assigned values: listenerPort, JNDI, jndi.dest, and actspec.auth. The current contents of the option after running default bindings include:

Use Jacl:

$AdminApp install $ear {-BindJndiForEJBMessageBinding {{Ejb1 MessageBean ejb-jar-ic.jar,META-INF/ejb-jar.xml myListenerPort jndi1 jndiDest1 actSpecAuth2}}}

Use Jacl with pattern matching:

$AdminApp install $ear {-BindJndiForEJBMessageBinding {{.* .* .*.jar,.* myListenerPort jndi1 jndiDest1 actSpecAuth2}}}

Use Jython:

AdminApp.install(ear, ['-BindJndiForEJBMessageBinding', [['Ejb1', 'MessageBean', 'ejb-jar-ic.jar,META-INF/ejb-jar.xml', 'myListenerPort', 'jndi1', 'jndiDest1', 'actSpecAuth2']]])

Use Jython with pattern matching:

AdminApp.install(ear, ['-BindJndiForEJBMessageBinding', [['.*', '.*', '.*.jar,.*', 'myListenerPort', 'jndi1', 'jndiDest1', 'actSpecAuth2']]])

The default Destination JNDI Name is collected from the corresponding message reference.

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update.

 

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.

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update. Use Jacl:

$AdminApp install c:/myapp.ear {-BindJndiForEJBNonMessageBinding {{"Increment Bean Jar" Inc Increment.jar,META-INF/ejb-jar.xml IncBean}}}

Use Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-BindJndiForEJBNonMessageBinding {{.* .* Increment.jar,.* IncBean}}}

Use Jython:

AdminApp.install('c:/myapp.ear', '[-BindJndiForEJBNonMessageBinding [["Increment Bean Jar" Inc Increment.jar,META-INF/ejb-jar.xml IncBean]]]')

Use Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-BindJndiForEJBNonMessageBinding', [['.*', '.*', 'Increment.jar,.*', 'IncBean']]])

 

buildVersion

Display the build version of an application EAR file. You cannot modify this option because it is read-only. This options returns the build version information for an application EAR if you have specified the build version in the MANIFEST.MF application EAR file.

 

cell

Specifies the cell name to install or update an entire application or to update an application in order to add a new module. If you want to update an entire application, this option only applies if the application contains a new module that does not exist in the installed application. Use Jython:

AdminApp.install('c:/myapp/myapp.ear', '[-cell cellName]')

Using Jacl:

$AdminApp install "c:/myapp.ear" {-cell cellName}

 

cluster

Specifies the cluster name to install or update an entire application or to update an application in order to add a new module. This option only applies in a ND environment. To update an entire application, this option only applies if the application contains a new module that does not exist in the installed application.

You cannot use the -cluster and -server options together. To deploy an application and specify the HTTP server during the deployment so that the application will appear in the generated plugin-cfg.xml file, first install the application with a target of -cluster. After you install the application and before you save, use edit command of the AdminApp object to add the additional mapping to the Web server. Use Jython:

AdminApp.install('c:/myapp/myapp.ear', '[-cluster clusterName]')

Using Jacl:

$AdminApp install "c:/myapp.ear" {-cluster clusterName}

 

contents

File that contains the content to update. For example, depending on the content type, the file could be an EAR file, a module, a partial zip, or a single file. The path to the file must be local to the scripting client. The contents option is required unless you have specified the delete option.

 

contenturi

Specifies the URI of the file that you are adding, updating, or removing from an application. This option only applies to the update command. The contenturi option is required if the content type is file or modulefile. This option is ignored for other content types.

 

contextroot

Specifies the context root that 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 to update a task.

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 that is needed for your application. You only need to provide data for rows or entries that are either missing information, or require an update. Use Jacl:

$AdminApp install c:/myapp.ear {-CorrectOracleIsolationLevel {{AsyncSender jms/MyQueueConnectionFactory jms/Resource1 2}}

Use Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-CorrectOracleIsolationLevel {{.* jms/MyQueueConnectionFactory jms/Resource1 2}}

Using Jython:

AdminApp.install('c:/myapp.ear', '[-CorrectOracleIsolationLevel [[AsyncSender jms/MyQueueConnectionFactory jms/Resource1 2]]]')

Use Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-CorrectOracleIsolationLevel', [['.*', 'jms/MyQueueConnectionFactory', 'jms/Resource1', 2]]])

 

CorrectUseSystemIdentity

Replaces RunAs System to RunAs Roles.

The enterprise beans that you install contain a RunAs system identity. You can optionally change this identity to a RunAs role. Use this option to provide missing data or update a task.

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update. Use Jacl:

$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 Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-CorrectUseSystemIdentity {{.* .* .* getValue() RunAsUser2 user2 password2} {.* .* .* Increment() RunAsUser2 user2 password2}}}

Using Jython:

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 Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-CorrectUseSystemIdentity', [['.*', '.*', '.*', 'getValue()', 'RunAsUser2', 'user2', 'password2'], ['.*', '.*', '.*', 'Increment()', 'RunAsUser2', 'user2', 'password2']]])

 

createMBeansForResourcescreateMBeansFor Resources

Specifies that MBeans are created for all resources such as, servlets, JavaServer Pages files, and enterprise beans, that are defined in an application when the application starts on a deployment target. This option does not require a value. The default setting is the nocreateMBeansForResources option.

 

CtxRootForWebMod

Edits the context root of the Web module. You can edit a context root that is defined in the application.xml file using this option. The current contents of this option after running default bindings are the following:

Use Jacl:

$AdminApp install myapp.ear {-appname MyApp -CtxRootForWebMod {{"IVT Application" ivt_app.war,web.xml /mycontextroot}}}

Using Jacl with pattern matching:

$AdminApp install myapp.ear {-appname MyApp -CtxRootForWebMod {{.* .* /mycontextroot}}}

Use Jython:

AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-CtxRootForWebMod', [["IVT Application", 'ivt_app.war,web.xml', '/mycontextroot']]])

Use Jython with pattern matching:

AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-CtxRootForWebMod', [['.*', '.*', '/mycontextroot']]])

 

custom

Specifies a name-value pair using the format name=value. Use the custom option to pass options to application deployment extensions. See the application deployment extension documentation for available custom options.

 

DataSourceFor10CMPBeans

Specifies optional data sources for individual 1.x container-managed persistence (CMP) beans. Use this option to provide missing data or to update a task.

Mapping a specific data source to a CMP bean overrides the default data source for the module that contains the enterprise bean. Each element of the DataSourceFor10CMPBeans option consists of the following fields: EJBModule, EJB, uri, JNDI, userName, password, login.config.name, and auth.props. Of these fields, the following can be assigned values: JNDI, userName, password, login.config.name, and auth.props. The current contents of the option after running default bindings include:

If the login.config.name is set to DefaultPrincipalMapping, a property is created with the name com.ibm.mapping.authDataAlias . The value of the property is set by the auth.props. If the login.config name is not set to DefaultPrincipalMapping, the auth.props can specify multiple properties. The string format is websphere:name= <name1>,value=<value1>,description=<desc1>. Specify multiple properties using the plus sign (+) .

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are missing information, or require an update. Use Jacl:

$AdminApp install c:/app1.ear {-DataSourceFor10CMPBeans {{"Increment CMP 1.1 EJB" IncCMP11 IncCMP11.jar,META-INF/ejb-jar.xml myJNDI user1 password1 loginName1 authProps1}}}

Use Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-DataSourceFor10CMPBeans {{.* .* IncCMP11.jar,.* myJNDI user1 password1 loginName1 authProps1}}}

Use Jython:

AdminApp.install('c:/app1.ear', ['-DataSourceFor10CMPBeans', [["Increment CMP 1.1 EJB", 'IncCMP11', 'IncCMP11.jar,META-INF/ejb-jar.xml', 'myJNDI', 'user1', 'password1', 'loginName1', 'authProps1']]])

Use Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-DataSourceFor10CMPBeans', [['.*', '.*', 'IncCMP11.jar,.*', 'myJNDI', 'user1', 'password1', 'loginName1', 'authProps1']]])

 

DataSourceFor20CMPBeans

Specifies optional data sources for individual 2.x container-managed persistence (CMP) beans. Use this option to provide missing data or to update a task.

Mapping a specific data source to a CMP bean overrides the default data source for the module that contains the enterprise bean. Each element of the DataSourceFor20CMPBeans option consists of the following fields: EJBModule, EJB, uri, JNDI, resAuth, login.config.name, and auth.props. Of these fields, the following can be assigned values: JNDI, resAuth, login.config.name, and auth.props. The current contents of the option after running default bindings includes the following:

Use Jacl:

$AdminApp install c:/app1.ear {-DataSourceFor20CMPBeans {{"Increment Enterprise Java Bean" Increment Increment.jar, META-INF/ejb-jar.xml jndi1 container}}}

Use Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-DataSourceFor20CMPBeans {{.* .* Increment.jar,.* jndi1 container}}}

Using Jython:

AdminApp.install('c:/app1.ear', ['-DataSourceFor20CMPBeans', [["Increment Enterprise Java Bean", 'Increment', 'Increment.jar, META-INF/ejb-jar.xml', 'jndi1', 'container']]])

Use Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-DataSourceFor20CMPBeans', [['.*', '.*', 'Increment.jar,.*', 'jndi1', 'container']]])

If the login.config.name is set to DefaultPrincipalMapping, a property is created with the name com.ibm.mapping.authDataAlias . The value of the property is set by the auth.props. If the login.config name is not set to DefaultPrincipalMapping, the auth.props can specify multiple properties. The string format is websphere:name= <name1>,value=<value1>,description=<desc1>. Specify multiple properties using the plus sign (+) .

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 require an update.

 

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.Each element of the

DataSourceFor 10EJBModules
option consists of the following fields: EJBModule, uri, JNDI, userName, password, login.config.name, and auth.props. Of these fields, the following can be assigned values: JNDI, userName, password, login.config.name, and auth.props. The current contents of the option after running default bindings include:

Use Jacl:

$AdminApp install c:/app1.ear {-DataSourceFor10EJBModules {{"Increment CMP 1.1 EJB" IncCMP11.jar,META-INF/ejb-jar.xml yourJNDI user2 password2 loginName authProps}}}

Use Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-DataSourceFor10EJBModules {{.* IncCMP11.jar,.* yourJNDI user2 password2 loginName authProps}}}

Use Jython:

AdminApp.install('c:/app1.ear', ['-DataSourceFor10EJBModules', [["Increment CMP 1.1 EJB", 'IncCMP11.jar,META-INF/ejb-jar.xml', 'yourJNDI', 'user2', 'password2', 'loginName', 'authProps']]])

Use Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-DataSourceFor10EJBModules', [['.*', 'IncCMP11.jar,.*', 'yourJNDI', 'user2', 'password2', 'loginName', 'authProps']]])

If the login.config.name is set to DefaultPrincipalMapping, a property is created with the name com.ibm.mapping.authDataAlias . The value of the property is set by the auth.props. If the login.config name is not set to DefaultPrincipalMapping, the auth.props can specify multiple properties. The string format is websphere:name= <name1>,value=<value1>,description=<desc1>. Specify multiple properties using the plus sign (+) .

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update.

 

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.

Each element of the DataSourceFor20EJBModules option consists of the following fields: EJBModule, uri, JNDI, resAuth, login.config.name, and auth.props. Of these fields, the following can be assigned values: JNDI, resAuth, login.config.name, and auth.props. The current contents of the option after running default bindings include:

Use Jacl:

$AdminApp install c:/app1.ear {-DataSourceFor20EJBModules {{"Increment Enterprise Java Bean" Increment.jar,META-INF/ejb-jar.xml jndi2 container}}}

Use Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-DataSourceFor20EJBModules {{.* Increment.jar,.* jndi2 container}}}

Using Jython:

AdminApp.install('c:/app1.ear', ['-DataSourceFor20EJBModules', [["Increment Enterprise Java Bean", 'Increment.jar,META-INF/ejb-jar.xml', 'jndi2', 'container']]])

Use Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-DataSourceFor20EJBModules', [['.*', 'Increment.jar,.*', 'jndi2', '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.

If the login.config.name is set to DefaultPrincipalMapping, a property is created with the name com.ibm.mapping.authDataAlias . The value of the property is set by the auth.props. If the login.config name is not set to DefaultPrincipalMapping, the auth.props can specify multiple properties. The string format is websphere:name= <name1>,value=<value1>,description=<desc1>. Specify multiple properties using the plus sign (+) .

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require update.

 

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 data source.

 

defaultbinding.datasource.password

Password for the default data source.

 

defaultbinding.datasource.username

defaultbinding. datasource. username
User name for the default data source.

 

defaultbinding.ejbjndi.prefix

Prefix for the enterprise bean Java Naming and Directory Interface (JNDI) name.

 

defaultbinding.force

Specifies that the default bindings 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

Deprecated. No replication option is available.

 

deployejb

Specifies to run the EJBDeploy tool during installation. This option does not require a value.

If you pre-deploy the application EAR file using the EJBDeploy tool then the default value is nodeployejb. If not, the default value is deployejb.

 

deployejb.classpath

Specifies an extra class path for the EJBDeploy tool.

 

deployejb.dbschema

Specifies the database schema for the EJBDeploy tool.

 

deployejb.dbtype

Specifies the database type for the EJBDeploy tool.Possible values include:

CLOUDSCAPE_V5 DB2UDB_V72 DB2UDBOS390_V6 DB2UDBISERIES INFORMIX_V73 INFORMIX_V93 MSSQLSERVER_V7 MSSQLSERVER_2000 ORACLE_V8 ORACLE_V9I SYBASE_V1200

For a list of current supported database vendor types, run ejbdeploy -?.

 

deployejb.rmic

Specifies extra RMIC options to use for the EJBDeploy tool.

 

deployws

Specifies to deploy Web services during installation. This option does not require a value.

The default value is: nodeployws.

 

deployws.classpath

Specifies the extra class path to use when you deploy Web services.

 

deployws.jardirs

Specifies the extra extension directories to use when you deploy Web services.

 

distributeApp

Specifies that the application management component distributes application binaries. This option does not require a value.

This setting is the default.

 

EmbeddedRar

Binds Java 2 Connector objects to JNDI names. You must bind each Java 2 Connector object in your application or module, such as, J2C connection factories, J2C activation specifications and J2C administrative objects, to a JNDI name. Each element of the EmbeddedRar option contains the following fields: RARModule, uri, j2cid, j2c.name, j2c.jndiName. You can assign the following values to the fields: j2c.name, j2c.jndiName.The current contents of the option after running default bindings include:

Module <rar module name>
URI <rar name>, META-INF/ ra.xml
Object identifier <identifier of the J2C object>
name j2cid
JNDI name eis/j2cid
Use Jacl:

$AdminApp install $embeddedEar {-EmbeddedRar {{"FVT Resource Adapter" jca15cmd.rar,META-INF/ra.xml javax.sql.DataSource javax.sql.DataSource1 eis/javax.sql.javax.sql.DataSSource1} {"FVT Resource Adapter" jca15cmd.rar,META-INF/ra.xml javax.sql.DataSource2 javax.sql.DataSource2 eis/javax.sql.DataSource2} {"FVT Resource Adapter" jca15cmd.rar,META-INF/ra.xml javax.jms.MessageListener javax.jms.MessageListener1 eis/javax.jms.MessageListener1} {"FVT Resource Adapter" jca15cmd.rar,META-INF/ra.xml javax.jms.MessageLListener2 javax.jms.MessageListener2 eis/javax.jms.MessageListener2} {"FVT Resource Adapter" jca15cmd.rar,META-INF/ra.xml fvt.adapter.message.FVTMessageProvider fvt.adapter.message.FVTMessageProvider1 eis/fvt.adapter.message.FVTMessageProvider1} {"FVT Resource Adapter" jca15cmd.rar,META-INF/ra.xml fvt.adapter.message.FVTMessageProvider2 fvt. adapter.message.FVTMessageProvider2 eis/fvt.adapter. message.FVTMessageProvider2}}}

Use Jacl with pattern matching:

$AdminApp install $embeddedEar {-EmbeddedRar {{.* .* .* javax.sql.DataSource1 eis/javax.sql.javax.sql.DataSSource1} {.* .* .* javax.sql.DataSource2 eis/javax.sql.DataSource2} {.* .* .* javax.jms.MessageListener1 eis/javax.jms.MessageListener1} {.* .* .* javax.jms.MessageListener2 eis/javax.jms.MessageListener2} {.* .* .* fvt.adapter.message.FVTMessageProvider1 eis/fvt.adapter.message.FVTMessageProvider1} {.* .* .* fvt.adapter.message.FVTMessageProvider2 eis/fvt.adapter.message.FVTMessageProvider2}}}

Use Jython:

AdminApp.install(embeddedEar, ['-EmbeddedRar', [["FVT Resource Adapter", 'jca15cmd.rar,META-INF/ra.xml', 'javax.sql.DataSource', 'javax.sql.DataSource1', 'eis/javax.sql.javax.sql.DataSSource1'], ["FVT Resource Adapter", 'jca15cmd.rar,META-INF/ra.xml javax.sql.DataSource2', 'javax.sql.DataSource2', 'eis/javax.sql.DataSource2'], ["FVT Resource Adapter", 'jca15cmd.rar,META-INF/ra.xml', 'javax.jms.MessageListener', 'javax.jms.MessageListener1', 'eis/javax.jms.MessageListener1'], ["FVT Resource Adapter", 'jca15cmd.rar,META-INF/ra.xml', 'javax.jms.MessageLListener2', 'javax.jms.MessageListener2', 'eis/javax.jms.MessageListener2'], ["FVT Resource Adapter", 'jca15cmd.rar,META-INF/ra.xml fvt.adapter.message.FVTMessageProvider', 'fvt.adapter.message.FVTMessageProvider1', 'eis/fvt.adapter.message. FVTMessageProvider1'], ["FVT Resource Adapter", 'jca15cmd.rar,META-INF/ ra.xml', 'fvt.adapter.message.FVTMessageProvider2', 'fvt.adapter.message. FVTMessageProvider2', 'eis/fvt.adapter.message.FVTMessageProvider2']]])

Use Jython with pattern matching:

AdminApp.install(embeddedEar, ['-EmbeddedRar', [['.*', '.*', '.*', 'javax.sql.DataSource1', 'eis/javax.sql.javax.sql.DataSSource1'], ['.*', '.*', '.*', 'javax.sql.DataSource2', 'eis/javax.sql.DataSource2'], ['.*', '.*', '.*', 'javax.jms.MessageListener1', 'eis/javax.jms.MessageListener1'], ['.*', '.*', '.*', 'javax.jms.MessageListener2', 'eis/javax.jms.MessageListener2'], ['.*', '.*', '.*', 'fvt.adapter.message.FVTMessageProvider1', 'eis/fvt.adapter.message.FVTMessageProvider1'], ['.*', '.*', '.*', 'fvt.adapter.message.FVTMessageProvider2', 'eis/fvt.adapter.message.FVTMessageProvider2']]])
Where j2cid is:

J2C connection factory: connection Factory Interface
J2C admin object: adminObject Interface
J2C activation specification: message listener type

If the ID is not unique in the ra.xml file, -<number> will be added. For example, javax.sql.DataSource-2.

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update.

 

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 to update a task.

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update. Use Jacl:

$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}}}

Use Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-EnsureMethodProtectionFor10EJB {{.* IncrementEJBBean.jar,.* ""} {.* TimeoutEJBBean.jar,.* methodProtection.denyAllPermission}}}

Use Jython:

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]]]')

Use Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-EnsureMethodProtectionFor10EJB', [['.*', 'IncrementEJBBean.jar,.*', ""], ['.*', 'TimeoutEJBBean.jar,.*', '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.

 

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 cleared. You can assign multiple roles for a method by separating roles names with commas. Use this option to provide missing data or to update a task.

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update the existing data. Use Jacl:

$AdminApp install c:/myapp.ear {-EnsureMethodProtectionFor20EJB {{CustomerEjbJar customerEjb.jar,META-INF/ejb-jar.xml methodProtection.uncheck} {SupplierEjbJar supplierEjb.jar,META-INF/ejb-jar.xml methodProtection.exclude}}}

Use Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-EnsureMethodProtectionFor20EJB {{.* customerEjb.jar,.* methodProtection.uncheck} {.* supplierEjb.jar,.* methodProtection.exclude}}}

Use Jython:

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]]]')

Use Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-EnsureMethodProtectionFor20EJB', [['.*', 'customerEjb.jar,.*', 'methodProtection.uncheck'], ['.*', 'supplierEjb.jar,.*', '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 that are separated by commas.

 

filepermission

This option enables you to set the appropriate file permissions on application files that are located in the installation directory. File permissions specified at the application level must be a subset of the node level file permission that defines the most lenient file permission that can be specified. Otherwise, node level permission values are used to set file permissions in the installation destination. The file name pattern is a regular expression. The default value is the following:

.*\.dll=755#.*\.so=755#.*\.a=755#.*\.sl=755
Use Jacl:

$AdminApp install /path_to/binaries/DefaultApplication.ear {-appname MyApp -cell GooddogNode04Cell -node GooddogNode -server server1 -filepermission .*\\.jsp=777#.*\\.xml=755}

Use Jython:

AdminApp.install("/path_to/binaries/DefaultApplication.ear", ["-appname", "MyApp", "-cell", "GooddogNode04Cell", "-node", "GooddogNode", "-server" , "server1", "-filepermission", ".*\\.jsp=777#.*\\.xml=755"])

 

installdir

Deprecated. This option is replaced by the installed.ear.destination option.

 

installed.ear.destination

Specifies the directory to place application binaries.

 

JSPCompileOptions

Assigns shared libraries to applications or every module. You can associate multiple shared libraries to applications and modules. The current contents of this option after running default bindings are the following:

Specify the options for the JSP precompiler. This option is only valid if you use the preCompileJSPs option also. Use Jacl:

$AdminApp install myapp.ear {-appname MyApp -preCompileJSPs -JSPCompileOptions {{"IVT Application" ivt_app.war,WEB-INF/web.xml jspcp AppDeploymentOption.Yes 15 AppDeploymentOption.No}}}

Using Jacl with pattern matching:

$AdminApp install myapp.ear {-appname MyApp -preCompileJSPs -JSPCompileOptions {{.* .* jspcp AppDeploymentOption.Yes 15 AppDeploymentOption.No}}}

Use Jython:

AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-preCompileJSPs', '-JSPCompileOptions', [["IVT Application", 'ivt_app.war,WEB-INF/web.xml', 'jspcp', 'AppDeloymentOption.Yes', 15, 'AppDeploymentOption.No']]])

Use Jython with pattern matching:

AdminApp.install('myapp.ear', '-appname', 'MyApp', '-preCompileJSPs', '-JSPCompileOptions', [['.*', '.*', 'jspcp', 'AppDeploymentOption.Yes', 15, 'AppDeploymentOption.No']]])

 

JSPReloadForWebMod

Edits the JSP reload attributes for the Web module. You can specify the reload attributes of the servlet and JSP for each module. The current contents of the option after running default bindings are the following:

Use the taskInfo command of the AdminApp object to obtain information about the data needed for you application. Use Jacl:

$AdminApp install myapp.ear {-appname MyApp -JspReloadForWebMod {{"IVT Application" ivt_app.war,WEB-INF/ibm-web-ext.xmi AppDeploymentOption.Yes 5}}}

Use Jacl with pattern matching:

$AdminApp install myapp.ear {-appname MyApp -JspReloadForWebMod {{.* .* AppDeploymentOption.Yes 5}}}

Use Jython:

AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-JspReloadForWebMod', [["IVT Application", 'ivt_app.war,WEB-INF/ibm-web-ext.xmi', 'AppDeploymentOption.Yes', 5]]])

Use Jython with pattern matching:

AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-JspReloadForWebMod', [['.*', '.*', 'AppDeploymentOption.Yes', 5]]])

 

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.

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. Use Jacl:

$AdminApp install c:/myapp.ear {-MapEJBRefToEJB {{"Examples Application" "" examples.war,WEB-INF/web.xml BeenThereBean com.ibm.websphere. beenthere.BeenThere IncBean}}}

Using Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-MapEJBRefToEJB {{.* .* .* .* .* IncBean}}}

Use Jython:

AdminApp.install('c:/myapp.ear', '[-MapEJBRefToEJB [["Examples Application" "" examples.war,WEB-INF/web.xml BeenThereBean com.ibm.websphere. beenthere.BeenThere IncBean]]]')

Using Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-MapEJBRefToEJB', [['.*', '.*', '.*', '.*', '.*', 'IncBean']]])

 

MapEnvEntryForWebMod

Edits the env-entry value of the Web module. You can use this option to edit the value of env-entry in the web.xml file. The current contents of this option after running default bindings are the following:

Use the taskInfo command of the AdminApp object to obtain information about the data needed for you application. Use Jacl:

$AdminApp install myapp.ear {-appname MyApp -MapEnvEntryForWebMod {{"IVT Application" ivt_app.war,WEB-INF/web.xml ivt/ivtEJBObject String null newEnvEntry}}}

Use Jacl with pattern matching:

$AdminApp install myapp.ear {-appname MyApp -MapEnvEntryForWebMod {{.* .* .* .* newEnvEntry}}}

Use Jython:

AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-MapEnvEntryForWebMod', [["IVT Application", 'ivt_app.war,WEB-INF/web.xml', 'ivt/ivtEJBObject', 'String', 'null', 'newEnvEntry']]])

Use Jython with pattern matching:

AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-MapEnvEntryForWebMod', [['.*', '.*', '.*', '.*', 'newEnvEntry']]])

 

MapInitParamForServlet

MapInitParam ForServlet
Edits the initial parameter of a Web module. You can use this option to edit the initial parameter of a servlet in the web.xml file. The current contents of this option after running the default bindings are the following:

Use the taskInfo command of the AdminApp object to obtain information about the data needed for you application. Use Jacl:

$AdminApp install myapp.ear {-appname MyApp -MapInitParamForServlet {{"IVT Application" ivt_app.war,WEB-INF/web.xml ivtservlet pName1 null MyInitParamValue}}}

Use Jacl with pattern matching:

$AdminApp install myapp.ear {-appname MyApp -MapInitParamForServlet {{.* .* .* .* .* MyInitParamValue}}}

Using Jython:

AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-MapInitParamForServlet', [["IVT Application", 'ivt_app.war,WEB-INF/web.xml', 'ivtservlet', 'pName1', 'null', 'MyInitParamValue']]])

Using Jython with pattern matching:

AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-MapInitParamForServlet', [['.*', '.*', '.*', '.*', '.*', 'MyInitParamValue']]])

 

MapMessageDestinationRefToEJB

Maps message destination references to Java Naming and Directory Interface (JNDI) names of administrative objects from the installed resource adapters. You must map each message destination reference that is defined in your application to an administrative object. Use this option to provide missing data or to update a task. The current contents of the option after running default bindings include:

Use Jacl:

$AdminApp install $earfile {-MapMessageDestinationRefToEJB {{ejb-jar-ic.jar Publisher ejb-jar-ic.jar,META-INF/ejb-jar.xml MyConnection jndi2} {ejb-jar-ic.jar Publisher ejb-jar-ic.jar,META-INF/ejb-jar.xml PhysicalTopic jndi3} {ejb-jar-ic.jar Publisher ejb-jar-ic.jar,META-INF/ejb-jar.xml jms/ABC jndi4}}}

Use Jacl with pattern matching:

$AdminApp install $earfile {-MapMessageDestinationRefToEJB {{.* .* .* MyConnection jndi2} {.* .* .* PhysicalTopic jndi3} {.* .* .* jms/ABC jndi4}}}

Use Jython:

AdminApp.install(ear1, ['-MapMessageDestinationRefToEJB', [['ejb-jar-ic.jar', 'Publisher', 'ejb-jar-ic.jar,META-INF/ ejb-jar.xml', 'MyConnection', 'jndi2'], ['ejb-jar-ic.jar', 'Publisher', 'ejb-jar-ic.jar,META-INF/ ejb-jar.xml', 'PhysicalTopic', 'jndi3'], ['ejb-jar-ic.jar', 'Publisher', 'ejb-jar-ic.jar,META-INF/ ejb-jar.xml', 'jms/ABC', 'jndi4']]])

Use Jython with pattern matching:

AdminApp.install(ear1, ['-MapMessageDestinationRefToEJB', [['.*', '.*', '.*', 'MyConnection', 'jndi2'], ['.*', '.*', '.*', 'PhysicalTopic', 'jndi3'], ['.*', '.*', '.*', 'jms/ABC', 'jndi4']]])

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update.

 

MapModulesToServers

Specifies the appserver 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 to update to a task.

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update. Use Jacl:

$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=server2+WebSphere:cell=mycell,node= yournode,server=server1}}}

Using Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-MapModulesToServers {{.* .*.jar,.* WebSphere:cell=mycell,node=mynode,server=server2} {.* .*.war,.* WebSphere:cell=mycell,node=mynode,server=server1}}}
The following example, adds server2 and server3 to application that is installed:

$AdminApp install c:/myapp.ear {-MapModulesToServers {{.* .* +WebSphere:cell=mycell,node=mynode,server=server2+ WebSphere:cell=mycell,node=mynode,server=server3}} -appname myapp -update -update.ignore.old}
The following example removes server1 from application that is installed:

$AdminApp edit myapp {-MapModulesToServers {{.* .* -WebSphere:cell=mycell,node=mynode,server=server1}} -update -update.ignore.old}

Use Jython:

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=server2+WebSphere:cell=mycell,node= yournode,server=server1]]]')

Use Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-MapModulesToServers', [['.*', '.*.jar,.*', 'WebSphere:cell=mycell,node=mynode,server=server2'] ['.*', '.*.war,.*', 'WebSphere:cell=mycell,node=mynode,server=server1']]])
The following example, adds server2 and server3 to application that is installed:

AdminApp.install('c:/myapp.ear', ['-MapModulesToServers', [['.*', '.*', '+WebSphere:cell=mycell,node=mynode,server=server2 +WebSphere:cell=mycell,node=mynode,server=server3']], '-appname', 'myapp', '-update', '-update.ignore.old'])
The following example removes server1 from application that is installed:

AdminApp.edit('myapp', ['-MapModulesToServers', [['.*', '.*', '-WebSphere:cell=mycell,node=mynode,server=server1']]])

 

MapResEnvRefToRes

Maps resource environment references to resources. You must map each resource environment reference that is defined in your application to a resource. Use this option to provide missing data or to update a task.

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update. Use Jacl:

$AdminApp install c:/myapp.ear {-MapResEnvRefToRes {{AsyncSender AsyncSender asyncSenderEjb.jar,META-INF/ejb-jar.xml jms/ASYNC_SENDER_QUEUE javax.jms.Queue jms/Resource2}}}

Using Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-MapResEnvRefToRes {{.* .* .* .* .* jms/Resource2}}}

Use Jython:

AdminApp.install('c:/myapp.ear', '[-MapResEnvRefToRes [[AsyncSender AsyncSender asyncSenderEjb.jar,META-INF/ejb-jar.xml jms/ASYNC_SENDER_QUEUE javax.jms.Queue jms/Resource2]]]')

Using Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-MapResEnvRefToRes', [['.*', '.*', '.*', '.*', '.*', 'jms/Resource2']]])

 

MapResRefToEJB

Maps resource references to resources. You must map each resource reference that is defined in your application to a resource. Use this option to provide missing data or to update a task.The parameters for MapResRefToEJB include:

The DefaultPrincipalMapping login configuration is used by Java 2 Connectors (J2C) to map users to principals that are defined in the J2C authentication data entries. If the login.config.name is set to DefaultPrincipalMapping, a property is created with the name com.ibm.mapping.authDataAlias . The value of the property is set by the auth.props. If the login.config name is not set to DefaultPrincipalMapping, the auth.props can specify multiple properties. The string format is websphere:name= <name1>,value=<value1>,description=<desc1>. Specify multiple properties using the plus sign (+) .

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update. Use Jacl:

$AdminApp install c:/app1.ear {-MapResRefToEJB {{deplmtest.jar MailEJBObject deplmtest.jar,META-INF/ejb-jar.xml mail/MailSession9 javax.mail.Session jndi1 login1 authProps1} {"JavaMail Sample WebApp" "" mtcomps.war,WEB-INF/web.xml mail/MailSession9 javax.mail. Session jndi2 login2 authProps2}}}

Use Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-MapResRefToEJB {{deplmtest.jar .* .* .* .* jndi1 login1 authProps1} {"JavaMail Sample WebApp" .* .* .* .* jndi2 login2 authProps2}}}

Using Jython:

AdminApp.install('c:/app1.ear', ['-MapResRefToEJB', [['deplmtest.jar', 'MailEJBObject', 'deplmtest.jar,META-INF/ejb-jar.xml mail/MailSession9', 'javax.mail.Session', 'jndi1', 'login1', 'authProps1'], ["JavaMail Sample WebApp", "", 'mtcomps.war,WEB-INF/web.xml', 'mail/MailSession9', 'javax.mail. Session', 'jndi2', 'login2', 'authProps2']]])

Use Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-MapResRefToEJB', [['deplmtest.jar', '.*', '.*', '.*', '.*', 'jndi1', 'login1', 'authProps1'], ["JavaMail Sample WebApp", '.*', '.*', '.*', '.*', 'jndi2', 'login2', 'authProps2']]])

 

MapRolesToUsers

Maps users to roles. You must map each role that is 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 pipe (|). Use this option to provide missing data or to update a task.

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update. Use Jacl:

$AdminApp install c:/myapp.ear {-MapRolesToUsers {{"All Role" No Yes "" ""} {"Every Role" Yes No "" ""} {DenyAllRole No No user1 group1}}}

Use Jython:

AdminApp.install('c:/myapp.ear', '[-MapRolesToUsers [["All Role" No Yes "" ""] ["Every Role" Yes No "" ""] [DenyAllRole No No user1 group1]]]')

where {{"All Role" No Yes "" ""} corresponds to the following:

"All Role" Represents the role name
No Indicates to allow access to everyone (yes/no)
Yes Indicates to allow access to all authenticated users (yes/no)
"" Indicates the mapped users
"" Indicates the mapped groups

where {{"All Role" No Yes "" ""} corresponds to the following:

"All Role" Represents the role name
No Indicates to allow access to everyone (yes/no)
Yes Indicates to allow access to all authenticated users (yes/no)
"" Indicates the mapped users
"" Indicates the mapped groups

 

MapRunAsRolesToUsers

Maps RunAs Roles to users. The enterprise beans you that 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 to update a task.

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update. Use Jacl:

$AdminApp install c:/myapp.ear {-MapRunAsRolesToUsers {{UserRole user1 password1} {AdminRole administrator administrator}}}

Using Jython:

AdminApp.install('c:/myapp.ear', '[-MapRunAsRolesToUsers [[UserRole user1 password1] [AdminRole administrator administrator]]]')

 

MapSharedLibForMod

Assigns shared libraries to application or every module. You can associate multiple shared libraries to applications and modules. The current contents of this option after running default bindings are the following:

Use the taskInfo command of the AdminApp object to obtain information about the data needed for you application. Use Jacl:

$AdminApp install myapp.ear {-appname MyApp -MapSharedLibForMod {{EAR1 META/application.xml sharedlib1} {"IVT Application" ivt_app.war,WEB-INF/web.xml sharedlib2} {"IVT EJB Module" ivtEJB.jar sharedlib3}}}

Use Jacl with pattern matching:

$AdminApp install myapp.ear {-appname MyApp -MapSharedLibForMod {{.* .* sharedlib1} {.* .* sharedlib2} {.* .* sharedlib3}}}

Use Jython:

AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-MapSharedLibForMod', [['EAR1', 'META/application.xml', 'sharedlib1'], ["IVT Application", 'ivt_app.war,WEB-INF/web.xml', 'sharedlib2'], ["IVT EJB Module", 'ivtEJB.jar', 'sharedlib3']]])

Use Jython with pattern matching:

AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-MapSharedLibForMod', [['.*', '.*', 'sharedlib1'], ['.*', '.*', 'sharedlib2'], ['.*', '.*', 'sharedlib3']]])

 

MapWebModToVH

Selects virtual hosts for Web modules. Specify the virtual host where you want to install the Web modules that are 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 to update a task.

Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. We need to provide data for rows or entries that are either missing information, or require an update. Use Jacl:

$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 Jacl with pattern matching:

$AdminApp install c:/myapp.ear {-MapWebModToVH {{.* .* default_host}}}

Use Jython:

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 Jython with pattern matching:

AdminApp.install('c:/myapp.ear', ['-MapWebModToVH', [['.*', '.*', 'default_host']]])

 

noallowDispatchRemoteInclude

Disables the enterprise application that dispatches includes to resources across web modules in different Java virtual machines in a managed node environment through the standard request dispatcher mechanism.

 

noallowPermInFilterPolicy

Specifies not to continue with the application deployment process when the application contains policy permissions that are in the filter policy. This option is the default setting and it does not require a value.

 

noallowServiceRemoteInclude

Disables the enterprise application that services an include request from an enterprise application that has the allowDispatchRemoteInclude option set to true.

 

node

Specifies the node name to install or update an entire application or to update an application in order to add a new module. If you want to update an entire application, this option only applies if the application contains a new module that does not exist in the installed application. Use Jython:

AdminApp.install('c:/myapp/myapp.ear', '[-node nodeName]')

Using Jacl:

$AdminApp install "c:/myapp.ear" {-node nodeName}

 

nocreateMBeansForResources

Specifies that MBeans are not created for all resources such as, servlets, JSPs, and enterprise beans, that are defined in an application when the application starts on a deployment target. This option is the default setting and it does not require a value.

 

nodeployejb

Specifies not to run the EJBDeploy tool during installation. This option is the default setting and it does not require a value.

 

nodeployws

Specifies not to deploy Web services during installation. This option is the default setting and it does not require a value.

 

nodistributeApp

Specifies that the application management component does not distribute application binaries. This option does not require a value. The default setting is the distributeApp option.

 

noreloadEnabled

Disables class reloading. This option does not require a value. The default setting is the reloadEnabled option.

 

nopreCompileJSPs

Specifies not to precompile JavaServer Pages files. This option is the default setting and it does not require a value.

 

noprocessEmbeddedConfig

Use this option to ignore the embedded configuration data that is include in the application. This option does not required a value.

If the application EAR file does not contain embedded configuration data, the noprocessEmbeddedConfig option is the default setting. Otherwise, the default setting is the processEmbeddedConfig option.

 

nouseMetaDataFromBinary

Specifies that the metadata that is used at run time, for example, deployment descriptors, bindings, extensions, and so on, come from the configuration repository. This option is the default setting and it does not require a value. Use this option to indicate that the metadata that is used at run time comes from the enterprise archive file (EAR) file.

 

nousedefaultbindings

Specifies not to use default bindings for installation. This option is the default setting and it does not require a value.

 

operation

Specifies the operation to perform. This option only applies to the update command. The valid values include:

The operation option is required if the content type is file or modulefile. If the value of the content type is app, the value of the operation option must be update.

The following examples show how to use the options for the update command to update a single file in a deployed application:

Use Jacl:

$AdminApp update app1 file {-operation update -contents c:/apps/app1/my.xml -contenturi app1.jar/my.xml}

Using Jython string:

AdminApp.update('app1', 'file', '[-operation update -contents c:/apps/app1/my.xml -contenturi app1.jar/my.xml]')

Use Jython list:

AdminApp.update('app1', 'file', ['-operation', 'update', '-contents', 'c:/apps/app1/my.xml', '-contenturi', app1.jar/my.xml'])

where AdminApp is the scripting object, update is the command, app1 is the name of the application you want to update, file is the content type, operation is an option of the update command, update is the value of the operationoption, contents is an option of the update command, /apps/app1/my.xml is the value of the contents option, contenturi is an option of the update command, app1.jar/my.xml is the value of the contenturi option.

where AdminApp is the scripting object, update is the command, app1 is the name of the application you want to update, file is the content type, operation is an option of the update command, update is the value of the operationoption, contents is an option of the update command, /apps/app1/my.xml is the value of the contents option, contenturi is an option of the update command, app1.jar/my.xml is the value of the contenturi option.

 

processEmbeddedConfig

Use this option to process the embedded configuration data that is included in the application. This option does not required a value.

If the application EAR file contains embedded configuration data, this option is the default setting. If not, the default setting is the nonprocessEmbeddedConfig option.

 

preCompileJSPs

Specifies to precompile the JavaServer Pages files. This option does not require a value. The default value is nopreCompileJSPs.

If you want to precompile JavaServer Pages files, specify it as a part of installation. The default is not to precompile JavaServer Pages files. The precompileJSPs option is ignored during deployment and JavaServer Pages files are not precompiled. The flag is set automatically using assembly tools.

 

reloadEnabled

Specifies that the file system of the application will be scanned for updated files so that changes reload dynamically. This option is the default setting and it does not require a value.

 

reloadInterval

Timeime period in seconds that the file system of the application will be scanned for updated files. Valid range is greater than zero. The default is three seconds.

 

server

Server name to install or update an entire application or to update an application in order to add a new module. If you want to update an application, this option only applies if the application contains a new module that does not exist in the installed application.

You cannot use the -cluster and -server options together. To deploy an application and specify the HTTP server during the deployment so that the application will appear in the generated plugin-cfg.xml file, first install the application with a target of -cluster. After you install the application and before you save, use edit command of the AdminApp object to add the additional mapping to the Web server. Use Jython:

AdminApp.install('c:/myapp/myapp.ear', '[-server serverName]')

Using Jacl:

$AdminApp install "c:/myapp.ear" {-server serverName}

 

target

Timearget for the installation functions of the AdminApp object. The following is an example of a target option: WebSphere:cell=mycell,node=mynode,server=myserver

You can specify multiple targets by delimiting them with a plus (+) sign. By default, the targets specified when you install or edit an application replace the existing target definitions in the application. You can use a leading plus (+) or negative (-) sign to add or remove targets without having to specify the targets that are not changed. Use Jacl:

$AdminApp install /path_to/binaries/DefaultApplication.ear {-appname MyApp -target WebSphere:cell= GooddogCell,node=GooddogNode,server=server2+WebSphere:cell= GooddogCell,node=BaddogNode,server=server3}
The following example removes server3 from the application that is installed:

$AdminApp install /path_to/binaries/DefaultApplication.ear {-appname MyApp -target -WebSphere:cell= GooddogCell,node=BaddogNode,server=server3 -update -update.ignore.old}
The following example adds server4 to the application that is installed:

$AdminApp upate app {-appname MyApp -target +WebSphere:cell= GooddogCell,node=GooddogNode,server=server4 -contents /path_to/binaries/DefaultApplication.ear -operation update -update.ignore.old}

Use Jython:

AdminApp.install("/path_to/binaries/DefaultApplication.ear", ["-appname", "MyApp", "-target", "WebSphere:cell=GooddogCell,node=GooddogNode,server=server2+ WebSphere:cell=GooddogCell,node=BaddogNode,server=server3"])
The following example removes server3 from the application that is installed:

AdminApp.install("/path_to/binaries/DefaultApplication.ear", ["-appname", "MyApp", "-target", "-WebSphere:cell=GooddogCell,node=BaddogNode,server=server3", "-update", "-update.ignore.old"])
The following example adds server4 to the application that is installed:

AdminApp.upate("app", ["-appname", "MyApp", "-target", "+WebSphere:cell=GooddogCell,node=GooddogNode,server=server4", "-contents", "/path_to/binaries/DefaultApplication.ear", "-operation", "update", "-update.ignore.old"])

 

update

Updates the installed application with a new version of the enterprise archive file (EAR) file. This option does not require a value.

The application that is being updated, which is specified by the appname option, must already be installed in the WAS 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.new

Specifies that during the update action, bindings from the new version of the application are ignored. This option does not require a value. This option applies only if you specify one of the following items:

 

update.ignore.old

Specifies that during the update action, the bindings from the installed version of the application are ignored. This option does not require a value. This option applies only if you specify one of the following items:

 

useMetaDataFromBinary

Specifies that the metadata that is 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 that is 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.

 

validateinstall

Level of application installation validation. Valid option values include:

 

verbose

Causes additional messages to display during installation. This option does not require a value.

 

WebServicesClientBindDeployedWSDL

The immutable values for this option identify the client Web service that you are modifying. The scoping fields include: Module, EJB, and Web service. The single mutable value for this task is the deployed WSDL file name. It indicates the Web Services Description Language (WSDL) the client uses.

The Module field identifies the enterprise or Web application within the application. If the module is an enterprise bean , the EJB field identifies a particular enterprise bean within the module. The Web service field identifies the Web service within the enterprise bean or the Web application module. This identifier corresponds to the wsdl:service attribute in the WSDL file, prepended with service/, for example, service/WSLoggerService2. Use Jacl:

$AdminApp install WebServicesSamples.ear {-WebServicesClientBindDeployedWSDL {{AddressBookW2JE.jar AddressBookW2JE service/WSLoggerService2 META-INF/wsdl/DeployedWsdl1.wsdl}}}

Use Jacl with pattern matching:

$AdminApp install WebServicesSamples.ear {-WebServicesClientBindDeployedWSDL {{.* .* .* META-INF/wsdl/DeployedWsdl1.wsdl}}}

Use Jython:

AdminApp.install('WebServicesSamples.ear', '[-WebServicesClientBindDeployedWSDL [[AddressBookW2JE.jar AddressBookW2JE service/WSLoggerService2 META-INF/wsdl/DeployedWsdl1.wsdl]]]')

Use Jython with pattern matching:

AdminApp.install('WebServicesSamples.ear', ['-WebServicesClientBindDeployedWSDL', ['.*', '.*', '.*', 'META-INF/wsdl/DeployedWsdl1.wsdl']]])

The deployed WSDL attribute names a WSDL file relative to the client module. An example of a deployed WSDL for a Web application is the following: WEB-INF/wsdl/WSLoggerService.

 

WebServicesClientBindPortInfo

The immutable values identify the port of a client Web service that you are modifying. The scoping fields include: Module, EJB, Web service and Port. The mutable values for this task include: Sync Timeout, BasicAuth ID, BasicAuth Password, SSL Config, and Overridden Endpoint URI. The basic authentication and SSL fields affect transport level security, not Web services security. Use Jacl:

$AdminApp install WebServicesSamples.ear {-WebServicesClientBindPortInfo {{AddressBookW2JE.jar AddressBookW2JE service/WSLoggerService2 WSLoggerJMS 3000 newHTTP_ID newHTTP_pwd sslAliasConfig http://yunus:9090/WSLoggerEJB/services/WSLoggerJMS}}}

Use Jacl with pattern matching:

$AdminApp install WebServicesSamples.ear {-WebServicesClientBindPortInfo {{.* .* .* .* 3000 newHTTP_ID newHTTP_pwd sslAliasConfig http://yunus:9090/WSLoggerEJB/services/WSLoggerJMS}}}

Using Jython:

AdminApp.install('WebServicesSamples.ear', '[-WebServicesClientBindPortInfo [[AddressBookW2JE.jar AddressBookW2JE service/WSLoggerService2 WSLoggerJMS 3000 newHTTP_ID newHTTP_pwd sslAliasConfig http://yunus:9090/WSLoggerEJB/services/WSLoggerJMS]]]')

Use Jython with pattern matching:

AdminApp.install('WebServicesSamples.ear', ['-WebServicesClientBindPortInfo', [['.*', '.*', '.*', '.*', '3000', 'newHTTP_ID', 'newHTTP_pwd', 'sslAliasConfig', 'http://yunus:9090/WSLoggerEJB/services/WSLoggerJMS']]])

 

WebServicesClientBindPreferredPort

Associates a preferred port (implementation) with a port type (interface) for a client Web service. The immutable values identify a port type of the client Web service that you are modifying. The scoping fields include: Module, EJB, Web service and Port Type. The mutable value for this task is Port.

Use Jacl:

$AdminApp install WebServicesSamples.ear {-WebServicesClientBindPreferredPort {{AddressBookW2JE.jar AddressBookW2JE service/WSLoggerService2 WSLoggerJMS WSLoggerJMSPort}}}

Use Jacl with pattern matching:

$AdminApp install WebServicesSamples.ear {-WebServicesClientBindPreferredPort {{.* .* .* .* WSLoggerJMSPort}}}

Use Jython:

AdminApp.install('WebServicesSamples.ear', '[-WebServicesClientBindPreferredPort [[AddressBookW2JE.jar AddressBookW2JE service/WSLoggerService2 WSLoggerJMS WSLoggerJMSPort]]]')

Use Jython with pattern matching:

AdminApp.install('WebServicesSamples.ear', ['-WebServicesClientBindPreferredPort',[['.*', '.*', '.*', '.*', 'WSLoggerJMSPort']]])

 

WebServicesServerBindPort

Sets two attributes of a Web service port. The immutable values identify the port of a Web service that you are modifying. The scope fields include: Module, Web service and Port. The mutable values include: WSDL Service Name, and Scope.

The scope determines the life cycle of implementing the Java bean. The valid values include: Request (new instance for each request), Application (one instance for each web-app), and Session (new instance for each HTTP session).

The scope attribute does not apply to Web services that a JMS transport. The scope attribute does not apply to enterprise beans.

The WSDL service name identifies a service when more than one service has the same port name. The WSDL service name is represented as a QName string, for example, {namespace}localname . Use Jacl:

$AdminApp install WebServicesSamples.ear {-WebServicesServerBindPort {{AddressBookW2JE.jar service/WSLoggerService2 WSLoggerJMS {} Session}}}

Use Jacl with pattern matching:

$AdminApp install WebServicesSamples.ear {-WebServicesServerBindPort {{.* WSClientTestService WSClientTest Request} {.* StockQuoteService StockQuote Application} {.* StockQuoteService StockQuote2 Session}}}

Use Jython:

AdminApp.install('WebServicesSamples.ear', '[-WebServicesServerBindPort [[AddressBookW2JE.jar service/WSLoggerService2 WSLoggerJMS "" Session]]]')

Use Jython with pattern matching:

AdminApp.install('WebServicesSamples.ear', ['-WebServicesServerBindPort', [['.*', 'WSClientTestService', 'WSClientTest', 'Request'], ['.*', 'StockQuoteService', 'StockQuote', 'Application'], ['.*', 'StockQuoteService', 'StockQuote2', 'Session']]])

 

WebServicesClientCustomProperty

Supports the configuration of the name value parameter for the description of the client bind file of a Web service. The immutable values identify the port of the Web service that you are modifying. The scope fields include: Module, Web service, and Port. The mutable values include: name and value.

The format of the name and value values include a string that represents multiple name and value pairs by using the + character as a separator. For example, name string = "n1+n2+n3" value string = "v1+v2+v3" yields name/value pairs: {{"n1" "v1"}, {"n2" "v2"}, {"n3" " v3"}} Use Jacl:

$AdminApp edit WebServicesSamples {-WebServicesClientCustomProperty {{join.jar com_ibm_ws_wsfvt_test_multiejbjar_client_WSClientTest service/StockQuoteService STockQuote propname1 propValue1} {ejbclientonly.jar Exchange service/STockQuoteService STockQuote propname2 propValue2}}}

Use Jacl with pattern matching:

$AdminApp edit WebServicesSamples {-WebServicesClientCustomProperty {{join.jar com_ibm_ws_wsfvt_test_multiejbjar_client_WSClientTest .* .* propname1 propValue1}{ejbclientonly.jar Exchange .* .* propname2 propValue2}}}

Use Jython:

AdminApp.edit('WebServicesSamples', ['-WebServicesClientCustomProperty', [['join.jar', 'com_ibm_ws_wsfvt_test_multiejbjar_client_WSClientTest', 'service/StockQuoteService', 'STockQuote', 'propname1', 'propValue1'], ['ejbclientonly.jar', 'Exchange', 'service/STockQuoteService', 'STockQuote', 'propname2', 'propValue2']]])

Use Jython with pattern matching:

AdminApp.edit('WebServicesSamples', ['-WebServicesClientCustomProperty', [['join.jar', 'com_ibm_ws_wsfvt_test_multiejbjar_client_WSClientTest', '.*', '.*', 'propname1', 'propValue1'],['ejbclientonly.jar', 'Exchange', '.*', '.*', 'propname2', 'propValue2']]])

 

WebServicesServerCustomProperty

Supports the configuration of the name value parameter for the description of the server bind file of a Web service. The scoping fields include... Module, EJB, and Web service. The mutable values for this task include: name and value.

The format of the these values include a string that represents multiple name and value pairs by using the plus (+) character as a separator. For example, name string = "n1+n2+n3" value string = "v1+v2+v3" yields name/value pairs: {{"n1" "v1"}, {"n2" "v2"}, {"n3" " v3"}} Use Jacl:

$AdminApp edit WebServicesSamples {-WebServicesServerCustomProperty {{AddressBookW2JE.jar AddressBookService AddressBook com.ibm.websphere.webservices.http.responseContentEncoding deflate}}}

Use Jacl with pattern matching:

$AdminApp edit WebServicesSamples {-WebServicesServerCustomProperty {{.* .* .* com.ibm.websphere.webservices.http.responseContentEncoding deflate}}}

Use Jython:

AdminApp.edit ( 'WebServicesSamples', '[ -WebServicesServerCustomProperty [[AddressBookW2JE.jar AddressBookService AddressBook com.ibm.websphere.webservices.http.responseContentEncoding deflate]]]')

Use Jython with pattern matching: 

AdminApp.edit('WebServicesSamples', 
              ['-WebServicesServerCustomProperty', 
              [['.*', '.*', '.*', 'com.ibm.websphere.webservices.http.responseContentEncoding', 'deflate']]])

 

Make a user-editable properties file available to a J2EE application

One of the challenges when writing J2EE-compliant applications is the management of configuration properties. All non-trivial applications should externalize various configuration parameters from application code. This includes such things as...

J2EE provides for some externalization of many of the J2EE-specific constructs...

...via the idea of references, but this is not sufficient. Most applications also have non-J2EE configuration information.

Configuration information is also likely to be edited by administrators as part of -- or even after -- application deployment. Thus, configuration choices that can only be made prior to creating the application EAR file are not really acceptable. What is needed is a simple, end-administrator-editable, J2EE-compliant way of managing configuration information. Of course, applications can build and design their own configuration management infrastructure (perhaps via JMX), but that approach would be quite complicated and expensive.

We can leverage WebSphere Application Server support for URL resources to create a J2EE-compliant URL resource that points to a user-editable properties file;

For more info, see...


Sub-topics

Usage table for the options of the AdminApp object install, installInteractive, update, updateInteractive, edit, and editInteractive commands

 

Related tasks

Pattern matching with the wsadmin tool

 

Related Reference

Example: Obtaining option information for AdminApp object commands
Commands for the AdminApp object

 

Reference topic