Command-line utilities

Look up a command by its name to find detailed syntax and usage of the command.

You can also search for command-line utilities using keywords.

addNode command
The addNode command incorporates an application server installation into a cell.
Administrative command invocation syntax using wsadmin scripting
The administrative command uses a specific syntax to invoke operations.
ANT task WsJpaDBGenTask
The ANT task WsJpaDBGenTask provides an alternative to the wsdbgen command.
Application client launcher for Java Web Start
The application client launcher for Java™ Web Start is a Java class, com.ibm.websphere.client.installer.ClientLauncher, which has a main() method that Java Web Start calls to start the application client container and to invoke the application client's main() method. It provides similar functions as the lauchClient command line tool to start application clients from the command line.
backupConfig command
The backupConfig command is a simple utility to back up the configuration of your node to a file.
Batch compiler ant task
The ant task JspC exposes all the batch compiler configuration options. It runs the batch compiler under the covers. It is backward compatible with the WebSphere® Application Server 5.x version of the JspC ant task. The following table lists all of the ant task attributes and their batch compiler equivalents.
buildClientLibJars tool
For a Java Platform, Enterprise Edition (Java EE) application client application and or Thin application client application to be launched using Java Web Start (JWS), the properties files bundled in Application Client for WebSphere Application Server must be installed in the Java Web Start. Use this tool to create those property JAR files. The Java Web Start client is used with platforms that support a web browser.
buildClientRuntime tool
For a Java Platform, Enterprise Edition (Java EE) application client application and or Thin application client application to be launched using Java Web Start (JWS), the library JAR files bundled in Application Client for WebSphere Application Server must be installed in the Java Web Start. Use this tool to build those JAR files. The Java Web Start client is used with platforms that support a web browser.
CancelEJBTimers command example
Examples are presented to illustrate how to use the command to cancel Enterprise JavaBeans (EJB) timers.
checkprereqs command
The checkprereqs command runs the prerequisite validator tool.
chgwassvr command
The chgwassvr command allows you to change the ports for an application server within a profile.
cleanupNode command
The cleanupNode command cleans up a node configuration from the cell repository.
clientRAR tool
Use the command line syntax for the client resource adapter installation tool to install a resource adapter in the client.
clientUpgrade command
Use the clientUpgrade command to migrate previous versions of client resources to Version 9.0-level resources.
clientUpgrade script
The clientUpgrade script migrates application client modules and their resources in an enterprise archive (EAR) file so that these application clients can run in WebSphere Application Server Version 8.5. The script converts an EAR file that you want to migrate and then overwrites the original EAR file with the converted EAR file.
collector command - summary option
Use the summary option to produce a concise text file summary of the installed versions and the contents of the collector.jar.
collector command options
The collector command options enable the collector tool to capture the information you must provide when you report a problem during your WebSphere Application Server installation.
configureOs400WebServerDefinition command
The configureOs400WebServerDefinition command creates a web server definition in a WebSphere Application Server or deployment manager profile.
convertlog command
The convertlog command is used to convert the message IDs in log entries from the old standard to the new standard, or the new standard back to the old.
createCertRequest command
The createCertRequest command creates a PKCS10 certificate request and stores it in a client keystore so that it can be used to send to a certificate authority (CA) server using the requestCertificate command line utility.
createRemoteMigrJar command
The createRemoteMigrJar command makes remote migrations easier because you no longer have to install WebSphere Application Server Version 9.0 on any source machine that is targeted to be replaced.
deregisterNode command
Use the deregisterNode command to unregister a node from an administrative agent so that you can use the node stand-alone, register the node with another administrative agent, or federate the node with the deployment manager.
Display command with examples
The display command is useful for obtaining data on a variety of processes.
dspwasinst command
The dspwasinst command displays information about a profile and the application servers it contains.
dumpNameSpace tool
You can use the dumpNameSpace tool to dump the contents of a namespace accessed through a name server. The dumpNameSpace tool is based on Java Naming and Directory Interface (JNDI).
DynamicCache command group for the AdminTask object
You can use the Jython scripting language to manage the dynamic cache service. Use the commands in the DynamicCache command group to create object and service cache instances with the wsadmin tool.
EARExpander command
Use the EARExpander command to expand an enterprise archive (EAR) file into a directory to run the application in that EAR file.
eclversion command
Use this command-line tool to find out information about the installed version of the Java Persistence API (JPA) 2.1 specification provider, Eclipselink, for the product.
EJB command group
The EJB command group for the AdminTask object provides commands that you can use to manipulate enterprise beans.
enablejvm command (deprecated)
The enablejvm command enables you to configure your application server or a specific profile to use the IBM® Technology for Java Virtual Machine, by choosing either option 11 or option 12 of the IBM Developer Kit for Java.
enbprfwas command
The enbprfwas command enables a profile to allow an application server to run under it and optionally changes the group profile to QEJBSVR.
endptEnabler command
The endptEnabler command is used to enable a set of web services within an enterprise archive (EAR) file. The endptEnabler command must run on EAR files containing Enterprise JavaBeans (EJB) modules that are enabled for web services.
Example: Using the Timer Service with the TimedObject interface
This example shows the implementation of the ejbTimeout() method that is called when the scheduled event occurs.
findEJBTimers command
Presented here are examples illustrate how to use the findEJBTimers command to find Enterprise JavaBeans (EJB) timers and explain the output statement. For relevant parameters and syntax information, read about the timer service commands.
genHistoryReport command
The genHistoryReport command generates the historyReport.html report file in the current working directory, which is usually the bin directory. The report includes a list of installed or uninstalled fix packs and interim fixes. The genHistoryReport script invokes the historyInfo script specifying the correct parameters to place the information generated into an HTML file in the current directory.
GenPluginCfg command
The GenPluginCfg command is used to regenerate the WebSphere web server plug-in (web server-specific) or a topology-centric (global) configuration file, plugin-cfg.xml.
genVersionReport command
The genVersionReport command uses the versionInfo command to generate the versionReport.html report file in the current working directory, which is usually the bin directory. The report includes a list of installed fix packs and interim fixes.
grtwasaut command
The grtwasaut command grants a user authority to a profile and the objects associated with it.
heapMonitor command
The heapMonitor command manages the iSeries WebSphere Custom Service Heap Monitor, which sends messages to QSYSOPR when the WebSphere Java heap is close to exceeding or exceeds the storage pool size.
historyInfo command
The historyInfo command generates a report that includes a history of installed or uninstalled fix packs and interim fixes.
ICPS CTRACE command
The CTRACE command specifies the cell from which trace data will be gathered.
Intelligent Management: hadmgrAdd command
The hadmgrAdd command incorporates a new deployment manager profile into a cell. The new deployment manager profile is converted to a highly available (HA) deployment manager peer in the same cell as the existing deployment manager profile.
Intelligent Management: hadmgrRemove command
Intelligent Management: VEUpgrade command
Use the VEUpgrade command to migrate product configuration data from an existing WebSphere Virtual Enterprise Version 6.1.0.5, Version 6.1.1, or Version 7.0 cell to a new Intelligent Management Version 8.5 cell.
ivt command
The install verification (ivt) script verifies that the application server for an instance is functioning correctly.
Java2WSDL command for JAX-RPC applications
The Java2WSDL command-line tool maps Java classes to a WSDL file for Java API for XML-based RPC (JAX-RPC) applications.
Java EE client application class loading
When you run your Java Platform, Enterprise Edition (Java EE) application client, a hierarchy of class loaders is created to load classes used by your application.
jobrecovery.bat|.sh batch script
You can use the jobrecovery script to enable a secondary site to take over when the primary site fails.
JSPBatchCompiler command
The batch compiler validates the syntax of JavaServer Pages, translates the JSP pages into Java source files, and compiles the Java source files into Java Servlet class files. The batch compiler also validates tag files and generates their Java implementation classes. Use this function to batch compile your JSP files and enable faster responses to the initial client requests for the JSP files on your production web server.
launchClient tool
You can use the Java Platform, Enterprise Edition (Java EE) command line syntax for the launchClient tool for WebSphere Application Server.
LocalizableTextEJBDeploy command
You can use the LocalizableTextEJBDeploy command to create a deployment Java archive (JAR) file for the localizable text service.
LTPA_LDAPSecurityOn and LTPA_LDAPSecurityOff command usage
Use the examples in this topic to enable and disable LTPA/LDAP security, based on single sign-on using the LDAP user registry.
managesdk command
The managesdk command provides the names of software development kits that are used by the product.
migrateEAR utility for Tivoli Access Manager
The migrateEAR utility migrates changes made to console users and groups in the admin-authz.xml and naming-authz.xml files into the Tivoli® Access Manager object space.
Modify command
You can issue the modify command from the MVS™ console to dynamically modify product operations.
Namespace dump utility for java:, local: and server namespaces
Sometimes it is helpful to dump the java: namespace for a Java Platform, Enterprise Edition (Java EE) application. You cannot use the dumpNameSpace command line utility for this purpose because the application's java: namespace is accessible only by that Java EE application. From the product scripting tool, you can invoke a NameServer MBean to dump the java: namespace for any Java EE application running in that same server process.
Port validator tool
The port validator tool verifies your WebSphere Application Server configuration to ensure that you do not have port conflicts between WebSphere Application Server profiles and products.
prerequisite validator tool
The prerequisite validator tool verifies your WebSphere Application Server installation, ensures that you have the appropriate prerequisite software and PTFs installed, and verifies certain configuration settings required by the product.
processStats script
The processStats script collects and summarizes Performance Monitoring Infrastructure (PMI) data, saving the results to a text file. This file is imported into the IBM Systems Workload Estimator as the basis for a WebSphere Application Server estimate.
PropFilePasswordEncoder command reference
The PropFilePasswordEncoder command encodes passwords that are located in plain text property files. This command encodes both Secure Authentication Server (SAS) property files and non-SAS property files. After you encode the passwords, a decoding command does not exist.
Qshell environment variables
WebSphere Application Server provides these Qshell environment variables that affect the WebSphere Application Server scripts.
queryCertificate command
The queryCertificate command uses an implementation class that is passed to communicate with a certificate authority (CA) server and query a certificate.
registerNode command
Use the registerNode command to register a stand-alone node with an administrative agent so that the administrative agent can manage the node.
removeNode command
The removeNode command returns a node from a WebSphere Application Server Network Deployment distributed administration cell to a stand-alone application server installation.
removeOs400WebServerDefinition command
The removeOs400WebServerDefinition command deletes a web server definition from the configuration repository of a Standalone or Deployment Manager profile.
renameNode command
A short name is assigned to a node during installation and customization. Use the renameNode command to modify the node name of a federated server.
republishEDMessages command
Use the republishEDMessages to republish the messages from the exception destination to the actual destination that they are originally produced for. This command can move messages from Exception destination to either a queue or a topic space. Based on the destination provided, the command determines the corresponding exception destination even if it is a custom exception destination. The messages that are to be moved can also be filtered through the selection criteria, which can be passed as an optional parameter in the command. In addition, the command also accepts timeout parameter, which can be used to limit the time that the operation can run on the messaging engine..
requestCertificate command
The requestCertificate command uses an implementation class that is passed in to communicate with a certificate authority (CA) server to request a CA signed certificate. The command then adds the certificate to a supplied keystore.
Resource Access Control Facility Tools
restoreConfig command
Use the restoreConfig command to restore the configuration of your node after backing up the configuration using the backupConfig command.
restoreJobManager command (deprecated)
The restoreJobManager command restores the job manager database from a previous backup.
retrieveSigners command
The retrieveSigners command creates a new client self-signed certificate, keystore, and SSL configuration in the ssl.client.props file. Using this command you can optionally extract the signer to a file.
revokeCertificate command
The revokeCertificate command uses an implementation class that is passed to communicate with a certificate authority (CA) server to revoke a certificate. Processing this command sends a revocation request to the CA server to mark this certificate as revoked.
RSA token certificate use
The Rivest Shamir Adleman (RSA) token uses certificates in a similar way that Secure Sockets Layer (SSL) uses them. However, the trust established for SSL and RSA are different, and RSA certificates should not use SSL certificates and vice versa. The SSL certificates can be used by pure clients, and when used for the RSA mechanism would allow the client to send an RSA token to the server. The RSA token authentication mechanism is purely for server-to-server requests and should not be used by pure clients. The way to prevent this is to control the certificates used by RSA in such as a way so they are never distributed to any clients. There is a different root certificate for RSA that prevents trust being established with clients who only need SSL certificates.
rvkwasaut command
The rvkwasaut command revokes user authority to a profile and the objects associated with it.
Sample JCL to display WebSphere for z/OS trace data
Use this sample JCL to display trace data for WebSphere Application Server for z/OS®.
Save UDDI Version 3 entities with a supplied key
The following example shows how to save a Version 3 business entity with a defined key. You might do this after you use UDDI Utility Tools to export from a Version 3 registry, because entities from a Version 3 registry are exported as Version 2 entities, so elements such as digital signatures are not present.
schemagen command for JAXB applications
Use the schema generator tool, schemagen, to generate an XML schema using Java Architecture for XML Binding (JAXB).
serverStatus command
Use the serverStatus command to obtain the status of one or all the servers configured on a node.
servicetools command
The servicetools command includes serviceability tools that you can use to troubleshoot WebSphere Application Server.
setupCmdLineXJB.bat, launchClientXJB.bat and other ActiveX batch files
Client applications and client services can use aids to access the ActiveX to EJB bridge. These aids enable the ActiveX to Enterprise JavaBeans (EJB) bridge to find its XJB.JAR file and the Java run-time environment.
Showlog commands for Common Base Events
The showlog command converts the service log from binary format into plain text.
sibDBUpgrade command
A messaging engine needs data definition language (DDL) statements to alter the existing database management system (DBMS) resources. The DBMS resources can be altered using the sibDBUpgrade command.
sibDDLGenerator command
A messaging engine needs data definition language (DDL) statements to create the DBMS (Database Management System) resources. These DBMS resources are generated by the sibDDLGenerator command.
START command
The START command reads the configuration file for the specified server process and starts the server, deployment manager, node agent, administrative agent, or job manager.
startManager command
Use the startManager command to manipulate a deployment manager with scripting.
startNode command
The startNode command reads the configuration file for the node agent process and constructs a launch command.
startServer command
The startServer command reads the configuration file for the specified server process and starts that server process.
STOP command
The STOP command reads the configuration file for the specified server process and stops the server, deployment manager, node agent, administrative agent, or job manager.
stopManager command
The stopManager command reads the configuration file for the WebSphere Application Server Network Deployment manager process.
stopNode command
The stopNode command reads the configuration file for the node agent process and sends a Java Management Extensions (JMX) command telling the node agent to shut down.
stopServer command
The stopServer command reads the configuration file for the specified server process. This command sends a Java management extensions (JMX) command to the server telling it to shut down.
syncNode command
The syncNode command forces a configuration synchronization to occur between the node and the deployment manager for the cell in which the node is configured.
Timer service commands
Information about Enterprise JavaBeans (EJB) timers is specific to the application that the timers are created for, and the timers are not visible outside of that application. Therefore, when you manage EJB timers, use the application that contains the enterprise bean and creates the EJB timer.
UDDI entity definition file
The entity definition file contains XML that exactly describes each of the specified entities, according to the UDDI Utility Tools schema.
UDDI Utility Tools
The UDDI Utility Tools is a suite of functions that you can use to migrate, move, or copy UDDI Version 2 entities, including child entities and their respective Version 2 entity keys, into a Version 3 UDDI registry.
UDDI Utility Tools at a command prompt
You can start UDDI Utility Tools at a command prompt. In some situations, there are prerequisites before you run the command.
UDDI Utility Tools configuration file
Configuration data for UDDI Utility Tools is in a configuration properties file, which describes the runtime environment, UDDI and database locations and access information, logging information, security configuration, entity definition file location, and other flags to control whether referenced entities can be imported, overwritten, or both.
UDDI Utility Tools limitations and resolutions
For some limitations with the UDDI Utility Tools, there are actions to resolve each issue.
UDDI Utility Tools log files
The following examples show the contents of two log files that are produced by running UDDI Utility Tools. The examples include some comments in brackets and in italics to highlight important points in the log file.
UDDI Utility Tools prerequisites
Before you use the UDDI Utility Tools, ensure that the required .jar files are available.
UDDI Utility Tools through the API
UDDI Utility Tools provides a public API to functions to export, import, promote, find, and delete UDDI entities. To invoke these functions, use the PromoterAPI class.
updateZOSStartArgs script
If you are running the product on z/OS Version 1.9 or higher, you can use the updateZOSStartArgs script that is provided with the product to control for which of your servers, z/OS can reuse address space identifiers (ASIDs) that are associated with cross-process services when those services end.
updwashost command (deprecated)
The updwashost script updates a profile if the host name of the server is changed.
uteconfig.bat|.sh batch script
You can use the uteconfig script to configure the unit test environment (UTE). Run the script to create a job scheduler configuration on the WebSphere Application Server profile that is used in Rational Application Developer.
versionInfo command
The versionInfo command generates a report that includes a list of installed fix packs and interim fixes.
WASMigrationAppInstaller command
The WASMigrationAppInstaller command for WebSphere Application Server Version 9.0 migrates applications from a previously installed version of WebSphere Application Server into the new version. Only applications that are not already installed are migrated.
WASPostUpgrade command
The WASPostUpgrade command for WebSphere Application Server retrieves the saved configuration that was created by the WASPreUpgrade command from the backupDirectory that you specified. The WASPostUpgrade script for WebSphere Application Server reads the configuration from this directory to migrate to WebSphere Application Server Version 9.0 and adds all migrated applications into the app_server_root/installedApps directory for the Version 9.0 installation.
WASPreUpgrade command
The WASPreUpgrade command for WebSphere Application Server Version 9.0 saves the configuration of a previously installed version of WebSphere Application Server into a migration-specific backup directory.
WASService command
The WASService command line tool enables you create a service for a product Java process on Linux® and Windows operating systems.
WLM dynamic application environment operator commands
The dynamic application environments are displayed and controlled separately from static application environments. In order to control the dynamic environments, you must set the Resource Access Facility (RACF®) server class profiles to give you the proper permission to issue MVS console commands.
wsadmin scripting tool
The wsadmin tool runs scripts. You can use the wsadmin tool to manage application servers as well as the configuration, application deployment, and server runtime operations.
wsappid command
The Java Persistence API (JPA) specification supports an entity primary key to be made up of more than one column. In this case, the primary key is called a composite or compound primary key. Provide an ID class, which is specified by the @IdClass annotation, to manage a composite primary key. Use the identity tool for JPA to generate an ID class for entities that use composite primary keys.
wsdbgen command
The command supports utilization of the pureQuery feature in Java Persistence API (JPA) applications.
wsdeploy command
Use the wsdeploy command to add WebSphere product-specific deployment classes to a web services-compatible enterprise application enterprise archive (EAR) file or an application client Java archive (JAR) file.
WSDL2Java command for JAX-RPC applications
Run the WSDL2Java command-line tool against the WSDL file to create Java APIs and deployment descriptor templates.
wsenhancer command
The entity enhancer tool for Java Persistence API (JPA) applications inserts bytecode into an entity class file that supports the JPA provider to manage the state of an entity. Use this command-line tool to enhance entities under the Java™ Persistence API (JPA) 2.0 specification provider, WSJPA/OpenJPA, for WebSphere Application Server.
wsgen command for JAX-WS applications
The wsgen command-line tool generates the necessary artifacts required for Java API for XML Web Services (JAX-WS) applications when starting from Java code. The generated artifacts are Java 5 compliant, making them portable across different Java versions and platforms.
wsimport command for JAX-WS applications
The wsimport command-line tool processes an existing Web Services Description Language (WSDL) file and generates the required artifacts for developing Java API for XML-Based Web Services (JAX-WS) web service applications. The generated artifacts are Java 5 compliant, making them portable across different Java versions and platforms.
wsjpaversion command
Use this command line tool to find out information about the installed version of the Java Persistence API (JPA) 2.0 specification provider, WSJPA/OpenJPA, for WebSphere Application Server.
wsmapping command
The wsmapping tool is used to provide top-down mapping of the entity object model to the database relational model. You can use the wsmapping tool to create database tables.
wsreversemapping command
The wsreversemapping tool generates persistent class definitions and metadata from a database schema.
wsschema command
The schema tool can be used to view the database schema in XML form or match an XML schema to an existing database.
xjc command for JAXB applications
Use the Java Architecture for XML Binding (JAXB) tools to generate Java classes from an XML schema with the xjc schema compiler tool.
z/OS display command
Use either the WebSphere Application Server administrative console or the z/OS MVS console to accomplish many operations tasks related to WebSphere Application Server for z/OS servers. Entering the z/OS display or modify commands through the MVS console can provide information or perform tasks that are useful for diagnosing problems.