Skip Headers
Oracle® Fusion Middleware WebLogic Scripting Tool Command Reference
12c Release 1 (12.1.1)

Part Number E24490-01
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

2 WebLogic Server WLST Online and Offline Command Reference

This chapters lists and summarizes the WLST commands in alphabetical order indicates which commands can be used in offline mode, online mode, or both.

WebLogic Server WLST Command Summary, Alphabetically By Command

The following tables summarizes each of the WebLogic Server WLST commands, alphabetically by command.

Table 2-1 WebLogic Server WLST Command Summary

This command... Enables you to... Use with WLST...

activate

Activate changes saved during the current editing session but not yet deployed.

Online

addHelpCommand

Adds new command help for a command to an existing command group. Once added to the group, the command (along with a brief description) is displayed in the command list for the group when you enter the help('commandGroup') command.

Online or Offline

addHelpCommandGroup

Adds a new help command group to those shown by the WLST help() command.

Online or Offline

addListener

Add a JMX listener to the specified MBean.

Online

addTemplate

Extend the current WebLogic domain using an application or service extension template.

Offline

assign

Assign resources to one or more destinations.

Offline

cancelEdit

Cancel an edit session, release the edit lock, and discard all unsaved changes. This operation can be called by any user with administrator privileges, even if the user did not start the edit session.

Online

cd

Navigate the hierarchy of configuration or runtime beans.

Online or Offline

closeDomain

Close the current WebLogic domain.

Offline

closeTemplate

Close the current domain template.

Offline

configToScript

Convert an existing server configuration (config directory) to an executable WLST script.

Online or Offline

connect

Connect WLST to a WebLogic Server instance.

Online or Offline

create

Create a configuration bean of the specified type for the current bean.

Online or Offline

currentTree

Return the current location in the hierarchy.

Online

custom

Navigate to the root of custom MBeans that are registered in the Runtime MBean Server.

Online

delete

Delete an instance of a configuration bean of the specified type for the current configuration bean.

Online or Offline

deploy

Deploy an application to a WebLogic Server instance.

Online

disconnect

Disconnect WLST from a WebLogic Server instance.

Online

distributeApplication

Copy the deployment bundle to the specified targets.

Online

domainConfig

Navigate to the last MBean to which you navigated in the domain configuration hierarchy or to the root of the hierarchy, DomainMBean.

Online

domainCustom

Navigate to the tree of custom MBeans that are registered in the Domain Runtime MBean Server.

Online

domainRuntime

Navigate to the last MBean to which you navigated in the domain runtime hierarchy or to the root of the hierarchy, DomainRuntimeMBean.

Online

dumpStack

Display stack trace from the last exception that occurred while performing a WLST action, and reset the stack trace.

Online or Offline

dumpVariables

Display all variables used by WLST, including their name and value.

Online or Offline

edit

Navigate to the last MBean to which you navigated in the configuration edit MBean hierarchy or to the root of the hierarchy, DomainMBean.

Online

encrypt

Encrypt the specified string.

Online

exit

Exit WLST from the user session and close the scripting shell.

Online or Offline

exportDiagnosticData

Execute a query against the specified log file.

Offline

exportDiagnosticDataFromServer

Executes a query on the server side and retrieves the exported WebLogic Diagnostic Framework (WLDF) data.

Online

find

Find MBeans and attributes in the current hierarchy.

Online

get

Return the value of the specified attribute.

Online or Offline

getActivationTask

Return the latest ActivationTask MBean on which a user can get status.

Online

getAvailableCapturedImages

Returns a list of the previously captured diagnostic images.

Online

getConfigManager

Return the latest ConfigurationManagerBean MBean which manages the change process.

Online

getMBean

Return the MBean by browsing to the specified path.

Online

getMBI

Return the MBeanInfo for the specified MBeanType or the cmo variable.

Online

getPath

Return the MBean path for the specified MBean instance.

Online

getWLDM

Return the WebLogic DeploymentManager object.

Online

invoke

Invoke a management operation on the current configuration bean.

Online

isRestartRequired

Determine whether a server restart is required.

Online

jndi

Navigates to the JNDI tree for the server to which WLST is currently connected.

Online

listApplications

List all applications that are currently deployed in the domain.

Online

listChildTypes

List all the children MBeans that can be created or deleted for the cmo.

Online

loadApplication

Load an application and deployment plan into memory.

Online or Offline

loadDB

Load SQL files into a database.

Offline

loadProperties

Load property values from a file.

Online and Offline

lookup

Look up the specified MBean.

Online

ls

List all child beans and/or attributes for the current configuration or runtime bean.

Online or Offline

man

Display help from MBeanInfo for the current MBean or its specified attribute.

Online

migrate

Migrate services to a target server within a cluster.

Online

nm

Determine whether WLST is connected to Node Manager.

Online

nmConnect

Connect WLST to Node Manager to establish a session.

Online or Offline

nmDisconnect

Disconnect WLST from a Node Manager session.

Online or Offline

nmEnroll

Enroll the machine on which WLST is currently running.

Online

nmGenBootStartupProps

Generates the Node Manager property files, boot.properties and startup.properties, for the specified server.

Online

nmKill

Kill the specified server instance that was started with Node Manager.

Online or Offline

nmLog

Return the Node Manager log.

Online or Offline

nmServerLog

Return the server output log of the server that was started with Node Manager.

Online or Offline

nmServerStatus

Return the status of the server that was started with Node Manager.

Online or Offline

nmStart

Start a server in the current domain using Node Manager.

Online or Offline

nmVersion

Return the Node Manager server version.

Online or Offline

prompt

Toggle the display of path information at the prompt.

Online or Offline

pwd

Display the current location in the configuration or runtime bean hierarchy.

Online or Offline

readDomain

Open an existing WebLogic domain for updating.

Offline

readTemplate

Open an existing domain template for WebLogic domain creation.

Offline

redeploy

Reload classes and redeploy a previously deployed application.

Online

redirect

Redirect WLST output to the specified filename.

Online or Offline

removeListener

Remove a listener that was previously defined.

Online

resume

Resume a server instance that is suspended or in ADMIN state.

Online

save

Save the edits that have been made but have not yet been saved.

Online

saveDiagnosticImageCaptureFile

Downloads the specified diagnostic image capture.

Online

saveDiagnosticImageCaptureEntryFile

Downloads a specific entry from the diagnostic image capture.

Online

serverRuntime

Navigate to the last MBean to which you navigated in the runtime MBean hierarchy or to the root of the hierarchy, ServerRuntimeMBean.

Online

set

Set the specified attribute value for the current configuration bean.

Online or Offline

setOption

Set options related to a WebLogic domain creation or update

Offline

showChanges

Show the changes made by the current user during the current edit session.

Online

showListeners

Show all listeners that are currently defined.

Online

shutdown

Gracefully shut down a running server instance or cluster.

Online

start

Start a Managed Server instance or a cluster using Node Manager.

Online

startApplication

Start an application, making it available to users.

Online

startEdit

Start a configuration edit session on behalf of the currently connected user.

Online

startNodeManager

Start Node Manager at default port (5556).

Online or Offline

startRecording

Record all user interactions with WLST; useful for capturing commands to replay.

Online or Offline

startServer

Start the Administration Server.

Online or Offline

state

Returns a map of servers or clusters and their state using Node Manager.

Online

stopApplication

Stop an application, making it un available to users.

Online

stopEdit

Stop the current edit session, release the edit lock, and discard unsaved changes.

Online

stopNodeManager

Stop Node Manager.

Online or Offline

stopRecording

Stop recording WLST commands.

Online or Offline

stopRedirect

Stop the redirection of WLST output to a file.

Online or Offline

storeUserConfig

Create a user configuration file and an associated key file.

Online

suspend

Suspend a running server.

Online

threadDump

Display a thread dump for the specified server.

Online or Offline

undeploy

Undeploy an application from the specified servers.

Online

updateApplication

Update an application configuration using a new deployment plan.

Online

updateDomain

Update and save the current domain.

Offline

unassign

Unassign applications or services from one or more destinations.

Offline

undo

Revert all unsaved or unactivated edits.

Online

validate

Validate the changes that have been made but have not yet been saved.

Online

viewMBean

Display information about an MBean, such as the attribute names and values, and operations.

Online

writeDomain

Write the domain configuration information to the specified directory.

Offline

writeIniFile

Convert WLST definitions and method declarations to a Python (.py) file.

Online or Offline

writeTemplate

Writes the domain configuration information to the specified domain template.

Offline


WebLogic Server WLST Online Command Summary

The following table summarizes the WebLogic Server WLST online commands, alphabetically by command.

Table 2-2 WebLogic Server WLST Online Command Summary

This command... Enables you to...

activate

Activate changes saved during the current editing session but not yet deployed.

addHelpCommand

Adds new command help for a command to an existing command group. Once added to the group, the command (along with a brief description) is displayed in the command list for the group when you enter the help('commandGroup') command.

addHelpCommandGroup

Adds a new help command group to those shown by the WLST help() command, and specifies the resource bundle in which the help information is defined for the group.

addListener

Add a JMX listener to the specified MBean.

cancelEdit

Cancel an edit session, release the edit lock, and discard all unsaved changes. This operation can be called by any user with administrator privileges, even if the user did not start the edit session.

cd

Navigate the hierarchy of configuration or runtime beans.

configToScript

Convert an existing server configuration (config directory) to an executable WLST script.

connect

Connect WLST to a WebLogic Server instance.

create

Create a configuration bean of the specified type for the current bean.

currentTree

Return the current tree location.

custom

Navigate to the root of custom MBeans that are registered in the Runtime MBean Server.

delete

Delete an instance of a configuration bean of the specified type for the current configuration bean.

deploy

Deploy an application to a WebLogic Server instance.

disconnect

Disconnect WLST from a WebLogic Server instance.

distributeApplication

Copy the deployment bundle to the specified targets.

domainConfig

Navigate to the last MBean to which you navigated in the domain configuration hierarchy or to the root of the hierarchy, DomainMBean.

domainCustom

Navigate to the tree of custom MBeans that are registered in the Domain Runtime MBean Server.

domainRuntime

Navigate to the last MBean to which you navigated in the domain runtime hierarchy or to the root of the hierarchy, DomainRuntimeMBean.

dumpStack

Display stack trace from the last exception that occurred, and reset the trace.

dumpVariables

Display all variables used by WLST, including their name and value.

edit

Navigate to the last MBean to which you navigated in the configuration edit MBean hierarchy or to the root of the hierarchy, DomainMBean.

encrypt

Encrypt the specified string.

exit

Exit WLST from the interactive session and close the scripting shell.

exportDiagnosticDataFromServer

Execute a query on the server side and retrieves the exported WebLogic Diagnostic Framework (WLDF) data.

find

Find MBeans and attributes in the current hierarchy.

get

Return the value of the specified attribute.

getActivationTask

Return the latest ActivationTask MBean on which a user can get status.

getAvailableCapturedImages

Returns a list of the previously captured diagnostic images.

getConfigManager

Return the latest ConfigurationManagerBean MBean which manages the change process.

getMBean

Return the MBean by browsing to the specified path.

getMBI

Return the MBeanInfo for the specified MBeanType or the cmo variable.

getPath

Return the MBean path for the specified MBean instance.

getWLDM

Return the WebLogic DeploymentManager object.

invoke

Invoke a management operation on the current configuration bean.

isRestartRequired

Determine whether a server restart is required.