Introduction and Roadmap

1 Introduction and Roadmap

Before you get started, you should understand the the contents and organization of this guide.

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.

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\\wlserver\samples\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 `cluster_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`.
`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`.

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
`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.
`basicWLSSdomain.py`	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.
`clusterMedRecDomain.py`	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.
`distributedQueue.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 extension template.
`geo1Domain.py`	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.
`geo2Domain.py`	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.
`replicatedDomain.py`	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.
`sampleMedRecDomain.py`	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.