WebLogic Scripting Tool

Introduction and Roadmap

Document Scope and Audience

Guide to This Document

Related Documentation

WLST Sample Scripts

WLST Online Sample Scripts

WLST Offline Sample Scripts

Using the WebLogic Scripting Tool

What is the WebLogic Scripting Tool?

What Does WLST Do?

How Does WLST Work?

Using WLST Online

Using WLST Offline

Modes of Operation

Interactive Mode

Script Mode

Embedded Mode

Main Steps for Using WLST

Setting Up Your Environment

Invoking WLST

Requirements for Entering WLST Commands

Securing Access to Security Data

Running Scripts

Invoke WLST and Run a Script

Run a Script From WLST

Importing WLST as a Jython Module

Exiting WLST

Running WLST from Ant

wlst Ant Task Syntax

Examples

Example 1

Example 2

Example 3

Getting Help

Recording User Interactions

Redirecting WLST Output to a File

Converting an Existing Configuration into a WLST Script

Customizing WLST

Creating and Configuring WebLogic Domains Using WLST Offline

Creating a Domain (Offline)

Updating an Existing Domain (Offline)

Browsing and Accessing Information About the Configuration Bean Hierarchy (Offline)

Editing a Domain (Offline)

Creating a Domain Template (Offline)

Exporting Diagnostic Data (Offline)

Stepping Through a Sample Script: Creating a Domain Using WLST Offline

Navigating and Editing MBeans

Navigating and Interrogating MBeans

Changing the Current Management Object

Navigating and Displaying Configuration MBeans Example

Browsing Runtime MBeans

Navigating and Displaying Runtime MBeans Example

Navigating Among MBean Hierarchies

Finding MBeans

Accessing Custom MBeans

Editing Configuration MBeans

Making Configuration Changes: Main Steps

Managing Configuration Changes

Tracking Configuration Changes

Managing Servers and Server Life Cycle

Managing the Server Life Cycle

Starting and Stopping Servers

Starting an Administration Server Without Node Manager

Starting Managed Servers and Clusters With Node Manager

Using WLST and Node Manager to Manage Servers

Monitoring Server State

Managing Server State

Automating WebLogic Server Administration Tasks

Creating a Sample Domain: Main Steps

Setting Up the Environment

Creating a Domain

Creating JDBC Resources

Creating JMS Resources

Creating Mail Resources

Deploying Applications

Script to Create and Configure a Sample Domain

Monitoring Domain Runtime Information

Accessing Domain Runtime Information: Main Steps

Script for Monitoring Server State

Script for Monitoring the JVM

Managing Security

Creating a User

Adding a User to a Group

Verifying Whether a User Is a Member of a Group

Listing Groups to Which a User Belongs

Listing Users and Groups in a Security Realm

Changing a Password

Protecting User Accounts in a Security Realm

Set Consecutive Invalid Login Attempts

Unlock a User Account

Configuring Logging

WLST Command and Variable Reference

Overview of WSLT Command Categories

Browse Commands

cd

Description

Syntax

Examples

currentTree

Description

Syntax

Example

prompt

Description

Examples

pwd

Description

Syntax

Example

Control Commands

addTemplate

Description

Syntax

Example

closeDomain

Description

Syntax

Example

closeTemplate

Description

Syntax

Example

connect

Description

Syntax

Examples

createDomain

Description

Syntax

Example

disconnect

Description

Syntax

Example

exit

Description

Syntax

Example

readDomain

Description

Syntax

Example

readTemplate

Description

Syntax

Example

updateDomain

Description

Syntax

Example

writeDomain

Description

Syntax

Example

writeTemplate

Description

Syntax

Example

Deployment Commands

deploy

Description

Syntax

Example

distributeApplication

Description

Syntax

Example

getWLDM

Description

Syntax

Example

loadApplication

Description

Syntax

Example

redeploy

Description

Syntax

Example

startApplication

Description

Syntax

Example

stopApplication

Description

Syntax

Example

undeploy

Description

Syntax

Example

updateApplication

Description

Syntax

Example

Diagnostics Commands

exportDiagnosticData

Description

Syntax

Example

exportDiagnosticDataFromServer

Description

Syntax

Example

Editing Commands

activate

Description

Syntax

Example

assign

Description

Syntax

Example

assignAll

Description

Syntax

Example

cancelEdit

Description

Syntax

Example

create

Description

Syntax

Example

delete

Description

Syntax

Example

encrypt

Description

Syntax

Example

get

Description

Syntax

Example

getActivationTask

Description

Syntax

Example

invoke

Description

Syntax

Example

isRestartRequired

Description

Syntax

Example

loadDB

Description

Syntax

Example

loadProperties

Description

Syntax

Example

save

Description

Syntax

Example

set

Description

Syntax

Example

setOption

Description

Syntax

Example

showChanges

Description

Syntax

Example

startEdit

Description

Syntax

Example

stopEdit

Description

Syntax

Example

unassign

Description

Syntax

Example

unassignAll

Description

Syntax

Example

undo

Description

Syntax

Example

validate

Description

Syntax

Example

Information Commands

addListener

Description

Syntax

Example

configToScript

Syntax

Example

dumpStack

Description

Syntax

Example

dumpVariables

Description

Syntax

Example

find

Description

Syntax

Example

getConfigManager

Description

Syntax

Example

getMBean

Description

Syntax

Example

getMBI

Description

Syntax

Example

getPath

Description

Syntax

Example

listChildTypes

Description

Syntax

Example

lookup

Description

Syntax

Example

ls

Description

Syntax

Example

man

Description

Syntax

Example

redirect

Description

Syntax

Example

removeListener

Description

Syntax

Example

showListeners

Description

Syntax

Example

startRecording

Description

Syntax

Example

state

Description

Syntax

Example

stopRecording

Description

Syntax

Example

stopRedirect

Description

Syntax

Example

storeUserConfig

Description

Syntax

Example

threadDump

Description

Syntax

Example

viewMBean

Description

Syntax

Example

writeIniFile

Description

Syntax

Example

Life Cycle Commands

migrate

Description

Syntax

Example

resume

Description

Syntax

Example

shutdown

Description

Syntax

Example

start

Description

Syntax

Example

startServer

Description

Syntax

Example

suspend

Description

Syntax

Example

Node Manager Commands

nm

Description

Syntax

Example

nmConnect

Description

Syntax

Example

nmDisconnect

Description

Syntax

Example

nmEnroll

Description

Syntax

Example

nmGenBootStartupProps

Description

Syntax

Example

nmKill

Description

Syntax

Example

nmLog

Description

Syntax

Example

nmServerLog

Description

Syntax

Example

nmServerStatus

Description

Syntax

Example

nmStart

Description

Syntax

Example

nmVersion

Description

Syntax

Example

startNodeManager

Description

Syntax

Example

Tree Commands

config

Description

Example

custom

Description

Example

domainConfig

Description

Example

domainRuntime

Description

Example

edit

Description

Example

jndi

Description

Example

runtime

Description

Example

serverConfig

Description

Example

serverRuntime

Description

Example

WLST Variable Reference

WLST Online and Offline Command Summary

WLST Command Summary, Alphabetically By Command

WLST Online Command Summary

WLST Offline Command Summary

WLST Deployment Objects

WLSTPlan Object

WLSTProgress Object

FAQs: WLST