Fusion Middleware Documentation
Advanced Search


WLST Command Reference for WebLogic Server
Close Window

Table of Contents

Show All | Collapse

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 table 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

Add 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

Add 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

addStartupGroup

Add a new server startup group.

Offline

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

captureAndSaveDiagnosticImage

Capture a diagnostic image and downloads it to the client.

Online

cd

Navigate the hierarchy of configuration or runtime beans.

Online or Offline

clone

Clone the server object.

Offline

closeDomain

Close the current WebLogic domain.

Offline

closestore

Close a store.

Offline

closeTemplate

Close the current domain template.

Offline

compactstore

Compact and defragment the space occupied by a file store.

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

createDomain

Create a WebLogic domain using the specified template.

Offline

createSystemResourceControl

Create a diagnostics resource from an external descriptor file.

Online

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

destroySystemResourceControl

Destroy a Diagnostics system resource control.

Online

disableSystemResource

Deactivate a diagnostic system resource control that is activated on a 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

dumpDiagnosticData

Dump the diagnostics data from a harvester to a local file.

Online

dumpStack

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

Online or Offline

dumpstore

Dump store contents in human-readable format to an XML file.

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

editCustom

Navigate to the root of custom MBeans.

Online

encrypt

Encrypt the specified string.

Online

enableSystemResource

Activate a diagnostic system resource on a server instance

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

Execute 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

Return a list of the previously captured diagnostic images.

Online

getConfigManager

Return the latest ConfigurationManagerBean MBean which manages the change process.

Online

getDatabaseDefaults

Connect to the database to retrieve schema information.

Offline

getMBean

Return the MBean by browsing to the specified path.

Online

getMBI

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

Online

getNodeManagerHome

Get the Node Manager home.

Offline

getNodeManagerType

Get the Node Manager type.

Offline

getopenstores

Return a list of opened stores (for script access).

Offline

getstoreconns

Return a list of connections in the specified store (for script access).

Offline

getPath

Return the MBean path for the specified MBean instance.

Online

getServerGroups

Retrieve a list of the server groups of which the specified server is a member.

Offline

getStartupGroup

Retrieve the server startup group.

Offline

getTopologyProfile

Return the domain topology profile for a domain.

Offline

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

Navigate 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

listServerGroups

Retrieve a map of the config-groups.xml server groups that are user-expandable.

Offline

liststore

List store names, open stores or connections in a store.

Offline

listSystemResourceControls

List the diagnostic system resources that are currently deployed on a server instance.

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

Generate 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

nmSoftRestart

Restart the specified System Component server instance.

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

openfilestore

Open a file store.

Offline

openjdbcstore

Open a JDBC store.

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

readDomainForUpgrade

Open an existing domain for reconfiguration

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

Download the specified diagnostic image capture.

Online

saveDiagnosticImageCaptureEntryFile

Download a specific entry from the diagnostic image capture.

Online

serverConfigF

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

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

setDistDestType

Set the distributed destination type for a JMS system resource.

Offline

setOption

Set options related to a WebLogic domain creation or update

Offline

setServerGroups

Set the server groups for the specified server.

Online or Offline

setSharedSecretStoreWithPassword

Set the shared secret store and password.

Offline

setStartupGroup

Sets the server startup group.

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, cluster, or system component.

Online

softRestart

Restart a system component server instance.

Online

start

Start a Managed Server instance, cluster, or system component 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

Return 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

undeploy

Undeploy an application from the specified servers.

Online

undo

Revert all unsaved or unactivated edits.

Online

validate

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

Online

validateConfig

Validate a domain configuration.

Offline

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

Write the domain configuration information to the specified domain template.

Online or 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

Add 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

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

captureAndSaveDiagnosticImage

Capture a diagnostic image and downloads it to the client.

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.

createSystemResourceControl

Create a diagnostics resource from an external descriptor file.

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.

destroySystemResourceControl

Destroy a Diagnostics system resource control.

disableSystemResource

Deactivate a diagnostic system resource control that is activated on a 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.

dumpDiagnosticData

Dump the diagnostics data from a harvester to a local file.

dumpStack

Display the 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.

editCustom

Navigate to the root of custom MBeans.

enableSystemResource

Activate a diagnostic system resource on a server instance

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

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

jndi

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

listApplications

List all applications that are currently deployed in the domain.

listChildTypes

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

listSystemResourceControls

List the diagnostic system resources that are currently deployed on a server instance.

loadApplication

Load an application and deployment plan into memory.

loadProperties

Load property values from a file.

lookup

Look up the specified MBean.

ls

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

man

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

migrate

Migrate services to a target server within a cluster.

nm

Determine whether WLST is connected to Node Manager.

nmConnect

Connect WLST to Node Manager to establish a session.

nmDisconnect

Disconnect WLST from a Node Manager session.

nmEnroll

Enroll the machine on which WLST is currently running.

nmGenBootStartupProps

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

nmKill

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

nmLog

Return the Node Manager log.

nmServerLog

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

nmServerStatus

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

nmSoftRestart

Restart the specified System Component server instance.

nmStart

Start a server in the current domain using Node Manager.

nmVersion

Return the Node Manager server version.

prompt

Toggle the display of path information at the prompt.

pwd

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

redeploy

Reload classes and redeploy a previously deployed application.

redirect

Redirect WLST output to the specified filename.

removeListener

Remove a listener that was previously defined.

resume

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

save

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

saveDiagnosticImageCaptureFile

Download the specified diagnostic image capture.

saveDiagnosticImageCaptureEntryFile

Download a specific entry from the diagnostic image capture.

serverConfig

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

serverRuntime

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

set

Set the specified attribute value for the current configuration bean.

setServerGroups

Set the server groups for the specified server.

showChanges

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

showListeners

Show all listeners that are currently defined.

shutdown

Gracefully shut down a running server instance, cluster, or system component.

softRestart

Restart a system component server instance.

start

Start a Managed Server instance, cluster, or system component using Node Manager.

startApplication

Start an application, making it available to users.

startEdit

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

startNodeManager

Start Node Manager at default port (5556).

startRecording

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

startServer

Start the Administration Server.

state

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

stopApplication

Stop an application, making it un available to users.

stopEdit

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

stopNodeManager

Stop Node Manager.

stopRedirect

Stop the redirection of WLST output to a file.

storeUserConfig

Create a user configuration file and an associated key file.

suspend

Suspend a running server.

threadDump

Display a thread dump for the specified server.

undeploy

Undeploy an application from the specified servers.

undo

Revert all unsaved or unactivated edits.

updateApplication

Update an application configuration using a new deployment plan.

validate

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

viewMBean

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

writeIniFile

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

writeTemplate

Write the domain configuration information to the specified domain template.


WebLogic Server WLST Offline Command Summary

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

Table 2-3 WebLogic Server WLST Offline Command Summary

This command... Enables you to...

addHelpCommand

Add 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

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

addStartupGroup

Add a new server startup group.

addTemplate

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

assign

Assign resources to one or more destinations.

cd

Navigate the hierarchy of configuration or runtime beans.

clone

Clone the server object.

closeDomain

Close the current domain.

closestore

Close a store.

closeTemplate

Close the current domain template.

compactstore

Compact and defragments the space occupied by a file store.

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.

createDomain

Create a WebLogic domain using the specified template.

delete

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

dumpStack

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

dumpstore

Dump store contents in human-readable format to an XML file.

dumpVariables

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

exit

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

exportDiagnosticData

Execute a query against the specified log file.

get

Return the value of the specified attribute.

getDatabaseDefaults

Connect to the database to retrieve schema information.

getNodeManagerHome

Get the Node Manager home.

getNodeManagerType

Get the Node Manager type.

getopenstores

Return a list of opened stores (for script access).

getstoreconns

Return a list of connections in the specified store (for script access).

getServerGroups

Retrieve a list of the server groups of which the specified server is a member.

getStartupGroup

Retrieve the server startup group.

getTopologyProfile

Return the domain topology profile for a domain.

listServerGroups

Retrieve a map of the config-groups.xml server groups that are user-expandable.

liststore

List store names, open stores or connections in a store.

loadApplication

Load an application and deployment plan into memory.

loadDB

Load SQL files into a database.

loadProperties

Load property values from a file.

ls

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

nmConnect

Connect WLST to Node Manager to establish a session.

nmSoftRestart

Restart the specified System Component server instance.

openfilestore

Open a file store.

openjdbcstore

Open a JDBC store.

prompt

Toggle the display of path information at the prompt.

pwd

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

readDomain

Open an existing WebLogic domain for updating.

readDomainForUpgrade

Open an existing domain for reconfiguration

readTemplate

Open an existing domain template for domain creation.

redirect

Redirect WLST output to the specified filename.

set

Set the specified attribute value for the current configuration bean.

setDistDestType

Set the distributed destination type for a JMS system resource.

setOption

Set options related to a WebLogic domain creation or update.

setServerGroups

Set the server groups for the specified server.

setSharedSecretStoreWithPassword

Set the shared secret store and password.

setStartupGroup

Set the server startup group.

startNodeManager

Start Node Manager at default port (5556).

startRecording

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

startServer

Start the Administration Server.

stopNodeManager

Stop Node Manager.

stopRedirect

Stop the redirection of WLST output to a file.

threadDump

Display a thread dump for the specified server.

unassign

Unassign applications or services from one or more destinations.

updateDomain

Update and save the current domain.

validateConfig

Validate a domain configuration.

writeDomain

Write the domain configuration information to the specified directory.

writeIniFile

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

writeTemplate

Write the domain configuration information to the specified domain template.