Skip to content

Oracle WebLogic Scripting Tool (WLST) - Process Steps

Check Server Status

Use this step to check the status of a WebLogic server.

NameTypeDescriptionRequired
Directory OffsetStringThe directory offset relative to the current working directory where the step should run.No
PasswordStringThe password to use to authenticate with the WebLogic server.No
PathStringThe fully-qualified path of the Weblogic Scripting Tool directory. (ex. {oracle_home}``/oracle_common/common/bin/)Yes
Server NameStringThe name of the WebLogic server.Yes
Server URLStringThe URL of the WebLogic server. The default WebLogic server URL is t3://localhost:7001.No
UsernameStringThe user name to use to authenticate with the WebLogic server.No
User Config FileStringOverrides Username and Password. Name and location of a user configuration file which contains an encrypted username and password.No
User Key FileStringOverrides Username and Password. Name and location of the key file that is associated with the specified user configuration file and is used to decrypt it.No

Deploy

Use this step to deploy an application to a WebLogic server.

NameTypeDescriptionRequired
Application NameStringThe name of the application to deploy.No
Directory OffsetStringThe directory offset relative to the current working directory where the step will run.No
File NameStringThe name of the file to deploy to the application.No
PasswordStringThe password to use to authenticate with the WebLogic server.No
URLStringThe URL of the WebLogic server. The default WebLogic server URL is t3://localhost:7001.No
UsernameStringThe user name to use to authenticate with the WebLogic server.No
User Config FileStringOverrides Username and Password. Name and location of a user configuration file which contains an encrypted username and password.No
User Key FileStringOverrides Username and Password. Name and location of the key file that is associated with the specified user configuration file and is used to decrypt it.No
WLST PathStringThe fully-qualified path of the Weblogic Scripting Tool directory. (ex. {oracle_home}``/oracle_common/common/bin/)Yes

Deploy SOA Composite Application

Use this step to deploy an Oracle SOA Composite Application to a WebLogic server.

NameTypeDescriptionRequired
Directory OffsetStringThe directory offset relative to the current working directory where the step will run.No
Optional ArgsStringA comma-separated list of arguments to append to the sca_deployComposite command, in the form option=value with string values in single quotes. For example: overwrite=true, forceDefault=true, configplan=C:/path/to/configplan, partition=defaultNo
PasswordPasswordThe password to use to authenticate with the WebLogic server.No
SAR LocationStringThe absolute path to either a SAR file, a ZIP file that includes multiple SARS, MARS, or both, or an EAR file that contains a SAR file.Yes
SOA URLStringURL of the server that hosts the SOA Infrastructure application (for example, http://myhost10:7001).Yes
URLStringThe URL of the WebLogic server. The default WebLogic server URL is t3://localhost:7001.Yes
UsernameStringThe user name to use to authenticate with the WebLogic server.No
User Config FileStringOverrides Username and Password. Name and location of a user configuration file which contains an encrypted username and password.No
User Key FileStringOverrides Username and Password. Name and location of the key file that is associated with the specified user configuration file and is used to decrypt it.No
WLST PathStringThe fully-qualified path of the Weblogic Scripting Tool directory. (ex. {oracle_home}``/oracle_common/common/bin/)Yes

Execute Script

Use this step to execute user defined python script files.

NameTypeDescriptionRequired
Directory OffsetStringThe directory offset relative to the current working directory where the step should run.No
Script FilesStringUser defined python scripts.Yes
WLST PathStringThe fully-qualified path of the WebLogic Scripting Tool directory. (ex. {oracle_home}``/oracle_common/common/bin/)Yes

Resume Server

Use this step to resume a suspended WebLogic server.

NameTypeDescriptionRequired
Directory OffsetStringThe directory offset relative to the current working directory where the step should run.No
PasswordStringThe password to use to authenticate with the WebLogic server.No
Server NameStringThe name of the WebLogic server.Yes
Server URLStringThe URL of the WebLogic server. The default WebLogic server URL is t3://localhost:7001.No
UsernameStringThe user name to use to authenticate with the WebLogic server.No
User Config FileStringOverrides Username and Password. Name and location of a user configuration file which contains an encrypted username and password.No
User Key FileStringOverrides Username and Password. Name and location of the key file that is associated with the specified user configuration file and is used to decrypt it.No
WLST PathStringThe fully-qualified path of the Weblogic Scripting Tool directory. (ex. {oracle_home}``/oracle_common/common/bin/)Yes

Shutdown Server

Use this step to shut down a WebLogic server.

NameTypeDescriptionRequired
Directory OffsetStringThe directory offset relative to the current working directory where the step should run.No
PasswordStringThe password to use to authenticate with the WebLogic server.No
Server NameStringThe name of the WebLogic server.Yes
Server URLStringThe URL of the WebLogic server. The default WebLogic server URL is t3://localhost:7001.No
UsernameStringThe user name to use to authenticate with the WebLogic server.No
User Config FileStringOverrides Username and Password. Name and location of a user configuration file which contains an encrypted username and password.No
User Key FileStringOverrides Username and Password. Name and location of the key file that is associated with the specified user configuration file and is used to decrypt it.No
WLST PathStringThe fully-qualified path of the Weblogic Scripting Tool directory. (ex. {oracle_home}``/oracle_common/common/bin/)Yes

Start Application

Use this step to start a deployed application.

NameTypeDescriptionRequired
Application NameStringThe name of the application to deploy.No
Directory OffsetStringThe directory offset relative to the current working directory where the step should run.No
PasswordStringThe password to use to authenticate with the WebLogic server.No
Server URLStringThe URL of the WebLogic server. The default WebLogic server URL is t3://localhost:7001.No
UsernameStringThe user name to use to authenticate with the WebLogic server.No
User Config FileStringOverrides Username and Password. Name and location of a user configuration file which contains an encrypted username and password.No
User Key FileStringOverrides Username and Password. Name and location of the key file that is associated with the specified user configuration file and is used to decrypt it.No
WLST PathStringThe fully-qualified path of the Weblogic Scripting Tool directory. (ex. {oracle_home}``/oracle_common/common/bin/)Yes

Start Server

Use this step to start a WebLogic server.

NameTypeDescriptionRequired
Directory OffsetStringThe directory offset relative to the current working directory where the step should run.No
Domain DirectoryStringThe directory where the domain is created. The default is ${MW\_HOME}/user_projects/domains/${YOUR\_DOMAIN}.Yes
Domain NameStringThe domain name that the WebLogic server exists in.Yes
Host NameStringHost name of Node Manager. This argument defaults to localhost.No
NM TypeStringThe Node Manager type.SSL is default.Note: If you specify plain for nmType, you must manually set the SecureListener parameter in WL_HOME/common/nodemanager/nodemanager.properties to false. Otherwise, the nmConnect command will fail.No
PasswordStringThe password to use to authenticate with the WebLogic server.No
PortStringPort number of Node Manager. This default argument should be based on the Node Manager type, as follows: plain=5556, rsh=514, ssh=22, ssl=5556.If left blank, defaults to 5556.No
Server NameStringThe name of the WebLogic server.Yes
UsernameStringThe user name to use to authenticate with the WebLogic server.No
User Config FileStringOverrides Username and Password. Name and location of a user configuration file which contains an encrypted username and password.No
User Key FileStringOverrides Username and Password. Name and location of the key file that is associated with the specified user configuration file and is used to decrypt it.No
WLST PathStringThe fully-qualified path of the Weblogic Scripting Tool directory. (ex. {oracle_home}``/oracle_common/common/bin/)Yes

Stop Application

Use this step to stop a running application.

NameTypeDescriptionRequired
Application NameStringThe name of the application to deploy.No
Directory OffsetStringThe directory offset relative to the current working directory where the step should run.No
PasswordStringThe password to use to authenticate with the WebLogic server.No
Server URLStringThe URL of the WebLogic server. The default WebLogic server URL is t3://localhost:7001.No
UsernameStringThe user name to use to authenticate with the WebLogic server.No
User Config FileStringOverrides Username and Password. Name and location of a user configuration file which contains an encrypted username and password.No
User Key FileStringOverrides Username and Password. Name and location of the key file that is associated with the specified user configuration file and is used to decrypt it.No
WLST PathStringThe fully-qualified path of the Weblogic Scripting Tool directory. (ex. {oracle_home}``/oracle_common/common/bin/)Yes

Suspend Server

Use this step to suspend a WebLogic server that is running.

NameTypeDescriptionRequired
Directory OffsetStringThe directory offset relative to the current working directory where the step should run.No
PasswordStringThe password to use to authenticate with the WebLogic server.No
Server NameStringThe name of the WebLogic server.Yes
Server URLStringThe URL of the WebLogic server. The default WebLogic server URL is t3://localhost:7001.No
UsernameStringThe user name use to authenticate with the WebLogic server.No
User Config FileStringOverrides Username and Password. Name and location of a user configuration file which contains an encrypted username and password.No
User Key FileStringOverrides Username and Password. Name and location of the key file that is associated with the specified user configuration file and is used to decrypt it.No
WLST PathStringThe fully-qualified path for the Weblogic Scripting Tool directory. (ex. {oracle_home}``/oracle_common/common/bin/)Yes

Undeploy

Use this step to undeploy an application from the WebLogic server.

NameTypeDescriptionRequired
Application NameStringThe name of the application to undeploy.No
Directory OffsetStringThe URL of the WebLogic server. The default WebLogic server URL is t3://localhost:7001.No
Directory OffsetStringThe directory offset relative to the current working directory where the step should run.No
PasswordStringThe password to use to authenticate with the WebLogic server.No
UsernameStringThe user name to use to authenticate with the WebLogic server.No
User Config FileStringOverrides Username and Password. Name and location of a user configuration file which contains an encrypted username and password.No
User Key FileStringOverrides Username and Password. Name and location of the key file that is associated with the specified user configuration file and is used to decrypt it.No
WLST PathStringThe fully-qualified path of the Weblogic Scripting Tool directory. (ex. {oracle_home}``/oracle_common/common/bin/)Yes