AdminApp object install, installInteractive, edit, editInteractive, update, and updateInteractive

 

+

Search Tips   |   Advanced Search

 

Overview

The following options are available for the install, installInteractive, edit, editInteractive, update, and updateInteractive commands:

 

ActSpecJNDI

Bind J2C activation specs to destination JNDI names. We can bind J2C activation specs in your application or module to a destination JNDI name.

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

  • RARModule
  • uri
  • j2cid
  • j2c.jndiName

The j2c.jndiName field can be assigned a value.

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

We can only use this option if the activation spec 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 the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. You need to provide data for rows or entries that are either missing information, or require an update.

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

 

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.

 

 

appname

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.

Jacl... 

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

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

 

BindJndiForEJBMessageBinding

Binds enterprise beans to listener port names 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:

  • EJBModule: Ejb1
  • EJB: MessageBean
  • URI: ejb-jar-ic.jar,META-INF/ejb-jar.xml
  • Listener port: [null]:
  • JNDI name: [eis/MessageBean]:
  • Destination JNDI Name: [jms/TopicName]:
  • ActivationSpec Authentication Alias: [null]:

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. You need to provide data for rows or entries that are either missing information, or require an update.

Jacl... 

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

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

 

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. You need to provide data for rows or entries that are either missing information, or require an update.

Jacl... 

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

Jython... 

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

 

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.

 

 

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 Network Deployment environment. 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.

 

 

contents

Specifies the file that contains the content that you want 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.

Jacl... 

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

Jython... 

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

 

CorrectUseSystemIdentity

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

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

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

 

createMBeansForResources

Specifies that MBeans are created for all resources such as, servlets, JavaServer Pages (JSP) 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.

 

 

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:

  • EJBModule: Increment CMP 1.1 EJB
  • EJB: IncCMP11
  • URI: IncCMP11.jar,META-INF/ejb-jar.xml
  • JNDI name: [DefaultDatasource]:
  • User name: [null]:
  • Password: [null]:
  • Login Configuration Name: [null]:
  • Properties: [null]:

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. You need to provide data for rows or entries that are missing information, or require an update.

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

 

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:

  • EJBModule: Increment enterprise bean
  • EJB: Increment
  • URI: Increment.jar,META-INF/ejb-jar.xml
  • JNDI name: [null]:
  • Resource authorization: [Per application]:
  • Login Configuration Name: [null]:
  • Properties: []:

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

Jacl... 

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

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

 

DataSourceFor10EJBModules

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:

  • EJBModule: Increment CMP 1.1 enterprise bean
  • uri: IncCMP11.jar,META-INF/ejb-jar.xml
  • JNDI name: [DefaultDatasource]:
  • User name: [null]:
  • Password: [null]:
  • Login Configuration Name: [null]:
  • Properties: [null]:

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. You need to provide data for rows or entries that are either missing information, or require an update.

Jacl... 

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

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

 

DataSourceFor20EJBModules

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:

  • EJBModule: Increment enterprise bean
  • URI: Increment.jar,META-INF/ejb-jar.xml
  • JNDI name: [DefaultDatasource]:
  • Resource authorization: [Per application]:
  • Login Configuration Name: [null]:
  • Properties: []:

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. You need to provide data for rows or entries that are either missing information, or require update.

Jacl... 

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

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

 

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

Specifies the password for the default data source.

 

 

defaultbinding.datasource.username

Specifies the user name for the default data source.

 

 

defaultbinding.ejbjndi.prefix

Specifies the 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

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 Enterprise Archive (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

Database schema for the EJBDeploy tool.

 

 

deployejb.dbtype

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 specs 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. 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 spec : 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. You need to provide data for rows or entries that are either missing information, or require an update.

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

 

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. You need to provide data for rows or entries that are either missing information, or require an update.

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

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

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

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

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

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.

 

installdir

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

 

 

installed.ear.destination

Directory to place application binaries.

 

 

MapModulesToServers

Specifies the application server where you want to install modules that are contained in your 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 your application. You need to provide data for rows or entries that are either missing information, or require an update.

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=server1}}}
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=server1]]]')

 

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.

Jacl... 

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

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

 

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:

  • EJB Module: ejb-jar-ic.jar
  • EJB: MessageBean
  • URI: ejb-jar-ic.jar,META-INF/ejb-jar.xml
  • JNDI Name: [eis/J2CACT1]:
  • Destination JNDI Name: [jms/TopicName]:
  • The default JNDI name will be picked up from the corresponding message destination reference.

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

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

 

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. You need to provide data for rows or entries that are either missing information, or require an update.

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

 

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.

Each element of the MapResRefToEJB option consists of the following fields: module, EJB, uri, referenceBinding, resRef.type, JNDI, login.config.name, and auth.props. Of these fields, the following can be assigned values: JNDI, login.config.name, auth.props. The JNDI field is required.

The current contents of the option after running default bindings include:

  • Module: deplmtest.jar
  • EJB: MailEJBObject
  • URI: deplmtest.jar,META-INF/ejb-jar.xml
  • Reference binding: jms/MyConnectionFactory
  • Resource type: javax.jms.ConnectionFactory
  • JNDI name: [jms/MyConnectionFactory]:
  • Login Configuration Name: [null]:
  • Properties: []:

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. You need to provide data for rows or entries that are either missing information, or require an update.

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

 

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

Jacl... 

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

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

 

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. You need to provide data for rows or entries that are either missing information, or require an update.

Jacl... 

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

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

 

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

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

 

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.

 

 

node

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.

 

 

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 Enterprise Archive (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 that you want to perform. This option only applies to the update command. The valid values include:

  • add - Adds new content.
  • addupdate - Adds or updates content based on the existence of content in the application.
  • delete - Deletes content.
  • update - Updates existing content.

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:

Jacl... 

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

Jython... string 

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

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.

 

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 Enterprise Archive (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 is nopreCompileJSPs.

 

 

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

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.

 

 

server

Specifies the 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.

 

 

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 WebSphere Application Server configuration. The update action merges bindings from the new version with the bindings from the old version, uninstalls the old version, and installs the new version. The binding information from new version of the EAR file is preferred over the corresponding one from the old version. If any element of binding is missing in the new version, the corresponding element from the old version is used.

 

 

update.ignore.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:

  • The update option for the install command.
  • The modulefile or app as the content type for the update command.

 

 

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:

  • The update option for the install command.
  • The modulefile or app as the content type for the update command.

 

 

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

Specifies the level of application installation validation.

Valid option values include:

  • off - Specifies no application deployment validation. This value is the default.
  • warn - Performs application deployment validation and continues with the application deployment process even when reported warnings or error messages exist.
  • fail - Performs application deployment validation and does not to continue with the application deployment process when reported warnings or error messages exist.

 

 

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.

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.

Jacl... 

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

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

 

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.

Jacl... 

$AdminApp install WebServicesSamples.ear {-WebServicesClientBindPortInfo 
{{AddressBookW2JE.jar AddressBookW2JE 
service/WSLoggerService2 WSLoggerJMS 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]]]')

 

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.

  • Port Type - QName ("{namespace} localname") of a port type that is defined by a wsdl:portType attribute in the WSDL file that identifies an interface.

  • Port - QName of a port defined by a wsdl:port attribute within a wsdl:service attribute in a WSDL file that identifies an implementation that has preference.

Jacl... 

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

AdminApp.install('WebServicesSamples.ear', '[-WebServicesClientBindPreferredPort 
[[AddressBookW2JE.jar AddressBookW2JE service/WSLoggerService2 
WSLoggerJMS 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 .

Jacl... 

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

Jython... 

AdminApp.install('WebServicesSamples.ear', '[-WebServicesServerBindPort 
[[AddressBookW2JE.jar service/WSLoggerService2 WSLoggerJMS "" 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"}}

Jacl... 

$AdminApp edit WebServicesSamples {-WebServicesServerCustomProperty 
{{AddressBookW2JE.jar AddressBookService AddressBook http.proxyHost
+http.proxyPort myhost+80}}}
Jython... 

AdminApp.edit ( 'WebServicesSamples', '[ -WebServicesServerCustomProperty 
[[AddressBookW2JE.jar AddressBookService AddressBook 
http.proxyHost+http.proxyPort myhost+80]]]')

 

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 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/value pairs: {{"n1" "v1"}, {"n2" "v2"}, {"n3" " v3"}}

Jacl... 

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

Jython... 

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

 

See also


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

 

See Also


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