1 Introduction and Roadmap

This section describes the contents and organization of this guide—WebLogic Scripting Tool.

Document Scope and Audience

This document describes the WebLogic Scripting Tool (WLST). It explains how you use the WLST command-line scripting interface to configure, manage, and persist changes to WebLogic Server instances and domains, and monitor and manage server runtime events.

This document is written for WebLogic Server administrators and operators who deploy Java EE applications using the Java Platform, Enterprise Edition (Java EE) from Sun Microsystems. It is assumed that readers are familiar with Web technologies and the operating system and platform where WebLogic Server is installed.

Guide to This Document

This document is organized as follows:

Related Documentation

Detailed information about Oracle WebLogic Server WLST commands, as well as custom commands for Oracle Fusion Middleware components, can be found in the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

WLST is one of several interfaces for managing and monitoring WebLogic Server. For information about the other management interfaces, see:

WLST Sample Scripts

The following sections describe the WLST online and offline sample scripts that you can run or use as templates for creating additional scripts. For information about running scripts, see Running Scripts.


The sample scripts are not installed by default. To install the server samples, you must select a custom installation of WebLogic Server and select to install the Server Examples.

WLST Online Sample Scripts

The WLST online sample scripts demonstrate how to perform administrative tasks and initiate WebLogic Server configuration changes while connected to a running server. WLST online scripts are located in the following directory: SAMPLES_HOME\server\examples\src\examples\wlst\online, where SAMPLES_HOME refers to the main examples directory of your WebLogic Server installation, such as c:\Oracle\Middleware\wlserver_10.3\samples.

Table 1-1 summarizes WLST online sample scripts.

Table 1-1 WLST Online Sample Scripts

WLST Sample Script Description

Connects WLST to an Administration Server, starts an edit session, and creates 10 Managed Servers. It then creates two clusters, assigns servers to each cluster, and disconnects WLST from the server.


Removes the clusters and servers created in cluster_creation.py.


Connects WLST to an Administration Server, starts an edit session, creates two JMS Servers, and targets them to the Administration Server. Then creates JMS topics, JMS queues, and JMS templates in a JMS System module. The JMS queues and topics are targeted using sub-deployments.


Removes the JMS System module created by configJMSSystemResource.py.


Connects WLST to an Administration Server, starts an edit session, and creates a JDBC data source called myJDBCDataSource.


Removes the JDBC data source created by jdbc_data_source_creation.py.

WLST Offline Sample Scripts

The WLST offline sample scripts demonstrate how to create domains using the domain templates that are installed with the software. The WLST offline scripts are located in the following directory: WL_HOME\common\templates\scripts\wlst, where WL_HOME refers to the top-level installation directory for WebLogic Server.

Table 1-1 summarizes WLST offline sample scripts.

Table 1-2 WLST Offline Sample Script

WLST Sample Script Description

Creates a simple WebLogic domain demonstrating how to open a domain template, create and edit configuration objects, and write the domain configuration information to the specified directory.

The sample consists of a single server, representing a typical development environment. This type of configuration is not recommended for production environments.

The script uses the Basic WebLogic Server Domain template.


Creates a single-cluster domain, creating three Managed Servers and assigning them to a cluster.

The script uses the Basic WebLogic Server Domain template and extends it using the Avitek Medical Records Sample extension template.


Demonstrates two methods for creating distributed queues.

The script uses the Basic WebLogic Server Domain template and extends it using the Avitek Medical Records Sample.


Creates a domain that defines resources similar to those used in the Avitek MedRec sample. This example does not recreate the MedRec example in its entirety, nor does it deploy any sample applications.

The script uses the Basic WebLogic Server Domain template.

In addition, sample scripts are provided that configure WebLogic domain resources using WLST offline and online on the Oracle Technology Network site at http://www.oracle.com/technology/index.html. To locate WLST sample scripts and information about WLST scripts, search for any of the following terms:

  • WLST scripts

  • WLST online scripts

  • WLST offline scripts

New and Changed WLST Features in This Release

For a comprehensive listing of the new WebLogic Server features introduced in this release, see Oracle Fusion Middleware What's New in Oracle WebLogic Server.