This article lists the available options for the install, installInteractive, edit, editInteractive, update, and updateInteractive commands of the AdminApp object.
You can use the commands for the AdminApp object to install, edit, update, and manage your application configurations. This topic provides additional options to use with the install, installInteractive, edit, editInteractive, update, and updateInteractive commands to administer your applications. The options listed in this topic apply to all of these commands except where noted.
You can use pattern matching to simplify the task of supplying required values for certain complex options. Pattern matching only applies to fields that are required or read only.
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.
Batch mode example usage
$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}}}
$AdminApp install $embeddedEar {-ActSpecJNDI {{.* .*.rar,.* javax.jms.MessageListener jndi5} {.* .*.rar,.* javax.jms.MessageListener2 jndi6}}}
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']]])
AdminApp.install(embeddedEar, ['-ActSpecJNDI', [['.*', '.*.rar,.*', 'javax.jms.MessageListener', 'jndi5'], ['.*', '.*.rar,.*', 'javax.jms.MessageListener2', 'jndi6']]])
The allowDispatchRemoteInclude option enables an enterprise application to dispatch includes to resources across web modules that are in different Java virtual machines in a managed node environment through the standard request dispatcher mechanism.
Batch mode example usage
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
deployments = AdminConfig.getid ('/Deployment:RRDEnabledAppname/') deploymentObject = AdminConfig.showAttribute (deployments, 'deployedObject') rrdAttr = ['allowDispatchRemoteInclude', 'true'] attrs = [rrdLocalAttr] AdminConfig.modify (deploymentObject, attrs)
The allowPermInFilterPolicy option specifies that the application server should 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.
Batch mode example usage
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
deployments = AdminConfig.getid ('/Deployment:RRDEnabledAppname/') deploymentObject = AdminConfig.showAttribute ('deployments', 'deployedObject') rrdAttr = ['allowServiceRemoteInclude', 'true'] attrs = [rrdAttr] AdminConfig.modify (deploymentObject, attrs)
The appname option specifies the name of the application. The default value is the display name of the application.
The BackendIdSelection option 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.
Batch mode example usage
$AdminApp install C:\myapp.ear {-BackendIdSelection {{Annuity20EJB Annuity20EJB.jar,META-INF\ejb-jar.xml DB2UDBNT_V72_1}}}
$AdminApp install /myapp.ear {-BackendIdSelection {{Annuity20EJB Annuity20EJB.jar,META-INF/ejb-jar.xml DB2UDBNT_V72_1}}}
$AdminApp install C:\myapp.ear {-BackendIdSelection {{.* Annuity20EJB.jar,.* DB2UDBNT_V72_1}}}
$AdminApp install /myapp.ear {-BackendIdSelection {{.* Annuity20EJB.jar,.* DB2UDBNT_V72_1}}}
AdminApp.install('C:\myapp.ear', '[-BackendIdSelection [[Annuity20EJB Annuity20EJB.jar,META-INF\ejb-jar.xml DB2UDBNT_V72_1]]]')
AdminApp.install('myapp.ear', '[-BackendIdSelection [[Annuity20EJB Annuity20EJB.jar,META-INF/ejb-jar.xml DB2UDBNT_V72_1]]]')
AdminApp.install('C:\myapp.ear', ['-BackendIdSelection', [['.*', 'Annuity20EJB.jar,.*', 'DB2UDBNT_V72_1']]])
AdminApp.install('myapp.ear', ['-BackendIdSelection',[['.*', 'Annuity20EJB.jar,.*', 'DB2UDBNT_V72_1']]])
The BindJndiForEJBMessageBinding option 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 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.
Batch mode example usage
$AdminApp install $ear {-BindJndiForEJBMessageBinding {{Ejb1 MessageBean ejb-jar-ic.jar,META-INF/ejb-jar.xml myListenerPort jndi1 jndiDest1 actSpecAuth1}}}
$AdminApp install $ear {-BindJndiForEJBMessageBinding {{.* .* .*.jar,.* myListenerPort jndi1 jndiDest1 actSpecAuth1}}}
AdminApp.install(ear, ['-BindJndiForEJBMessageBinding', [['Ejb1', 'MessageBean', 'ejb-jar-ic.jar,META-INF/ejb-jar.xml', 'myListenerPort', 'jndi1', 'jndiDest1', 'actSpecAuth1']]])
AdminApp.install(ear, ['-BindJndiForEJBMessageBinding', [['.*', '.*', '.*.jar,.*', 'myListenerPort', 'jndi1', 'jndiDest1', 'actSpecAuth1']]])
The BindJndiForEJBNonMessageBinding option 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.
Batch mode example usage
$AdminApp install C:\myapp.ear {-BindJndiForEJBNonMessageBinding {{"Increment Bean Jar" Inc Increment.jar,META-INF\ejb-jar.xml IncBean}}}
$AdminApp install myapp.ear {-BindJndiForEJBNonMessageBinding {{"Increment Bean Jar" Inc Increment.jar,META-INF/ejb-jar.xml IncBean}}}
$AdminApp install C:\myapp.ear {-BindJndiForEJBNonMessageBinding{{.* .* Increment.jar,.* IncBean}}}
$AdminApp install myapp.ear {-BindJndiForEJBNonMessageBinding {{.* .* Increment.jar,.* IncBean}}}
AdminApp.install('C:\myapp.ear', '[-BindJndiForEJBNonMessageBinding [["Increment Bean Jar" Inc Increment.jar,META-INF\ejb-jar.xml IncBean]]]')
AdminApp.install('myapp.ear', '[-BindJndiForEJBNonMessageBinding [["Increment Bean Jar" Inc Increment.jar,META-INF/ejb-jar.xml IncBean]]]')
AdminApp.install('C:\myapp.ear', ['-BindJndiForEJBNonMessageBinding', [['.*', '.*', 'Increment.jar,.*', 'IncBean']]])
AdminApp.install('myapp.ear', ['-BindJndiForEJBNonMessageBinding', [['.*', '.*', 'Increment.jar,.*', 'IncBean']]])
The buildVersion option displays the build version of an application EAR file. You cannot modify this option because it is read-only. This options returns the build version information for an application EAR if you have specified the build version in the MANIFEST.MF application EAR file.
Batch mode example usage
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. 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.
Batch mode example usage
AdminApp.install('C:\myapp\myapp.ear', '[-cell cellName]')
AdminApp.install('/myapp/myapp.ear', '[-cell cellName]')
$AdminApp install "C:\myapp.ear" {-cell cellName}
$AdminApp install "myapp.ear" {-cell cellName}
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 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. You cannot use the -cluster and -server options together.
If you want 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, you must first install the application with a target of -cluster. After you install the application and before you save, use edit command of the AdminApp object to add the additional mapping to the Web server.
Batch mode example usage
AdminApp.install('C:\myapp\myapp.ear', '[-cluster clusterName]')
AdminApp.install('/myapp/myapp.ear', '[-cluster clusterName]')
$AdminApp install "C:\myapp.ear" {-cluster clusterName}
$AdminApp install "myapp.ear" {-cluster clusterName}
The contents option 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.
The contenturi option 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.
The contextroot option specifies the context root that you use when installing a stand-alone Web archive (WAR) file.
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 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.
Batch mode example usage
$AdminApp install C:\myapp.ear {-CorrectOracleIsolationLevel {{AsyncSender jms\MyQueueConnectionFactory jms\Resource1 2}}
$AdminApp install myapp.ear {-CorrectOracleIsolationLevel {{AsyncSender jms/MyQueueConnectionFactory jms/Resource1 2}}
$AdminApp install C:\myapp.ear {-CorrectOracleIsolationLevel {{.* jms\MyQueueConnectionFactory jms\Resource1 2}}
$AdminApp install myapp.ear {-CorrectOracleIsolationLevel {{.* jms/MyQueueConnectionFactory jms/Resource1 2}}
AdminApp.install('C:\myapp.ear', ['-CorrectOracleIsolationLevel', [['.*', 'jms\MyQueueConnectionFactory', 'jms\Resource1', 2]]])
AdminApp.install('myapp.ear', ['-CorrectOracleIsolationLevel', [['.*', 'jms/MyQueueConnectionFactory', 'jms/Resource1', 2]]])
The CorrectUseSystemIdentity option replaces RunAs System to RunAs Roles. The enterprise beans that you install contain a RunAs system identity. You can optionally change this identity to a RunAs role. Use this option to provide missing data or update a task.
Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. You need to provide data for rows or entries that are either missing information, or require an update.
Batch mode example usage
$AdminApp install C:\myapp.ear {-CorrectUseSystemIdentity {{Inc "Increment Bean Jar" Increment.jar,META-INF\ejb-jar.xml getValue() RunAsUser2 user2 password2} {Inc "Increment Bean Jar" Increment.jar,META-INF\ejb-jar.xml Increment() RunAsUser2 user2 password2}}}
$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}}}
$AdminApp install C:/myapp.ear {-CorrectUseSystemIdentity {{.* .* .* getValue() RunAsUser2 user2 password2} {.* .* .* Increment() RunAsUser2 user2 password2}}}
$AdminApp install myapp.ear {-CorrectUseSystemIdentity {{.* .* .* getValue() RunAsUser2 user2 password2} {.* .* .* Increment() RunAsUser2 user2 password2}}}
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]]]')
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]]]')
AdminApp.install('C:\myapp.ear', ['-CorrectUseSystemIdentity', [['.*', '.*', '.*', 'getValue()', 'RunAsUser2', 'user2', 'password2'], ['.*', '.*', '.*', 'Increment()', 'RunAsUser2', 'user2', 'password2']]])
AdminApp.install('myapp.ear', ['-CorrectUseSystemIdentity', [['.*', '.*', '.*', 'getValue()', 'RunAsUser2', 'user2', 'password2'], ['.*', '.*', '.*', 'Increment()', 'RunAsUser2', 'user2', 'password2']]])
The createMBeansForResources option 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.
Batch mode example usage
$AdminApp install myapp.ear {-appname MyApp -CtxRootForWebMod {{"IVT Application" ivt_app.war,web.xml /mycontextroot}}}
$AdminApp install myapp.ear {-appname MyApp -CtxRootForWebMod {{.* .* /mycontextroot}}}
AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-CtxRootForWebMod', [["IVT Application", 'ivt_app.war,web.xml', '/mycontextroot']]])
AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-CtxRootForWebMod', [['.*', '.*', '/mycontextroot']]])
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.
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.
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.
Batch mode example usage
$AdminApp install C:/app1.ear {-DataSourceFor10CMPBeans {{"Increment CMP 1.1 EJB" IncCMP11 IncCMP11.jar,META-INF/ejb-jar.xml myJNDI user1 password1 loginName1 authProps1}}}
$AdminApp install myapp.ear {-DataSourceFor10CMPBeans {{"Increment CMP 1.1 EJB" IncCMP11 IncCMP11.jar,META-INF/ejb-jar.xml myJNDI user1 password1 loginName1 authProps1}}}
$AdminApp install C:\myapp.ear {-DataSourceFor10CMPBeans {{.* .* IncCMP11.jar,.* myJNDI user1 password1 loginName1 authProps1}}}
$AdminApp install myapp.ear {-DataSourceFor10CMPBeans {{.* .* IncCMP11.jar,.* myJNDI user1 password1 loginName1 authProps1}}}
AdminApp.install('C:\app1.ear', ['-DataSourceFor10CMPBeans', [["Increment CMP 1.1 EJB", 'IncCMP11', 'IncCMP11.jar,META-INF/ejb-jar.xml', 'myJNDI', 'user1', 'password1', 'loginName1', 'authProps1']]])
AdminApp.install('myapp.ear', ['-DataSourceFor10CMPBeans', [["Increment CMP 1.1 EJB", 'IncCMP11', 'IncCMP11.jar,META-INF/ejb-jar.xml', 'myJNDI', 'user1', 'password1', 'loginName1', 'authProps1']]])
AdminApp.install('C:\myapp.ear', ['-DataSourceFor10CMPBeans', [['.*', '.*', 'IncCMP11.jar,.*', 'myJNDI', 'user1', 'password1', 'loginName1', 'authProps1']]])
AdminApp.install('myapp.ear', ['-DataSourceFor10CMPBeans', [['.*', '.*', 'IncCMP11.jar,.*', 'myJNDI', 'user1', 'password1', 'loginName1', 'authProps1']]])
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.
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.
Batch mode example usage
$AdminApp install C:\app1.ear {-DataSourceFor20CMPBeans {{"Increment EJB module" Increment Increment.jar,META-INF\ejb-jar.xml jndi1 container}}}
$AdminApp install myapp.ear {-DataSourceFor20CMPBeans {{"Increment EJB module" Increment Increment.jar,META-INF/ejb-jar.xml jndi1 container}}}
$AdminApp install C:\myapp.ear {-DataSourceFor20CMPBeans {{.* .* Increment.jar,.* jndi1 container}}}
$AdminApp install myapp.ear {-DataSourceFor20CMPBeans {{.* .* Increment.jar,.* jndi1 container}}}
AdminApp.install('C:\app1.ear', ['-DataSourceFor20CMPBeans', [["Increment EJB module", 'Increment', 'Increment.jar,META-INF\ejb-jar.xml', 'jndi1', 'container']]])
AdminApp.install('myapp.ear', ['-DataSourceFor20CMPBeans', [["Increment EJB module", 'Increment', 'Increment.jar,META-INF/ejb-jar.xml', 'jndi1', 'container']]])
AdminApp.install('C:\myapp.ear', ['-DataSourceFor20CMPBeans', [['.*', '.*', 'Increment.jar,.*', 'jndi1', 'container']]])
AdminApp.install('myapp.ear', ['-DataSourceFor20CMPBeans', [['.*', '.*', 'Increment.jar,.*', 'jndi1', 'container']]])
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.
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.
Batch mode example usage
$AdminApp install C:\app1.ear {-DataSourceFor10EJBModules {{"Increment CMP 1.1 EJB" IncCMP11.jar,META-INF\ejb-jar.xml yourJNDI user2 password2 loginName authProps}}}
$AdminApp install myapp.ear {-DataSourceFor10EJBModules {{"Increment CMP 1.1 EJB" IncCMP11.jar,META-INF/ejb-jar.xml yourJNDI user2 password2 loginName authProps}}}
$AdminApp install C:\myapp.ear {-DataSourceFor10EJBModules {{.* IncCMP11.jar,.* yourJNDI user2 password2 loginName authProps}}}
$AdminApp install myapp.ear {-DataSourceFor10EJBModules {{.* IncCMP11.jar,.* yourJNDI user2 password2 loginName authProps}}}
AdminApp.install('C:\app1.ear', ['-DataSourceFor10EJBModules', [["Increment CMP 1.1 EJB", 'IncCMP11.jar,META-INF\ejb-jar.xml', 'yourJNDI', 'user2', 'password2', 'loginName', 'authProps']]])
AdminApp.install('myapp.ear', ['-DataSourceFor10EJBModules', [["Increment CMP 1.1 EJB", 'IncCMP11.jar,META-INF/ejb-jar.xml', 'yourJNDI', 'user2', 'password2', 'loginName', 'authProps']]])
AdminApp.install('C:\myapp.ear', ['-DataSourceFor10EJBModules', [['.*', 'IncCMP11.jar,.*', 'yourJNDI', 'user2', 'password2', 'loginName', 'authProps']]])
AdminApp.install('myapp.ear', ['-DataSourceFor10EJBModules', [['.*', 'IncCMP11.jar,.*', 'yourJNDI', 'user2', 'password2', 'loginName', 'authProps']]])
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, and auth.props.
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.
Batch mode example usage
$AdminApp install C:\app1.ear {-DataSourceFor20EJBModules {{"Increment EJB module" Increment.jar,META-INF/ejb-jar.xml jndi2 container}}}
$AdminApp install myapp.ear {-DataSourceFor20EJBModules {{"Increment EJB module" Increment.jar,META-INF/ejb-jar.xml jndi2 container}}}
$AdminApp install C:\myapp.ear {-DataSourceFor20EJBModules {{.* Increment.jar,.* jndi2 container}}}
$AdminApp install myapp.ear {-DataSourceFor20EJBModules {{.* Increment.jar,.* jndi2 container}}}
AdminApp.install('C:\app1.ear', ['-DataSourceFor20EJBModules', [["Increment EJB module", 'Increment.jar,META-INF\ejb-jar.xml', 'jndi2', 'container']]])
AdminApp.install('myapp.ear', ['-DataSourceFor20EJBModules', [["Increment EJB module", 'Increment.jar,META-INF/ejb-jar.xml', 'jndi2', 'container']]])
AdminApp.install('C:\myapp.ear', ['-DataSourceFor20EJBModules', [['.*', 'Increment.jar,.*', 'jndi2', 'container']]])
AdminApp.install('myapp.ear', ['-DataSourceFor20EJBModules', [['.*', 'Increment.jar,.*', 'jndi2', 'container']]])
The defaultbinding.cf.jndi option specifies the Java Naming and Directory Interface (JNDI) name for the default connection factory.
The defaultbinding.cf.resauth option specifies the RESAUTH for the connection factory.
The CorrectUseSystemIdentity option specifies the Java Naming and Directory Interface (JNDI) name for the default data source.
The defaultbinding.datasource.password option specifies the password for the default data source.
The CorrectUseSystemIdentity option specifies the user name for the default data source.
The defaultbinding.ejbjndi.prefix option specifies the prefix for the enterprise bean Java Naming and Directory Interface (JNDI) name.
The defaultbinding.force option specifies that the default bindings override the current bindings.
The defaultbinding.strategy.file option specifies a custom default bindings strategy file.
The defaultbinding.virtual.host option specifies the default name for a virtual host.
Batch mode example usage
The CorrectUseSystemIdentity option is deprecated. No replication option is available.
The deployejb option 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.
The CorrectUseSystemIdentity option specifies an extra class path for the EJBDeploy tool.
The deployejb.dbschema option specifies the database schema for the EJBDeploy tool.
The deployejb.dbtype option specifies the database type for the EJBDeploy tool.
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 the ejbdeploy -? command.
The deployejb.rmic option specifies extra RMIC options to use for the EJBDeploy tool.
The deployws option specifies to deploy Web services during installation. This option does not require a value.
The default value is: nodeployws.
The deployws.classpath option specifies the extra class path to use when you deploy Web services.
The deployws.jardirs option specifies the extra extension directories to use when you deploy Web services.
The CorrectUseSystemIdentity option specifies that the application management component distributes application binaries. This option does not require a value. This setting is the default.
The EmbeddedRar option binds Java 2 Connector objects to JNDI names. You must bind each Java 2 Connector object in your application or module, such as, J2C connection factories, J2C activation specifications and J2C administrative objects, to a JNDI name. Each element of the EmbeddedRar option contains the following fields: RARModule, uri, j2cid, j2c.name, j2c.jndiName. You can assign the following values to the fields: j2c.name, j2c.jndiName.
Module: <rar module name> URI: <rar name>,META-INF/ra.xml Object identifier: <identifier of the J2C object> name: j2cid JNDI name: eis/j2cid
J2C connection factory: connectionFactoryInterface J2C admin object: adminObjectInterface J2C activation specification: message listener type
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.
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
$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}}}
$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}}}
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']]])
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']]])
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 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.
Batch mode example usage
$AdminApp install C:/myapp.ear {-EnsureMethodProtectionFor10EJB {{"Increment EJB Module" IncrementEJBBean.jar,META-INF/ejb-jar.xml ""} {"Timeout EJB Module" TimeoutEJBBean.jar,META-INF/ejb-jar.xml methodProtection.denyAllPermission}}}
$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}}}
$AdminApp install C:\myapp.ear {-EnsureMethodProtectionFor10EJB {{.* IncrementEJBBean.jar,.* ""} {.* TimeoutEJBBean.jar,.* methodProtection.denyAllPermission}}}
$AdminApp install myapp.ear {-EnsureMethodProtectionFor10EJB {{.* IncrementEJBBean.jar,.* ""} {.* TimeoutEJBBean.jar,.* methodProtection.denyAllPermission}}}
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]]]')
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]]]')
AdminApp.install('C:\myapp.ear', ['-EnsureMethodProtectionFor10EJB', [['.*', 'IncrementEJBBean.jar,.*', ""], ['.*', 'TimeoutEJBBean.jar,.*', 'methodProtection.denyAllPermission']]])
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. You can also leave the value blank if you want the method to remain unprotected.
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. You can assign multiple roles for a method by separating roles names with commas. Use this option to provide missing data or to update a task.
Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. You need to provide data for rows or entries that are either missing information, or require an update the existing data.
Batch mode example usage
$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}}}
$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}}}
$AdminApp install C:\myapp.ear {-EnsureMethodProtectionFor20EJB {{.* customerEjb.jar,.* methodProtection.uncheck} {.* supplierEjb.jar,.* methodProtection.exclude}}}
$AdminApp install myapp.ear {-EnsureMethodProtectionFor20EJB {{.* customerEjb.jar,.* methodProtection.uncheck} {.* supplierEjb.jar,.* methodProtection.exclude}}}
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]]]')
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]]]')
AdminApp.install('C:\myapp.ear', ['-EnsureMethodProtectionFor20EJB', [['.*', 'customerEjb.jar,.*', 'methodProtection.uncheck'], ['.*', 'supplierEjb.jar,.*', 'methodProtection.exclude']]])
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.
.*\.dll=755#.*\.so=755#.*\.a=755#.*\.sl=755
Batch mode example usage
$AdminApp install C:\ASV\o0528.02\WebSphere\AppServer\binaries\DefaultApplication.ear {-appname MyApp -cell GooddogNode04Cell -node GooddogNode -server server1 -filepermission .*\\.jsp=777#.*\\.xml=755}
$AdminApp install /ASV/o0528.02/WebSphere/AppServer/binaries/DefaultApplication.ear {-appname MyApp -cell GooddogNode04Cell -node GooddogNode -server server1 -filepermission .*\\.jsp=777#.*\\.xml=755}
AdminApp.install("C:\ASV\o0528.02\WebSphere\AppServer\binaries\DefaultApplication.ear", ["-appname", "MyApp", "-cell", "GooddogNode04Cell", "-node", "GooddogNode", "-server", "server1", "-filepermission", ".*\\.jsp=777#.*\\.xml=755"])
AdminApp.install("/ASV/o0528.02/WebSphere/AppServer/binaries/DefaultApplication.ear", ["-appname", "MyApp", "-cell", "GooddogNode04Cell", "-node", "GooddogNode", "-server", "server1", "-filepermission", ".*\\.jsp=777#.*\\.xml=755"])
The installdir option is deprecated. This option is replaced by the installed.ear.destination option.
The installed.ear.destination option specifies the directory to place application binaries.
Batch mode example usage
$AdminApp install myapp.ear {-appname MyApp -preCompileJSPs -JSPCompileOptions {{"IVT Application" ivt_app.war,WEB-INF/web.xml jspcp AppDeploymentOption.Yes 15 AppDeploymentOption.No}}}
$AdminApp install myapp.ear {-appname MyApp -preCompileJSPs -JSPCompileOptions {{.* .* jspcp AppDeploymentOption.Yes 15 AppDeploymentOption.No}}}
AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-preCompileJSPs', '-JSPCompileOptions', [["IVT Application", 'ivt_app.war,WEB-INF/web.xml', 'jspcp', 'AppDeloymentOption.Yes', 15, 'AppDeploymentOption.No']]])
AdminApp.install('myapp.ear', '-appname', 'MyApp', '-preCompileJSPs', '-JSPCompileOptions', [['.*', '.*', 'jspcp', 'AppDeploymentOption.Yes', 15, 'AppDeploymentOption.No']]])
Batch mode example usage
$AdminApp install myapp.ear {-appname MyApp -JSPReloadForWebMod {{"IVT Application" ivt_app.war,WEB-INF/ibm-web-ext.xmi AppDeploymentOption.Yes 5}}}
$AdminApp install myapp.ear {-appname MyApp -JSPReloadForWebMod {{.* .* AppDeploymentOption.Yes 5}}}
AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-JSPReloadForWebMod', [["IVT Application", 'ivt_app.war,WEB-INF/ibm-web-ext.xmi', 'AppDeploymentOption.Yes', 5]]])
AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-JSPReloadForWebMod', [['.*', '.*', 'AppDeploymentOption.Yes', 5]]])
The MapEJBRefToEJB option 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.
Batch mode example usage
$AdminApp install C:\myapp.ear {-MapEJBRefToEJB {{"Examples Application" "" examples.war,WEB-INF\web.xml BeenThereBean com.ibm.websphere.beenthere.BeenThere IncBean}}}
$AdminApp install myapp.ear {-MapEJBRefToEJB {{"Examples Application" "" examples.war,WEB-INF/web.xml BeenThereBean com.ibm.websphere.beenthere.BeenThere IncBean}}}
$AdminApp install C:\myapp.ear {-MapEJBRefToEJB {{.* .* .* .* .* IncBean}}}
$AdminApp install myapp.ear {-MapEJBRefToEJB {{.* .* .* .* .* IncBean}}}
AdminApp.install('C:\myapp.ear', '[-MapEJBRefToEJB [["Examples Application" "" examples.war,WEB-INF\web.xml BeenThereBean com.ibm.websphere.beenthere.BeenThere IncBean]]]')
AdminApp.install('myapp.ear', '[-MapEJBRefToEJB [["Examples Application" "" examples.war,WEB-INF/web.xml BeenThereBean com.ibm.websphere.beenthere.BeenThere IncBean]]]')
AdminApp.install('C:\myapp.ear', ['-MapEJBRefToEJB', [['.*', '.*', '.*', '.*', '.*', 'IncBean']]])
AdminApp.install('myapp.ear', ['-MapEJBRefToEJB', [['.*', '.*', '.*', '.*', '.*', 'IncBean']]])
Batch mode example usage
$AdminApp install myapp.ear {-appname MyApp -MapEnvEntryForWebMod {{"IVT Application" ivt_app.war,WEB-INF/web.xml ivt/ivtEJBObject String null newEnvEntry}}}
$AdminApp install myapp.ear {-appname MyApp -MapEnvEntryForWebMod {{.* .* .* .* newEnvEntry}}}
AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-MapEnvEntryForWebMod', [["IVT Application", 'ivt_app.war,WEB-INF/web.xml', 'ivt/ivtEJBObject', 'String', 'null', 'newEnvEntry']]])
AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-MapEnvEntryForWebMod', [['.*', '.*', '.*', '.*', 'newEnvEntry']]])
If there is a new line character in the description, use the following syntax:
$AdminApp install myapp.ear {-appname MyApp -MapEnvEntryForWebMod {{.* .* .* (?s).* newEnvEntry}}}
AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-MapEnvEntryForWebMod', [['.*', '.*', '.*', '(?s).*', 'newEnvEntry']]])
Batch mode example usage
$AdminApp install myapp.ear {-appname MyApp -MapInitParamForServlet {{"IVT Application" ivt_app.war,WEB-INF/web.xml ivtservlet pName1 null MyInitParamValue}}}
$AdminApp install myapp.ear {-appname MyApp -MapInitParamForServlet {{.* .* .* .* .* MyInitParamValue}}}
AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-MapInitParamForServlet', [["IVT Application", 'ivt_app.war,WEB-INF/web.xml', 'ivtservlet', 'pName1', 'null', 'MyInitParamValue']]])
AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-MapInitParamForServlet', [['.*', '.*', '.*', '.*', '.*', 'MyInitParamValue']]])
The MapMessageDestinationRefToEJB option 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.
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.
Batch mode example usage
$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}}}
$AdminApp install $earfile {-MapMessageDestinationRefToEJB {{.* .* .* MyConnection jndi2} {.* .* .* PhysicalTopic jndi3} {.* .* .* jms/ABC jndi4}}}
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']]])
AdminApp.install(ear1, ['-MapMessageDestinationRefToEJB', [['.*', '.*', '.*', 'MyConnection', 'jndi2'], ['.*', '.*', '.*', 'PhysicalTopic', 'jndi3'], ['.*', '.*', '.*', 'jms/ABC', 'jndi4']]])
The MapModulesToServers option specifies the application server where you want to install modules that are contained in your application. You can install modules on the same server, or disperse them among several servers. Use this option to provide missing data or 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.
Batch mode example usage
$AdminApp install C:\myapp.ear {-MapModulesToServers {{"Increment Bean Jar" Increment.jar,META-INF\ejb-jar.xml WebSphere:cell=mycell,node=mynode,server=server1} {"Default Application" default_app.war,WEB-INF\web.xml WebSphere:cell=mycell,node=mynode,server=server1} {"Examples Application" examples.war,WEB-INF\web.xml WebSphere:cell=mycell,node=mynode,server=server2+WebSphere:cell=mycell,node=yournode,server=server1}}}
$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}}}
$AdminApp install C:\myapp.ear {-MapModulesToServers {{.* .*.jar,.* WebSphere:cell=mycell,node=mynode,server=server2} {.* .*.war,.* WebSphere:cell=mycell,node=mynode,server=server1}}}
$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}
$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 application that is installed:
$AdminApp edit myapp {-MapModulesToServers {{.* .* -WebSphere:cell=mycell,node=mynode,server=server1}} -update -update.ignore.old}
$AdminApp edit myapp {-MapModulesToServers {{.* .* -WebSphere:cell=mycell,node=mynode,server=server1}} -update -update.ignore.old}
AdminApp.install('C:\myapp.ear', '[-MapModulesToServers [["Increment Bean Jar" Increment.jar,META-INF\ejb-jar.xml WebSphere:cell=mycell,node=mynode,server=server1] ["Default Application" default_app.war,WEB-INF\web.xml WebSphere:cell=mycell,node=mynode,server=server1] ["Examples Application" examples.war,WEB-INF\web.xml WebSphere:cell=mycell,node=mynode,server=server2+WebSphere:cell=mycell,node=yournode,server=server1]]]')
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]]]')
AdminApp.install('C:\myapp.ear', ['-MapModulesToServers', [['.*', '.*.jar,.*', 'WebSphere:cell=mycell,node=mynode,server=server2'] ['.*', '.*.war,.*', 'WebSphere:cell=mycell,node=mynode,server=server1']]])
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'])
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 application that is installed:
AdminApp.edit('myapp', ['-MapModulesToServers', [['.*', '.*', '-WebSphere:cell=mycell,node=mynode,server=server1']]])
AdminApp.edit('myapp', ['-MapModulesToServers', [['.*', '.*', '-WebSphere:cell=mycell,node=mynode,server=server1']]])
The MapResEnvRefToRes option 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.
Batch mode example usage
$AdminApp install C:\myapp.ear {-MapResEnvRefToRes {{AsyncSender AsyncSender asyncSenderEjb.jar,META-INF\ejb-jar.xml jms\ASYNC_SENDER_QUEUE javax.jms.Queue jms\Resource2}}}
$AdminApp install myapp.ear {-MapResEnvRefToRes {{AsyncSender AsyncSender asyncSenderEjb.jar,META-INF/ejb-jar.xml jms/ASYNC_SENDER_QUEUE javax.jms.Queue jms/Resource2}}}
$AdminApp install C:\myapp.ear {-MapResEnvRefToRes {{.* .* .* .* .* jms/Resource2}}}
$AdminApp install myapp.ear {-MapResEnvRefToRes {{.* .* .* .* .* jms/Resource2}}}
AdminApp.install('C:\myapp.ear', '[-MapResEnvRefToRes [[AsyncSender AsyncSender asyncSenderEjb.jar,META-INF\ejb-jar.xml jms\ASYNC_SENDER_QUEUE javax.jms.Queue jms\Resource2]]]')
AdminApp.install('myapp.ear', '[-MapResEnvRefToRes [[AsyncSender AsyncSender asyncSenderEjb.jar,META-INF/ejb-jar.xml jms/ASYNC_SENDER_QUEUE javax.jms.Queue jms/Resource2]]]')
AdminApp.install('C:\myapp.ear', ['-MapResEnvRefToRes', [['.*', '.*', '.*', '.*', '.*', 'jms\Resource2']]])
AdminApp.install('myapp.ear', ['-MapResEnvRefToRes', [['.*', '.*', '.*', '.*', '.*', 'jms/Resource2']]])
The MapResRefToEJB option maps resource references to resources. You must map each resource reference that is defined in your application to a resource. Use this option to provide missing data or to update a task.
The DefaultPrincipalMapping login configuration is used by Java 2 Connectors (J2C) to map users to principals that are defined in the J2C authentication data entries. If the login.config.name is set to DefaultPrincipalMapping, a property is created with the name com.ibm.mapping.authDataAlias . The value of the property is set by the auth.props. If the login.config name is not set to DefaultPrincipalMapping, the auth.props can specify multiple properties. The string format is websphere:name= <name1>,value=<value1>,description=<desc1>. Specify multiple properties using the plus sign (+) .
Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. You need to provide data for rows or entries that are either missing information, or require an update.
Batch mode example usage
$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}}}
$AdminApp install myapp.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}}}
$AdminApp install C:\myapp.ear {-MapResRefToEJB {{deplmtest.jar .* .* .* .* jndi1 login1 authProps1} {"JavaMail Sample WebApp" .* .* .* .* jndi2 login2 authProps2}}}
$AdminApp install myapp.ear {-MapResRefToEJB {{deplmtest.jar .* .* .* .* jndi1 login1 authProps1} {"JavaMail Sample WebApp" .* .* .* .* jndi2 login2 authProps2}}}
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']]])
AdminApp.install('myapp.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']]])
AdminApp.install('C:\myapp.ear', ['-MapResRefToEJB', [['deplmtest.jar', '.*', '.*', '.*', '.*', 'jndi1', 'login1', 'authProps1'], ["JavaMail Sample WebApp", '.*', '.*', '.*', '.*', 'jndi2', 'login2', 'authProps2']]])
AdminApp.install('myapp.ear', ['-MapResRefToEJB', [['deplmtest.jar', '.*', '.*', '.*', '.*', 'jndi1', 'login1', 'authProps1'], ["JavaMail Sample WebApp", '.*', '.*', '.*', '.*', 'jndi2', 'login2', 'authProps2']]])
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. You can specify multiple users or groups for a single role by separating them with a pipe (|). Use this option to provide missing data or to update a task.
Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. You need to provide data for rows or entries that are either missing information, or require an update.
Batch mode example usage
$AdminApp install C:/myapp.ear {-MapRolesToUsers {{"All Role" No Yes "" ""} {"Every Role" Yes No "" ""} {DenyAllRole No No user1 group1}}}
$AdminApp install myapp.ear {-MapRolesToUsers {{"All Role" No Yes "" ""} {"Every Role" Yes No "" ""} {DenyAllRole No No user1 group1}}}
AdminApp.install('C:/myapp.ear', '[-MapRolesToUsers [["All Role" No Yes "" ""] ["Every Role" Yes No "" ""] [DenyAllRole No No user1 group1]]]')
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:
"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 |
The MapRunAsRolesToUsers option 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.
Batch mode example usage
$AdminApp install C:\myapp.ear {-MapRunAsRolesToUsers {{UserRole user1 password1} {AdminRole administrator administrator}}}
$AdminApp install myapp.ear {-MapRunAsRolesToUsers {{UserRole user1 password1} {AdminRole administrator administrator}}}
AdminApp.install('C:\myapp.ear', '[-MapRunAsRolesToUsers [[UserRole user1 password1] [AdminRole administrator administrator]]]')
AdminApp.install('myapp.ear', '[-MapRunAsRolesToUsers [[UserRole user1 password1] [AdminRole administrator administrator]]]')
Use the taskInfo command of the AdminApp object to obtain information about the data needed for you application.
Batch mode example usage
$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}}}
$AdminApp install myapp.ear {-appname MyApp -MapSharedLibForMod {{.* .* sharedlib1} {.* .* sharedlib2} {.* .* sharedlib3}}}
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']]])
AdminApp.install('myapp.ear', ['-appname', 'MyApp', '-MapSharedLibForMod', [['.*', '.*', 'sharedlib1'], ['.*', '.*', 'sharedlib2'], ['.', '.*', 'sharedlib3']]])
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 your application. You can install Web modules on the same virtual host, or disperse them among several hosts. Use this option to provide missing data or to update a task.
Use the taskInfo command of the AdminApp object to obtain information about the data that is needed for your application. You need to provide data for rows or entries that are either missing information, or require an update.
Batch mode example usage
$AdminApp install C:\myapp.ear {-MapWebModToVH {{"Default Application" default_app.war,WEB-INF/web.xml default_host} {"Examples Application" examples.war,WEB-INF/web.xml default_host}}}
$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}}}
$AdminApp install C:\myapp.ear {-MapWebModToVH {{.* .* default_host}}}
$AdminApp install myapp.ear {-MapWebModToVH {{.* .* default_host}}}
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]]]')
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]]]')
AdminApp.install('C:\myapp.ear', ['-MapWebModToVH', [['.*', '.*', 'default_host']]])
AdminApp.install('myapp.ear', ['-MapWebModToVH', [['.*', '.*', 'default_host']]])
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.
The noallowPermInFilterPolicy option 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.
The noallowServiceRemoteInclude option disables the enterprise application that services an include request from an enterprise application that has the allowDispatchRemoteInclude option set to true.
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. 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.
Batch mode example usage
AdminApp.install('C:\myapp\myapp.ear', '[-node nodeName]')
AdminApp.install('/myapp/myapp.ear', '[-node nodeName]')
$AdminApp install "C:\myapp.ear" {-node nodeName}
$AdminApp install "/myapp.ear" {-node nodeName}
The nocreateMBeansForResources option 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.
The nodeployejb option specifies not to run the EJBDeploy tool during installation. This option is the default setting and it does not require a value.
The CorrectUseSystemIdentity option specifies not to deploy Web services during installation. This option is the default setting and it does not require a value.
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.
The noreloadEnabled option disables class reloading. This option does not require a value. The default setting is the reloadEnabled option.
The nopreCompileJSPs option specifies not to precompile JavaServer Pages files. This option is the default setting and it does not require a value.
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 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.
The nouseMetaDataFromBinary option 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.
Batch mode example usage
The nousedefaultbindings option specifies not to use default bindings for installation. This option is the default setting and it does not require a value.
Batch mode example usage
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:
$AdminApp update app1 file {-operation update -contents C:\apps\app1\my.xml -contenturi app1.jar\my.xml}
$AdminApp update app1 file {-operation update -contents /apps/app1/my.xml -contenturi app1.jar/my.xml}
AdminApp.update('app1', 'file', '[-operation update -contents C:\apps\app1\my.xml -contenturi app1.jar\my.xml]')
AdminApp.update('app1', 'file', '[-operation update -contents /apps/app1/my.xml -contenturi app1.jar/my.xml]')
AdminApp.update('app1', 'file', ['-operation', 'update', '-contents', 'C:\apps\app1\my.xml', '-contenturi', app1.jar\my.xml'])
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.
The processEmbeddedConfig option processes 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.
The preCompileJSPs option specifies to precompile the JavaServer Pages files. This option does not require a value. The default value is nopreCompileJSPs.If you want to precompile JavaServer Pages files, specify it as a part of installation. The default is not to precompile JavaServer Pages files. The precompileJSPs option is ignored during deployment and JavaServer Pages files are not precompiled. The flag is set automatically using assembly tools.
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 it does not require a value.
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.
You cannot use the -cluster and -server options together. If you want 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, you must first install the application with a target of -cluster. After you install the application and before you save, use edit command of the AdminApp object to add the additional mapping to the Web server.
Batch mode example usage
AdminApp.install('C:\myapp\myapp.ear', '[-server serverName]')
AdminApp.install('/myapp/myapp.ear', '[-server serverName]')
$AdminApp install "C:\myapp.ear" {-server serverName}
$AdminApp install "/myapp.ear" {-server serverName}
The target option specifies the target for the installation functions of the AdminApp object. The following is an example of a target option: WebSphere:cell=mycell,node=mynode,server=myserver
You can specify multiple targets by delimiting them with a plus (+) sign. By default, the targets that you specify when you install or edit an application replace the existing target definitions in the application. You can use a leading plus (+) or negative (-) sign to add or remove targets without having to specify the targets that are not changed.
Batch mode example usage
$AdminApp install C:\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}
$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 C:\ASV\o0528.02\WebSphere\AppServer\binaries\DefaultApplication.ear {-appname MyApp -target -WebSphere:cell=GooddogCell,node=BaddogNode,server=server3 -update -update.ignore.old}
$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 update app {-appname MyApp -target +WebSphere:cell=GooddogCell,node=GooddogNode,server=server4 -contents C:\ASV\o0528.02\WebSphere\AppServer\binaries\DefaultApplication.ear -operation update -update.ignore.old}
$AdminApp update 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}
AdminApp.install("C:\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"])
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("C:\ASV\o0528.02\WebSphere\AppServer\binaries\DefaultApplication.ear", ["-appname", "MyApp", "-target", "-WebSphere:cell=GooddogCell,node=BaddogNode,server=server3", "-update", "-update.ignore.old"])
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.update("app", ["-appname", "MyApp", "-target", "+WebSphere:cell=GooddogCell,node=GooddogNode,server=server4", "-contents", "C:\ASV\o0528.02\WebSphere\AppServer\binaries\DefaultApplication.ear", "-operation", "update", "-update.ignore.old"])
AdminApp.update("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"])
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 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.
The update.ignore.new option specifies that during the update action, bindings from the new version of the application are simply not preferred when there is an existing binding. That is, bindings from the new version of the application are ignored - if and only if - there is an existing binding. Otherwise, the new bindings are honored and not ignored. This option does not require a value.
The useMetaDataFromBinary option 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.
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 specification when you specify the -usedefaultbindings option to deploy an application. If an activation specification 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.
The verbose option causes additional messages to display during installation. This option does not require a value.
The WebServicesClientBindDeployedWSDL option identifies 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.
Batch mode example usage
$AdminApp install WebServicesSamples.ear {-WebServicesClientBindDeployedWSDL {{AddressBookW2JE.jar AddressBookW2JE service/WSLoggerService2 META-INF/wsdl/DeployedWsdl1.wsdl}}}
$AdminApp install WebServicesSamples.ear {-WebServicesClientBindDeployedWSDL {{.* .* .* META-INF/wsdl/DeployedWsdl1.wsdl}}}
AdminApp.install('WebServicesSamples.ear', '[-WebServicesClientBindDeployedWSDL [[AddressBookW2JE.jar AddressBookW2JE service/WSLoggerService2 META-INF/wsdl/DeployedWsdl1.wsdl]]]')
AdminApp.install('WebServicesSamples.ear', ['-WebServicesClientBindDeployedWSDL',['.*', '.*', '.*', 'META-INF/wsdl/DeployedWsdl1.wsdl']]])
The WebServicesClientBindPortInfo option identifies 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 Secure Sockets Layer (SSL) fields affect transport level security, not Web services security.
Batch mode example usage
$AdminApp install WebServicesSamples.ear {-WebServicesClientBindPortInfo {{AddressBookW2JE.jar AddressBookW2JE service/WSLoggerService2 WSLoggerJMS 3000 newHTTP_ID newHTTP_pwd sslAliasConfig http://yunus:9090/WSLoggerEJB/services/WSLoggerJMS}}}
$AdminApp install WebServicesSamples.ear {-WebServicesClientBindPortInfo {{.* .* .* .* 3000 newHTTP_ID newHTTP_pwd sslAliasConfig http://yunus:9090/WSLoggerEJB/services/WSLoggerJMS}}}
AdminApp.install('WebServicesSamples.ear', '[-WebServicesClientBindPortInfo [[AddressBookW2JE.jar AddressBookW2JE service/WSLoggerService2 WSLoggerJMS 3000 newHTTP_ID newHTTP_pwd sslAliasConfig http://yunus:9090/WSLoggerEJB/services/WSLoggerJMS]]]')
AdminApp.install('WebServicesSamples.ear', ['-WebServicesClientBindPortInfo', [['.*', '.*', '.*', '.*', '3000', 'newHTTP_ID', 'newHTTP_pwd', 'sslAliasConfig', 'http://yunus:9090/WSLoggerEJB/services/WSLoggerJMS']]])
Batch mode example usage
$AdminApp install WebServicesSamples.ear {-WebServicesClientBindPreferredPort {{AddressBookW2JE.jar AddressBookW2JE service/WSLoggerService2 WSLoggerJMS WSLoggerJMSPort}}}
$AdminApp install WebServicesSamples.ear {-WebServicesClientBindPreferredPort {{.* .* .* .* WSLoggerJMSPort}}}
AdminApp.install('WebServicesSamples.ear', '[-WebServicesClientBindPreferredPort [[AddressBookW2JE.jar AddressBookW2JE service/WSLoggerService2 WSLoggerJMS WSLoggerJMSPort]]]')
AdminApp.install('WebServicesSamples.ear', ['-WebServicesClientBindPreferredPort',[['.*', '.*', '.*', '.*', 'WSLoggerJMSPort']]])
The WebServicesServerBindPort option 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 Java Message Service (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
$AdminApp install WebServicesSamples.ear {-WebServicesServerBindPort {{AddressBookW2JE.jar service/WSLoggerService2 WSLoggerJMS {} Session}}}
$AdminApp install WebServicesSamples.ear {-WebServicesServerBindPort {{.* WSClientTestService WSClientTest Request} {.* StockQuoteService StockQuote Application}{.* StockQuoteService StockQuote2 Session}}}
AdminApp.install('WebServicesSamples.ear', '[-WebServicesServerBindPort [[AddressBookW2JE.jar service/WSLoggerService2 WSLoggerJMS "" Session]]]')
AdminApp.install('WebServicesSamples.ear', ['-WebServicesServerBindPort', [['.*', 'WSClientTestService', 'WSClientTest', 'Request'], ['.*', 'StockQuoteService', 'StockQuote', 'Application'],['.*', 'StockQuoteService', 'StockQuote2', 'Session']]])
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 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"}}
Batch mode example usage
$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}}}
$AdminApp edit WebServicesSamples {-WebServicesClientCustomProperty {{join.jar com_ibm_ws_wsfvt_test_multiejbjar_client_WSClientTest .* .* propname1 propValue1}{ejbclientonly.jar Exchange .* .* propname2 propValue2}}}
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']]])
AdminApp.edit('WebServicesSamples', ['-WebServicesClientCustomProperty', [['join.jar', 'com_ibm_ws_wsfvt_test_multiejbjar_client_WSClientTest', '.*', '.*', 'propname1', 'propValue1'],['ejbclientonly.jar', 'Exchange', '.*', '.*', 'propname2', 'propValue2']]])
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
$AdminApp edit WebServicesSamples {-WebServicesServerCustomProperty {{AddressBookW2JE.jar AddressBookService AddressBook com.ibm.websphere.webservices.http.responseContentEncoding deflate}}}
$AdminApp edit WebServicesSamples {-WebServicesServerCustomProperty {{.* .* .* com.ibm.websphere.webservices.http.responseContentEncoding deflate}}}
AdminApp.edit ( 'WebServicesSamples', '[ -WebServicesServerCustomProperty [[AddressBookW2JE.jar AddressBookService AddressBook com.ibm.websphere.webservices.http.responseContentEncoding deflate]]]')
AdminApp.edit ( 'WebServicesSamples', ['-WebServicesServerCustomProperty', [['.*', '.*', '.*', 'com.ibm.websphere.webservices.http.responseContentEncoding', 'deflate']]])