Skip navigation.
Downloads | Product Documentation | Support

WebLogic Scripting Tool

# Introduction and Roadmap

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

- Document Scope and Audience
- Guide to This Document
- Related Documentation
- WLST Sample Scripts

# Document Scope and Audience

This document describes the BEA 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 J2EE applications using the Java 2 Platform, Enterprise Edition (J2EE) 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:

- This chapter, Introduction and Roadmap, introduces the organization of this guide and lists related documentation.
- Using the WebLogic Scripting Tool, describes how the scripting tool works, its modes of operation, and the basic steps for invoking it.
- Creating and Configuring WebLogic Domains Using WLST Offline, describes how to create a new domain or update an existing domain without connecting to a running WebLogic Server (that is, using WLST offline)—supporting the same functionality as the Configuration Wizard.
- Navigating and Editing MBeans, describes how to retrieve domain configuration and runtime information, and edit configuration or custom MBeans.
- Managing Servers and Server Life Cycle, describes using WLST to start and stop WebLogic Server instances and to monitor and manage the server life cycle.
- Automating WebLogic Server Administration Tasks, describes using scripts to automate the creation and management of domains, servers, and resources.
- WLST Command and Variable Reference, provides detailed descriptions for each of the WLST commands and variables.
- WLST Online and Offline Command Summary, summarizes WLST commands alphabetically and by online/offline usage.
- WLST Deployment Objects, describes WLST deployment objects that you can use to update a deployment plan or access information about the current deployment activity.
- FAQs: WLST, provides a list of common questions and answers.

# Related Documentation

- Using Ant Tasks to Configure and Use a WebLogic Server Domain in Developing Applications With WebLogic Server
- Administration Console Online Help
- Creating WebLogic Domains Using the Configuration Wizard
- Developing Custom Management Utilities with JMX
- WebLogic SNMP Agent Command-Line Reference

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

## 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:\``beahome``\weblogic91\samples`.

Table 1-1 summarizes WLST online sample scripts.

Table 1-1 WLST Online Sample Scripts

WLST Sample Script | Description
`cluster_creation.py` | 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.
`cluster_deletion.py` | Removes the clusters and servers created in `cluster_creation.py`.
`jdbc_data_source_creation.py` | Connects WLST to an Administration Server, starts an edit session, and creates a JDBC data source called myJDBCDataSource.
`jdbc_data_source_deletion.py` | Removes the JDBC data source created by `jdbc_data_source_creation.py`.
`configJMSSystemResource.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.
`deleteJMSSystemResource.py` | Removes the JMS System module created by `configJMSSystemResource.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-2 summarizes WLST offline sample scripts.

Table 1-2 WLST Offline Sample Script

WLST Sample Script | Description
--- | ---
`basicWLSDomain.py` | 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.
`clusterMedRecDomain.py` | 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.
`distributedQueues.py` | 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.
`sampleMedRecDomain.py` | 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. This example demonstrates steps similar to those shown in the WLST online script described in Creating a Sample Domain: Main Steps, but uses WLST offline. The script uses the Basic WebLogic Server Domain template.

In addition, BEA provides sample scripts to configure WebLogic domain resources using WLST offline and online on the dev2dev Web site. For more information, see the wlst Project Home at `https://wlst.projects.dev2dev.bea.com`.