1 Introduction and Roadmap
- Document Scope and Audience
This document describes the Oracle 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 WebLogic domains, and monitor and manage server run-time events. - Guide to This Document
You should understand the organization of this document. - Related Documentation
- WLST Sample Scripts
Oracle Fusion Middleware provides both WLST online and offline sample scripts.
Document Scope and Audience
This document describes the Oracle 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 WebLogic domains, and monitor and manage server run-time events.
This document is written for WebLogic Server administrators and operators who deploy Java EE applications using the Java Platform, Enterprise Edition (Java EE). It is assumed that readers are familiar with Web technologies and the operating system and platform where WebLogic Server is installed.
Parent topic: Introduction and Roadmap
Guide to This Document
You should understand the organization of this document.
It 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 WebLogic Domains Using WLST Offline describes how to create a new WebLogic domain or update an existing WebLogic domain without connecting to a running WebLogic Server (that is, using WLST offline)—supporting the same functionality as the Configuration Wizard.
-
Managing the Server Life Cycle describes using WLST to start and stop WebLogic Server instances and to monitor and manage the server life cycle.
-
Navigating MBeans (WLST Online) describes how to retrieve WebLogic domain configuration and run-time information, and edit configuration or custom MBeans.
-
Configuring Existing WebLogic Domains describes using scripts to automate the creation and management of WebLogic domains, servers, and resources.
-
Updating the Deployment Plan describes using WLST to update an application's deployment plan.
-
Getting Runtime Information describes using WLST to retrieve information about the run-time state of WebLogic Server instances.
-
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.
-
WLST Deprecated Features lists the deprecated features for WLST.
Parent topic: Introduction and Roadmap
Related Documentation
For information about the WLST commands and their syntax, see:
-
WebLogic Server WLST Online and Offline Command Reference in the WLST Command Reference for WebLogic Server for the WLST commands that are available for WebLogic Server.
-
Introduction and Roadmap to the Infrastructure WLST Commands in the WLST Command Reference for Infrastructure Components for the WLST commands that are available for Oracle Fusion Middleware infrastructure components, including Java Required Files (JRF), Web services, Metadata services (MDS), Application Development Framework (ADF), Dynamic Monitoring Service (DMS), Logging, Diagnostic Framework, and User Messaging Service (UMS).
-
Introduction and Roadmap in the WLST Command Reference for Infrastructure Security for the WLST commands that are available for Oracle Fusion Middleware Infrastructure Security components, including Oracle Platform Security Services, Auditing, SSL, wallets, and OPSS Keystore Service.
-
Introduction and Roadmap in the WebCenter WLST Command Reference for the WLST commands that are available for WebCenter components, including WebCenter Portal, WebCenter Content, and WebCenter Capture.
-
Introduction and Roadmap in the WLST Command Reference for SOA Suite for the WLST commands that are available for SOA, Business Process Management (BPM), Enterprise Scheduler (ESS), and Managed File Transfer (MFT).
-
Overview of the WebLogic Scripting Tool for Oracle Traffic Director in the WebLogic Scripting Tool Command Reference for Oracle Traffic Director for the WLST commands that are available for Oracle Traffic Director.
-
Oracle HTTP Server WLST Custom Commands in the Administering Oracle HTTP Server for the WLST commands that are available for Oracle HTTP Server.
WLST is one of several interfaces for managing and monitoring WebLogic Server. For information about the other management interfaces, see:
-
Using Ant Tasks to Configure and Use a WebLogic Server Domain in Developing Applications for Oracle WebLogic Server, describes using WebLogic Ant tasks for starting and stopping WebLogic Server instances and configuring WebLogic domains.
-
Deployment Tools in Deploying Applications to Oracle WebLogic Server describes several tools that WebLogic Server provides for deploying applications and stand-alone modules.
-
Oracle WebLogic Server Administration Console Online Help describes a Web-based graphical user interface for managing and monitoring WebLogic domains.
-
Creating WebLogic Domains Using the Configuration Wizard describes using a graphical user interface to create a WebLogic domain or extend an existing one.
-
Creating Templates and Domains Using the Pack and Unpack Commands describes commands that recreate existing WebLogic domains quickly and easily.
-
Developing Custom Management Utilities Using JMX for Oracle WebLogic Server describes using Java Management Extensions (JMX) APIs to monitor and modify WebLogic Server resources.
-
Monitoring Oracle WebLogic Server with SNMP describes using Simple Network Management Protocol (SNMP) to monitor WebLogic domains.
-
Administering Server Environments for Oracle WebLogic Server describes how you design, configure, and manage WebLogic Server environments. It is a resource for system administrators and operators responsible for implementing a WebLogic Server installation.
-
Administering Node Manager for Oracle WebLogic Server describes how to configure and use Node Manager to control and manage servers within a WebLogic Server environment.
Parent topic: Introduction and Roadmap
WLST Sample Scripts
Oracle Fusion Middleware provides both WLST online and offline sample scripts.
The following sections describe the sample scripts that you can run or use as templates for creating additional scripts:
For information about running scripts, see Running Scripts.
Note:
The sample scripts are not installed by default. To install the server samples, you must select the Complete With Examples option when installing WebLogic Server.
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: ORACLE_HOME
\user_projects\applications\wl_server\examples\src\examples\wlst\online
.
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 |
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 |
jdbc_data_source_creation.py |
Connects WLST to an Administration Server, starts an edit session, and creates a JDBC data source called |
jdbc_data_source_deletion.py |
Removes the JDBC data source created by |
Parent topic: WLST Sample Scripts
WLST Offline Sample Scripts
The WLST offline sample scripts demonstrate how to create WebLogic domains using the domain templates that are installed with the software. The WLST offline scripts are located in the following directory: ORACLE_HOME
\wlserver\common\templates\scripts\wlst
.
Table 1-2 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 simple WebLogic SIP Server domain using the Basic WebLogic SIP Server Domain template. The script demonstrates 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. |
|
Creates a single-cluster WebLogic 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 extension template. |
|
Creates a simple WebLogic SIP Server domain using the Geographic Redundancy Site 1 Domain template. The script demonstrates 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. |
|
Creates a simple WebLogic SIP Server domain using the Geographic Redundancy Site 2 Domain template. The script demonstrates 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. |
|
Creates a simple WebLogic SIP Server domain using the Oracle WebLogic SIP Server Replicated Domain template. The script demonstrates 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. |
|
Creates a WebLogic 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. |
Parent topic: WLST Sample Scripts