WAS v8.5 > Reference > Commands (wsadmin scripting)

Options for the AdminApp object install, installInteractive, edit, editInteractive, update, and updateInteractive commands using wsadmin.sh

We can use the commands for the AdminApp object to manage application configurations.

We can set a configuration value using options in batch mode. To identify which configuration object is to be set or updated, the values of read only fields are used to find the corresponding configuration object.

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


ActSpecJNDI

Bind Java 2 Connector (J2C) activation specifications to destination JNDI names.

We can assign a value to each of the following elements of the ActSpecJNDI option:

The contents of the option after running default bindings include:

To use this option...

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are missing information, or require an update.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


allowDispatchRemoteInclude

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

Jacl:

Jython:


allowPermInFilterPolicy

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.

allowServiceRemoteInclude

Set true to service include requests.

Jacl:

Jython:


appname

Name of the application. Default is the display name of the application.


BackendIdSelection

Backend ID for the enterprise bean JAR modules that have container-managed persistence 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:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


BindJndiForEJBBusiness

Bind EJB modules with business interfaces to JNDI names. Ensure that each EJB module with business interfaces is bound to a JNDI name.

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

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

For a no-interface view, the business interface value is an empty string ("").

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


BindJndiForEJBMessageBinding

Bind message-driven enterprise beans to listener port names or to activation specification JNDI names. Use this option to provide missing data or update a task. When a message-driven enterprise bean is bound to an activation specification JNDI name, we can also specify the destination JNDI name and authentication alias.

Each element of the BindJndiForEJBMessageBinding option consists of the following fields: EJBModule, EJB, uri, listenerPort, JNDI, jndi.dest, and actspec.auth. Some of these fields can be assigned values: listenerPort, JNDI, jndi.dest, and actspec.auth.

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

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

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are missing information, or require an update.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


BindJndiForEJBNonMessageBinding

Bind enterprise beans to JNDI names. Ensure each non message-driven enterprise bean in the application or module is bound to a JNDI name. Use this option to provide missing data or update a task.

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

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

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

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are missing information, or require an update.

Batch mode example usage

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


blaname

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


buildVersion

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


cell

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

Batch mode example usage

Jacl:

Jython:


clientMode

Deploy client modules to an isolated deployment target (isolated), a federated node of a deployment manager (federated), or an application server (server_deployed). If we specify this option, install the client modules only onto a v8.0 or later deployment target.

Default is isolated.

The choice of client deployment mode affects how java: lookups are handled. All Java URL name spaces (global, application, module, and component) are local in isolated client processes. The name spaces reside on a server in federated and server deployed client processes. The server chosen as a target for a client module determines where those name spaces are created. All java: lookups for federated or server deployed client modules are directed to the target server. The client module does not actually run in the target server. Multiple instances of the same client module will all share the component name space in the federated and server deployed modes. Choosing the federated mode is simply a declaration of intent to launch the client module using Java Network Launching Protocol (JNLP), but the JNDI mechanics of federated and server deployed modes are the same.


contents

File containing the content to update. For example, depending on the content type, the file could be an EAR file, a module, a partial zip, or a single file.

The path to the file must be local to the scripting client. The contents option is required unless we have specified the delete option.


contenturi

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

Context root to use when installing a stand-alone WAR file.


CorrectOracleIsolationLevel

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

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


CorrectUseSystemIdentity

Replace 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 AdminApp taskInfo to obtain information. Provide data for rows or entries that are missing information, or require an update.

Batch mode example usage

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


createMBeansForResources

MBeans are created for all resources, such as servlets, 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.


CtxRootForWebMod

Edit the context root of the web module. We can edit a context root defined in application.xml using this option. The current contents of this option after running default bindings are the following:

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

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


custom

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


CustomActivationPlan

Runtime components to add or remove from the default runtime components used to run the application. Only use this option when the application server can not obtain all necessary runtime components by inspecting the application.

Jython:

Jython with pattern matching:

CustomActivationPlan components to add. Specify a WS_ComponentToAdd value in the command.

Component WS_ComponentToAdd value
EJB container WS_EJBContainer
Portlet container WS_PortletContainer
JavaServer Faces (JSF) WS_JSF
SIP container WS_SipContainer
Compensation scope service WS_Compensation
Application profile WS_AppProfile
Activity session WS_ActivitySession
Internationalization WS_I18N
Startup beans WS_StartupService


DataSourceFor10CMPBeans

Data sources for individual 1.x container-managed persistence 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 containing the enterprise bean. Each element of the DataSourceFor10CMPBeans option consists of the following fields: EJBModule, EJB, uri, JNDI, userName, password, login.config.name, and auth.props. Of these fields, the following can be assigned values: JNDI, userName, password, login.config.name, and auth.props.

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

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

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are missing information, or requiring an update.

Batch mode example usage

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


DataSourceFor20CMPBeans

Optional data sources for individual 2.x container-managed persistence 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 containing the enterprise bean. Each element of the DataSourceFor20CMPBeans option consists of the following fields: EJBModule, EJB, uri, JNDI, resAuth, login.config.name, and auth.props. Of these fields, the following can be assigned values: JNDI, resAuth, login.config.name, and auth.props.

The current contents of the option after running default bindings includes the following:

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

Use AdminApp taskInfo to obtain information. You only need to provide data for rows or entries that are missing information, or requiring an update.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


DataSourceFor10EJBModules

Default data source for the enterprise bean module containing 1.x container-managed persistence beans. Use this option to provide missing data or update a task.

Each element of the DataSourceFor10EJBModules option consists of the following fields: EJBModule, uri, JNDI, userName, password, login.config.name, and auth.props. Of these fields, the following can be assigned values: JNDI, userName, password, login.config.name, and auth.props.

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

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

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are missing information, or require an update.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


DataSourceFor20EJBModules

Default data source for the enterprise bean 2.x module containing 2.x container managed persistence (CMP) beans. Use this option to provide missing data or update a task.

Each element of the DataSourceFor20EJBModules option consists of the following fields: EJBModule, uri, JNDI, resAuth, login.config.name, and auth.props. Of these fields, the following can be assigned values: JNDI, resAuth, login.config.name, auth.props, and extended datasource properties.

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

The last field in each entry of this task specifies the value for resource authorization. Valid values for resource authorization are per connection factory or container.

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

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are either missing information, or require update.

Jacl:

Jacl with pattern matching:

If we use multiple values for extended data source properties, you must assign the values to a variable and use that variable for the property value. For example:

In the command substitution, reference the variable as shown in the following example:

Jython:

Jython with pattern matching:

If we use multiple values for extended data source properties, surround the two values with double quote characters. For example:


defaultbinding.cf.jndi

JNDI name for the default connection factory.


defaultbinding.cf.resauth

RESAUTH for the connection factory.


defaultbinding.datasource.jndi

JNDI name for the default data source.


defaultbinding.datasource.password

Password for the default data source.


defaultbinding.datasource.username

User name for the default data source.


defaultbinding.ejbjndi.prefix

Prefix for the enterprise bean JNDI name.


defaultbinding.force

Default bindings override the current bindings.


defaultbinding.strategy.file

Custom default bindings strategy file.


defaultbinding.virtual.host

Default name for a virtual host.


depl.extension.reg (deprecated)

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


deployejb

Run the EJBDeploy tool during installation. This option does not require a value. The EJBDeploy runs during installation of EJB 1.x or 2.x modules. The EJB deployment tool does not run during installation of EJB 3.x modules.

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

You must use this deployejb option in the following situations:

If an EJB module is packaged in a web archive (WAR), we do not need to use this deployejb option.

For this option, install only onto a v6.1 or later deployment target.


deployejb.classpath

Extra class path for the EJBDeploy tool.


deployejb.complianceLevel

JDK compliance level for the EJBDeploy tool.

Possible values include:

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


deployejb.dbschema

Database schema for the EJBDeploy tool.


deployejb.dbtype

Database type for the EJBDeploy tool.

Possible values include:

The following databases support SQLJ: DB2UDB_V82, DB2UDB_V81, DB2UDBOS390_V7, and DB2UDBOS390_V8.

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


deployejb.dbaccesstype

Type of database access for the EJBDeploy tool. Valid values are SQLj and JDBC. The default is JDBC.


deployejb.rmic

Extra RMIC options to use for the EJBDeploy tool.


deployejb.sqljclasspath

Location of the SQLJ translator classes.


deployws

Deploy web services during installation. This option does not require a value.

Default is: nodeployws.


deployws.classpath

Extra class path to use when we deploy web services.

To specify the class paths of multiple entries, separate the entries with the same separator used with the CLASSPATH environment variable. For Windows, use a semicolon (;) to separate the entries. For Unix use a colon (:) to separate the entries.


deployws.jardirs

Extra extension directories to use when we deploy web services.


distributeApp

Application management component distribute application binaries. This option does not require a value. This setting is the default.


EmbeddedRar

Bind Java 2 Connector objects to JNDI names. You must bind each Java 2 Connector object in the application or module, such as, J2C connection factories, J2C activation specifications and J2C 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:

Where j2cid is:

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are either missing information, or requiring an update.

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

Batch mode example usage

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


enableClientModule

Deploy client modules. Select this option if the file to deploy has one or more client modules to deploy. If selected, install the client modules only onto a v8.0 or later deployment target.

This option does not require a value. Default is noenableClientModule. By default, the enableClientModule option is ignored during deployment and client modules are not deployed.


EnsureMethodProtectionFor10EJB

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 AdminApp taskInfo to obtain information. Provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:

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

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 AdminApp taskInfo to obtain information. Provide data for rows or entries that are either missing information, or require an update the existing data.

Batch mode example usage

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:

The last field in each entry of this task specifies the value of the protection. Valid protection values include: methodProtection.uncheck, methodProtection.exclude, or a list of security roles that are separated by commas.


filepermission

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

Jacl:

Jython:


installdir (deprecated)

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


installed.ear.destination

Directory to place application binaries.


JSPCompileOptions

JSP compilation options for web modules. This option is only valid if we use the preCompileJSPs option also. The current contents of this option after running default bindings are the following:

For Use Full Package Names and Disable JSP Runtime Compilation, specify a Yes or No value in the language specific for the locale. WAS v8.5 supports the values AppDeploymentOption.Yes and AppDeploymentOption.No instead of Yes and No. However, IBM recommends specified Yes or No in the language for the locale.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


JSPReloadForWebMod

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

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

For JSP enable class reloading, specify a Yes or No value in the language specific for the locale. WAS v8.5 supports the values AppDeploymentOption.Yes and AppDeploymentOption.No instead of Yes and No. However, IBM recommends specified Yes or No in the language for the locale.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:

For IBM extension and binding files, the .xmi or .xml file name extension is different depending on whether you are using a pre-Java EE 5 application or module or a Java EE 5 or later application or module. An IBM extension or binding file is named ibm-*-ext.xmi or ibm-*-bnd.xmi where * is the type of extension or binding file such as app, application, ejb-jar, or web. The following conditions apply:

However, a Java EE 5 or later module can exist within an application that includes pre-Java EE 5 files and uses the .xmi file name extension.

The ibm-webservices-ext.xmi, ibm-webservices-bnd.xmi, ibm-webservicesclient-bnd.xmi, ibm-webservicesclient-ext.xmi, and ibm-portlet-ext.xmi files continue to use the .xmi file extensions. sptcfg


MapEJBRefToEJB

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

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

Use AdminApp taskInfo to obtain information. You only need to provide data for rows or entries that are missing information, or those where to update the existing data.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


MapEnvEntryForApp

Edit the env-entry value of the application. We can use this option to edit the value of env-entry in application.xml.

The current contents of this option after running default bindings are the following:

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

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:

If there is a new line character in the description, use the following syntax:

Jacl with pattern matching:

Using Jython with pattern matching:


MapEnvEntryForEJBMod

Edit the env-entry value of the EJB module. We can use this option to edit the value of environment entries in the EJB module, ejb-jar.xml.

The current contents of this option after running default bindings are the following:

If the EJB module uses EJB 3.0 or later, the contents of this option are populated only from the XML deployment descriptor. We cannot get deployment information from annotations with this option.

Use AdminApp taskInfo to obtain information.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:

If there is a new line character in the description, use the following syntax:

Jacl with pattern matching:

Using Jython with pattern matching:


MapEnvEntryForWebMod

Edit the env-entry value of the web module. We can use this option to edit the value of env-entry in the web.xml file.

The current contents of this option after running default bindings are the following:

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

Use AdminApp taskInfo to obtain information.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:

If there is a new line character in the description, use the following syntax:

Jacl with pattern matching:

Using Jython with pattern matching:


MapInitParamForServlet

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

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

Use AdminApp taskInfo to obtain information.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


MapJaspiProvider

Web application or web modules where to override the Java Authentication SPI (JASPI) settings from the global or domain security configuration. The contents of this option are the following:

For Use JASPI, specify a Yes, No, or Inherit value in the language specific for the locale.

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are missing information or that require an update.

Jacl:

Jython:


MapMessageDestinationRefToEJB

Map message destination references to JNDI names of administrative objects from the installed resource adapters. You must map each message destination reference defined in the application to an administrative object. Use this option to provide missing data or to update a task.

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

If the message destination reference is from an EJB 3.0 or later module, then the JNDI name is optional and the run time provides a container default.

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are missing information, or require an update.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


MapModulesToServers

Application server to install modules that are contained in the application. We can install modules on the same server, or disperse them among several servers. Use this option to provide missing data or to update to a task.

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are missing information, or require an update.

Batch mode example usage

The following example installs Increment.jar on one server:

Jacl:

Jython:

The following example removes server1 from the application that is installed:

Jacl:

Jython:


MapResEnvRefToRes

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

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are missing information, or require an update.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


MapResRefToEJB

Map resource references to resources. You must map each resource reference defined in the application to a resource. Use this option to provide missing data or to update a task.

The parameters for MapResRefToEJB include:

The DefaultPrincipalMapping login configuration is used by Java 2 Connectors (J2C) to map users to principals 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 AdminApp taskInfo to obtain information. Provide data for rows or entries that are either missing information, or requiring an update.

Batch mode example usage

Jacl:

Jacl with pattern matching:

If we use multiple values for extended data source properties, you must assign the values to a variable and use that variable for the property value. For example:

In the command substitution, reference the variable as shown in the following example:

Jython:

Jython with pattern matching:

If we use multiple values for extended data source properties, surround the two values with double quote characters. For example:


MapRolesToUsers

Map users to roles. You must map each role 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 AdminApp taskInfo to obtain information. Provide data for rows or entries that are missing information, or require an update.

Jacl:

Jython:

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

MapRolesToUsers option descriptions. Map each role to a user or group.

Option Description
"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

Map RunAs Roles to users. The enterprise beans that you install contain predefined RunAs roles. Enterprise beans that need to run as a particular role for recognition while interacting with another enterprise bean use RunAs roles. Use this option to provide missing data or to update a task.

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are missing information, or require an update.

Jacl:

Jython:


MapSharedLibForMod

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

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

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


MapWebModToVH

Select virtual hosts for web modules. Specify the virtual host where to install the web modules that are contained in the application. We can install web modules on the same virtual host, or disperse them among several hosts. Use this option to provide missing data or to update a task.

Use AdminApp taskInfo to obtain information. Provide data for rows or entries that are missing information, or require an update.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


MetadataCompleteForModules

Enable each Java EE 5 or later module to write out the complete deployment descriptor, including deployment information from annotations. Then the system marks the deployment descriptor for the module as complete.

If your Java EE 5 or later application uses annotations and a shared library, do not use this option. When the application uses annotations and a shared library, setting the metadata-complete attribute to true causes the product to incorrectly represent an @EJB annotation in the deployment descriptor as <ejb-ref> rather than <ejb-local-ref>. For web modules, setting the metadata-complete attribute to true might cause InjectionException errors. If set the metadata-complete attribute to true, avoid errors by not using a shared library, by placing the shared library in either the classes or lib directory of the application server, or by fully specifying the metadata in the deployment descriptors.

The current contents of this option after running default bindings are the following:

Use AdminApp taskInfo to obtain information.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


ModuleBuildID

Display the build identifier of a module in an application EAR file. We cannot modify this option because it is read-only. This option returns the build information for a module if we have specified the build identifer in the MANIFEST.MF of a module or application EAR file. The build information consists of the module name, module URI, and build identifier.

The current contents of the option after running default bindings resemble the following:

Jython:


noallowDispatchRemoteInclude

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


noallowPermInFilterPolicy

Do not 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 does not require a value.


noallowServiceRemoteInclude

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


node

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

Batch mode example usage

Jacl:

Jython:


nocreateMBeansForResources

MBeans are not created for all resources, such as servlets, JSP files, 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

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


nodeployws

Do not deploy web services during installation. This option is the default setting and does not require a value.


nodistributeApp

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


noenableClientModule

Do not deploy client modules. This option does not require a value. This is the default. The default is not to deploy client modules. Use the enableClientModule option to deploy client modules.


noreloadEnabled

Disable class reloading. This option is the default setting and does not require a value. To specify the file system of the application be scanned for updated files so that changes reload dynamically, use the reloadEnabled option.


nopreCompileJSPs

Do not precompile JSP files. This option is the default setting and does not require a value.


noprocessEmbeddedConfig

System should ignore the embedded configuration data that is included in the application. This option does not require a value. If the application EAR file does not contain embedded configuration data, the noprocessEmbeddedConfig option is the default setting. Otherwise, the default setting is the processEmbeddedConfig option.


nouseAutoLink

Do not to use the useAutoLink option, and not to automatically resolve EJB references from EJB module versions prior to EJB 3.0 and from web module versions that are prior to v2.4.


nouseMetaDataFromBinary

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


nousedefaultbindings

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


novalidateSchema

Do not validate the deployment descriptors against published Java EE deployment descriptor schemas. This option does not require a value. This is the default. The default is not to validate deployment descriptors.


operation

Operation to perform. This option only applies to the update or updateInteractive commands. The valid values include:

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

The contenturi option is ignored when the content type is app.

The following examples show how to use the options for the update command to update an entire deployed enterprise application:

Using Jacl:

Jython string:

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

Using Jacl:

Jython string:

Jython list:

where AdminApp is the scripting object, update is the command, app1 is the name of the application to update, file is the content type, operation is an option of the update command, update is the value of the operation option, 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

Process the embedded configuration data that is included in the application. This option does not require a value. If the application EAR file contains embedded configuration data, this option is the default setting. If not, the default setting is the nonprocessEmbeddedConfig option.

This setting affects installation of enhanced EAR files. An enhanced EAR file results when we export an installed application. Enhanced EAR files have an embedded configuration that consists of files such as resource.xml and variables.xml. This option loads an embedded configuration to the application scope from the EAR file.

If you exported the application from a cell other than the current cell and did not specify the $(CELL) variable for the installed.ear.destination option when first installing the application, use the nonprocessEmbeddedConfig option to expand the enhanced EAR file in the profile_root/installedApps/current_cell_name directory. Otherwise, use this processEmbeddedConfig option to expand the enhanced EAR file in the profile_root/installedApps/original_cell_name directory, where original_cell_name is the cell on which the application was first installed. If you specified the $(CELL) variable for the installed.ear.destination option when we first installed the application, installation expands the enhanced EAR file in the profile_root/installedApps/current_cell_name directory.


preCompileJSPs

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


reloadEnabled

File system of the application will be scanned for updated files so that changes reload dynamically. If this option is enabled and if application classes are changed, then the application is stopped and restarted to reload updated classes. This option is not the default setting and does not require a value. The default setting is the noreloadEnabled option.


reloadInterval

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


SharedLibRelationship

Assign assets or composition unit IDs as shared libraries for each Java EE module.

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

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

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

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

Batch mode example usage

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


server

Name of the server on which to perform one of the following actions:

Jacl:

Jython:


target

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

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

Batch mode example usage

The following example specifies server1 as the target server for the application installation:

Jacl:

Jython:


update

Update the installed application with a new version of the 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 or module 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

Specify that during the update action, binding information from the old version of the application or module is preferred over the corresponding binding information from the new version. If any element of the binding does not exist in the old version, the element from the new version is used. That is, bindings from the new version of the application or module are ignored if a binding exists in the old version. Otherwise, the new bindings are honored and not ignored. This option does not require a value.

This option applies only if we specify one of the following items:


update.ignore.old

Specify that during the update action, the binding information from the new version of the application or module is preferred over the corresponding binding information from the old version. The bindings from the old version of the application or module are ignored. This option does not require a value. This option applies only if we specify one of the following items:


useAutoLink

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

Batch mode example usage

Jacl:

Jython:


usedefaultbindings

Specify 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 we 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.


useMetaDataFromBinary

Specify the metadata used at run time, for example, deployment descriptors, bindings, extensions, and so on, come from the EAR file. This option does not require a value. Default is nouseMetaDataFromBinary, which means the metadata used at run time comes from the configuration repository.


validateinstall

Specify the level of application installation validation. Valid option values include:


validateSchema

Validate the deployment descriptors against published Java EE deployment descriptor schemas. When this application deployment option is selected, the product analyzes each deployment descriptor to determine the Java EE specification version for the deployment descriptor, selects the appropriate schema, and then checks the deployment descriptor against the Java EE deployment descriptor schema. Validation errors result in error messages.

This option does not require a value. Default is novalidateSchema. By default, the validateSchema option is ignored during deployment and the product does not validate deployment descriptors.


verbose

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


WebServicesClientBindDeployedWSDL

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:

Jacl with pattern matching:

To install the WebServicesSamples.ear sample, which is in installableApps directory of SCA samples, specify the BindJndiForEJBNonMessageBinding and MapWebModToVH options as well as the WebServicesClientBindDeployedWSDL option:

Jython:

To install the WebServicesSamples.ear sample, specify the BindJndiForEJBNonMessageBinding and MapWebModToVH options as well as the WebServicesClientBindDeployedWSDL option:

Jython with pattern matching:


WebServicesClientBindPortInfo

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 Secure Sockets Layer (SSL) fields affect transport level security, not Web Services Security.

Jacl:

To install the WebServicesSamples.ear sample, specify the BindJndiForEJBNonMessageBinding and MapWebModToVH options as well as the WebServicesClientBindPortInfo option:

Jacl with pattern matching:

Jython:

To install the WebServicesSamples.ear sample, specify the BindJndiForEJBNonMessageBinding and MapWebModToVH options as well as the WebServicesClientBindPortInfo option:

Jython with pattern matching:


WebServicesClientBindPreferredPort

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

Jacl:

To install the WebServicesSamples.ear sample, specify the BindJndiForEJBNonMessageBinding and MapWebModToVH options as well as the WebServicesClientBindPreferredPort option:

Jacl with pattern matching:

Jython:

To install the WebServicesSamples.ear sample, specify the BindJndiForEJBNonMessageBinding and MapWebModToVH options as well as the WebServicesClientBindPreferredPort option:

Jython with pattern matching:


WebServicesServerBindPort

Set 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:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


WebServicesClientCustomProperty

Configure 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 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:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


WebServicesServerCustomProperty

Configure 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 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"}}.

Jacl:

Jacl with pattern matching:

Jython:

Jython with pattern matching:


Subtopics


Related concepts:

Usage table for the options of the AdminApp object install, installInteractive, update, updateInteractive, edit, and editInteractive commands using wsadmin.sh
Development and assembly tools
Pattern matching using wsadmin.sh
Samples, v8.5 information center
Example: Obtain option information for AdminApp object commands using wsadmin.sh
Commands for the AdminApp object using wsadmin.sh


+

Search Tips   |   Advanced Search