WebLogic Server Command Reference

weblogic.Admin Command-Line Reference (Deprecated)

Note: The weblogic.Admin utility is deprecated as of WebLogic Server® 9.0. Both weblogic.Admin utility and wlconfig tool are now restricted as follows:

• No access to MBeans that have been added in WebLogic Server 9.0. These tools use the compatibility MBean server to access MBeans, and this MBean server does not contain MBeans that are new in WebLogic Server 9.0.
• No longer able to configure security MBeans, but can still be used to view and invoke methods on the security MBeans.
• No longer able to create or modify Local Configuration MBeans, but can be used to view them and invoke their operations.

BEA Systems recommends that you use the WebLogic Scripting Tool (WLST) for equivalent functionality. For more information, see WebLogic Scripting Tool.

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:

• Required Environment for the weblogic.Admin Utility
• Syntax for Invoking the weblogic.Admin Utility
• Command for Storing User Credentials
• Commands for Managing the Server Life Cycle
• Commands for Retrieving Information about WebLogic Server and Server Instances
• Commands for Managing JDBC Connection Pools
• Commands for Managing WebLogic Server MBeans
• Running Commands in Batch Mode
• Commands for Working with Clusters

For more information, see:

• "Automating WebLogic Server Administration Tasks" in WebLogic Scripting Tool. Describes using WLST commands to automate typical domain and server configuration tasks.
• "Using Ant Tasks to Configure a WebLogic Server Domain" in Developing Applications with WebLogic Server.
• "Overview of Deployment Tools" in Deploying WebLogic Server Applications. Describes deployment tools to help you configure and deploy applications.

 

---

Required Environment for the weblogic.Admin Utility

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

Install and configure the WebLogic Server software, as described in the WebLogic Server Installation Guide.
Add WebLogic Server classes to the CLASSPATH environment variable and WL_HOME\server\bin to the PATH environment variable.

You can use a WL_HOME\server\bin\setWLSEnv script to set both variables. See Modifying the Classpath.

If you want the weblogic.Admin utility to use a listen port that is reserved for administration traffic, you must configure a domain-wide administration port as described in "Configure the domain-wide administration port" in the Administration Console Online Help.

The domain-wide administration port is secured by SSL. For information about using secured ports with the weblogic.Admin utility, see SSL Arguments.

Note: If a server instance is deadlocked, it can respond to weblogic.Admin commands only if you have enabled the domain-wide administration port. If you have not already enabled the domain-wide administration port, your only option is to shut down the server instance by killing 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 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
• Connection Arguments
• User Credentials Arguments
• Protocol Support

Note: Both the weblogic.Deployer tool and the BEA WebLogic Scripting Tool (WLST) also use the SSL arguments, Connection arguments, and User Credentials arguments.

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.

Table 2-1 SSL Arguments

Argument	Definition
-Dweblogic.security. TrustKeyStore= DemoTrust	Causes weblogic.Admin to trust the CA certificates in the demonstration trust keystore (WL_HOME\server\lib\DemoTrust.jks). This argument is required if the server instance to which you want to connect is using the demonstration identity and certificates. By default, weblogic.Admin trusts only the CA certificates in the Java Standard Trust keystore (JAVA_HOME\jre\lib\security).
-Dweblogic.security. JavaStandardTrustKeysto rePassPhrase=password	Specifies the password that was used to secure the Java Standard Trust keystore. If the Java Standard Trust keystore is protected by a password, and if you want to trust its CA certificates, you must use this argument. By default, the Java Standard Trust keystore is not protected by a password.
-Dweblogic.security. CustomTrustKeyStoreFileNa me=filename -Dweblogic.security.Trust KeyStoreType=CustomTrust	Causes weblogic.Admin to trust the CA certificates in a custom keystore that is located at filename. You must use both arguments to trust custom keystores.
-Dweblogic.security.Custo mTrustKeyStorePassPhrase= password	Specifies the password that was used to secure the custom keystore. You must use this argument only if the custom keystore is protected by a password.
-Dweblogic.security.SSL. hostnameVerifier= classname	Specifies the name of a custom Host Name Verifier class. The class must implement the weblogic.security.SSL.HostnameVerifier interface.
-Dweblogic.security.SSL. ignoreHostnameVerificat ion=true	Disables host name verification.

Using SSL to Secure Administration Requests: Main Steps

To secure administration requests with SSL:

Ensure that two-way SSL is disabled on the server instance to which you want to connect.

By default, when you enable SSL, a server instance supports one-way SSL. Because two-way SSL provides additional security, you might have enabled two-way SSL. However, weblogic.Admin does not support two-way SSL.

Ensure that the trusted CA certificates are stored in a keystore that the weblogic.Admin utility can access through the file system.
When you invoke the weblogic.Admin utility, include arguments that specify the following:
• A secure protocol and port.

See Protocol Support.

• (Optional) The trusted CA certificates and certificate authorities.

See Specifying Trust for weblogic.Admin.

• (Optional) A host name verifier.

See Specifying Host Name Verification for weblogic.Admin.

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:

• To trust only the CA certificates in the Java Standard Trust keystore, you do not need to specify command-line arguments, unless the keystore is protected by a password.

If the Java Standard Trust keystore is protected by a password, use the following command-line argument:

-Dweblogic.security.JavaStandardTrustKeyStorePassPhrase=password

• To trust both the CA certificates in the Java Standard Trust keystore and in the demonstration trust keystore, include the following argument:

-Dweblogic.security.TrustKeyStore=DemoTrust

This argument is required if the server instance to which you want to connect is using the demonstration identity and certificates.

If the Java Standard Trust keystore is protected by a password, include the following command-line argument:

-Dweblogic.security.JavaStandardTrustKeyStorePassPhrase=password

• To trust only the CA certificates in a keystore that you create, specify the following command-line arguments:
• -Dweblogic.security.CustomTrustKeyStoreFileName=filename

where filename specifies the fully qualified path to the trust keystore.

• -Dweblogic.security.TrustKeyStoreType=CustomTrust

This optional command-line argument specifies the type of the keystore. Generally, this value for type is jks.

• If the custom keystore is protected by a password, include
  -Dweblogic.security.CustomTrustKeyStorePassPhrase=password

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:

• To use the host name verifier that the WebLogic Security Service provides, you do not need to specify host name verification arguments.

Note: If you specify an IP address or the localhost string in the weblogic.Admin -url or -adminurl argument, the host name verifier that the WebLogic Security Service provides will allow the connection if the common name (CN) field of the digital certificate matches the DNS name of the local host.

• To use a custom host name verifier, specify:
  -Dweblogic.security.SSL.hostnameVerifier=classname

where classname specifies the implementation of the weblogic.security.SSL.HostnameVerifier interface.

• To disable host name verification, specify:
  -Dweblogic.security.SSL.ignoreHostnameVerification=true

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.

Table 2-2 Connection Arguments 

Argument	Definition
-url [protocol://]listen-address:listen-port	The listen address and listen port of the server instance that runs the command. In most cases, you should specify the Administration Server's address and port, which is the central management point for all servers in a domain. Some commands, such as START and CREATE, must run on the Administration Server. The documentation for each command indicates whether this is so. If you specify a Managed Server's listen address and port, the command can access data only for that server instance; you cannot run a command on one Managed Server to view or change data for another server instance. When you use MBean-related commands, you must specify the Administration Server's listen address and port to access Administration MBeans. To access Local Configuration MBeans or Runtime MBeans, you can specify the server instance on which the MBeans reside. (However, the -adminurl argument can also retrieve Local Configuration MBeans or Runtime MBeans from any server.) For more information on where MBeans reside, see "Understanding WebLogic Server MBeans" in Developing Custom Management Utilities with JMX. To use a listen port that is not secured by SSL, the format is -url [protocol://]listen-address:port To use a port that is secured by SSL, the format is -url secure-protocol://listen-address:port If you have set up a domain-wide administration port, you must specify the administration port number: -url secure-protocol://listen-address:domain-wide-admin-port For information about valid values for protocol and secure-protocol, see Protocol Support. For more information about the listen address and listen ports, see -Dweblogic.ListenAddress=host and -Dweblogic.ListenPort= portnumber. For more information about the domain-wide administration port, see "Configure the domain-wide administration port" in the Administration Console Online Help. The default value for this argument is t3://localhost:7001.
-adminurl [protocol://]Admin-Server-listen-address:listen-port	Enables the Administration Server to retrieve Local Configuration MBeans or Runtime MBeans for any server instance in the domain. For information about types of MBeans, see "Understanding WebLogic Server MBeans" in Developing Custom Management Utilities with JMX. For all commands other than the MBean commands, -adminurl admin-address and -url admin-address are synonymous. The -adminurl value must specify the listen address and listen port of the Administration Server. To use a port that is not secured by SSL, the format is -adminurl [protocol]Admin-Server-listen-address:port. To use a port that is secured by SSL, the format is -adminurl secure-protocol://Admin-Server-listen-address:port If you have set up a domain-wide administration port, you must specify the administration port number: -adminurl secure-protocol://Admin-Server-listen-address:domain-wide-admin-port For information about valid values for protocol and secure-protocol, see Protocol Support. There is no default value for this argument.

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.

Table 2-3 User Credentials Arguments 

Argument	Definition
-username username	The name of the user who is issuing the command. This user must have appropriate permission to view or modify the target of the command. For information about permissions for system administration tasks, see "Users, Groups, And Security Roles" in Securing WebLogic Resources.
-password password	The password that is associated with the username. If you do not specify the -password argument, weblogic.Admin prompts you for a password. If WL_HOME\server\bin is specified in the PATH environment variable, weblogic.Admin uses a set of WebLogic Server libraries that prevent the password from being echoed to standard out. For information on setting environment variables, see Required Environment for the weblogic.Admin Utility.
-userconfigfile config-file	Specifies the name and location of a user-configuration file, which contains an encrypted username and password. The encrypted username must have permission to invoke the command you specify. If you do not specify -userconfigfile config-file, and if you do not specify -username username, weblogic.Admin searches for a user-configuration file at the default path name. (See STOREUSERCONFIG.)
-userkeyfile admin-key	Specifies the name and location of the key file that is associated with the user-configuration file you specify. When you create a user-configuration file, the STOREUSERCONFIG command uses a key file to encrypt the username and password. Only the key file that encrypts a user-configuration file can decrypt the username and password. If you do not specify -userkeyfile admin-key, weblogic.Admin searches for a key file at the default path name. (See STOREUSERCONFIG.)

Note: The exit code for all commands is 1 if the Administration client cannot connect to the server or if the WebLogic Server instance rejects the username and password.

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:

• If you specify -username username -password password, the utility passes the unencrypted values to the server instance you specify in the -url argument.
• These arguments take precedence over the { -userconfigfile config-file -userkeyfile admin-key } arguments.
• If you specify -username username, the utility prompts for a password. Then it passes the unencrypted values to the server instance you specify in the -url argument.
• This argument also takes precedence over the { -userconfigfile config-file -userkeyfile admin-key } arguments.
• If you specify { -userconfigfile config-file -userkeyfile admin-key } and do not specify { -username username [-password password]}, the utility passes the values that are encrypted in config-file to the server instance you specify in the -url argument.
• If you specify neither { -username username [-password password] } nor { -userconfigfile config-file -userkeyfile admin-key }, the utility searches for a user-configuration file and key file at the default path names. The default path names vary depending on the JVM and the operating system. See Configuring the Default Path Name.

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:

• The WebLogic Server administration domain is named MedRec.
• The Administration Server is named MedRecServer and listens on port 7011.
• The Administration Server uses the name of its host machine, AdminHost, as its listen address. For more information about the listen address and listen ports, see -Dweblogic.ListenAddress=host and -Dweblogic.ListenPort= portnumber.
• The weblogic username has system-administrator privileges and uses weblogic for a password.
• The user credentials have not been encrypted in a user configuration file.
• A Managed Server named MedRecManagedServer uses the name of its host machine, ManagedHost, as its listen address and 8001 as its listen port.

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.

Caution: You must ensure that only authorized users can access the key file. Any user who accesses a valid user-configuration and key file pair gains the privileges of the encrypted username. To secure access to the key file, you can store the key file in a directory that provides read and write access only to authorized users, such as WebLogic Server administrators. Alternatively, you can write the key file to a removable medium, such as a floppy or CD, and lock the medium in a drawer when it is not being used.

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 

Argument	Definition
-userconfigfile config-file	Specifies a file pathname at which the STOREUSERCONFIG command creates a user-configuration file. The pathname can be absolute or relative to the directory from which you enter the command. If a file already exists at the specified pathname, the command overwrites the file with a new file that contains the newly encrypted username and password. If you do not specify this option, STOREUSERCONFIG does the following: To determine the directory in which to create the user-configuration file, it uses the JVM's user-home directory. The default value varies depending on the SDK and type of operating system. See Configuring the Default Path Name. To determine the file name, it prepends your operating-system username to the string -WebLogicConfig.properties. For example, username-WebLogicConfig.properties. You can use Java options to specify a different username. See Configuring the Default Path Name.
-userkeyfile keyfile	Specifies a file pathname at which the STOREUSERCONFIG command creates a key file. The pathname can be absolute or relative to the directory from which you enter the command. If a file already exists at the specified pathname, STOREUSERCONFIG uses the existing key file to encrypt the new user-configuration file. If you do not specify this option, STOREUSERCONFIG does the following: To determine the directory in which to create the key file, it uses the JVM's user-home directory. The default value varies depending on the SDK and type of operating system. See Configuring the Default Path Name. To determine the file name, it prepends your operating-system username to the string -WebLogicConfig.properties. For example, username-WebLogicConfig.properties. You can use Java options to specify a different username. See Configuring the Default Path Name.
-username username [-password password ]	Specifies the username and password to encrypt. The STOREUSERCONFIG command does not verify that the username and password are valid WebLogic Server user credentials. If you omit the -password password argument, STOREUSERCONFIG prompts you to enter a password.

 

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:

• user-home-directory\username-WebLogicConfig.properties
• user-home-directory\username-WebLogicKey.properties

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.

The value of the home directory varies depending on the SDK and type of operating system. For example, on UNIX, the home directory is usually "~username." On Windows, the home directory is usually "C:\Documents and Settings\username".

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

• -Duser.home=pathname specifies the value of user-home-directory
• -Duser.name=username specifies the value of 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:

Use the -username username and -password password arguments to specify the username and password to be encrypted.
Specify the name and location of the user-configuration and key files by doing one of the following:
• Use the -userconfigfile config-file and -userkeyfile key-file arguments:
  java weblogic.Admin -username username -password password
-userconfigfile config-file -userkeyfile key-file
STOREUSERCONFIG
• Use the default behavior to create files named
  user-home-directory\username-WebLogicConfig.properties and
  user-home-directory\username-WebLogicKey.properties:
java weblogic.Admin -username username -password password
STOREUSERCONFIG
• Use the -Duser.home=directory and -Duser.name=username Java options to create files named
  directory\username-WebLogicConfig.properties and
  directory\username-WebLogicKey.properties:
java -Duser.home=directory -Duser.name=username
weblogic.Admin -username username -password password
STOREUSERCONFIG

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:

Create an initial user-configuration file and key file pair.

For example, enter the following command:

java weblogic.Admin -username username -password password
-userconfigfile c:\AdminConfig -userkeyfile e:\myKeyFile
STOREUSERCONFIG

When you create an additional user-configuration file, specify the existing key file.

For example, enter the following command:

java weblogic.Admin -username username -password password
-userconfigfile c:\anotherConfigFile -userkeyfile e:\myKeyFile
STOREUSERCONFIG

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

Table 2-4 Overview of Commands for Managing the Server Life Cycle 

Command	Description
CANCEL_SHUTDOWN	Cancels the SHUTDOWN command for the WebLogic Server that is specified in the URL. See CANCEL_SHUTDOWN.
FORCESHUTDOWN	Terminates a server instance without waiting for active sessions to complete. See FORCESHUTDOWN.
LOCK	Locks a WebLogic Server against non-privileged logins. Any subsequent login attempt initiates a security exception which may contain an optional string message. See LOCK.
RESUME	Makes a server available to receive requests from external clients. See RESUME.
SHUTDOWN	Gracefully shuts down a WebLogic Server. See SHUTDOWN.
START	Uses a configured Node Manager to start a Managed Server in the RUNNING state. See START.
STARTINSTANDBY	Uses a configured Node Manager to start a Managed Server and place it in the STANDBY state. See STARTINSTANDBY.
UNLOCK	Unlocks the specified WebLogic Server after a LOCK operation. See UNLOCK.

 

 

---

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]

Argument	Definition
-Dweblogic.system.BootIdentityFile=filename [-Dweblogic.RootDirectory=path]	Cause the command to retrieve encrypted user credentials from a boot identity file. See "Boot Identity Files" in Managing Server Startup and Shutdown. Use these arguments if you invoke this command from a script, you have not created a user configuration file, and you do not want to store user credentials in your script. If you do you not use the -username argument or a user configuration file to specify credentials (see User Credentials Arguments), the command retrieves user credentials from a boot properteis file as follows: If you invoke the command from a server's root directory, and if the server's root directory contains a valid boot.properties file, it retrieves credentials from this file by default. For information about a server's root directory, see "A Server's Root Directory." If you invoke the command from a server's root directory, but the server's boot identity file is not in the server's root directory or is not named boot.properties, the command can use a boot identity file if you include the following argument: -Dweblogic.system.BootIdentityFile=filename where filename is the fully qualified pathname of a valid boot identity file. If you do not invoke the command from a server's root directory, the command can use a boot identity file if you include both of the following arguments in the command: -Dweblogic.system.BootIdentityFile=filename -Dweblogic.RootDirectory=path where filename is the fully qualified pathname of a valid boot identity file and path is the relative or fully-qualified name of the server's root directory. If you have not created a boot identity file for a server, or if you do not want to use it, you must use the -username and -password arguments to provide user credentials. If you specify both -Dweblogic.system.BootIdentityFile=filename and -username and -password, the command uses the credentials specified in the -username and -password arguments.
targetServer	The name of the server to shut down. If you do not specify a value, the command shuts down the server that you specified in the -url argument.

 

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.

Note: This command is privileged. It requires the password for the WebLogic Server administrative user.

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"]

Argument	Definition
-url [protocol://]listen-address:listen-port	Specify the listen address and listen port of the server instance that you want to lock. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
"stringMessage"	Message, in double quotes, to be supplied in the security exception that is thrown if a non-privileged user attempts to log in while the WebLogic Server instance is locked.

 

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]

Argument	Definition
-url secure-protocol://listen-address:listen-port	Because servers can be in the STANDBY state only if the domain-wide administration port is enabled, to resume a server you must specify the Administration Server and domain-wide administration port as follows: t3s://Admin-Server-listen-address:domain-wide-admin-port or https://Admin-Server-listen-address:domain-wide-admin-port For more information, see the -url entry in Table 2-2 and Protocol Support.
targetServer	The name of the server to resume. If you do not specify a value, the command resumes the server that you specified in the -url argument.

 

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]

Argument	Definition
-Dweblogic.system.BootIdentityFile=filename [-Dweblogic.RootDirectory=path]	Cause the command to retrieve encrypted user credentials from a boot identity file. See "Boot Identity Files" in Managing Server Startup and Shutdown. Use these arguments if you invoke this command from a script, you have not created a user configuration file, and you do not want to store user credentials in your script. If you do you not use the -username argument or a user configuration file to specify credentials (see User Credentials Arguments), the command retrieves user credentials from a boot properteis file as follows: If you invoke the command from a server's root directory, and if the server's root directory contains a valid boot.properties file, it retrieves credentials from this file by default. For information about a server's root directory, see "A Server's Root Directory." If you invoke the command from a server's root directory, but the server's boot identity file is not in the server's root directory or is not named boot.properties, the command can use a boot identity file if you include the following argument: -Dweblogic.system.BootIdentityFile=filename where filename is the fully qualified pathname of a valid boot identity file. If you do not invoke the command from a server's root directory, the command can use a boot identity file if you include both of the following arguments in the command: -Dweblogic.system.BootIdentityFile=filename -Dweblogic.RootDirectory=path where filename is the fully qualified pathname of a valid boot identity file and path is the relative or fully-qualified name of the server's root directory. If you have not created a boot identity file for a server, or if you do not want to use it, you must use the -username and -password arguments to provide user credentials. If you specify both -Dweblogic.system.BootIdentityFile=filename and -username and -password, the command uses the credentials specified in the -username and -password arguments.
-ignoreExistingSessions	Causes a graceful shutdown operation to drop all HTTP sessions immediately. If you do not specify this option, the command refers to the Ignore Sessions During Shutdown setting for the server in the domain's config.xml file. For more information, see "Controlling Graceful Shutdowns" in Managing Server Startup and Shutdown. By default, a graceful shutdown operation waits for HTTP sessions to complete or timeout.
-timeout seconds	The number of seconds subsystems have to complete in-flight work and suspend themselves. If you specify a timeout value and the subsystems do not complete work and suspend themselves within that period, WebLogic Server will perform a forced shutdown on the server instance.
targetServer	The name of the server to shut down. If you do not specify a value, the command shuts down the server that you specified in the -url argument.
seconds	Number of seconds allowed to elapse between the invoking of this command and the shutdown of the server.
"stringMessage"	Message, in double quotes, to be supplied in the message that is sent if a user tries to log in while the WebLogic Server is being shut down.

 

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 domain's Administration Server must be running.
• The Node Manager must be running on the Managed Server's host machine.
• The Managed Server must be configured to communicate with a Node Manager. For more information, see "Configure Machines" and "Assign Server Instances to Machines" in the Administration Console Online Help.

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 

Argument	Definition
-url [protocol://]listen-address:listen-port	Must specify the listen address and listen port of the domain's Administration Server. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
targetServer	The name of the Managed Server to start.

 

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:

The Administration Server determines which machine MedRecManagedServer is configured to run on. It instructs the Node Manager that is running on that machine to start MedRecManagedServer in the state that the Startup Mode field specifies.
The Node Manager indicates its progress by writing messages to its standard out. You can view these messages from the Administration Console on the ServerName—>Control—>Remote Start Output page.
If the command succeeds, the weblogic.Admin utility returns to the following message:

Server "MedRecManagedServer" was started ...
Please refer to server log files for completion status ... 

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:

• The domain's Administration Server must be running.
• The Node Manager must be running on the Managed Server's host machine.
• The Managed Server must be configured to communicate with a Node Manager. For more information, see "Configure Machines" and "Assign Server Instances to Machines" in the Administration Console Online Help.
• The domain must be configured to use a domain-wide administration port as described in "Configure the domain-wide administration port" in the Administration Console Online Help.

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 

Argument	Definition
-url secure-protocol://listen-address:listen-port	You must specify the Administration Server and domain-wide administration port as follows: t3s://Admin-Server-listen-address:domain-wide-admin-port or https://Admin-Server-listen-address:domain-wide-admin-port For more information, see the -url entry in Table 2-2 and Protocol Support.
targetServer	The name of the WebLogic Server to start in the STANDBY state.

 

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:

The Administration Server determines which machine MedRecManagedServer is configured to run on. It instructs the Node Manager that is running on that machine to start MedRecManagedServer in the state that the Start Mode field specifies.
The Node Manager indicates its progress by writing messages to its standard out. You can view these messages from the Administration Console on the ServerName—>Control—>Remote Start Output page.
If the command succeeds, the weblogic.Admin utility returns to the following message:

Server "MedRecManagedServer" was started ...
Please refer to server log files for completion status ... 

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 Machines—>Monitoring—>Node 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-5 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.

Table 2-5 Overview of Commands for Retrieving Information about WebLogic Server 

Command	Description
CONNECT	Makes the specified number of connections to a WebLogic Server instance and returns two numbers representing the total time for each round trip and the average amount of time (in milliseconds) that each connection is maintained. See CONNECT.
GETSTATE	Returns the current state of the specified WebLogic Server instance. See GETSTATE.
HELP	Provides syntax and usage information for all WebLogic Server commands (by default) or for a single command if a command value is specified on the HELP command line. See HELP.
LICENSES	Lists the licenses for all WebLogic Server instances that are installed on a specific server. See LICENSES.
LIST	Lists the bindings of a node in a server's JNDI naming tree. See LIST.
PING	Sends a message to verify that a WebLogic Server instance is listening on a port and is ready to accept client requests. See PING. For a similar command that returns information about all servers in a cluster, see CLUSTERSTATE.
SERVERLOG	Displays the server log file generated on a specific server instance. See SERVERLOG.
THREAD_DUMP	Provides a real-time snapshot of the WebLogic Server threads that are currently running on a particular instance. See THREAD_DUMP.
VERSION	Displays the version of the WebLogic Server software that is running on the machine specified by the value of URL. See VERSION.

 

 

---

CONNECT

Connects to a WebLogic Server instance and returns two numbers representing the total time for each round trip and the average amount of time (in milliseconds) that each connection is maintained.

Syntax

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

Argument	Definition
-url [protocol://]listen-address:listen-port	Specify the listen address and listen port of the server instance to which you want to connect. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
count	Number of connections the weblogic.Admin utility makes to the specified server instance. By default, this command makes only one connection.

 

Example

In the following example, the weblogic.Admin utility establishes 10 connections to a WebLogic Server instance whose listen address is ManagedHost and listen port is 8001:

java weblogic.Admin -url ManagedHost:8001 -username weblogic 
   -password weblogic CONNECT 10

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

If the command establishes the connections, it returns the following information:

Connection: 0 - 3,229 ms
Connection: 1 - 17 ms
Connection: 2 - 14 ms
Connection: 3 - 20 ms
Connection: 4 - 18 ms
Connection: 5 - 25 ms 
Connection: 6 - 27 ms 
Connection: 7 - 15 ms 
Connection: 8 - 15 ms
Connection: 9 - 15 ms 
  RTT = ~3422 milliseconds, or ~342 milliseconds/connection  

If the command does not establish a connection, it returns nothing.

In this example, the first connection required 3,229 milliseconds and the second connection required 17 milliseconds. The average time for all connections was 3422 milliseconds.

 

---

GETSTATE

Returns the current state of a server.

For more information about server states, see "Understanding Server Life Cycle" 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 is to shut down the server instance by killing 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 ] weblogic.Admin 
     [ Connection Arguments ] 
     [ User Credentials Arguments ]
   GETSTATE [targetServer]

Argument	Definition
targetServer	The name of the server for which you want to retrieve the current state. If you do not specify a value, the command returns the state of the server that you specified in the -url argument.

 

Example

The following example returns the state of a WebLogic Server instance that runs on a machine named AdminHost:

java weblogic.Admin -url AdminHost:7001 -username weblogic 
   -password weblogic GETSTATE

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

If the command succeeds for a running server, it returns the following:

Current state of "MedRecServer" : RUNNING

For a complete list of server states, see "Understanding Server Life Cycle" in Managing Server Startup and Shutdown.

 

---

HELP

Provides syntax and usage information for all WebLogic Server commands (by default) or for a single command if a command value is specified on the HELP command line.

You can issue this command from any computer on which the WebLogic Server is installed. You do not need to start a server instance to invoke this command, nor do you need to supply user credentials.

Syntax

java weblogic.Admin HELP [COMMAND]

Example

In the following example, information about using the PING command is requested:

java weblogic.Admin HELP PING

The command returns the following:

Usage: java [SSL trust options]
    weblogic.Admin [ [-url | -adminurl] [<protocol>://]<listen-address>:<port>]
    -username <username> -password <password>
    PING <roundTrips> <messageLength>

Where:
roundTrips = Number of pings.
messageLength = Size of the packet (in bytes) to send in each ping. The default
size is 100 bytes. Requests for pings with packets larger than 10 MB throw exceptions.

Description: Sends a message to verify that a WebLogic Server instance is listen
ing on a port and is ready to accept WebLogic client requests.

Example(s):
Connecting through a non-secured port:
java weblogic.Admin -url t3://localhost:7001 -username weblogic -password weblog
ic ping 3 100

Connecting through an SSL port of a server that uses the demonstration keys and certificates:
|java -Dweblogic.security.TrustKeyStore=DemoTrust 
weblogic.Admin -url t3s:\localhost:7001 -username weblogic -password weblogic
PING <roundTrips> <messageLength>

 

---

LICENSES

Lists the BEA licenses for all WebLogic Server instances installed on the specified host.

Syntax

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

Example

The following command returns a list of licenses for a host named AdminHost:

java weblogic.Admin -url AdminHost:7001 -username weblogic 
   -password weblogic LICENSES

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

If the command establishes a connection, it returns license information to standard out.

 

---

LIST

Lists the bindings of a node in the JNDI naming tree.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [ Connection Arguments ] 
     [ User Credentials Arguments ]
   LIST [JNDIcontextName] 

Argument	Definition
JNDIcontextName	The JNDI context for lookup, for example, weblogic, weblogic.ejb, javax. By default, the command lists the bindings immediately below the InitialContext of the specified server instance.

 

Example

The following command returns the initial context for the MedRecServer example server that runs on a machine named AdminHost:

java weblogic.Admin -url AdminHost:7011 -username weblogic 
   -password weblogic LIST

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

If the command succeeds, it returns information similar to the following abbreviated output:

Contents of InitialContext
    jms: weblogic.jndi.internal.ServerNamingNode
  javax: weblogic.jndi.internal.ServerNamingNode
  mail: weblogic.jndi.internal.ServerNamingNode
...

To view the JNDI tree below the mail context, enter the following command:

 java weblogic.Admin -url AdminHost:7011 -username weblogic 
   -password weblogic LIST mail

If the command succeeds, it returns the following:

Contents of mail
  MedRecMailSession: javax.mail.Session  

 

---

PING

Sends a message to verify that a WebLogic Server instance is listening on a port and is ready to accept WebLogic client requests.

For information on returning a description of all servers in a cluster, see CLUSTERSTATE.

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 is to shut down the server instance by killing 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 ] weblogic.Admin 
     [ Connection Arguments ] 
     [ User Credentials Arguments ]
   PING [roundTrips] [messageLength]

Argument	Definition
roundTrips	Number of pings.
messageLength	Size of the packet (in bytes) to be sent in each ping. Requests for pings with packets larger than 10 MB throw exceptions.

 

Example

The following command pings a server instance 10 times:

java weblogic.Admin -url AdminHost:7001 -username weblogic 
   -password weblogic PING 10

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

If the command succeeds, it returns output similar to the following:

Sending 10 pings of 100 bytes.
  RTT = ~46 milliseconds, or ~4 milliseconds/packet

The following command pings a server instance that is running on a host computer named ManagedHost:

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

 

---

SERVERLOG

Returns messages from the local log file of a server instance. The command returns messages only from the current log file; it does not return messages in log files that the server instance has archived (renamed) because of log file rotation.

By default, the command returns the first 500 messages from the current log file (messages within the file are ordered from oldest to newest). You can change the default behavior by specifying a time and date range, but you cannot change the number of messages to be returned. The command always returns up to 500 messages, depending on the number of messages in the log file.

For each message, the command returns the following message attributes, separated by spaces:

MessageID TimeStamp Severity Subsystem MessageText

For more information about message attributes, see "Message Attributes" in the Configuring Log Files and Filtering Log Messages.

This command can not be used to return the domain-wide log file. You can view the domain-wide log file from the Administration Console. For more information about server log files, see "View and configure logs" in the Administration Console Online Help.

Syntax

java [ SSL Arguments ] weblogic.Admin
[-url URL]
[ User Credentials Arguments ]
SERVERLOG [starttime [endtime]]

Argument	Definition
-url [protocol://]listen-address:listen-port	Specify the listen address and listen port of the server instance for which you want to retrieve the local log file. If you use the -url argument to specify the Administration Server, the command returns the local log file of the Administration Server. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
starttime	Returns up to 500 messages in the current log file with a time stamp that is after the time you specify. The date format is yyyy/mm/dd. Time is indicated using a 24-hour clock. The start date and time are entered inside quotation marks, in the following format: "yyyy/mm/dd hh:mm" By default, SERVERLOG returns up to 500 messages in chronological order starting from the beginning of the current log file.
endtime	Specifies the end of a time range and causes SERVERLOG to return up to 500 messages with a time stamp that is after starttime and before endtime. The date format is yyyy/mm/dd. Time is indicated using a 24-hour clock. The end date and time are entered inside quotation marks, in the following format: "yyyy/mm/dd hh:mm" By default, SERVERLOG returns up to 500 messages in chronological order starting with the starttime value and ending with the time at which you issued the SERVERLOG command.

 

Example

The following command returns all messages in the local log file of a server instance named MedRecManagedServer and pipes the output through the command shell's more command:

java weblogic.Admin -url ManagedHost:8001 -username weblogic 
   -password weblogic SERVERLOG | more

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

If the command succeeds, it returns output similar to the following truncated example:

130036    Oct 18, 2002 4:19:12 PM EDT Info  XML   Initializing XMLRegistry.
001007    Oct 18, 2002 4:19:13 PM EDT  Info   JDBC  Initializing... issued. 
001007    Oct 18, 2002 4:19:13 PM EDT  Info JDBC   Initialize Done issued.
190000    Oct 18, 2002 4:19:13 PM EDT   Info   Connector  Initializing J2EE Connector Service 
190001    Oct 18, 2002 4:19:13 PM EDT     Info     Connector J2EE Connector Service initialized successfully
...

The following command returns messages that were written to the local log file since 8:00 am today:

java weblogic.Admin -url ManagedHost:8001 -username weblogic 
   -password weblogic SERVERLOG 08:00

The following command returns messages that were written to the local log file between 8:00 am and 8:30 am on October 18, 2002:

java weblogic.Admin -url ManagedHost:8001 -username weblogic 
 -password weblogic SERVERLOG "2002/10/18 08:00" "2002/10/18 08:30"

 

---

THREAD_DUMP

Prints a snapshot of the WebLogic Server threads that are currently running for a specific server instance. The server instance prints the snapshot to its standard out.

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 is to shut down the server instance by killing 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.

Note: The THREAD_DUMP command is supported only on Sun JVM and BEA JRockit^®.

Syntax

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

Example

The following example causes a server instance that is running on a host named ManagedHost to print a thread dump to standard out:

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

If the command succeeds, the command itself returns the following:

Thread Dump is available in the command window that is running the server.

The server instance prints a thread dump to its standard out, which, by default, is the shell (command prompt) within which the server instance is running.

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

 

---

VERSION

Displays the version of the WebLogic Server software that is running the server instance you specify with the -url argument.

Syntax

java weblogic.Admin [-url URL] -username username 
   [-password password] VERSION

Argument	Definition
-url [protocol://]listen-address:listen-port	Specify the listen address and listen port of a WebLogic Server instance. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.

 

Example

The following command displays the version of the WebLogic Server software that is currently running on a host named ManagedHost:

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

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

If the command succeeds, it returns output similar to the following:

WebLogic Server 9.0  Sat Oct 15 22:51:04 EDT 2002 207896
WebLogic XMLX Module 9.0  Sat Oct 15 22:51:04 EDT 2002 207896

 

---

Commands for Managing JDBC Connection Pools

Table 2-6 lists the WebLogic Server administration commands for connection pools. Subsequent sections describe command syntax and arguments, and provide an example for each command.

For additional information about connection pools see "Simplified JDBC Resource Configuration" in Programming WebLogic JDBC.

Note: All JDBC commands are privileged commands. You must supply the username and password for a WebLogic Server administrative user to use these commands.

Table 2-6 Overview of Commands for Managing JDBC Connection Pools

Command	Description
CREATE_POOL	Creates a connection pool. See CREATE_POOL.
DESTROY_POOL	Closes all connections in the connection pool and deletes the connection pool configuration. See DESTROY_POOL.
DISABLE_POOL	Temporarily disables a connection pool, preventing any clients from obtaining a connection from the pool. See DISABLE_POOL.
ENABLE_POOL	Enables a connection pool after it has been disabled. The JDBC connection states for each in-use connection are exactly as they were when the connection pool was disabled; clients can continue JDBC operations exactly where they left off. See ENABLE_POOL.
TEST_POOL	Tests a connection pool by reserving and releasing a connection from the connection pool. Requires testConnsOnReserve or testConnsOnRelease to be true and testTableName must be set. See TEST_POOL
RESET_POOL	Closes and reopens all allocated connections in a connection pool. This may be necessary after the DBMS has been restarted, for example. Often when one connection in a connection pool has failed, all of the connections in the pool are bad. See RESET_POOL.
EXISTS_POOL	Tests whether a connection pool with a specified name exists in a specified WebLogic Server instance. Use this command to determine whether a dynamic connection pool has already been created or to ensure that you select a unique name for a dynamic connection pool you want to create. See EXISTS_POOL.

 

 

---

CREATE_POOL

Creates a connection pool on the WebLogic Server instance running at the specified URL.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [ Connection Arguments ] 
     [ User Credentials Arguments ]
   CREATE_POOL poolName props=myProps,initialCapacity=1,maxCapacity=1,
   capacityIncrement=1,allowShrinking=true,shrinkPeriodMins=15,
   driver=myDriver,url=myURL, testConnsOnReserve=true,
   testTableName=tablename

Argument	Definition
poolName	Required. A unique name of the connection pool. Must be unique in the domain.
aclName	Identifies the different access lists within fileRealm.properties in the server configuration directory. Paired name must be dynaPool.
props	Required. Database connection properties; typically in the format "database login name; server network id". Required entries vary by DBMS. Separate property value pairs with a semicolon.
password	Optional. Database login password. This value overrides any database password specified in props.
initialCapacity	Optional. Initial number of connections in a pool. If this property is defined, WebLogic Server creates these connections at boot time. Default is 1; cannot exceed maxCapacity.
maxCapacity	Optional. Maximum number of connections allowed in the pool. Default is 1; if defined, maxCapacity should be =>1.
capacityIncrement	Optional. Number of connections to add at a time when the connection pool is expanded. Default = 1.
allowShrinking	Optional. Indicates whether or not the pool can shrink when connections are detected to not be in use. Default = true.
shrinkPeriodMins	Optional. Interval between shrinking. Units in minutes. Minimum = 1. If allowShrinking = True, then default = 15 minutes.
driver	Required. Fully qualified driver classname of the JDBC driver.
url	Required. URL of the database as required by the JDBC driver. Format varies by DBMS.
testConnsOnReserve	Optional. Indicates reserved test connections. Default = False.
testConnsOnRelease	Optional. Indicates test connections when they are released. Default = False.
testTableName	Optional. Database table used when testing connections; must be present for tests to succeed. Required if either testConnsOnReserve or testConnsOnRelease are defined. Can also be a SQL query instead of a database table name. To use a SQL query, enter SQL followed by a space and the SQL query to run in place of the standard test.
refreshPeriod	Optional. Sets the connection refresh interval in minutes. Every unused connection will be tested using testTableName. Connections that do not pass the test will be closed and reopened in an attempt to reestablish a valid physical database connection. If TestTableName is not set then the test will not be performed.
loginDelaySecs	Optional. The number of seconds to delay before creating each physical database connection. This delay takes place both during initial pool creation and during the lifetime of the pool whenever a physical database connection is created. Some database servers cannot handle multiple requests for connections in rapid succession. This property allows you to build in a small delay to let the database server catch up. This delay takes place both during initial pool creation and during the lifetime of the pool whenever a physical database connection is created.

 

Example

The following example creates a connection pool named demoPool on the MedRecManagedServer instance running on the host machine named ManagedHost and listening at port 8001:

java weblogic.Admin -url t3://ManagedHost:8001 -username weblogic
   -password weblogic CREATE_POOL demoPool
   url=jdbc:pointbase:server://localhost:9092/demo,
   driver=com.pointbase.jdbc.jdbcUniversalDriver,
   testConnsOnReserve=true,
   testTableName=SYSTABLES,
   initialCapacity=2
   maxCapacity=10
   capacityIncrement=2
   allowShrinking=true
   props=user=examples;password=examples

If the command succeeds, it returns output similar to the following:

Connection pool "demoPool" created successfully.

 

---

DESTROY_POOL

Connections are closed and removed from the pool and the pool is destroyed when it has no remaining connections.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [-url URL]
     [ User Credentials Arguments ]
   DESTROY_POOL poolName [true|false]

Argument	Definition
-url [protocol://]listen-address:listen-port	Specify the listen address and listen port of the Administration Server. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
poolName	Required. Unique name of pool.
false (soft shutdown)	Soft shutdown waits for connections to be returned to the pool before closing them.
true (default—hard shutdown)	Hard shutdown kills all connections immediately. Clients using connections from the pool get exceptions if they attempt to use a connection after a hard shutdown.

 

Example

The following command destroys a connection pool named demoPool in a WebLogic Domain with the Administration Server running on a machine named AdminHost and listening at port 7001.

java weblogic.Admin -url AdminHost:7001 -username weblogic
   -password weblogic DESTROY_POOL demoPool false

 

---

DISABLE_POOL

You can temporarily disable a connection pool, preventing any clients from obtaining a connection from the pool.

You have the following options for disabling a pool. 1) Freeze the connections in a pool that you later plan to enable, or 2) Destroy the connections.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [-url URL]
     [ User Credentials Arguments ]
   DISABLE_POOL -poolName connection_pool_name [true|false]

Argument	Definition
-url [protocol://]listen-address:listen-port	Optional. Specify the listen address and listen port of a WebLogic Server instance on which the connection pool has been deployed. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
-poolName	Name of the connection pool.
false (disables and suspends)	Disables the connection pool, and suspends clients that currently have a connection. Attempts to communicate with the database server throw an exception. Clients can, however, close their connections while the connection pool is disabled; the connections are then returned to the pool and cannot be reserved by another client until the pool is enabled.
true (default—disables and destroys)	Disables the connection pool, and destroys the client's JDBC connection to the pool. Any transaction on the connection is rolled back and the connection is returned to the connection pool.

 

Example

In the following example, the command disables a connection pool named demoPool in a WebLogic domain where the Administration Server is running on a machine named AdminHost and listening at port 7001. This command freezes connections to be enabled later:

java weblogic.Admin -url AdminHost:7001 -username weblogic
   -password weblogic DISABLE_POOL -poolName demoPool false

 

---

ENABLE_POOL

When a pool is enabled, the JDBC connection states for each in-use connection are exactly as they were when the connection pool was disabled; clients can continue JDBC operations exactly where they left off.

Syntax

java weblogic.Admin [-url URL]
   -username username [-password password]
   ENABLE_POOL -poolName connection_pool_name

Argument	Definition
-url [protocol://]listen-address:listen-port	Optional. Specify the listen address and listen port of a WebLogic Server instance on which the connection pool has been deployed and is disabled. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
-poolName	Name of the connection pool.

 

Example

In the following command, a connection pool named demoPool is re-enabled after being disabled:

java weblogic.Admin -url AdminHost:7001 -username weblogic
   -password weblogic ENABLE_POOL -poolName demoPool

 

---

TEST_POOL

Reserves and releases a connection from the connection pool. The command also runs a test query using the connection, either before reserving the connection or after releasing the connection, to make sure the database is available. This command requires that either testConnsOnReserve or testConnsOnRelease is set to true and testTableName is specified.

Note: The TEST_POOL command tests an individual instance of the connection pool. To test all instances (deployments) of the connection pool, repeat the command for each instance in your configuration.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [-url URL]
     [ User Credentials Arguments ]
   TEST_POOL -poolName connection_pool_name

Argument	Definition
-url [protocol://]listen-address:listen-port	Specify the listen address and listen port of a WebLogic Server instance on which the connection pool has been deployed. Providing the url of a server on which the connection pool has NOT been deployed will return incorrect results. If the pool is deployed on multiple servers, run the command multiple times, each time pointing to one server instance on which the connection pool has been deployed. Running the command on only one server instance DOES NOT return the overall, aggregated status of the pool. See Note on page 57. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, refer to the -url entry in Table 2-3 on page 11 and Protocol Support.
-poolName	Name of the connection pool as listed in the configuration file (config.xml).

 

Example

This command tests the connection pool registered as MedRecPool and deployed on a server that listens on port 8001 of the host ManagedHost:

java weblogic.Admin -url ManagedHost:8001 -username weblogic -password weblogic TEST_POOL -poolName MedRecPool

If the command succeeds, it returns the following:

JDBC Connection Test Succeeded for connection pool "MedRecPool".

 

---

RESET_POOL

This command closes and reopens the database connections in a connection pool.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [-url URL]
     [ User Credentials Arguments ]
   RESET_POOL -poolName connection_pool_name

Argument	Definition
-url [protocol://]listen-address:listen-port	Optional. Specify the listen address and listen port of a WebLogic Server instance on which the connection pool has been deployed. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
-poolName	Name of the connection pool as listed in the configuration file (config.xml).

 

Example

This command closes and reopens database connection in the connection pool named demoPool for the WebLogic Server instance listening on port 7001 of the host AdminHost.

 java weblogic.Admin -url AdminHost:7001 -username weblogic
   -password weblogic RESET_POOL -poolName demoPool

 

---

EXISTS_POOL

Tests whether a connection pool with a specified name exists in the WebLogic Server domain. You can use this method to determine whether a dynamic connection pool has already been created or to ensure that you select a unique name for a dynamic connection pool you want to create.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [-url URL]
     [ User Credentials Arguments ]
   EXISTS_POOL -poolName connection_pool_name

Argument	Definition
-url [protocol://]listen-address:listen-port	Specify the listen address and listen port of the Administration Server. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
-poolName	Name of connection pool.

 

Example

The following command determines wether or not a pool with a specific name exists:

java weblogic.Admin -url AdminHost:7001 -username weblogic
   -password weblogic EXISTS_POOL -poolName demoPool

 

---

Commands for Managing WebLogic Server MBeans

The following sections describe weblogic.Admin commands for managing WebLogic Server MBeans.

• Specifying MBean Types
• MBean Management Commands

"WebLogic Server MBean Reference" provides a detailed reference for all WebLogic Server MBeans.

Specifying MBean Types

To specify which MBean or MBeans you want to access, view, or modify, all of the MBean management commands require either the -mbean argument or the -type argument.

Use the -mbean argument to operate on a single instance of an MBean.

Use the -type argument to operate on all MBeans that are an instance of a type that you specify. An MBean's type refers to the interface class of which the MBean is an instance. All WebLogic Server MBeans are an instance of one of the interface classes defined in the weblogic.management.configuration or weblogic.management.runtime packages. For configuration MBeans, type also refers to whether an instance is an Administration MBean or a Local Configuration MBean. For a complete list of all WebLogic Server MBean interface classes, see the Type-Safe Access for WebLogic Server MBeans (Deprecated) for the weblogic.management.configuration or weblogic.management.runtime packages.

To determine the value that you provide for the -type argument, do the following:

Find the MBean's interface class and remove the MBean suffix from the class name. For an MBean that is an instance of the weblogic.management.runtime.JDBCConnectionPoolRuntimeMBean, use JDBCConnectionPoolRuntime.
For a Local Configuration MBean, append Config to the name. For example, for a Local Configuration MBean that is an instance of the weblogic.management.configuration.JDBCConnectionPoolMBean interface class, use JDBCConnectionPoolConfig. For the corresponding Administration MBean instance, use JDBCConnectionPool.

MBean Management Commands

Table 2-7 is an overview of the MBean management commands.

Table 2-7 MBean Management Command Overview 

Command	Description
CREATE	Creates an Administration MBean instance. This command cannot be used for Runtime MBeans or Local Configuration MBeans. See CREATE.
DELETE	Deletes an MBean instance. See DELETE.
GET	Displays properties of MBeans. See GET.
INVOKE	Invokes management operations that an MBean exposes for its underlying resource. See INVOKE.
QUERY	Searches for MBeans whose WebLogicObjectName matches a pattern that you specify. See QUERY.
SET	Sets the specified property values for the named MBean instance. This command cannot be used for Runtime MBeans. See SET.

 

 

---

CREATE

Creates an instance of a WebLogic Server Administration MBean. This command cannot be used for Runtime MBeans or Local Configuration MBeans.

If the command is successful, it returns OK.

When you use this command, WebLogic Server populates the Administration MBean with default values and saves the MBean's configuration in the domain's config.xml file. For some types of Administration MBeans, WebLogic Server does not create the corresponding Local Configuration MBean replica until you restart the server instance that hosts the underlying managed resource. For example, if you create a JDBCConnectionPool Administration MBean to manage a JDBC connection pool on a Managed Server named ManagedMedRecServer, you must restart ManagedMedRecServer so that it can create its local replica of the JDBCConnectionPool Administration MBean that you created. For more information on MBean replication and the life cycle of MBeans, see "Understanding WebLogic Server MBeans" in Developing Custom Management Utilities with JMX.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     -url URL
     [ User Credentials Arguments ]
   CREATE -name name -type mbeanType 

or

java [ SSL Arguments ] weblogic.Admin 
     [-url URL]
     [ User Credentials Arguments ]
   CREATE -mbean objectName 

Argument	Definition
-url [protocol://]listen-address:listen-port	Specify the listen address and listen port of the Administration Server. You can create Administration MBeans only on the Administration Server. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
-name name	The name you choose for the MBean that you are creating.
-type mbeanType	The type of MBean that you are creating. For more information, see Specifying MBean Types.
-mbean objectName	Fully qualified object name of an MBean in the WebLogicObjectName format. For example: "domain:Type=type,Name=name" For more information, see the Javadoc for WebLogicObjectName.

 

Example

The following example uses the -name and -type arguments to create a JDBCConnectionPool Administration MBean named myPool on an Administration Server:

java weblogic.Admin -url AdminHost:7001 -username weblogic 
   -password weblogic CREATE -name myPool -type JDBCConnectionPool

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

If the command succeeds, it prints the following to standard out:

Ok

The following example uses the -mbean argument and WebLogicObjectName conventions to create a JDBCConnectionPool Administration MBean named myPool on an Administration Server:

java weblogic.Admin -url AdminHost:7001 -username weblogic
   -password weblogic 
    CREATE -mbean "mydomain:Type=JDBCConnectionPool,Name=myPool"

 

---

DELETE

Deletes MBeans. If you delete an Administration MBean, WebLogic Server removes the corresponding entry from the domain's config.xml file.

If the command is successful, it returns OK.

Note: When you delete an Administration MBean, a WebLogic Server instance does not delete the corresponding Configuration MBean until you restart the server instance.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [ {-url URL} |   
       {-adminurl[protocol://]Admin-Server-listen-address:listen-port}
     ]
     [ User Credentials Arguments ]
   DELETE {-type mbeanType|-mbean objectName}

Arguments	Definition
{-url [protocol://]listen-address:listen-port} or {-adminurl [protocol://]Admin-Server-listen-address:listen-port}	To delete Administration MBeans, use -url to specify the Administration Server's listen address and listen port. To delete Runtime MBeans or Local Configuration MBeans, use one of the following: -url to specify the listen address and listen port of the server instance on which you want to delete MBeans. -adminurl to delete instances of a Runtime or Local Configuration MBean type from all server instances in the domain. For more information, see the -url and -adminurl entries in Table 2-3 and Protocol Support.
-type mbeanType	Deletes all MBeans of the specified type. For more information, see Specifying MBean Types.
-mbean objectName	Fully qualified object name of an MBean in the WebLogicObjectName format. For example: "domain:Type=type,Name=name" For more information, see the Javadoc for WebLogicObjectName.

 

Example

The following example deletes the JDBCConnectionPool Administration MBean named myPool:

java weblogic.Admin -url AdminHost:7011 -username weblogic 
 -password weblogic DELETE -mbean
 MedRec:Name=myPool,Type=JDBCConnectionPool

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

If the command succeeds, it prints the following to standard out:

Ok

 

---

GET

Displays MBean properties (attributes) and JMX object names (in the WebLogicObjectName format).

The output of the command is as follows:

{MBeanName object-name {property1 value} {property2 value}. . .} 
. . .

Note that the properties and values are expressed as name-value pairs, each of which is returned within curly brackets. This format facilitates parsing of the output by a script.

If -pretty is specified, each property-value pair is displayed on a new line and curly brackets are not used to separate the pairs:

MBeanName: object-name
property1: value
property2: value
.
.
.
MBeanName: object-name
property1: value
abbribute2: value

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [ {-url URL} |   
       {-adminurl[protocol://]Admin-Server-listen-address:listen-port}
     ]
     [ User Credentials Arguments ]
   GET [-pretty] {-type mbeanType|-mbean objectName} 
   [-property property1] [-property property2]...

Argument	Definition
{-url [protocol://]listen-address:listen-port} or {-adminurl [protocol://]Admin-Server-listen-address:listen-port}	To retrieve Administration MBeans, use -url to specify the Administration Server's listen address and listen port. To retrieve Runtime MBeans or Local Configuration MBeans, use one of the following: -url to specify the listen address and listen port of the server instance on which you want to retrieve MBeans. -adminurl to retrieve instances of a Runtime or Local Configuration MBean type from all server instances in the domain. For more information, see the -url and -adminurl entries in Table 2-3 and Protocol Support.
-type mbeanType	Returns information for all MBeans of the specified type. For more information, see Specifying MBean Types.
-mbean objectName	Fully qualified object name of an MBean in the WebLogicObjectName format: "domain:Type=type,Location=location,Name=name" For more information, see the Javadoc for WebLogicObjectName.
-pretty	Places property-value pairs on separate lines.
-property property	The name of the MBean property (attribute) or properties to be listed. Note: If property is not specified using this argument, all properties are displayed.

 

Example

The following example displays all properties of the JDBCConnectionPool Administration MBean for a connection pool named MedRecPool. Note that the command must connect to the Administration Server to retrieve information from an Administration MBean:

java weblogic.Admin -url AdminHost:7011 -username weblogic 
 -password weblogic GET -pretty -mbean
 MedRec:Name=MedRecPool,Type=JDBCConnectionPool

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

If the command succeeds, it returns output similar to the following truncated example:

---------------------------
MBeanName: "MedRec:Name=MedRecPool,Type=JDBCConnectionPool"
        ACLName:
        CachingDisabled: true
        CapacityIncrement: 1
        ConnLeakProfilingEnabled: false
        ConnectionCreationRetryFrequencySeconds: 0
        ConnectionReserveTimeoutSeconds: 10
...

The following example displays all instances of all JDBCConnectionPoolRuntime MBeans for all servers in the domain.

java weblogic.Admin -adminurl AdminHost:7001 -username weblogic 
 -password weblogic GET -pretty -type JDBCConnectionPoolRuntime

The following example displays all instances of all JDBCConnectionPoolRuntime MBeans that have been deployed on the server instance that listens on ManagedHost:8001:

java weblogic.Admin -url ManagedHost:8001 -username weblogic 
 -password weblogic GET -pretty -type JDBCConnectionPoolRuntime 

 

---

INVOKE

Invokes a management operation for one or more MBeans. For WebLogic Server MBeans, you usually use this command to invoke operations other than the getAttribute and setAttribute that most WebLogic Server MBeans provide.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [ {-url URL} |   
       {-adminurl[protocol://]Admin-Server-listen-address:listen-port}
     ]
     [ User Credentials Arguments ]
   INVOKE {-type mbeanType|-mbean objectName} -method 
   methodname [argument . . .]

Arguments	Definition
{-url [protocol://]listen-address:listen-port} or {-adminurl [protocol://]Admin-Server-listen-address:listen-port}	To invoke operations for Administration MBeans, use -url to specify the Administration Server's listen address and listen port. To invoke operations for Runtime MBeans, use one of the following: -url to specify the listen address and listen port of the server instance on which you want to invoke Runtime MBean operations. -adminurl to invoke operations for all instances of a Runtime MBean on all server instances in the domain. We recommend that you do not invoke operations for Local Configuration MBeans. Instead, invoke the operation on the corresponding Administration MBean.
-type mbeanType	Invokes the operation on all MBeans of a specific type. For more information, see Specifying MBean Types.
-mbean objectName	Fully qualified object name of an MBean, in the WebLogicObjectName format: "domain:Type=type,Location=location,Name=name" For more information see the Javadoc for WebLogicObjectName.
-method methodname	Name of the method to be invoked.
argument	Arguments to be passed to the method call. When the argument is a String array, the arguments must be passed in the following format: "String1;String2;. . . "

 

Example

The following example enables a JDBC connection pool by invoking the enable method of the JDBCConnectionPoolRuntime MBean:

java weblogic.Admin -url AdminHost:7011 -username weblogic 
 -password weblogic INVOKE
 -mbean MedRec:Location=MedRecServer,Name=myPool,
  ServerRuntime=MedRec,Type=JDBCConnectionPoolRuntime 
 -method enable

If the command succeeds, it returns the following:

{MBeanName="MedRec:Location=MedRecServer,Name=MedRecPool,ServerRuntime=Med
RecServer,Type=JDBCConnectionPoolRuntime"} 

Ok

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

The following example enables all JDBC connection pools in the domain by invoking the enable method of all the JDBCConnectionPoolRuntime MBeans:

java weblogic.Admin -adminurl AdminHost:7001 -username weblogic 
 -password weblogic INVOKE
 -type JDBCConnectionPoolRuntime -method enable

 

---

QUERY

Searches for WebLogic Server MBeans whose WebLogicObjectName matches a pattern that you specify.

All MBeans that are created from a WebLogic Server MBean type are registered in the MBean Server under a name that conforms to the weblogic.management.WebLogicObjectName conventions. You must know an MBean's WebLogicObjectName if you want to use weblogic.Admin commands to retrieve or modify specific MBean instances. For more information, See "WebLogic Server MBean Object Names" in Developing Custom Management Utilities with JMX.

The output of the command is as follows:

{MBeanName object-name {property1 value} {property2 value}. . .} 
. . .

Note that the properties and values are expressed as name-value pairs, each of which is returned within curly brackets. This format facilitates parsing of the output by a script.

If -pretty is specified, each property-value pair is displayed on a new line and curly brackets are not used to separate the pairs:

MBeanName: object-name
property1: value
property2: value
.
.
.
MBeanName: object-name
property1: value
abbribute2: value

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [ {-url URL} |   
       {-adminurl[protocol://]Admin-Server-listen-address:listen-port}
     ]
     [ User Credentials Arguments ]
   QUERY -pretty -pattern object-name-pattern 

Argument	Definition
{-url [protocol://]listen-address:listen-port} or {-adminurl [protocol://]Admin-Server-listen-address:listen-port}	To search for Administration MBean object names, use -url to specify the Administration Server's listen address and listen port. To search for the object names of Local Configuration or Runtime MBeans, use one of the following: -url to specify the listen address and listen port of the server instance on which you want to search. -adminurl to search on all server instances in the domain. For more information, see the -url and -adminurl entries in Table 2-3 and Protocol Support.
-pretty	Places property-value pairs on separate lines.
-pattern	A partial WebLogicObjectName for which the QUERY command searches. The value must conform to the following pattern: domain-name:property-list For the domain-name portion of the pattern, you can use the * character, which matches any character sequence. Because the server instance that you specify with the -url or -adminurl argument can access only the MBeans that belong to its domain, the * character is sufficient. For example, if you use -url to specify a server in the MedRec domain, QUERY can only return MBeans that are in the MedRec domain. It cannot search for MBeans in a domain named mydomain. For the property-list portion of the pattern, specify one or more components (property-value pairs) of a WebLogicObjectName. For a list of all WebLogicObjectName property-value pairs, See "WebLogic Server MBean Object Names" in Developing Custom Management Utilities with JMX. (For example, all WebLogicObjectNames include Name=value and Type=value property-value pairs.) You can specify these property-value pairs in any order. Within a given naming property-value pair, there is no pattern matching. Only complete property-value pairs are used in pattern matching. However, you can use the * wildcard character in the place of one or more property-value pairs. For example, Name=Med* is not valid, but Name=MedRecServer,* is valid. If you provide at least one property-value pair in the property-list, you can locate the wildcard anywhere in the given pattern, provided that the property-list is still a comma-separated list.

 

Example

The following example searches for all JDBCConnectionPoolRuntime MBeans that are on a server instance that listens at ManagedHost:8001:

java weblogic.Admin -url ManagedHost:8001 -username weblogic 
 -password weblogic QUERY
 -pattern *:Type=JDBCConnectionPoolRuntime,*

If the command succeeds, it returns the following:

Ok

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

The following example searches for all instances of MedRecPool MBeans on all servers in the current domain. It uses -adminurl, which instructs the Administration Server to query the Administration MBeanHome interface (This interface has access to all MBeans in the domain):

java weblogic.Admin -adminurl AdminHost:7011 -username weblogic 
 -password weblogic QUERY -pattern *:Name=MedRecPool,*

If the command succeeds, it returns an instance of the JDBCConnectionPool Administration MBean that is named MedRecPool, along with all corresponding Local Configuration and Runtime MBeans.

 

---

SET

Sets the specified property (attribute) values for a configuration MBean. This command cannot be used for Runtime MBeans or Local Configuration MBeans.

If the command is successful, it returns OK and saves the new values to the config.xml file.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [-url URL]
     [ User Credentials Arguments ]
   SET {-type mbeanType|-mbean objectName}
   -property property1 property1_value 
   [-property property2 property2_value] . . .

Argument	Definition
-url [protocol://]listen-address:listen-port	Specifies the listen address and listen port of the Administration Server. Only the Administration Server can access Administration MBeans. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
-type mbeanType	Sets the properties for all MBeans of a specific type. For more information, see Specifying MBean Types.
-mbean objectName	Fully qualified object name of an MBean in the WebLogicObjectName format. For example: "domain:Type=type,Name=name" For more information, see the Javadoc for WebLogicObjectName.
-property property	The name of the property to be set.
property _value	The value to be set. Some properties require you to specify the name of a WebLogic Server MBean. In this case, specify the fully qualified object name of an MBean in the WebLogicObjectName format. For example: "domain:Type=type,Name=name" For more information, see the Javadoc for WebLogicObjectName. When the property value is an MBean array, separate each MBean object name by a semicolon and surround the entire property value list with quotes: "domain:Name=name,Type=type;domain:Name=name,Type=type" When the property value is a String array, separate each string by a semicolon and surround the entire property value list with quotes: "String1;String2;. . . " When the property value is a String or String array, you can set the value to null by using either of the following: -property property-name "" -property property-name For example, both -property ListenAddress "" and -property ListenAddress set the listen address to null. If the property value contains spaces, surround the value with quotes: "-Da=1 -Db=3" For example: SET -type ServerStart -property Arguments "-Da=1 -Db=3" When setting the properties for a JDBC Connection Pool, you must pass the arguments in the following format: "user:username;password:password;server:servername"

 

Example

The following example sets to 64 the StdoutSeverityLevel property of ServerMBean for a server named MedRecManagedServer:

java weblogic.Admin -url http://AdminHost:7011 
  -username weblogic -password weblogic 
  SET -mbean
  MedRec:Location=MedRecManagedServer,Name=MedRecManagedServer,
  Type=ServerConfig
 -property StdoutSeverityLevel 64

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

If the command succeeds, the server instance writes a log message similar to the following:

<Sep 16, 2002 12:11:27 PM EDT> <Info> <Logging> <000000> <Log messages of every severity will be displayed in the shell console.>

The command prints Ok to standard out.

The following example sets to 64 the StdoutSeverityLevel property for all administration instances of ServerMBean in the current domain:

java weblogic.Admin -url http://AdminHost:7001 
  -username weblogic -password weblogic 
  SET -type Server -property StdoutSeverityLevel 64

 

---

Running Commands in Batch Mode

By default, each weblogic.Admin command that you invoke starts a JVM, acts on a server instance, and then shuts down the JVM. To improve performance for issuing several weblogic.Admin commands in an uninterrupted sequence, you can use the BATCHUPDATE command to run multiple commands in batch mode. The BATCHUPDATE command starts a JVM, runs a list of commands, and then shuts down the JVM.

For example, if a domain contains multiple server instances, you can create a file that returns the listen ports of all Managed Servers in a domain. Then you specify this file as an argument in weblogic.Admin BATCHUPDATE command.

 

---

BATCHUPDATE

Runs a sequence of weblogic.Admin commands. All output from commands that BATCHUPDATE runs is printed to standard out.

Using this command provides better performance than issuing a series of individual weblogic.Admin commands. For more information, see the previous section, Running Commands in Batch Mode.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [ {-url URL} |   
       {-adminurl[protocol://]Admin-Server-listen-address:listen-port}
     ]
     [ User Credentials Arguments ]
    BATCHUPDATE -batchFile fileLocation   
   [-continueOnError] [-batchCmdVerbose] 

Argument	Definition
{-url [protocol://]listen-address:listen-port} or {-adminurl [protocol://]Admin-Server-listen-address:listen-port}	If the batch file contains commands that access Administration MBeans, use -url to specify the Administration Server's listen address and listen port. If the batch file contains commands that access Local Configuration or Runtime MBeans, use one of the following: -url to specify the listen address and listen port of the server instance on which you want to access MBeans. -adminurl to access all Local Configuration or Runtime MBeans in the domain. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url and -adminurl entries in Table 2-2 and Protocol Support.
-batchfile fileLocation	The name of a text file that contains a list of weblogic.Admin commands. If you use a relative pathname, the root context is the directory from which you issue the weblogic.Admin BATCHUPDATE command. The file must contain one or more commands, formatted as follows: COMMAND-NAME arguments Place each command on a separate line. Within the batch file, the BATCHUPDATE command ignores any line that begins with a # character. Note: Quoted MBean names are allowed in the batch file.
-continueOnError	If one of the commands fails or emits errors, weblogic.Admin ignores the error and continues to the next command. By default, weblogic.Admin stops processing commands as soon as it encounters an error.
-batchCmdVerbose	Causes BATCHUPDATE to indicate which command it is currently invoking. As it invokes a command, BATCHUPDATE prints the following to standard out: Executing command: command-from-batchfile

 

Example

This example uses the BATCHUPDATE command to return the listen ports for a collection of server instances in a domain. A file named commands.txt contains the following lines:

get -mbean MedRec:Name=MedRecServer,Type=Server -property ListenPort
get -mbean MedRec:Name=MedRecManagedServer,Type=Server -property ListenPort     

The following command invokes the commands in commands.txt:

java weblogic.Admin -url AdminHost:7011 -username weblogic -password weblogic BATCHUPDATE -batchFile c:\commands.txt -continueOnError -batchCmdVerbose

If the command succeeds it outputs the following to standard out:

Executing command: get -mbean MedRec:Name=MedRecServer,Type=Server -property ListenPort
{MBeanName="MedRec:Name=MedRecServer,Type=Server"{ListenPort=7011}}
Executing command: get -mbean MedRec:Name=MedRecManagedServer,Type=Server -property ListenPort
{MBeanName="MedRec:Name=MedRecManagedServer,Type=Server"{ListenPort=7021}} 

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

 

---

Commands for Working with Clusters

Table 2-8 is an overview of the commands for working with clusters. Subsequent sections describe command syntax and arguments, and provide an example for each command.

Table 2-8 MBean Management Command Overview 

Command	Description
CLUSTERSTATE	Returns the number and state of servers in a cluster. See CLUSTERSTATE.
MIGRATE	Migrates a JMS service or a JTA service from one server instance to another within a cluster. See MIGRATE.
STARTCLUSTER	Starts all servers in a cluster See STARTCLUSTER.
STOPCLUSTER	Forces all servers in a cluster to shut down. See STOPCLUSTER.
VALIDATECLUSTERCONFIG	Parses the domain's configuration file and reports any discrepancies in all cluster-related elements. See VALIDATECLUSTERCONFIG.

 

 

---

CLUSTERSTATE

Returns the number and state of servers in a cluster.

Syntax

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

Argument	Definition
{-url [protocol://]listen-address:listen-port}	Specify the listen address and listen port of any server instance that is currently active and that belongs to the cluster. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
-clusterName clusterName	The name of the cluster as specified in the domain's configuration file (config.xml).

 

Example

The following example returns information about a cluster:

java weblogic.Admin -url AdminHost:7011 
  -username weblogic -password weblogic 
  CLUSTERSTATE -clustername MedRecCluster

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

If the command succeeds, it returns output similar to the following:

There are 3 server(s) in cluster: MedRecCluster

The alive servers and their respective states are listed below:
MedRecManagedServer2---RUNNING
MedRecManagedServer3---RUNNING

The other server(s) in the cluster that are not active are:
MedRecManagedServer1

 

---

MIGRATE

Migrates a JMS service or a JTA Transaction Recovery service to a targeted server within a server cluster.

For more information about migrating services, see "Service Migration" in the Using WebLogic Clusters guide.

Syntax

To migrate JMS resources:

java [ SSL Arguments ] weblogic.Admin 
     [-url URL]
     [ User Credentials Arguments ]
  MIGRATE -migratabletarget "serverName (migratable)"
  -destination serverName [-sourcedown] [-destinationdown]

To migrate JTA resources:

java [ SSL Arguments ] weblogic.Admin 
     [-url URL]
     [ User Credentials Arguments ]
  MIGRATE -jta -migratabletarget serverName
  -destination serverName [-sourcedown] [-destinationdown]

Argument	Definition
{-url [protocol://]listen-address:listen-port}	Specify the listen address and listen port of the Administration Server. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
-jta	Specifies that the migration is a migration of JTA services. If you do not specify this argument, the MIGRATE command migrates JMS services.
-migratabletarget	Names the server from which the service will migrate. The syntax for the server name varies depending on the type of service you are migrating: For JMS, specify "servername (migratable)" For example, "myserver (migratable)" For JTA, specify servername For example, myserver
-destination	Names the server to which the service will migrate.
-sourcedown	Specifies that the source server is down. This switch should be used very carefully. If the source server is not in fact down, but only unavailable because of network problems, the service will be activated on the destination server without being removed from the source server, resulting in two simultaneous running versions of the same service, which could cause corruption of the transaction log or of JMS messages.
-destinationdown	Specifies that the destination server is down. When migrating a JMS service to a non-running server instance, the server instance will activate the JMS service upon the next startup. When migrating the JTA Transaction Recovery Service to a non-running server instance, the target server instance will assume recovery services when it is started.

 

Examples

In the following example, a JMS service is migrated from myserver2 to myserver3.

java weblogic.Admin -url AdminHost:7001 -username weblogic
   -password weblogic
   MIGRATE -migratabletarget "myserver2 (migratable)" 
  -destination myserver3

In the following example, a JTA Transaction Recovery service is migrated from myserver2 to myserver3.

java weblogic.Admin -url AdminHost:7001 -username weblogic
   -password weblogic
    MIGRATE -jta -migratabletarget myserver2 
   -destination myserver3 -sourcedown

 

---

STARTCLUSTER

Starts all of the servers that are in a cluster have been configured to use a Node Manager.

This command requires the following environment:

• The domain's Administration Server must be running.
• The Node Manager must be running on the Managed Server's host machine.
• The Managed Server must be configured to communicate with a Node Manager. For more information, see "Configure Machines" and "Assign Server Instances to Machines" in the Administration Console Online Help.

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 ]
   STARTCLUSTER -clusterName clusterName 

Argument	Definition
{-url [protocol://]listen-address:listen-port}	Specify the listen address and listen port of the Administration Server. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
-clusterName clusterName	The name of the cluster as specified in the domain's configuration file (config.xml).

 

Example

The following example starts a cluster:

java weblogic.Admin -url AdminHost:70011 
  -username weblogic -password weblogic 
  STARTCLUSTER -clustername Cluster

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

If the command succeeds, it returns output similar to the following:

Starting servers in cluster MedRecCluster: MedRecMS2,MedRecMS1
All servers in the cluster "MedRecCluster" started successfully. 

 

---

STOPCLUSTER

Forces all servers in a cluster to shut down without waiting for active sessions to complete.

To verify that the command succeeds for a given server instance, refer to the server's local message log and look for the following message:
<BEA-000238> <Shutdown has completed.>

Review the message time stamp to verify that it was generated by the server session for which you issued the stop command.

For more information about forced shutdowns, see "Forced Shutdown" in Managing Server Startup and Shutdown.

Syntax

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

Argument	Definition
{-url [protocol://]listen-address:listen-port}	Specify the listen address and listen port of the Administration Server. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
-clusterName clusterName	The name of the cluster as specified in the domain's configuration file (config.xml).

 

Example

The following example stops a cluster:

java weblogic.Admin -url AdminHost:7011 
  -username weblogic -password weblogic 
  STOPCLUSTER -clustername MedRecCluster 

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

If the command succeeds, it returns output similar to the following:

Shutting down servers in cluster MedRecCluster: MedRecMS2,MedRecMS1
All servers in the cluster "MedRecCluster" were issued the shutdown request.
Look in the server logs to verify the success or failure of the shutdown
request.

 

---

VALIDATECLUSTERCONFIG

Parses the domain's configuration file and reports any errors in the configuration of cluster-related elements.

You can run this command only on a WebLogic Server host that can access the domain's configuration file through the host's file system.

Syntax

java [ SSL Arguments ] weblogic.Admin 
     [-url URL]
     [ User Credentials Arguments ]
   VALIDATECLUSTERCONFIG 
   -configPath pathname 

Argument	Definition
{-url [protocol://]listen-address:listen-port}	Specify the listen address and listen port of any active server in the domain, regardless of whether it belongs to a cluster. If you specify a secure listen port, you must also specify a secure protocol. If you do not specify a value, the command assumes t3://localhost:7001. For more information, see the -url entry in Table 2-2 and Protocol Support.
-configPath pathname	The path and file name of the domain's configuration file. A relative pathname is resolved to the directory in which you issue the VALIDATECLUSTERCONFIG command.

 

Example

The following example validates the cluster-related configuration elements for the MedRec domain. In this example, the command is issued from the WL_HOME directory:

java weblogic.Admin -url AdminHost:7011 
  -username weblogic -password weblogic 
  VALIDATECLUSTERCONFIG -configpath
  samples\domains\medrec\config.xml 

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

If the cluster configuration contains errors, the command returns a message that describes the error. For example:
ERROR:Cluster name:MyCluster has an INVALID Multicast address:null Please pick an address between (224.0.0.1 and 255.255.255.255)

If the cluster configuration is free of errors, the command returns nothing.