Options for AdminApp install, installInteractive, edit, editInteractive, update, and updateInteractive commands


Overview

Use AdminApp to manage the application configurations.

Pattern matching only applies to fields that are required or read only.

If an application is running, changing an application setting causes the application to restart. On stand-alone servers, the application restarts after you save the change. On multiple-server products, the application restarts after you save the change and files synchronize on the node where the application is installed. To control when synchronization occurs on multiple-server products, deselect Synchronize changes with nodes on the Console preferences page.


Options

 

ActSpecJNDI

The ActSpecJNDI option binds J2C activation specifications to destination JNDI names. You can optionally bind J2C activation specifications in the application or module to a destination JNDI name. We can assign a value to each of the following elements of the ActSpecJNDI option: RARModule, uri, j2cid, and j2c.jndiName fields. The contents of the option after running default bindings include:

To use this option, specify the Destination property in the ra.xml file and set the introspected type of the Destination property as javax.jms.Destination

Use the taskinfo command of AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage

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

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

Using Jython with pattern matching:

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

 

allowDispatchRemoteInclude

Enable 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.

Batch mode example usage

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

 

allowPermInFilterPolicy

Specify that the appserver should continue with the application deployment process even when the application contains policy permissions in the filter policy. This option does not require a value.

 

allowServiceRemoteInclude

The allowServiceRemoteInclude option enables an enterprise application to service an include request from an enterprise application with the allowDispatchRemoteInclude option set to true.

Batch mode example usage

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

 

appname

The appname option specifies the name of the application. The default value is the display name of the application.

 

BackendIdSelection

The BackendIdSelection option 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 an application assembly tool. Use this option to change the backend ID during installation.

Batch mode example usage

Jacl...

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

Using Jacl with pattern matching:

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

Jython...

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

Using Jython with pattern matching:

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

 

BindJndiForEJBBusiness

The BindJndiForEJBBusiness option binds EJB modules with business interfaces to JNDI names. Ensure that each EJB module with business interfaces is bound to a JNDI name. The current contents of the option after running default bindings include:

If specify the target resource JNDI name using the BindJndiForEJBNonMessageBinding option, do not specify a business interface JNDI name in the BindJndiForEJBBusiness option. If we do not specify the target resource JNDI name, specify a business interface JNDI name. If we do not specify a business interface JNDI name, the runtime provides a container default.

Use the taskinfo command of AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage

Jacl...

$AdminApp install $ear {-BindJndiForEJBMessageBinding {{SampleModule SampleEJB sample.jar,META-INF/ejb-jar.xml com.ibm.sample.business.bnd.LocalTargetOne ejblocal:ejb/LocalTargetOne}}}

Using Jacl with pattern matching:

$AdminApp install $ear {-BindJndiForEJBMessageBinding {{.* .* .*.jar,.* com.ibm.sample.business.bnd.LocalTargetOne ejblocal:ejb/LocalTargetOne}}}

Jython...

AdminApp.install(ear, ['-BindJndiForEJBMessageBinding', [['SampleModule', 'SampleEJB', 'sample.jar,META-INF/ejb-jar.xml', 'com.ibm.sample.business.bnd.LocalTargetOne', 'ejblocal:ejb/LocalTargetOne']]])

Using Jython with pattern matching:

AdminApp.install(ear, ['-BindJndiForEJBMessageBinding', [['.*', '.*', '.*.jar,.*', 'com.ibm.sample.business.bnd.LocalTargetOne', 'ejblocal:ejb/LocalTargetOne']]])

 

BindJndiForEJBMessageBinding

The BindJndiForEJBMessageBinding option binds enterprise beans to listener port names or JNDI names. Use this option to provide missing data or update a task. Ensure each message-driven enterprise bean in the 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:

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

Use the taskinfo command of AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage

Jacl...

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

Using Jacl with pattern matching:

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

Jython...

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

Using Jython with pattern matching:

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

 

BindJndiForEJBNonMessageBinding

The BindJndiForEJBNonMessageBinding option binds enterprise beans to JNDI names. Ensure each non message-driven enterprise bean in the application or module is bound to a JNDI name. Use this option to provide missing data or update a task. The current contents of the option after running default bindings include:

Special constraints exist for EJBs 3.0 modules. If specify the target resource JNDI name, do not specify the local home or remote home JNDI names. We also cannot specify the JNDI for business interfaces field in the BindJndiForEJBBusiness option. If we do not specify the target resource JNDI name, then the local and remote home JNDI name fields are optional. If we do not specify local and remote JNDI names, the runtime provides a container default.

If we do not use EJB 3.0 modules, specify the target resource JNDI name.

Use the taskinfo command of AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage

Jacl...

$AdminApp install C:\myapp.ear {-BindJndiForEJBNonMessageBinding{{.* .* ejb-jar-ic.jar,.* com.ibm.wssvt.acme.annuity.common.business.ejbws.ejb2xjaxrpc.AnnuityMgmtSvcEJB2xJAXRPC "" "" }}}

Using Jacl with pattern matching:

$AdminApp install myapp.ear {-BindJndiForEJBNonMessageBinding {{.* .* ejb-jar-ic.jar,.* com.ibm.wssvt.acme.annuity.common.business.ejbws.ejb2xjaxrpc.AnnuityMgmtSvcEJB2xJAXRPC "" ""}}}

Jython...

AdminApp.install('myapp.ear', '[-BindJndiForEJBNonMessageBinding [[Ejb1 MessageBean ejb-jar-ic.jar,META-INF/ejb-jar.xml com.ibm.wssvt.acme.annuity.common.business.ejbws.ejb2xjaxrpc.AnnuityMgmtSvcEJB2xJAXRPC "" ""]]]')

Using Jython with pattern matching:

AdminApp.install('myapp.ear', ['-BindJndiForEJBNonMessageBinding', [['.*', '.*', 'ejb-jar-ic.jar,.*', 'com.ibm.wssvt.acme.annuity.common.business.ejbws.ejb2xjaxrpc.AnnuityMgmtSvcEJB2xJAXRPC', '', '']]])

 

blaname

Use the blaname option to specify the name of business level application under which the system creates the Java EE application. This option is optional. If we do not specify a value, the system sets the name as the Java EE application name. This option is available only with the install command.

 

buildVersion

The buildVersion option displays the build version of an application EAR file. We cannot modify this option because it is read-only. This option returns the build version information for an application EAR if we have specified the build version in the MANIFEST.MF application EAR file.

 

cell

The cell option specifies the cell name to install or update an entire application, or to update an application in order to add a new module. To update an entire application, this option only applies if the application contains a new module that does not exist in the installed application.

Batch mode example usage

Jython...

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

Jacl...

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

 

cluster

The cluster option 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 an 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. We 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 the edit command of AdminApp to add the additional mapping to the Web server.

Batch mode example usage

Jython...

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

Jacl...

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

 

contents

The contents option specifies the 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 we have specified the delete option.

 

contenturi

The contenturi option specifies the URI of the file that we 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

The contextroot option specifies the context root that you use when installing a stand-alone WAR file.

 

CorrectOracleIsolationLevel

The CorrectOracleIsolationLevel option 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 AdminApp to obtain information about the data that is needed for the application. You only need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage

Jacl...

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

Using Jacl with pattern matching:

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

Using Jython with pattern matching:

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

Jython...

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

 

CorrectUseSystemIdentity

The CorrectUseSystemIdentity option replaces RunAs System to RunAs Roles. The enterprise beans that you install contain a RunAs system identity. We 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 AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage

Jacl...

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

Using Jacl with pattern matching:

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

Jython...

AdminApp.install('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]]]')

Using Jython with pattern matching:

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

 

createMBeansForResources

The createMBeansForResources option specifies that MBeans are created for all resources, such as servlets, JSPs, and enterprise beans, 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

The CtxRootForWebMod option edits the context root of the Web module. We 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:

If the Web module is a Servlet 2.5, the contents of this option are populated only from the XML deployment descriptor. We cannot get deployment information from annotations with this option.

Batch mode example usage

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

Jython...

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

Using Jython with pattern matching:

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

 

custom

The custom option 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.

 

CustomActivationPlan

The CustomActivationPlan option specifies runtime components to add or remove from the default runtime components that are used to run the application. Only use this option when the appserver can not obtain all necessary runtime components by inspecting the application.

Batch mode example usage

Jython...

AdminApp.install('myapp.ear','[-CustomActivationPlan [["Increment EJB module" Increment.jar,META-INF/ejb-jar.xml WebSphere:specname=WS_ComponentToAdd ""] ["Default Web Application" DefaultWebApplication.war,WEB-INF/web.xml "" ""]]')

Using Jython with pattern matching:

AdminApp.install('myapp.ear','[-CustomActivationPlan [[.* Increment.jar,META-INF/ejb-jar.xml WebSphere:specname=WS_ComponentToAdd ""] [.* DefaultWebApplication.war,WEB-INF/web.xml "" ""]]')

 

DataSourceFor10CMPBeans

The DataSourceFor10CMPBeans option 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 AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are missing information, or requiring an update.

Batch mode example usage

Jacl...

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

Using Jacl with pattern matching:

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

Jython...

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

Using Jython with pattern matching:

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

 

DataSourceFor20CMPBeans

The DataSourceFor20CMPBeans option 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:

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 AdminApp to obtain information about the data needed for the application. You only need to provide data for rows or entries that are missing information, or requiring an update.

Batch mode example usage

Jacl...

$AdminApp install myapp.ear {-DataSourceFor20CMPBeans {{"Increment EJB module" Increment Increment.jar,META-INF/ejb-jar.xml jndi1 container "" ""}}}

Using Jacl with pattern matching:

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

Jython...

AdminApp.install('myapp.ear', ['-DataSourceFor20CMPBeans', [["Increment EJB module", 'Increment', 'Increment.jar,META-INF/ejb-jar.xml', 'jndi1', 'container', '', '']]])

Using Jython with pattern matching:

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

 

DataSourceFor10EJBModules

The DataSourceFor10EJBModules option 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 DataSourceFor10EJBModules 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:

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 AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage Using Jacl:

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

Using Jacl with pattern matching:

$AdminApp install myapp.ear {-DataSourceFor10EJBModules {{.* IncCMP11.jar,.* theJNDI user2 password2 loginName authProps}}}

Jython...

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

Using Jython with pattern matching:

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

 

DataSourceFor20EJBModules

The DataSourceFor20EJBModules option 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, auth.props, and extended datasource properties. The current contents of the option after running default bindings include:

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 AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or require update.

Batch mode example usage

Jacl...

$AdminApp install myapp.ear {-DataSourceFor20EJBModules {{"Increment EJB module" Increment.jar,META-INF/ejb-jar.xml jndi2 container "" "" "clientApplicationInformation=newapplication" ""}}}

Using Jacl with pattern matching:

$AdminApp install myapp.ear {-DataSourceFor20EJBModules {{.* Increment.jar,.* jndi2 container "" "" "clientApplicationInformation=new application" ""}}}

Jython...

AdminApp.install('myapp.ear', ['-DataSourceFor20EJBModules', [["Increment EJB module", 'Increment.jar,META-INF/ejb-jar.xml', 'jndi2', 'container', '', '', 'clientApplicationInformation=newapplication+clientWorkstation=9.10.117.65', '']]])

Using Jython with pattern matching:

AdminApp.install('C:\myapp.ear', ['-DataSourceFor20EJBModules', [['.*', 'Increment.jar,.*', 'jndi2', 'container', '', '', 'clientApplicationInformation=newapplication+clientWorkstation=9.10.117.65', '']]])

[Linux] [Solaris]

[AIX] [HP-UX]

AdminApp.install('myapp.ear', ['-DataSourceFor20EJBModules', [['.*', 'Increment.jar,.*', 'jndi2', 'container', '', '', 'clientApplicationInformation=new application+clientWorkstation=9.10.117.65', '']]])

 

defaultbinding.cf.jndi

The defaultbinding.cf.jndi option specifies the JNDI name for the default connection factory.

 

defaultbinding.cf.resauth

The defaultbinding.cf.resauth option specifies the RESAUTH for the connection factory.

 

defaultbinding.datasource.jndi

The defaultbinding.datasource.jndi option specifies the JNDI name for the default data source.

 

defaultbinding.datasource.password

The defaultbinding.datasource.password option specifies the password for the default data source.

 

defaultbinding.datasource.username

The defaultbinding.datasource.username option specifies the user name for the default data source.

 

defaultbinding.ejbjndi.prefix

The defaultbinding.ejbjndi.prefix option specifies the prefix for the enterprise bean JNDI name.

 

defaultbinding.force

The defaultbinding.force option specifies that the default bindings override the current bindings.

 

defaultbinding.strategy.file

The defaultbinding.strategy.file option specifies a custom default bindings strategy file.

 

defaultbinding.virtual.host

The defaultbinding.virtual.host option specifies the default name for a virtual host.

 

depl.extension.reg (deprecated)

Deprecated feature: The depl.extension.reg option is deprecated. No replication option is available.depfeat

 

deployejb

The deployejb option specifies to run the EJBDeploy tool during installation. This option does not require a value.

If we 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

The deployejb.classpath option specifies an extra class path for the EJBDeploy tool.

 

deployejb.complianceLevel

The deployejb.complianceLevel option specifies the JDK compliance level for the EJBDeploy tool. Possible values include:

1.4 (default) 5.0 6.0

For a list of currently supported JDK compliance levels, run the ejbdeploy -? command.

 

deployejb.dbschema

The deployejb.dbschema option specifies the database schema for the EJBDeploy tool.

 

deployejb.dbtype

The deployejb.dbtype option specifies the database type for the EJBDeploy tool. Possible values include:

DB2UDB_V81 DB2UDB_V82 DB2UDB_V91 DB2UDB_V95 DB2UDBOS390_V8 DB2UDBOS390_NEWFN_V8 DB2UDBOS390_V9 DB2UDBISERIES_V53 DB2UDBISERIES_V54 DB2UDBISERIES_V61 DERBY_V10 DERBY_V101 INFORMIX_V100 INFORMIX_V111 INFORMIX_V115 MSSQLSERVER_2005 ORACLE_V10G ORACLE_V11G SYBASE_V15 SYBASE_V125

The following databases support Structured Query Language in Java (SQLJ): DB2UDB_V82, DB2UDB_V81, DB2UDBOS390_V7, and DB2UDBOS390_V8.

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

 

deployejb.dbaccesstype

The deployejb.dbaccesstype option specifies the type of database access. Valid values are SQLj and JDBC. The default is JDBC.

 

deployejb.rmic

The deployejb.rmic option specifies extra RMIC options to use for the EJBDeploy tool.

 

deployejb.sqljclasspath

The deployejb.sqljclasspath option specifies the location of the SQLJ translator classes.

 

deployws

The deployws option specifies to deploy Web services during installation. This option does not require a value.

The default value is: nodeployws.

 

deployws.classpath

The deployws.classpath option specifies the extra class path to use when you deploy Web services.

 

deployws.jardirs

The deployws.jardirs option specifies the extra extension directories to use when you deploy Web services.

 

distributeApp

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

 

EmbeddedRar

The EmbeddedRar option binds Java 2 Connector objects to JNDI names. You must bind each Java 2 Connector object in the application or module, such as, J2C connection factories, J2C activation specifications and J2C admin objects, to a JNDI name. Each element of the EmbeddedRar option contains the following fields: RARModule, uri, j2cid, j2c.name, j2c.jndiName. We 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
Where j2cid is:

J2C connection factory: connectionFactoryInterface J2C admin object: adminObjectInterface J2C activation specification: message listener type

Use the taskinfo command of AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

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

Batch mode example usage

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

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

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

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

 

EnsureMethodProtectionFor10EJB

The EnsureMethodProtectionFor10EJB option 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 AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage Using Jacl:

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

Using Jacl with pattern matching:

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

Jython...

AdminApp.install('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]]]')

Using Jython with pattern matching:

AdminApp.install('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. We can also leave the value blank if we want the method to remain unprotected.

 

EnsureMethodProtectionFor20EJB

The EnsureMethodProtectionFor20EJB option 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. We 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 AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or require an update the existing data.

Batch mode example usage

Jacl...

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

Using Jacl with pattern matching:

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

Jython...

AdminApp.install('myapp.ear', '[-EnsureMethodProtectionFor20EJB [[CustmerEjbJar customerEjb.jar,META-INF/ejb-jar.xml methodProtection.uncheck] [SupplierEjbJar supplierEjb.jar,META-INF/ejb-jar.xml methodProtection.exclude]]]')

Using Jython with pattern matching:

AdminApp.install('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

The filepermission 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

Batch mode example usage

Jacl...

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

Jython...

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

 

installdir (deprecated)

Deprecated feature: The installdir option is deprecated. This option is replaced by the installed.ear.destination option.depfeat

 

installed.ear.destination

The installed.ear.destination option specifies the directory to place application binaries.

 

JSPCompileOptions

The JSPCompileOptions option specifies Java ServerPages (JSP) compilation options for Web modules. This option is only valid if we use the preCompileJSPs option also. The current contents of this option after running default bindings are the following:

Batch mode example usage Using 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}}}

Jython...

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

Using Jython with pattern matching:

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

 

JSPReloadForWebMod

The JSPReloadForWebMod option edits the JSP reload attributes for the Web module. We 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 AdminApp to obtain information about the data needed for the application.

Batch mode example usage

Jacl...

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

Using Jacl with pattern matching:

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

Jython...

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

Using Jython with pattern matching:

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

 

MapEJBRefToEJB

The MapEJBRefToEJB option maps enterprise Java references to enterprise beans. You must map each enterprise bean reference defined in the application to an enterprise bean. Use this option to provide missing data or update to a task.

If the EJB reference is from EJB 3.0, Web 2.4, or Web 2.5 module, the JNDI name is optional. If we specify the useAutoLink option, the JNDI name is optional. Runtime provides a container default. An EJB 3.0 module cannot contain container-managed or bean-managed persistence entity beans. Installation fails when a container-managed or bean-managed persistence entity bean is packaged in a EJB 3.0 module of a Java EE application. We can only package container-managed or bean-managed persistence in an EJB 2.1 or earlier module.

Use the taskinfo command of AdminApp to obtain information about the data needed for the 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.

Batch mode example usage

Jacl...

$AdminApp install 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 myapp.ear {-MapEJBRefToEJB {{.* .* .* .* .* IncBean}}}

Jython...

AdminApp.install('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('myapp.ear', ['-MapEJBRefToEJB', [['.*', '.*', '.*', '.*', '.*', 'IncBean']]])

 

MapEnvEntryForWebMod

The MapEnvEntryForWebMod option edits the env-entry value of the Web module. 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:

If the Web module is a Servlet 2.5, the contents of this option are populated only from the XML deployment descriptor. We cannot get deployment information from annotations with this option.

Use the taskinfo command of AdminApp to obtain information about the data needed for the application.

Batch mode example usage

Jacl...

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

Using Jacl with pattern matching:

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

Jython...

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

Using Jython with pattern matching:

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

If there is a new line character in the description, use the following syntax: Using Jacl with pattern matching:

$AdminApp install myapp.ear {-appname MyApp -MapEnvEntryForWebMod {{.* .* .* (?s).* newEnvEntry}}}

Using Jython with pattern matching:

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

 

MapInitParamForServlet

The MapInitParamForServlet option edits the initial parameter of a Web module. Use this option to edit the initial parameter of a servlet in web.xml. The current contents of this option after running the default bindings are the following:

If the Web module is a Servlet 2.5, the contents of this option are populated only from the XML deployment descriptor. We cannot get deployment information from annotations with this option.

Use the taskinfo command of AdminApp to obtain information about the data needed for the application.

Batch mode example usage

Jacl...

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

Using Jacl with pattern matching:

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

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

The MapMessageDestinationRefToEJB option maps message destination references to JNDI names of administrative objects from the installed resource adapters. You must map each message destination reference that is defined in the 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:

If the message destination reference is from a EJB 3.0 module, then the JNDI name is optional and runtime provides a container default.

Use the taskinfo command of AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage Using 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}}}

Using Jacl with pattern matching:

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

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

Using Jython with pattern matching:

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

 

MapModulesToServers

The MapModulesToServers option specifies the appserver where you want to install modules that are contained in the application. We 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 the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage

Jacl...

$AdminApp install /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 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}

[Linux] [Solaris]

[AIX] [HP-UX]

$AdminApp install /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 the application that is installed:

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

Jython...

AdminApp.install('/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 Jython with pattern matching:

AdminApp.install('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 the application that is installed:

AdminApp.install('/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 the application that is installed:

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

 

MapResEnvRefToRes

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

Use the taskinfo command of AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage

Jacl...

$AdminApp install 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 myapp.ear {-MapResEnvRefToRes {{.* .* .* .* .* jms/Resource2}}}

Jython...

AdminApp.install('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('myapp.ear', ['-MapResEnvRefToRes', [['.*', '.*', '.*', '.*', '.*', 'jms/Resource2']]])

 

MapResRefToEJB

The MapResRefToEJB option maps resource references to resources. You must map each resource reference that is defined in the 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 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 AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage Using Jacl:

$AdminApp install myapp.ear {-MapResRefToEJB {{deplmtest.jar MailEJBObject deplmtest.jar,META-INF/ejb-jar.xml mail/MailSession9 javax.mail.Session jndi1 login1 authProps1 "clientApplicationInformation=new application"} {"Java Mail Sample WebApp" "" mtcomps.war,WEB-INF/web.xml mail/MailSession9 javax.mail.Session jndi2 login2 authProps2 ""}}}

Using Jacl with pattern matching:

$AdminApp install myapp.ear {-MapResRefToEJB {{deplmtest.jar .* .* .* .* jndi1 login1 authProps1 "clientApplicationInformation=new application"} {"Java Mail Sample WebApp" .* .* .* .* jndi2 login2 authProps2 ""}}}

Jython...

AdminApp.install('myapp.ear', ['-MapResRefToEJB', [['deplmtest.jar', 'MailEJBObject', 'deplmtest.jar,META-INF/ejb-jar.xml mail/MailSession9', 'javax.mail.Session', 'jndi1', 'login1', 'authProps1', 'clientApplicationInformation=new application+clientWorkstation=9.10.117.65'], ["Java Mail Sample WebApp", "", 'mtcomps.war,WEB-INF/web.xml', 'mail/MailSession9', 'javax.mail.Session', 'jndi2', 'login2', 'authProps2', '']]])

Using Jython with pattern matching:

AdminApp.install('myapp.ear', ['-MapResRefToEJB', [['deplmtest.jar', '.*', '.*', '.*', '.*', 'jndi1', 'login1', 'authProps1', 'clientApplicationInformation=new application+clientWorkstation=9.10.117.65'], ["Java Mail Sample WebApp", '.*', '.*', '.*', '.*', 'jndi2', 'login2', 'authProps2', '']]])

 

MapRolesToUsers

The MapRolesToUsers option 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. We 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 AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage Using Jacl:

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

Jython...

AdminApp.install('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:


Table 1. MapRolesToUsers option descriptions

"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)
"" Mapped users
"" Mapped groups

 

MapRunAsRolesToUsers

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

Use the taskinfo command of AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage

Jacl...

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

Jython...

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

 

MapSharedLibForMod

The MapSharedLibForMod option assigns shared libraries to application or every module. We 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 AdminApp to obtain information about the data needed for the application.

Batch mode example usage

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

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

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']]])
Using Jython with pattern matching:

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

 

MapWebModToVH

The MapWebModToVH option selects virtual hosts for Web modules. Specify the virtual host where you want to install the Web modules that are contained in the application. We 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 AdminApp to obtain information about the data that is needed for the application. we need to provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage Using Jacl:

$AdminApp install myapp.ear {-MapWebModToVH {{"Default Application" default_app.war,WEB-INF/web.xml default_host} {"Examples Application" examples.war,WEB-INF/web.xml default_host}}}

Using Jacl with pattern matching:

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

Jython...

AdminApp.install('myapp.ear', '[-MapWebModToVH [["Default Application" default_app.war,WEB-INF/web.xml default_host] ["Examples Application" examples.war,WEB-INF/web.xml default_host]]]')

Using Jython with pattern matching:

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

 

MetadataCompleteForModules

The MetadataCompleteForModules option allows each EJB 3.0 module or Web 2.5 module to write out the complete deployment descriptor including deployment information from annotations. Then the system marks the deployment descriptor for the module as complete. The current contents of this option after running default bindings are the following:

Use the taskinfo command of AdminApp to obtain information about the data that is needed for the application.

Batch mode example usage

Jacl...

$AdminApp install mayapp.ear {-MetadataCompleteForModules {{EJBDD_1.jar EJBDD_1.jar,META-INF/ejb-jar.xml false}}}

Using Jacl with pattern matching:

$AdminApp install myapp.ear {-MetadataCompleteForModules {{.* EJBDD_1.jar,.* false}}}

Jython...

AdminApp.install('myapp.ear', ['-MetadataCompleteForModules', [['EJBDD_1,jar', 'EJBDD_1.jar,META-INF/ejb-jar.xml', 'false']]])

Using Jython with pattern matching:

AdminApp.install('myapp.ear', ['-MetadataCompleteForModules', [['.*', 'EJBDD_1.jar,.*', 'false']]]

 

noallowDispatchRemoteInclude

The noallowDispatchRemoteInclude option 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

The noallowPermInFilterPolicy option specifies not to continue with the application deployment process when the application contains policy permissions in the filter.policy. This option is the default setting and does not require a value.

 

noallowServiceRemoteInclude

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

 

node

The node option specifies the node name to install or update an entire application or to update an application in order to add a new module. To update an entire application, this option only applies if the application contains a new module that does not exist in the installed application.

Batch mode example usage

Jython...

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

Jacl...

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

 

nocreateMBeansForResources

The nocreateMBeansForResources option specifies that MBeans are not created for all resources, such as servlets, JSPs files, and enterprise beans, 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

The nodeployejb option specifies not to run the EJBDeploy tool during installation. This option is the default setting and does not require a value.

 

nodeployws

The nodeployws option specifies not to deploy Web services during installation. This option is the default setting and does not require a value.

 

nodistributeApp

The nodistributeApp option 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

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

 

nopreCompileJSPs

The nopreCompileJSPs option specifies not to precompile JSPs files. This option is the default setting and does not require a value.

 

noprocessEmbeddedConfig

The noprocessEmbeddedConfig option specifies that the system should 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.

 

nouseAutoLink

The nouseAutoLink option specifies not to use the useAutoLink option, and not to automatically resolve EJB references from EJB module versions prior to EJB 3.0 and from Web module versions that are prior to V2.4.

 

nouseMetaDataFromBinary

The nouseMetaDataFromBinary option specifies that the metadata 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 does not require a value. Use this option to indicate that the metadata used at run time comes from the enterprise archive file (EAR) file.

 

nousedefaultbindings

The nousedefaultbindings option specifies not to use default bindings for installation. This option is the default setting and does not require a value.

 

operation

The operation option 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.

Batch mode example usage

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

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

Using Jython string:

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

Using Jython list:

AdminApp.update('app1', 'file', ['-operation', 'update', '-contents', '/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.

 

processEmbeddedConfig

The processEmbeddedConfig option processes 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

The preCompileJSPs option specifies to precompile the JSPs files. This option does not require a value. The default value is nopreCompileJSPs. To precompile JSPs files, specify it as a part of installation. The default is not to precompile JSPs files. The preCompileJSPs option is ignored during deployment and JSPs files are not precompiled. The flag is set automatically using assembly tools.

 

reloadEnabled

The reloadEnabled option 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 does not require a value.

 

reloadInterval

The reloadInterval option specifies the time 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.

 

SharedLibRelationship

The SharedLibRelationship option assigns assets or composition unit IDs as shared libraries for each Java EE module. The current contents of the option after running default bindings include:

We can specify assets and composition unit IDs in the relationship, as the following guidelines explain:

To specify more than one asset or composition unit ID, separate each value with the plus sign character (+).

When using the edit command for the Java EE application, we can override the relationship with a new set of composition unit relationship IDs, or we can add or remove existing composition unit relationships. We cannot specify an asset relationship when using the edit command. Specify the first character of the composition unit ID as the plus sign character (+) to add to the relationship, or specify the number sign character (#) to remove the composition unit ID from existing relationships. For example, the +cuname=cu2.zip composition unit syntax adds the cu2 composition unit to the relationship. The #cuname=cu1.zip+cuname=cu2.zip composition unit syntax removes the cu1 and cu2 composition units from the relationship.

Batch mode example usage Using Jacl:

$AdminApp install mayapp.ear {-SharedLibRelationship {{EJB3BNDBean.jar EJB3BNDBean.jar,META-INF/ejb-jar.xml WebSphere:cuname=sharedLibCU1 "" Yes}}}

Using Jacl with pattern matching:

$AdminApp install myapp.ear {-SharedLibRelationship {{.* EJB3BNDBean.jar,.* WebSphere:cuname=sharedLibCU1 "" Yes}}}

Jython...

AdminApp.install('myapp.ear', ['-SharedLibRelationship', [['EJB3BNDBean,jar', 'EJB3BNDBean.jar,META-INF/ejb-jar.xml', 'WebSphere:cuname=sharedLibCU1,' '', 'Yes']]])

Using Jython with pattern matching:

AdminApp.install('myapp.ear', ['-SharedLibRelationship', [['.*', 'EJB3BNDBean.jar,.*', 'WebSphere:cuname=sharedLibCU1', '', 'Yes']]]

 

server

The server option specifies the name of the server on which you want to perform one of the following actions:

We 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 the edit command of AdminApp to add the additional mapping to the Web server.

Batch mode example usage

Jython...

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

Jacl...

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

 

target

The target option specifies the target for the installation functions of AdminApp.

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.

Use a leading plus (+) or negative (-) sign to add or remove targets without having to specify the targets that are not changed.

Batch mode example usage

Jacl...

$AdminApp install /ASV/o0528.02/WebSphere/AppServer/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 /ASV/o0528.02/WebSphere/AppServer/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 /ASV/o0528.02/WebSphere/AppServer/binaries/DefaultApplication.ear -operation update -update.ignore.old}

Jython...

AdminApp.install("/ASV/o0528.02/WebSphere/AppServer/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("/ASV/o0528.02/WebSphere/AppServer/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", "/ASV/o0528.02/WebSphere/AppServer/binaries/DefaultApplication.ear", "-operation", "update", "-update.ignore.old"])

 

update

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

The application to update, 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

The update.ignore.new option 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 we specify one of the following items:

 

update.ignore.old

The update.ignore.old option 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 we specify one of the following items:

 

useAutoLink

Use the useAutoLink option to automatically resolve EJB references from EJB module versions prior to EJB 3.0, and from Web module versions that are prior to V2.4. If we enable the useAutoLink option, optionally specify the JNDI name for MapEJBRefToEJB option. Each module in the application must share one common target to enable autolink support.

Batch mode example usage

Jacl...
[Linux] [Solaris]

[AIX] [HP-UX]

$AdminApp install /myapp.ear {-useAutoLink}

Jython... [Linux] [Solaris]

[AIX] [HP-UX]

AdminApp.install('myapp.ear','[-useAutoLink]')

 

useMetaDataFromBinary

The useMetaDataFromBinary option 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

The usedefaultbindings option specifies to use default bindings for installation. This option does not require a value. The default setting is nousedefaultbindings.

To use the existing listener port instead of using or creating a new activation specification, determine whether the EJB JAR version is lower than 2.1. The system automatically creates and uses an activation spec when specify the -usedefaultbindings option to deploy an application. If an activation spec exists, the system ignores the listener port, and instead uses the activation specification. To deploy an application with an EJB JAR version greater than or equal to 2.1 using the defined listener ports instead of a new activation specification, set the com.ibm.websphere.management.application.dfltbndng.mdb.preferexisting system property to true in the wsadmin.properties file in the properties directory of the profile of interest.

 

validateinstall

The validateinstall option specifies the level of application installation validation. Valid option values include:

 

verbose

The verbose option causes additional messages to display during installation. This option does not require a value.

 

WebServicesClientBindDeployedWSDL

The WebServicesClientBindDeployedWSDL option identifies the client Web service that we 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 app 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 app module. This identifier corresponds to the wsdl:service attribute in the WSDL file, prepended with service/, for example, service/WSLoggerService2.

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

Batch mode example usage

Jacl...

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

Using Jacl with pattern matching:

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

Jython...

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

Using Jython with pattern matching:

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

 

WebServicesClientBindPortInfo

The WebServicesClientBindPortInfo option identifies the port of a client Web service that we are modifying. The scoping fields include: Module, EJB, Web service and Port. The mutable values for this task include:

Sync Timeout, BasicAuth ID, BasicAuth , SSL Config, and Overridden Endpoint URI. The basic authentication and SSL fields affect TLS, not WS-Security.

Batch mode example usage

Jacl...

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

Using Jacl with pattern matching:

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

Jython...

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

Using Jython with pattern matching:

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

 

WebServicesClientBindPreferredPort

The WebServicesClientBindPreferredPort option 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 we are modifying. The scoping fields include: Module, EJB, Web service and Port Type. The mutable value for this task is Port.

Batch mode example usage Using Jacl:

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

Using Jacl with pattern matching:

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

Jython...

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

Using Jython with pattern matching:

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

 

WebServicesServerBindPort

The WebServicesServerBindPort option sets two attributes of a Web service port. The immutable values identify the port of a Web service that we 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 .

Batch mode example usage

Jacl...

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

Using Jacl with pattern matching:

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

Jython...

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

Using Jython with pattern matching:

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

 

WebServicesClientCustomProperty

The WebServicesClientCustomProperty option 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 we 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"}},

Batch mode example usage Using 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}}}

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

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

Using 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

The WebServicesServerCustomProperty option supports the configuration of the name value parameter for the description of the server bind file of a Web service. The scoping fields include the following: 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 and value pairs: {{"n1" "v1"}, {"n2" "v2"}, {"n3" " v3"}}.

Batch mode example usage

Jacl...

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

Using Jacl with pattern matching:

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

Jython...

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

Using Jython with pattern matching:

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




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

 

Related

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