WebLogic Server Command Reference

weblogic.Admin Command-Line Reference (Deprecated)

The weblogic.Admin utility is a command-line interface that you can use to administer, configure, and monitor WebLogic Server.

Like the Administration Console, for most commands this utility assumes the role of client that invokes administrative operations on the Administration Server, which is the central management point for all servers in a domain. (All Managed Servers retrieve configuration data from the Administration Server, and the Administration Server can access runtime data from all Managed Servers.) While the Administration Console interacts only with the Administration Server, the weblogic.Admin utility can access the Administration Server as well as all active server instances directly. If the Administration Server is down, you can still use the weblogic.Admin utility to retrieve runtime information from Managed Servers and invoke some administrative commands. However, you can save configuration changes to the domain’s config.xml file only when you access the Administration Server.

To automate administrative tasks, you can invoke the weblogic.Admin utility from shell scripts. If you plan to invoke this utility multiple times from a shell script, consider using the BATCHUPDATE command, which is described in Running Commands in Batch Mode.

The following sections describe using the weblogic.Admin utility:

For more information, see:

Required Environment for the weblogic.Admin Utility

To set up your environment for the weblogic.Admin utility:

Syntax for Invoking the weblogic.Admin Utility

java [ SSL Arguments ]
     weblogic.Admin 
     [ Connection Arguments ] 
     [ User Credentials Arguments ]
     COMMAND-NAME command-arguments 

The command names and arguments are not case sensitive.

The following sections provide detailed syntax information:

SSL Arguments

java [ -Dweblogic.security.TrustKeyStore=DemoTrust ]
     [ -Dweblogic.security.JavaStandardTrustKeyStorePassPhrase=password ]
     [ -Dweblogic.security.CustomTrustKeyStoreFileName=filename 
       -Dweblogic.security.TrustKeyStoreType=CustomTrust
       [-Dweblogic.security.CustomTrustKeyStorePassPhrase=password ]
     ]
     [ -Dweblogic.security.SSL.hostnameVerifier=classname ]
     [ -Dweblogic.security.SSL.ignoreHostnameVerification=true ]
     weblogic.Admin 
     [ User Credentials Arguments ] 
     COMMAND-NAME command-arguments 

If you have enabled the domain-wide administration port, or if you want to secure your administrative request by using some other listen port that is secured by SSL, you must include SSL arguments when you invoke weblogic.Admin. Table 2-1 describes all SSL arguments for the weblogic.Admin utility.

Using SSL to Secure Administration Requests: Main Steps

To secure administration requests with SSL:

Specifying Trust for weblogic.Admin

When the weblogic.Admin utility connects to a server’s SSL port, it must specify a set of certificates that describe the certificate authorities (CAs) that the utility trusts.

To specify trust for weblogic.Admin:

Specifying Host Name Verification for weblogic.Admin

A host name verifier ensures the host name URL to which the client connects matches the host name in the digital certificate that the server sends back as part of the SSL connection. A host name verifier is useful when an SSL client, or a SSL server acting as a client, connects to an application server on a remote host. It helps to prevent man-in-the-middle attacks. See " Using Host Name Verification" in Managing WebLogic Security.

To specify host name verification for weblogic.Admin:

Connection Arguments

java [ SSL Arguments ]
     weblogic.Admin 
     [ {– url URL} | {– adminurl URL} ]
     [ User Credentials Arguments ]
     COMMAND-NAME command-arguments

When you invoke most weblogic.Admin commands, you specify the arguments in Table 2-2 to connect to a WebLogic Server instance. Some commands have special requirements for the connection arguments. Any special requirements are described in the command documentation.

User Credentials Arguments

java [ SSL Arguments ]
     weblogic.Admin 
     [ Connection Arguments ] 
     [ { -username username [-password password] } |
       [ -userconfigfile config-file [-userkeyfile admin-key] ] 
     ]
     COMMAND-NAME command-arguments 

When you invoke most weblogic.Admin commands, you specify the arguments in Table 2-3 to provide the user credentials of a WebLogic Server user who has permission to invoke the command.

Specifying User Credentials

The simplest way to specify user credentials is to create a user configuration file and key file in the default location. Thereafter, you do not need to include user credentials in weblogic.Admin invocations. A user-configuration file contains encrypted user credentials that can be decrypted only by a single key file. See STOREUSERCONFIG.

For example, the following command creates a user configuration file and key file in the default location:

java weblogic.Admin -username weblogic -password weblogic STOREUSERCONFIG

After you enter this STOREUSERCONFIG command, you can invoke weblogic.Admin without specifying credentials on the command line or in scripts. For example:

java weblogic.Admin GET -pretty -type -Domain

If you create a user configuration file or key file in a location other than the default, you can include the -userconfigfile config-file and -userkeyfile admin-key arguments on the command line or in scripts.

If you do not create a user configuration file and key file, you must use the -username and -password arguments when invoking the weblogic.Admin utility directly on the command line or in scripts. With these arguments, the username and password are not encrypted. If you store the values in a script, the user credentials can be used by anyone who has read access to the script.

The following list summarizes the order of precedence for the weblogic.Admin user-credentials arguments:

Examples of Providing User Credentials

The following command specifies the username weblogic and password weblogic directly on the command line:
java weblogic.Admin -username weblogic -password weblogic COMMAND

The following command uses a user-configuration file and key file that are located at the default pathname:
java weblogic.Admin COMMAND

See Configuring the Default Path Name.

The following command uses a user-configuration file named c:\wlUser1-WebLogicConfig.properties and a key file named e:\secure\myKey:
java -userconfigfile c:\wlUser1-WebLogicConfig.properties
-userkeyfile e:\secure\myKey COMMAND

Protocol Support

The -url and -adminurl arguments of the weblogic.Admin utility support the t3, t3s, http, https, and iiop protocols.

If you want to use http or https to connect to a server instance, you must enable HTTP Tunneling for that instance. For more information, see " Configure HTTP Protocol" in the Administration Console Online Help.

If you want to use iiop to connect to a server instance, you must enable the iiop protocol for that instance. For more information, see " Enable and Configure IIOP" in the Administration Console Online Help.

If you use the -url argument to specify a non-secured port, the weblogic.Admin utility uses t3 by default. For example, java weblogic.Admin -url localhost:7001 resolves to java weblogic.Admin -url t3://localhost:7001.

If you use either the -url or -adminurl argument to specify a port that is secured by SSL, you must specify either t3s or https. See Using SSL to Secure Administration Requests: Main Steps.

Example Environment

In many of the examples throughout the sections that follow, it is assumed that a certain environment has been set up:

Exit Codes Returned by weblogic.Admin

All weblogic.Admin commands return an exit code of 0 if the command succeeds and an exit code of 1 if the command fails.

To view the exit code from a Windows command prompt, enter echo %ERRORLEVEL% after you run a weblogic.Admin command. To view the exit code in a bash shell, enter echo $?.

For example:

D:\>java weblogic.Admin -username weblogic -password weblogic GET -pretty 
-mbean "MedRec:Name=MyServer,Type=Server" -property ListenPort

---------------------------
MBeanName: "MedRec:Name=MyServer,Type=Server"
        ListenPort: 7010

D:\>echo %ERRORLEVEL%
0

weblogic.Admin calls System.exit(1) if an exception is raised while processing a command, causing Ant and other Java client JVMs to exit. You can override this default behavior by specifying -noExit for Ant tasks (wlconfig) and -continueOnError for weblogic.Admin batch operations (BATCHUPDATE).

Command for Storing User Credentials

For any weblogic.Admin command that connects to a WebLogic Server instance, you must provide user credentials. You can use the STOREUSERCONFIG command to encrypt the user credentials instead of passing credentials directly on the command line or storing unencrypted credentials in scripts. See Specifying User Credentials.

STOREUSERCONFIG

Creates a user-configuration file and an associated key file. The user-configuration file contains an encrypted username and password. The key file contains a secret key that is used to encrypt and decrypt the username and password.

Only the key file that originally encrypted the username and password can decrypt the values. If you lose the key file, you must create a new user-configuration and key file pair.

Unlike other weblogic.Admin commands, the STOREUSERCONFIG command does not connect to a WebLogic Server instance. The data encryption and file creation are accomplished by the JVM in which the STOREUSERCONFIG command runs. Because it does not connect to a WebLogic Server instance, the command cannot verify that the username and password are valid WebLogic Server credentials.

Syntax

java weblogic.Admin 
  -username username [-password password]
  [ -userconfigfile config-file ] [ -userkeyfile keyfile ]
  STOREUSERCONFIG 

Configuring the Default Path Name

If you do not specify the location in which to create and use a user-configuration file and key file, the weblogic.Admin and weblogic.Deployer utilities supply the following default values:

Where user-home-directory is the home directory of the operating-system user account as determined by the JVM, and username is your operating-system username.

You can use the following Java options to specify values for user-home-directory and username:

For example, the following command configures the user-home directory to be c:\myHome and the user name to be wlAdmin. The command will search for the following user-configuration file and user key file:
c:\myHome\wlAdmin-WebLogicConfig.properties
c:\myHome\wlAdmin-WebLogicKey.properties

java -Duser.home=c:\myHome -Duser.name=wlAdmin
weblogic.Admin COMMAND

Creating User-Configuration and Key Files

To create user-configuration and key files:

You can change the name and location of a user-configuration file or a key file after you create them, as long as you use the two files as a pair.

Using a Single Key File for Multiple User-Configuration Files

To use one key file to encrypt multiple user-configuration files:

Examples

In the following example, a user who is logged in to a UNIX operating system as joe encrypts the username wlAdmin and password wlPass:

java weblogic.Admin -username wlAdmin -password wlPass
STOREUSERCONFIG

The command determines whether a key file named ~joe/joe-WebLogicKey.properties exists. If such a file does not exist, it prompts the user to select y to confirm creating a key file. If the command succeeds, it creates two files:
~joe\joe-WebLogicConfig.properties
~joe\joe-WebLogicKey.properties

The file joe-WebLogicConfig.properties contains an encrypted version of the strings wlAdmin and wlPass. Any command that uses the ~joe\joe-WebLogicConfig.properties file must specify the ~joe\joe-WebLogicKey.properties key file.

In the following example, the user joe is a System Administrator who wants to create a user-configuration file for an operating-system account named pat. For the sake of convenience, joe wants to create the user-configuration file in pat’s home directory, which will simplify the syntax of the weblogic.Admin commands that pat invokes. For added security, only one key file exists at joe’s organization, and it is located on a removable hard drive.

To create a user configuration file in pat’s home directory that is encrypted and decrypted by a key file name e:\myKeyFile:

java -Duser.name=pat -Duser.home="C:\Documents and Settings\pat" weblogic.Admin -username wlOperatorPat -password wlOperator1 -userkeyfile e:\myKeyFile
STOREUSERCONFIG

A user who logs in to pat’s account can use the following syntax to invoke weblogic.Admin commands:
java weblogic.Admin -userkeyfile e:\myKeyFile COMMAND

For information on using user-configuration and key files, see Specifying User Credentials.

Commands for Managing the Server Life Cycle

Table 2-5 is an overview of commands that manage the life cycle of a server instance. Subsequent sections describe command syntax and arguments, and provide an example for each command. For more information about the life cycle of a server instance, see " Understanding Server Life Cycle" in Managing Server Startup and Shutdown and " Managing Servers and Server Life Cycle" in WebLogic Scripting Tool.

CANCEL_SHUTDOWN

The CANCEL_SHUTDOWN command cancels the SHUTDOWN command for a specified WebLogic Server.

When you use the SHUTDOWN command, you can specify a delay (in seconds). An administrator may cancel the shutdown command during the delay period. Be aware that the SHUTDOWN command disables logins, and they remain disabled even after cancelling the shutdown. Use the UNLOCK command to re-enable logins.

See SHUTDOWN and UNLOCK.

This command is deprecated because the ability to specify a delay in the SHUTDOWN command is also deprecated. Instead of specifying a delay in the SHUTDOWN command, you can now set attributes to control how a server shuts down. For more information, see " Controlling Graceful Shutdowns" in Managing Server Startup and Shutdown.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [ Connection Arguments ] 
     [ User Credentials Arguments ]
     CANCEL_SHUTDOWN

Example

The following example cancels the shutdown of a WebLogic Server instance that runs on a machine named ManagedHost and listens on port 8001:

java weblogic.Admin -url ManagedHost:8001 -username weblogic 
   -password weblogic CANCEL_SHUTDOWN

For more information about the environment in which this example runs, see Example Environment.

FORCESHUTDOWN

Terminates a server instance without waiting for active sessions to complete. For more information, see “ Force Shutdown" in Managing Server Startup and Shutdown.

If a server instance is in a deadlocked state, it can respond to weblogic.Admin commands only if you have enabled the domain-wide administration port. (A deadlocked server is one in which all threads are struck trying to acquire locks held by other threads.) If you have not already enabled the domain-wide administration port, your only option for shutting down the server instance is to kill the Java process that is running the server. You will lose all session data. For information on enabling the domain-wide administration port, see " Configure the domain-wide administration port" in the Administration Console Online Help.

Syntax

java [ SSL Arguments ] 
   [-Dweblogic.system.BootIdentityFile=filename 
     [-Dweblogic.RootDirectory=path]
   ]
   weblogic.Admin 
   [ Connection Arguments ] 
   [ User Credentials Arguments ]
   FORCESHUTDOWN [targetServer]

Example

The following command instructs the Administration Server to shut down a Managed Server:

java weblogic.Admin -url AdminHost:7011 -username weblogic 
   -password weblogic FORCESHUTDOWN MedRecManagedServer

After you issue the command, MedRecManagedServer prints messages to its log file and to its standard out. The messages indicate that the server state is changing and that the shutdown sequence is starting.

If the command succeeds, the final message that the target server prints is as follows:

<Oct 12, 2002 11:28:59 AM EDT> <Alert> <WebLogicServer> <000219> <The
shutdown sequence has been initiated.> 

In addition, if the command succeeds, the weblogic.Admin utility returns the following:

Server "MedRecManagedServer" was force shutdown successfully ...

For more information about the environment in which this example runs, see Example Environment.

In the following example, the Administration Server is not available, so the command instructs the Managed Server to shut itself down:

java weblogic.Admin -url ManagedHost:8001 -username weblogic 
-password weblogic FORCESHUTDOWN 

The following example provides user credentials by referring to a boot identity file. The example specifies the server’s root directory and boot identity file name so that it can be invoked from any directory:

java -Dweblogic.system.BootIdentityFile=c:\mydomain\boot.properties
 -Dweblogic.RootDirectory=c:\mydomain
 weblogic.Admin -url AdminHost:7001 FORCESHUTDOWN 

LOCK

Locks a WebLogic Server instance against non-privileged logins. Any subsequent login attempt initiates a security exception which may contain an optional string message.

Instead of using the LOCK command, start a server in the STANDBY state. In this state, a server instance responds only to administrative requests over the domain-wide administration port. See " Understanding Server Life Cycle" in Managing Server Startup and Shutdown.

Syntax

java [ SSL Arguments ]
     weblogic.Admin 
     [ -url [protocol://]listen-address:listen-port ] 
     [ User Credentials Arguments ]
   LOCK ["stringMessage"]

Example

In the following example, a Managed Server named MedRecManagedServer is locked.

java weblogic.Admin -url ManagedHost:8001 -username weblogic
   -password weblogic 
   LOCK "Sorry, WebLogic Server is temporarily out of service."

Any application that subsequently tries to log into the locked server with a non-privileged username and password receives the specified message: Sorry, WebLogic Server is temporarily out of service.

RESUME

Moves a server instance from the STANDBY or ADMIN state to the RUNNING state.

For more information about server states, see " Understanding Server Life Cycle" in Managing Server Startup and Shutdown.

Syntax

java [ SSL Arguments ]
     weblogic.Admin 
     [-url URL]
     [ User Credentials Arguments ]
   RESUME [targetServer]

Example

The following example connects to the Administration Server and instructs it to resume a Managed Server:

java weblogic.Admin -url t3s://AdminHost:9002 -username weblogic 
-password weblogic RESUME MedRecManagedServer

For more information about the environment in which this example runs, see Example Environment.

SHUTDOWN

Gracefully shuts down the specified WebLogic Server instance.

A graceful shutdown gives WebLogic Server subsystems time to complete certain application processing currently in progress. By default, a server instance waits for pending HTTP sessions to finish as a part of the graceful shutdown. You can override this behavior using the -ignoreExistingSessions argument. See " Controlling Graceful Shutdowns" in Managing Server Startup and Shutdown.

In release 6.x, this command included an option to specify a number of seconds to wait before starting the shutdown process. This option is now deprecated. To support this deprecated option, this command assumes that a numerical value in the field immediately after the SHUTDOWN command indicates seconds. Thus, you cannot use this command to gracefully shut down a server whose name is made up entirely of numbers. Instead, you must use the Administration Console. For information, see " Shut Down a Server Instance" in the Administration Console Online Help.

Instead of specifying a delay in the SHUTDOWN command, you can now use a -timeout option, or set attributes in the Administration Console to control how a server shuts down. For more information, see " Controlling Graceful Shutdowns" in Managing Server Startup and Shutdown.

If a server instance is in a deadlocked state, it can respond to weblogic.Admin commands only if you have enabled the domain-wide administration port. (A deadlocked server is one in which all threads are struck trying to acquire locks held by other threads.) If you have not already enabled the domain-wide administration port, your only option for shutting down the server instance is to kill the Java process that is running the server. You will lose all session data. For information on enabling the domain-wide administration port, see " Configure the domain-wide administration port" in the Administration Console Online Help.

Syntax

java [ SSL Arguments ]
     [-Dweblogic.system.BootIdentityFile=filename 
       [-Dweblogic.RootDirectory=path]
     ]
     weblogic.Admin 
     [ Connection Arguments ] 
     [ User Credentials Arguments ]
   SHUTDOWN [-ignoreExistingSessions] [-timeout seconds] 
   [targetServer] 

(Deprecated)java [ SSL Arguments ]
     [-Dweblogic.system.BootIdentityFile=filename 
       [-Dweblogic.RootDirectory=path]
     ]
     weblogic.Admin 
     [ Connection Arguments ] 
     [ User Credentials Arguments ]
   SHUTDOWN [seconds [“stringMessage”]] [targetServer]

Example

The following example instructs the Administration Server to shut down a Managed Server:

java weblogic.Admin -url AdminHost:7011 -username weblogic 
-password weblogic SHUTDOWN MedRecManagedServer

After you issue the command, MedRecManagedServer prints messages to its log file and to its standard out. The messages indicate that the server state is changing and that the shutdown sequence is starting.

If the command succeeds, the final message that the target server prints is as follows:

<Oct 12, 2002 11:28:59 AM EDT> <Alert> <WebLogicServer> <000219> <The
shutdown sequence has been initiated.> 

In addition, if the command succeeds, the weblogic.Admin utility returns the following:

Server "MedRecManagedServer" was shutdown successfully ...

For more information about the environment in which this example runs, see Example Environment.

In the following example, the Administration Server is not available. The same user connects to a Managed Server and instructs it to shut itself down:

java weblogic.Admin -url ManagedHost:8001 -username weblogic 
-password weblogic SHUTDOWN 

The following example provides user credentials by referring to a boot identity file. The example specifies the server’s root directory and boot identity file name so that it can be invoked from any directory:

java -Dweblogic.system.BootIdentityFile=c:\mydomain\boot.properties
 -Dweblogic.RootDirectory=c:\mydomain weblogic.Admin
 -url AdminHost:7001 SHUTDOWN

START

Starts a Managed Server using Node Manager.

This command requires the following environment:

The Startup Mode field in the Administration Console determines whether a Managed Server starts in the RUNNING, STANDBY, or ADMIN state. See “ Specify a Startup Mode” in the Administration Console Online Help and " Understanding Server Life Cycle" in Managing Server Startup and Shutdown.

Syntax

java [ SSL Arguments ] weblogic.Admin 
   [-url URL]
   [ User Credentials Arguments ]
   START targetServer 

Example

The following example instructs the Administration Server and Node Manager to start a Managed Server:

java weblogic.Admin -url AdminHost:7011 -username weblogic 
-password weblogic START MedRecManagedServer

When you issue the command, the following occurs:

For more information about the environment in which this example runs, see Example Environment.

STARTINSTANDBY

Starts a Managed Server using Node Manager.

Prior to WebLogic Server 9.0, this command started a Managed Server using the Node Manager and placed it in a STANDBY state. In this state, a server is not accessible to requests from external clients.

In WebLogic Server 9.0, the Startup Mode field in the Administration Console determines the state in which a Managed Server starts, regardless of which command you use to start the server instance. See “ Specify a Startup Mode” and “ Start Managed Servers in the STANDBY Mode” in the Administration Console Online Help.

This command requires the following environment:

For more information about server states, see " Understanding Server Life Cycle" in Managing Server Startup and Shutdown.

Syntax

java [ SSL Arguments ] weblogic.Admin 
   [-url URL]
   [ User Credentials Arguments ]
   STARTINSTANDBY targetServer 

Example

The following example instructs the Administration Server and Node Manager to start a Managed Server:

java weblogic.Admin -url t3s://AdminHost:9002 -username weblogic 
-password weblogic STARTINSTANDBY MedRecManagedServer

When you issue the command, the following occurs:

When you use the Node Manager to start a Managed Server, the Node Manager writes standard out and standard error messages to its log file. You can view these messages from the Administration Console on the MachinesMonitoringNode Manager Log page.

For more information about the environment in which this example runs, see Example Environment.

UNLOCK

Unlocks the specified WebLogic Server after a LOCK operation.

This command is deprecated because the LOCK command is deprecated. Instead of LOCK and UNLOCK, use STARTINSTANDY and RESUME. For more information, see RESUME.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [-url URL]
     [ User Credentials Arguments ]
   UNLOCK

Example

In the following example, an administrator named adminuser with a password of gumby1234 requests the unlocking of the WebLogic Server listening on port 7001 on machine localhost:

java weblogic.Admin -url localhost:7001 -username adminuser 
   -password gumby1234 UNLOCK

Commands for Retrieving Information about WebLogic Server and Server Instances

Table 2-12 is an overview of commands that return information about WebLogic Server installations and instances of WebLogic Server. Subsequent sections describe command syntax and arguments, and provide an example for each command.