WebLogic Scripting Tool

     Previous  Next    Open TOC in new window    View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

WLST Online and Offline Command Summary

The following sections summarize the WLST commands, as follows:

Note: You can list a summary of all online and offline commands from the command-line using the following commands, respectively:
Note: help("online")
help("offline")

 


WLST Command Summary, Alphabetically By Command

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

Table B-1 WLST Command Summary 
This command...
Enables you to...
Use with WLST...
Activate changes saved during the current editing session but not yet deployed.
Online
Add a JMX listener to the specified MBean.
Online
Extend the current domain using an application or service extension template.
Offline
Assign resources to one or more destinations.
Offline
Assign all applications or services to one or more destinations.

Note: This command is deprecated as of WebLogic Server 9.0. You should update your scripts to use the assign command, as described in assign.

Offline
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
Navigate the hierarchy of configuration or runtime beans.
Online or Offline
Close the current domain.
Offline
Close the current domain template.
Offline
Navigate to the last MBean to which you navigated in the Administration or local configuration MBean hierarchy or to the root of the hierarchy, DomainMBean.

Note: This command is deprecated as of WebLogic Server 9.0. You should update your script to use the serverConfig command as described in serverConfig.

Online
Convert an existing server configuration (config directory) to an executable WLST script.
Online or Offline
Connect WLST to a WebLogic Server instance.
Online or Offline
Create a configuration bean of the specified type for the current bean.
Online or Offline
Return the current location in the hierarchy.
Online
Navigate to the root of custom MBeans that are registered in the server.
Online
Delete an instance of a configuration bean of the specified type for the current configuration bean.
Online or Offline
Deploy an application to a WebLogic Server instance.
Online
Disconnect WLST from a WebLogic Server instance.
Online
Copy the deployment bundle to the specified targets.
Online
Navigate to the last MBean to which you navigated in the domain configuration hierarchy or to the root of the hierarchy, DomainMBean.
Online
Navigate to the last MBean to which you navigated in the domain runtime hierarchy or to the root of the hierarchy, DomainRuntimeMBean.
Online
Display stack trace from the last exception that occurred while performing a WLST action, and reset the stack trace.
Online or Offline
Display all variables used by WLST, including their name and value.
Online or Offline
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 the specified string.
Online
Exit WLST from the user session and close the scripting shell.
Online or Offline
Execute a query against the specified log file.
Offline
Executes a query on the server side and retrieves the exported WebLogic Diagnostic Framework (WLDF) data.
Online
Find MBeans and attributes in the current hierarchy.
Online
Return the value of the specified attribute.
Online or Offline
Return the latest ActivationTask MBean on which a user can get status.
Online
Return the latest ConfigurationManagerBean MBean which manages the change process.
Online
Return the MBean by browsing to the specified path.
Online
Return the MBeanInfo for the specified MBeanType or the cmo variable.
Online
Return the MBean path for the specified MBean instance.
Online
Return the WebLogic DeploymentManager object.
Online
Invoke a management operation on the current configuration bean.
Online
Determine whether a server restart is required.
Online
Navigates to the JNDI tree for the server to which WLST is currently connected.
Online
List all the children MBeans that can be created or deleted for the cmo.
Online
Load an application and deployment plan into memory.
Online or Offline
Load SQL files into a database.
Offline
Load property values from a file.
Online and Offline
Look up the specified MBean.
Online
List all child beans and/or attributes for the current configuration or runtime bean.
Online or Offline
Display help from MBeanInfo for the current MBean or its specified attribute.
Online
Migrate services to a target server within a cluster.
Online
Determine whether WLST is connected to Node Manager.
Online
Connect WLST to Node Manager to establish a session.
Online or Offline
Disconnect WLST from a Node Manager session.
Online or Offline
Enroll the machine on which WLST is currently running.
Online
Generates the Node Manager property files, boot.properties and startup.properties, for the specified server.
Online
Kill the specified server instance that was started with Node Manager.
Online or Offline
Return the Node Manager log.
Online or Offline
Return the server output log of the server that was started with Node Manager.
Online or Offline
Return the status of the server that was started with Node Manager.
Online or Offline
Start a server in the current domain using Node Manager.
Online or Offline
Return the Node Manager server version.
Online or Offline
Toggle the display of path information at the prompt.
Online or Offline
Display the current location in the configuration or runtime bean hierarchy.
Online or Offline
Open an existing domain for updating.
Offline
Open an existing domain template for domain creation.
Offline
Reload classes and redeploy a previously deployed application.
Online
Redirect WLST output to the specified filename.
Online or Offline
Remove a listener that was previously defined.
Online
Resume a server instance that is suspended or in ADMIN state.
Online
Navigate to the last MBean to which you navigated in the Runtime hierarchy or the root of all runtime objects, DomainRuntimeMBean.

Note: This command is deprecated as of WebLogic Server 9.0. You should update your scripts to use the serverRuntime command, as described in serverRuntime.

Online
Save the edits that have been made but have not yet been saved.
Online
Navigate to the last MBean to which you navigated in the configuration MBean hierarchy or to the root of the hierarchy, DomainMBean.
Online
Navigate to the last MBean to which you navigated in the runtime MBean hierarchy or to the root of the hierarchy, ServerRuntimeMBean.
Online
Set the specified attribute value for the current configuration bean.
Online or Offline
Set options related to a domain creation or update
Offline
Show the changes made by the current user during the current edit session.
Online
Show all listeners that are currently defined.
Online
Gracefully shut down a running server instance or cluster.
Online
Start a Managed Server instance or a cluster using Node Manager.
Online
Start an application, making it available to users.
Online
Start a configuration edit session on behalf of the currently connected user.
Online
Start Node Manager at default port (5556).
Online or Offline
Record all user interactions with WLST; useful for capturing commands to replay.
Online or Offline
Start the Administration Server.
Online or Offline
Returns a map of servers or clusters and their state using Node Manager.
Online
Stop an application, making it un available to users.
Online
Stop the current edit session, release the edit lock, and discard unsaved changes.
Online
Stop recording WLST commands.
Online or Offline
Stop the redirection of WLST output to a file.
Online or Offline
Create a user configuration file and an associated key file.
Online
Suspend a running server.
Online
Display a thread dump for the specified server.
Online or Offline
Undeploy an application from the specified servers.
Online
Update an application configuration using a new deployment plan.
Online
Update and save the current domain.
Offline
Unassign applications or services from one or more destinations.
Offline
Unassign all applications or services from one or more destinations.

Note: This command is deprecated as of WebLogic Server 9.0. You should update your scripts to use the unassign command, as described in unassign.

Offline
Revert all unsaved or unactivated edits.
Online
Validate the changes that have been made but have not yet been saved.
Online
Display information about an MBean, such as the attribute names and values, and operations.
Online
Write the domain configuration information to the specified directory.
Offline
Convert WLST definitions and method declarations to a Python (.py) file.
Online or Offline
Writes the domain configuration information to the specified domain template.
Offline

 


WLST Online Command Summary

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

Table B-2 WLST Online Command Summary 
This command...
Enables you to...
Activate changes saved during the current editing session but not yet deployed.
Add a JMX listener to the specified MBean.
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.
Navigate the hierarchy of configuration or runtime beans.
Navigate to the last MBean to which you navigated in the configuration MBean hierarchy or to the root of all configuration beans, DomainMBean.

Note: This command is deprecated as of WebLogic Server 9.0. You should update your script to use the serverConfig command as described in serverConfig.

Convert an existing server configuration (config directory) to an executable WLST script.
Connect WLST to a WebLogic Server instance.
Create a configuration bean of the specified type for the current bean.
Return the current tree location.
Navigate to the root of custom MBeans that are registered in the server.
Delete an instance of a configuration bean of the specified type for the current configuration bean.
Deploy an application to a WebLogic Server instance.
Disconnect WLST from a WebLogic Server instance.
Copy the deployment bundle to the specified targets.
Navigate to the last MBean to which you navigated in the domain configuration hierarchy or to the root of the hierarchy, DomainMBean.
Navigate to the last MBean to which you navigated in the domain runtime hierarchy or to the root of the hierarchy, DomainRuntimeMBean.
Display stack trace from the last exception that occurred, and reset the trace.
Display all variables used by WLST, including their name and value.
Navigate to the last MBean to which you navigated in the configuration edit MBean hierarchy or to the root of the hierarchy, DomainMBean.
Encrypt the specified string.
Exit WLST from the interactive session and close the scripting shell.
Execute a query on the server side and retrieves the exported WebLogic Diagnostic Framework (WLDF) data.
Find MBeans and attributes in the current hierarchy.
Return the value of the specified attribute.
Return the latest ActivationTask MBean on which a user can get status.
Return the latest ConfigurationManagerBean MBean which manages the change process.
Return the MBean by browsing to the specified path.
Return the MBeanInfo for the specified MBeanType or the cmo variable.
Return the MBean path for the specified MBean instance.
Return the WebLogic DeploymentManager object.
Invoke a management operation on the current configuration bean.
Determine whether a server restart is required.
Navigates to the JNDI tree for the server to which WLST is currently connected.
List all the children MBeans that can be created or deleted for the cmo.
Load an application and deployment plan into memory.
Load property values from a file.
Look up the specified MBean.
List all child beans and/or attributes for the current configuration or runtime bean.
Display help from MBeanInfo for the current MBean or its specified attribute.
Migrate services to a target server within a cluster.
Determine whether WLST is connected to Node Manager.
Connect WLST to Node Manager to establish a session.
Disconnect WLST from a Node Manager session.
Enroll the machine on which WLST is currently running.
Generates the Node Manager property files, boot.properties and startup.properties, for the specified server.
Kill the specified server instance that was started with Node Manager.
Return the Node Manager log.
Return the server output log of the server that was started with Node Manager.
Return the status of the server that was started with Node Manager.
Start a server in the current domain using Node Manager.
Return the Node Manager server version.
Toggle the display of path information at the prompt.
Display the current location in the configuration or runtime bean hierarchy.
Reload classes and redeploy a previously deployed application.
Redirect WLST output to the specified filename.
Remove a listener that was previously defined.
Resume a server instance that is suspended or in ADMIN state.
Navigate to the last MBean to which you navigated in the Runtime hierarchy or the root of all runtime objects, DomainRuntimeMBean.

Note: This command is deprecated as of WebLogic Server 9.0. You should update your scripts to use the serverRuntime command, as described in serverRuntime.

Save the edits that have been made but have not yet been saved.
Navigate to the last MBean to which you navigated in the configuration MBean hierarchy or to the root of the hierarchy, DomainMBean.
Navigate to the last MBean to which you navigated in the runtime MBean hierarchy or to the root of the hierarchy, ServerRuntimeMBean.
Set the specified attribute value for the current configuration bean.
Show the changes made by the current user during the current edit session.
Show all listeners that are currently defined.
Gracefully shut down a running server instance or cluster.
Start a Managed Server instance or a cluster using Node Manager.
Start an application, making it available to users.
Start a configuration edit session on behalf of the currently connected user.
Start Node Manager at default port (5556).
Record all user interactions with WLST; useful for capturing commands to replay.
Start the Administration Server.
Returns a map of servers or clusters and their state using Node Manager
Stop an application, making it un available to users.
Stop the current edit session, release the edit lock, and discard unsaved changes.
Stop recording WLST commands.
Stop the redirection of WLST output to a file.
Create a user configuration file and an associated key file.
Suspend a running server.
Display a thread dump for the specified server.
Undeploy an application from the specified servers.
Revert all unsaved or unactivated edits.
Update an application configuration using a new deployment plan.
Validate the changes that have been made but have not yet been saved.
Display information about an MBean, such as the attribute names and values, and operations.
Convert WLST definitions and method declarations to a Python (.py) file.

 


WLST Offline Command Summary

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

Table B-3 WLST Offline Command Summary 
This command...
Enables you to...
Extend the current domain using an application or service extension template.
Assign resources to one or more destinations.
Assign all applications or services to one or more destinations.

Note: This command is deprecated as of WebLogic Server 9.0. You should update your scripts to use the assign command, as described in assign.

Navigate the hierarchy of configuration or runtime beans.
Close the current domain.
Close the current domain template.
Convert an existing server configuration (config directory) to an executable WLST script.
Connect WLST to a WebLogic Server instance.
Create a configuration bean of the specified type for the current bean.
Delete an instance of a configuration bean of the specified type for the current configuration bean.
Display stack trace from the last exception that occurred while performing a WLST action, and reset the stack trace.
Display all variables used by WLST, including their name and value.
Exit WLST from the interactive session and close the scripting shell.
Execute a query against the specified log file.
Return the value of the specified attribute.
Load SQL files into a database.
Load property values from a file.
List all child beans and/or attributes for the current configuration or runtime bean.
Connect WLST to Node Manager to establish a session.
Toggle the display of path information at the prompt.
Display the current location in the configuration or runtime bean hierarchy.
Open an existing domain for updating.
Open an existing domain template for domain creation.
Redirect WLST output to the specified filename.
Set the specified attribute value for the current configuration bean.
Set options related to a domain creation or update.
Start Node Manager at default port (5556).
Record all user interactions with WLST; useful for capturing commands to replay.
Start the Administration Server.
Stop recording WLST commands.
Stop the redirection of WLST output to a file.
Display a thread dump for the specified server.
Unassign applications or services from one or more destinations.
Unassign all applications or services from one or more destinations.

Note: This command is deprecated as of WebLogic Server 9.0. You should update your scripts to use the unassign command, as described in unassign.

Update and save the current domain.
Write the domain configuration information to the specified directory.
Convert WLST definitions and method declarations to a Python (.py) file.
Writes the domain configuration information to the specified domain template.


  Back to Top       Previous  Next