Use the WebLogic plugin to interact with the Oracle WebLogic server for application and server management, interacting or editing existing applications, and deploying new applications. You can start and stop both the managed servers and the administration server using this integration. You can use Jython scripting to create script files or to enter a new embedded file.
Plugin version 4.0.0.2023101919
Revised on October 20, 2023
CloudBees CD/RO Integration to WebLogic
Use this plugin to interact with the Oracle WebLogic server for application and server management, interacting or editing existing applications, and deploying new applications. You can start and stop both the Managed Servers and the Administration Server using this integration. You can use Jython scripting to create script files or to enter a new embedded file.
Integrated Version
This plugin was developed and tested against following WebLogic Server Versions:
-
12c (12.2.1.1.0) on Windows
-
12c (12.2.1.1.0) on Linux
-
11g (10.3.6.0) on Windows
-
11g (10.3.6.0) on Linux
Updated Perl version required
This plugin uses an updated version of Perl, cb-perl shell (instead of legacy ec-perl). To run the plugin, a CloudBees CD/RO agent version 10.3 or later is required.
Plugin configurations
Plugin configurations are sets of parameters that can be applied across some, or all, of the plugin procedures. They can reduce the repetition of common values, create predefined parameter sets, and securely store credentials. Each configuration is given a unique name that is entered in the designated parameter for the plugin procedures that use them.
Creating plugin configurations
To create plugin configurations in CloudBees CD/RO, complete the following steps:
-
Navigate to
. -
Select Add plugin configuration to create a new configuration.
-
In the New Configuration window, specify a Name for the configuration.
-
Select the Project that the configuration belongs to.
-
Optionally, add a Description for the configuration.
-
Select the appropriate Plugin for the configuration.
-
Configure the parameters per the descriptions below.
Configuration procedure parameters
Parameter | Description | ||
---|---|---|---|
Configuration name |
|||
WebLogic URL |
URL of WebLogic Server (must include protocol, server and port). Two protocols are supported: |
||
WLST script absolute path |
Absolute path to WLST. For example,
|
||
JAVA_HOME |
|
||
JAVA_VENDOR |
|
||
MW_HOME |
|
||
Login as |
Username and password to connect to WebLogic server. |
||
Enable named sessions? |
If selected, each WebLogic edit session will have unique name assigned. Named sessions are not supported by WebLogic server prior to version 12. Defaults to |
||
Test connection? |
Check if connection should be established during config creation to validate credentials. |
||
Test connection resource |
A resource which is used for the testing connection. |
||
Debug level |
Debug level, higher debug level - more debug messages.
|
Plugin procedures
CreateCluster
Create a cluster.
CreateCluster parameters
Parameter | Description |
---|---|
WLST script absolute path |
Absolute path to WLST. For example, |
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
Cluster name |
Name of the cluster to be created. |
Multicast Address |
Multicast IP Address. |
Multicast Port |
Multicast Port. |
CreateDomain
Create a domain
CreateDomain parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
User Credentials |
Credentials of the user (Username and password). |
||
Domain Template |
Name and location of the domain template from which you want to create a domain. |
||
Domain Directory |
Name of the directory to which you want to write the domain configuration information. |
||
Listen Address |
Server Listen Address. |
||
Listen Port |
Server Listen Port. |
CreateManagedServer
Create a Managed Server.
CreateManagedServer parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Server name |
Name of the managed server to be created. |
||
Listen Address |
Server Listen Address. |
||
Listen Port |
Server Listen Port. |
AddServerToCluster
Add server to cluster.
AddServerToCluster parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Server name |
Name of the server which is to be added to cluster. |
||
Cluster name |
Name of the cluster in which server is to be added. |
DeleteCluster
Delete a cluster.
DeleteCluster parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Cluster name |
Name of the cluster to be deleted. |
DeleteManagedServer
Delete a Managed Server.
DeleteManagedServer parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Server name |
Name of the managed server to be deleted. |
StartAdminServer
Starts a WebLogic Admin Server
StartAdminServer parameters
Parameter | Description | ||
---|---|---|---|
Script Location |
Absolute path of the start WebLogic script, including filename and extension. For example, |
||
Admin Server Instance name |
Instance name of the Admin Server to start. For example, |
||
Config name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Maximum elapsed time |
Defines the maximum time in seconds that the job will try to check into the server. Note that the step has a |
StartCluster
Starts a cluster
StartCluster parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Cluster name |
Name of the cluster to start. For example, |
||
Timeout |
Timeout in seconds for cluster start. |
StartManagedServer
Starts a WebLogic Managed Server
StartManagedServer parameters
Parameter | Description | ||
---|---|---|---|
Script Location |
Absolute path of the start server script, including filename and extension. For example, |
||
Instance name |
Instance name of the Managed Server to start. (Required) |
||
Config name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Admin Server URL |
URL from the Admin Server (including protocol and port). (Required) |
||
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Maximum elapsed time |
Defines the maximum time in seconds that the job will try to check into the server. Note that the step has a |
StartNodeManager
Start the WebLogic Node Manager
StartNodeManager parameters
Parameter | Description |
---|---|
Node Manager Script Location |
Absolute path of the startNodeManager script, including filename and extension. For example, |
Maximum elapsed time |
Defines the time in seconds that the job wait to test the status of the node manager. Note that the step has a |
StopAdminServer
Stops a WebLogic Admin Server
StopAdminServer parameters
Parameter | Description |
---|---|
Script Location |
Absolute path of the stop WebLogic script, including filename and extension. For example, |
Config name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
StopCluster
Stops a cluster
StopCluster parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Cluster name |
Name of the cluster to stop. For example, |
||
Shutdown Timeout |
Timeout in seconds for cluster shutdown. |
||
Force Shutdown? |
Value specifying whether WLST should terminate a server instance or a cluster without waiting for the active sessions to complete. This argument defaults to |
||
Ignore Sessions? |
Value specifying whether WLST should drop all HTTP sessions immediately or wait for HTTP sessions to complete or timeout while shutting down. This argument defaults to |
StopManagedServer
Stops a WebLogic Managed Server
StopManagedServer parameters
Parameter | Description |
---|---|
Script Location |
Absolute path of the stop server script, including filename and extension. For example, |
Instance name |
Instance name of the Managed Server to stop. (Required) |
Config name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
StopNodeManager
Stop the WebLogic Node Manager
StopNodeManager parameters
Parameter | Description | ||
---|---|---|---|
Config name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Host name |
Host name of Node Manager. This argument defaults to |
||
Node Manager Port |
Port number of Node Manager. This argument defaults to a value that is based on the Node Manager server type, for plain type, defaults to |
||
Domain name |
Name of the domain that you want to manage. This argument defaults to |
||
Domain Path |
Path of the domain directory to which you want to save the Node Manager secret file ( |
||
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Node Manage Type |
Type of the Node Manager server. This argument defaults to |
||
Maximum elapsed time |
Defines the time in seconds that the job wait to test the status of the node manager. Note that the step has a |
SuspendServer
Suspends the provided server
SuspendServer parameters
Parameter | Description | ||
---|---|---|---|
Configuration |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Server name |
Name of the server to suspend. (Required) |
||
Ignore Sessions |
Boolean value specifying whether WLST should drop all HTTP sessions immediately or wait for HTTP sessions to complete or time out while suspending. This argument defaults to |
||
Timeout |
Time (in seconds) the WLST waits for the server to complete in-process work before suspending the server. This argument defaults to |
||
Force |
Boolean value specifying whether WLST should suspend the server without waiting for active sessions to complete. This argument defaults to |
||
Block |
Boolean value specifying whether WLST blocks user interaction until the server is started. This argument defaults to |
ResumeServer
Resumes the provided server
ResumeServer parameters
Parameter | Description | ||
---|---|---|---|
Configuration |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Server name |
Name of the server to resume. (Required) |
||
Block |
Boolean value specifying whether WLST should block user interaction until the server is resumed. This argument defaults to |
DeployApp
Deploys or redeploys an application or module
DeployApp parameters
Parameter | Description | ||
---|---|---|---|
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Application name |
Deployment name to assign to a newly-deployed application or standalone module. For example, |
||
Is library? |
Select this parameter if the application is library. |
||
Application Path |
Absolute path of the application to deploy. For example, |
||
Targets |
Targets on which to deploy the application or module (comma-separated list of the target servers, clusters, or virtual hosts). |
||
Stage mode |
Staging mode for the application you are deploying. Possible values are: If not provided, default stage mode will be used. Refer to Oracle documentation for details. |
||
Deployment plan path |
Path to read a deployment plan (if there is one) or to save a new one from the Deployment plan content parameter. |
||
Plan version |
Deployment plan version. |
||
Deployment plan content |
A WebLogic Server deployment plan is an XML document that you use to configure an application for deployment to a specific WebLogic Server environment. |
||
Overwrite deployment plan? |
If selected, deployment plan will be overwritten, if deployment plan content has been provided and deployment plan file already exists. This option defaults to |
||
Additional options |
Comma-separated list of deployment options, specified as name-value pairs. Refer to WLST deploy documentation (The options, which are not included in this form). |
||
Archive version |
Archive version number. Is used for production redeployment, specifies the application version which is going to be retired, while Archive version stays along with the new one. |
||
Retire gracefully? |
Retirement policy to gracefully retire an application only after it has completed all in-flight work. This policy is only meaningful for |
||
Retire timeout |
Time (in seconds) WLST waits before retiring an application that has been replaced with a newer version. This option defaults to |
||
Version identifier |
Version identifier that is being used by production redeployment. A string, that uniquely identifies the current application version across all versions of the same application. |
||
Upload? |
Optional. Boolean value specifying whether the application files are uploaded to the WebLogic Server Administration Server’s upload directory prior to deployment. Use this option when you are on a different machine from the Administration Server and you cannot copy the deployment files by other means. This option defaults to |
||
Remote? |
Boolean value specifying whether the operation will be remote from the file system that contains the source. Use this option when you are on a different machine from the Administration Server and the deployment files are already at the specified location where the Administration Server is located.
This option defaults to |
UpdateAppConfig
Update a configuration of an already deployed app.
UpdateAppConfig parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Application name |
Name of the application which is to be updated. |
||
Application version |
Application version to update. |
||
Plan Path |
Absolute path to the new deployment plan file. |
||
Deployment Plan Content |
Content of the deployment plan. Required, if the file mentioned in Plan Path doesn’t exist or empty. |
||
Overwrite deployment plan? |
If checked, deployment plan will be overwritten, if deployment plan content has been provided and deployment plan file already exists. This option defaults to |
||
Additional options |
Comma-separated list of deployment options, specified as name-value pairs. For example: block=false,createPlan=true |
UndeployApp
Stops the deployment unit and removes staged files from target servers.
UndeployApp parameters
Parameter | Description | ||
---|---|---|---|
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Application name |
Name of the application to undeploy. For example, |
||
Retire Gracefully? (DEPRECATED) |
Retirement policy to gracefully retire an application only after it has completed all in-flight work. This policy is only meaningful for stop and redeploy operations and is mutually exclusive to the retire timeout policy. *This parameter is DEPRECATED and will be removed in the next release.* |
||
Application version |
Specifies a single application version to undeploy. See Requirements and Restrictions for Production Redeployment for reference. |
||
Additional options |
Additional options for |
||
Give Up on Error? |
If checked, any ambiguous situation will be treated as fatal error. Defaults to false. |
UpdateApp (DEPRECATED)
Update an already deployed app. (DEPRECATED)
UpdateApp parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Application name |
Name of the application which is to be updated. |
||
Plan Path |
Name of the new deployment plan file. The filename can be absolute or relative to the application directory. |
||
Additional options |
Comma-separated list of deployment options, specified as name-value pairs. |
RunDeployer
Runs weblogic.Deployer
in a free-mode.
RunDeployer parameters
Parameter | Description |
---|---|
Command To Use |
The |
Java Parameters |
Java parameters to pass. For example, |
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
Additional Commands |
Additional commands to be entered for |
Java Absolute Path |
Absolute path of Java. For example, |
Application name |
Name of the application to manage. For example, |
setDomainEnv Script Absolute Path |
Absolute path of the |
weblogic jar Absolute Path |
Absolute path of the WebLogic jar, needed to run the |
StartApp
Starts an application
StartApp parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Application name |
Name of the application to start. For example, |
||
Application version |
Specific application version to be started. |
||
Additional options |
Additional options for |
StopApp
Stop an application
StopApp parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Application nameConfiguration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Application name |
Name of the application to start. For example, |
||
Application version |
Specific application version to be stopped. |
||
Additional options |
Additional options for |
CreateOrUpdateDatasource
This procedure creates a new generic JDBC Data Source or updates an existing one based on the update action.
CreateOrUpdateDatasource parameters
Parameter | Description | ||
---|---|---|---|
Configuration |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Datasource name |
Unique name of the JDBC generic Data Source to be created. |
||
DataSource Driver Class |
The full package name of JDBC driver class used to create the physical database connections in the connection pool. (Note that this driver class must be in the classpath of every server to which it is targeted/deployed). |
||
Database URL |
The JDBC URL of the database to connect to. The format of the URL varies by JDBC driver. The URL is passed to the JDBC driver to create the physical database connections. Examples:
|
||
JNDI name |
The JNDI path to where this Datasource is bound. For example jdbc/MYDS
By default, the JNDI name is the name of the Datasource. Applications that look up the JNDI path will get a |
||
Datasource Credentials |
Username and password for the Database. |
||
Database name |
Name of the Database/Default Schema to which the Database connection is to.
|
||
JDBC Driver Properties |
The list of properties passed to the JDBC driver that are used to create physical database connections. For example:
|
||
Target Server List |
A list of comma separated list of Servers on which the Data Source should be targeted. If targets are not specified, Data Source will be created but not deployed. |
||
Update Action |
This parameter controls as to what the Update Action should be when a DataSource with the same name exists
|
||
Additional options |
Use this option to specify optional parameters for example initial pool size, min pool size, max pool size, validation SQL etc. |
DeleteDatasource
Deletes a Datasource
DeleteDatasource parameters
Parameter | Description | ||
---|---|---|---|
Configuration |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Datasource name |
The unique name that identifies this Datasource in the WebLogic domain to delete it. |
CreateDatasource (DEPRECATED)
Creates a Datasource (DEPRECATED)
CreateDatasource parameters
Parameter | Description | ||
---|---|---|---|
Configuration |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Datasource name |
A unique name that identifies this Datasource in the WebLogic domain. |
||
Database |
The database used by the Datasource. |
||
Server Instance |
Instance name of the Server to include the Datasource. For example, |
||
Datasource JNDI |
The JNDI path to where this Datasource is bound. By default, the JNDI name is the name of the Datasource. Applications that look up the JNDI path will get a |
||
Datasource Driver Class |
The full package name of JDBC driver class used to create the physical database connections in the connection pool.
|
||
Datasource URL |
The URL of the database to connect to. The format of the URL varies by JDBC driver. The URL is passed to the JDBC driver to create the physical database connections. |
||
Database User |
The user to connect to the database. |
||
Database Password |
The password attribute passed to the JDBC driver when creating physical database connections. The value is stored in an encrypted form in the descriptor file and when displayed on the Administration Console. |
CreateOrUpdateConnectionFactory
Creates or updates Connection Factory
CreateOrUpdateConnectionFactory parameters
Parameter | Description |
---|---|
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
Connection Factory name |
Unique name of the Connection Factory that is created. |
JMS Module name |
Name of the JMS module in which the Connection Factory is created. |
Subscription Sharing Policy |
The Connection Factory Subscription Sharing Policy Subscribers can be used to control which subscribers can access new subscriptions.Values can be either Sharable or Exclusive. |
Client ID Policy |
The Client ID Policy indicates whether more than one JMS connection can use the same Client ID. Oracle recommends setting the Client ID policy to Unrestricted if sharing durable subscribers. Subscriptions created with different Client ID policies are always treated as independent subscriptions. |
JNDI name |
JNDI Name is used to look up the Connection factory using JNDI lookup. If the connection factory is created without passing this parameter, it can be only used in an Application Scoped context. |
Maximum Messages per Session |
This limit specifies the number of messages that can be queued for an asynchronous session. Default value is |
XA Connection Factory Enabled? |
Indicates if this connection factory should create XA queues and XA topics in order to accommodate JTA aware transactions. Default is Yes. |
Subdeployment name |
Name of Subdeployment. Required only if you do not want default targeting and instead want to use advanced targeting. |
Target WLS Instance List |
Comma delimited set of WebLogic Server instances (Standalone or cluster) to which the Connection Factory would be targeted to. Required only if Subdeployment Name is specified. |
Target JMS Server List |
Comma delimited set of JMS Servers to which the Connection Factory would be targeted to. Required only if Subdeployment Name is specified. |
Update Action |
This parameter controls as to what the Update Action should be when a Connection Factory with the same name exists:
|
Additional options |
Use this option to pass related parameters that pertain to Delivery, Client, Transaction or Flow Control. E.g.,
|
CreateOrUpdateJMSModule
Creates or updates JMS Module
CreateOrUpdateJMSModule parameters
Parameter | Description |
---|---|
Configuration |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
JMS Module name |
Unique name of the JMS system Module to be created or updated. |
Target WLS Instance List |
Comma delimited set of WebLogic Server instances (Standalone or cluster) to which the JMS system module would be deployed. |
Update Action |
This parameter controls as to what the Update Action should be when a JMS Module with the same name exists:
|
CreateOrUpdateJMSModuleSubdeployment
Creates or updates JMS Module Subdeployment
CreateOrUpdateJMSModuleSubdeployment parameters
Parameter | Description |
---|---|
Configuration |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
JMS Module name |
Unique name of the JMS Module in which the Sub-Deployment should be created. Note that this module should exist already for this Procedure to succeed. |
Subdeployment name |
Name of the Subdeployment to be created or updated. |
Target WLS Instance List |
One or more comma separated list of Servers or Clusters that constitute the Sub-Deployment. In essence a Sub-Deployment provides a way to group multiple targets to which JMS Resources can be created on. |
Update Action |
This parameter controls as to what the Update Action should be when a JMS Subdeployment with the same name exists:
|
CreateOrUpdateJMSQueue
Creates or updates JMS Queue
CreateOrUpdateJMSQueue parameters
Parameter | Description |
---|---|
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
JMS Queue name |
Unique name of the JMS Queue Name that is going to be created or updated. |
JMS Module name |
Name of the JMS module in which the JMS Queue is created. If there is already a JMS Queue with the specified name, it will be updated. The specified JMS Module should exist, if the module does not exist, the procedure will fail. |
JNDI name |
JNDI Name is used to look up the JMS Queue using JNDI lookup. If the JMS Queue is created without passing this parameter, it can be only used in an Application Scoped context. |
Subdeployment name |
Name of Subdeployment. Required in order to deploy the Queue. If this is not specified the Queue will not be usable. |
Target JMS Server |
JMS Server to which the Topic would be targeted to. Required only if Subdeployment Name is specified. |
Update Action |
This parameter controls as to what the Update Action should be when a JMS Queue with the same name exists
|
Additional options |
Use this option to specify general or advanced parameters, message thresholds and quota, message delivery overrides, message logging and message delivery failure options, e.g.,
|
CreateOrUpdateJMSServer
Creates or updates JMS Server
CreateOrUpdateJMSServer parameters
Parameter | Description |
---|---|
Configuration |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
JMS Server name |
Unique name of the JMS Server to be created or updated. |
Target WLS Instance |
The WLS Instance (Standalone or Cluster) to which this Server should be targeted. However, if this is not specified the JMS Server is not usable. |
Update Action |
This parameter controls as to what the Update Action should be when a JMS Module with the same name exists
|
CreateOrUpdateJMSTopic
Creates or updates JMS Topic
CreateOrUpdateJMSTopic parameters
Parameter | Description |
---|---|
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
JMS Topic name |
Unique name of the JMS Topic that is going to be created or updated. |
JMS Module name |
Name of the JMS module in which the JMS Topic is created. If there is already a JMS Topic with the specified name, it will be updated. |
JNDI name |
JNDI Name is used to look up the JMS Topic using JNDI lookup. If the JMS Topic is created without passing this parameter, it can be only used in an Application Scoped context. |
Subdeployment name |
Name of Subdeployment. Required in order to deploy the Topic. If this is not specified the Topic will not be usable. |
Target JMS Server |
JMS Server to which the Topic would be targeted to. Required only if Subdeployment Name is specified. |
Update Action |
This parameter controls as to what the Update Action should be when a JMS Topic with the same name exists:
MessagingPerformancePreference=30 DeliveryFailureParams.RedeliveryLimit=5 |
DeleteConnectionFactory
Deletes Connection Factory
DeleteConnectionFactory parameters
Parameter | Description |
---|---|
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
Connection Factory name |
Unique name of the Connection Factory that is going to be deleted. If the Connection Factory with the specified name does not exist, the procedure will fail. |
JMS Module name |
Name of the JMS module in which the Connection Factory was created. |
DeleteJMSModuleSubdeployment
Deletes JMS Module Subdeployment
DeleteJMSModuleSubdeployment parameters
Parameter | Description |
---|---|
Configuration |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
JMS Module name |
Unique name of the JMS Module in which the Sub-Deployment should be created. Note that this module should exist already for this Procedure to succeed. |
Subdeployment name |
Name of the Subdeployment to be created or updated. |
DeleteJMSQueue
Deletes JMS Queue
DeleteJMSQueue parameters
Parameter | Description |
---|---|
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
JMS Queue name |
Unique name of the JMS Queue that needs to be deleted. If JMS Queue with the specified name does not exist, the procedure will fail. |
JMS Module name |
Name of the JMS module in which the JMS Queue was created. |
DeleteJMSServer
Deletes JMS Server
DeleteJMSServer parameters
Parameter | Description |
---|---|
Configuration |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
JMS Server name |
Unique name of the JMS Server that needs deleting. If the server with the specified name does not exist, the procedure will fail. |
DeleteJMSTopic
Deletes JMS Topic
DeleteJMSTopic parameters
Parameter | Description |
---|---|
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
JMS Topic name |
Unique name of the JMS Topic that is going to be deleted. If JMS Topic with the specified name does not exist in the JMS Module, the procedure will fail. |
JMS Module name |
Name of the JMS module in which the JMS Topic was created. |
CreateUser
Create a user
CreateUser parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
User Credentials |
User credentials(Username and password). |
||
Domain name |
Name of the user domain. |
||
Realm name |
Name of the user realm. |
||
User Description |
Description about the user. |
||
Overwrite Existing User |
If enabled it will delete already existing user of the same name and recreate new user. |
CreateGroup
Create a group
CreateGroup parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Group name |
Name of the group to be created. |
||
Domain name |
Name of the group domain. |
||
Realm name |
Name of the group realm. |
||
Group Description |
Description about the group. |
||
Overwrite Existing Group |
If enabled it will delete already existing group of the same name and recreate new group. |
AddUserToGroup
Add a user to group.
AddUserToGroup parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
User name |
Name of the user to be added. |
||
Group name |
Name of the group in which user is to be added. |
||
Domain name |
Name of the user domain. |
||
Realm name |
Name of the user realm. |
ChangeUserPassword
Change password of a user.
ChangeUserPassword parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Old User Credentials |
Old user credentials(username and password). |
||
New User Credentials |
New user credentials(Username and password). Username should be same as username in old credentials. |
||
Domain name |
Name of the user domain. |
||
Realm name |
Name of the user realm. |
RemoveUserFromGroup
Remove a user from group.
RemoveUserFromGroup parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
User name |
Name of the user to be removed. |
||
Group name |
Name of the group from which user is to be removed. |
||
Domain name |
Name of the user domain. |
||
Realm name |
Name of the user realm. |
ConfigureUserLockoutManager
Configure User Lockout Manager.
ConfigureUserLockoutManager parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Lockout Threshold |
The maximum number of consecutive invalid login attempts that can occur before a user’s account is locked out. Minimum value: |
||
Lockout Duration |
The number of minutes that a user’s account is locked out. Minimum value: |
||
Lockout Enabled |
Specifies whether the server locks users out when there are invalid login attempts on their account. |
UnlockUserAccount
Unlock a user account.
UnlockUserAccount parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Server nameConfiguration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
User name |
Name of the user whose account is to be unlocked. |
||
Domain name |
Name of the user domain. |
||
Realm name |
Name of the user realm. |
DeleteGroup
Delete a group
DeleteGroup parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
Group name |
Name of the group to be deleted. |
||
Domain name |
Name of the user domain. |
||
Realm name |
Name of the user realm. |
DeleteUser
Delete a user
DeleteUser parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
User name |
Name of the user to be deleted. |
||
Domain name |
Name of the user domain. |
||
Realm name |
Name of the user realm. |
CheckClusterStatus
Check the status of the given server cluster name.
CheckClusterStatus parameters
Parameter | Description | ||
---|---|---|---|
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Maximum elapsed time |
Defines the maximum time in seconds that the job will try to check into the cluster. Blank implies no wait time (URL only checked one time). |
||
Success criteria |
Indicates the expected correct result to be obtained when running checking the cluster. |
||
Cluster name |
Indicates the name of the cluster to be checked. |
CheckServerStatus
Check the status of the given server URL
CheckServerStatus parameters
Parameter | Description | ||
---|---|---|---|
Configuration name |
Name of the configuration to be used. URL, port, and credentials are retrieved from the given configuration. |
||
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Maximum elapsed time |
Defines the maximum time in seconds that the job will try to check into the server. Blank implies no wait time (URL only checked one time). |
||
Success criteria |
Indicates the expected correct result to be obtained when running checking the server. |
||
Instance name |
Indicates the name of the instance to be checked. |
RunWLST
Runs Jython scripts using weblogic.WLST
RunWLST parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Script File Absolute Path |
Absolute path of a Jython script containing the desired job. The path is used only if |
||
Script File Source |
Indicates the source of the script file to execute. Either a existent file in the path defined in the |
||
Script File |
Content of the script file to run if |
||
Additional Commands |
Additional commands to be entered for |
||
Additional Environment Variables |
Additional environment variables as comma separated key-value pairs. For example:
|
||
weblogic jar Absolute Path |
Absolute path of the WebLogic jar, needed to run the run Jython scripts using |
CreateTemplate
Creates a domain template from the existing domain.
CreateTemplate parameters
Parameter | Description | ||
---|---|---|---|
WLST script absolute path |
Absolute path to WLST. For example,
|
||
Domain Directory |
Name of the domain directory from which you want to create the template. |
||
Template name |
Name (use .jar extension) and location of the domain template to store the domain configuration information. A domain template is a JAR file that contains domain configuration documents, applications, security data, startup scripts, and other information needed to create a WebLogic domain. |
CheckPageStatus
Check the status of a page on a given URL
CheckPageStatus parameters
Parameter | Description |
---|---|
Credentials to be entered |
The credentials needed to check the status of the page. |
Maximum elapsed time |
Defines the maximum time in seconds that the job will try to check into the server. Blank implies no wait time (URL only checked one time). |
Target URL |
URL of the page to be checked. (Required) |
Success criteria |
Indicates the expected correct result to be obtained when running checking the server. |
Discover
This procedure connects to a WebLogic environment, discovers objects specified by user and creates a WebLogic plugin configuration and an Application/Environment model in CloudBees CD/RO based on objects discovered.
Discover parameters
Parameter | Description |
---|---|
Resource name |
Name of the CloudBees CD/RO resource that represents the WebLogic environment that needs to be discovered. |
Resource Hostname |
Hostname of a machine with WebLogic and CloudBees CD/RO Agent running on it. Either Resource hostname (and port) or Resource Name should be specified. |
Resource Port |
Port of CloudBees CD/RO agent running on the machine. Default is |
Oracle Home |
Installation path of the WebLogic server, e.g. |
WLST Path |
Absolute Path to WLST utility. If not provided, the procedure will look for it, in known locations. Not required if Oracle Home is specified. |
Weblogic Connection Hostname |
Hostname to connect to WebLogic instance. |
Weblogic Connection Protocol |
Protocol to connect to WebLogic instance. |
WebLogic Credentials |
Username and password to connect to WebLogic server. |
Environment Project name |
If specified, a project if created for the environment. |
Environment name |
If specified, will be used to create CloudBees CD/RO environment. |
Application Project name |
Project name to create Application based on discovered objects. |
Application name |
Application for placing discovered objects. |
Object Names |
Objects to be retrieved from the WL Server in The list of Object Names can be found in the .csv report generated by this procedure. The list of supported object types:
|
ConfigurationParametersHolder
ConfigurationParametersHolder
ConfigurationParametersHolder parameters
Parameter | Description | ||
---|---|---|---|
WebLogic URL |
URL of WebLogic Server (must include protocol, server and port). Two protocols are supported: t3 and t3s, e.g. |
||
WLST script absolute path |
Absolute path to WLST. For example,
|
||
JAVA_HOME |
|
||
JAVA_VENDOR |
|
||
MW_HOME |
|
||
Login as |
Username and password to connect to WebLogic server. |
||
Enable named sessions? |
If checked, each WebLogic edit session will have unique name assigned. Named sessions are not supported by WebLogic server prior to version 12. Defaults to |
||
Test connection resource |
A resource which is used for the testing connection. |
||
Debug level |
Debug level, higher debug level - more debug messages.
|
Release notes
EC-WebLogic 4.0.0
-
Upgraded from Perl 5.8 to Perl 5.32. The EC-WebLogic plugin is not backward compatible with CloudBees CD/RO 10.3 and earlier.
-
Starting with the 4.0.0 release, CloudBees CD/RO agent v10.3 or later is required to run EC-WebLogic plugin procedures.
3.5.0
-
Add checking connection while creating a configuration.
-
Jobs for the successful CreateConfiguration and EditConfiguration run is now preserved.
-
Add logging while running CreateConfiguration.
3.4.1
-
Fixed the issue with lost output parameters for 9.0. Upon upgrade or clean installation of 9.0, output parameters were not created for the plugin’s procedures.
3.4.0
-
Introduced the following 2 new procedures:
-
CreatorUpdateDataSource to support Data Source management.
-
Discover procedure to support the discovery functionality where in an EF model can be created from an existing WebLogic environment.
-
Modified DeleteDataSource procedure
-
Procedure CreateDataSource is deprecated
3.3.0
-
Added support for JMS Resource Management by adding the following procedures:
-
CreateOrUpdateJMSServer
-
DeleteJMSServer
-
CreateOrUpdateJMSModule
-
DeleteJMS Module
-
CreateOrUpdateConnectionFactory
-
DeleteConnectionFactory
-
CreateOrUpdateJMSQueue
-
DeleteJMSQueue
-
CreateOrUpdateJMSTopic
-
DeleteJMSTopic
-
CreateOrUpdateJMSModuleSubdeployment
-
DeleteJMSModuleSubdeployment
-
3.2.4
-
Configured the plugin to allow the ElectricFlow UI to render the plugin procedure parameters entirely using the configured form XMLs.
-
Enabled the plugin for managing the plugin configurations in-line when defining an application process step or a pipeline stage task.
3.2.3
-
UpdateApp procedure has been marked as deprecated.
-
Following procedures have been added:
-
UpdateAppConfig
-
StartCluster
-
StopCluster
-
CheckClusterStatus
-
Additional parameters have been added to the following procedures:
-
StartApp
-
StopApp
-
UndeployApp
-
DeployApp
-
Checkbox Retire Gracefully? from UndeployApp procedure has been marked as deprecated and will be removed in the next release.
-
DeployApp does redeployment if application already exists.
-
StartApp and StopApp have been improved and warning is being thrown if application is already in the desired state.
-
StartCluster and StopCluster have been improved and warning is being thrown if cluster is already in the desired state.
-
Support of named edit sessions (concurrent edit sessions) has been added. If WebLogic server doesn’t have support of the named edit sessions, warning will be thrown.
-
MW_HOME
environment variable has been added to the plugin configuration.
3.2.2
-
Added missing documentation.
-
Fixed multiline inputs for text areas in CreateUser and CreateGroup procedures.
-
Fixed issue with CreateUser and DeleteUser procedure when credentials was not found.
-
Cleanup was performed.
3.2.1
-
A lot of minor improvements and bugfixes.
-
Added the following new procedures:
-
Add Server to Cluster
-
Add User to Group
-
Change User Password
-
Configure User Lockout Manager
-
Create Cluster
-
Create Domain
-
Create Group
-
Create Template
-
Create User
-
Delete Cluster
-
Delete Group
-
Delete User
-
Remove User from Group
-
Unlock User Account
-
Update App
3.0.0
-
Refactored the CheckPageStatus, CheckServerStatus, CreateDataSource, DeleteDataSource, DeployApp, RunWLST, StartApp, StopApp, and UndeployApp procedures.
-
Added link to plugin Configuration Page in plugin step panels.
2.0.6
-
Fixed typos in references to the
createDataSource
anddeleteDataSource
files in themanifest.pl
so that the files are included correctly in the plugin jar. -
Fixed errors in the createDataSource procedure.
2.0.5
-
Added four procedures to create datasource, delete datasource, suspend a server, and resume a server.
-
Fixed minor bugs.
2.0.3
-
Added a parameter in the start and stop server procedures to determine the maximum time in seconds to test the status of the server.
-
Created two procedures to start and stop the Node Manager.
2.0.0
-
New Help Page Format.
-
Add new Parameter Panels for each procedure.
-
Add the weblogic jar Absolute Path parameter to the DeployApp, UndeployApp, StartApp, StopApp, RunDeployer and RunWLST procedures. It is required to a Linux environment to load WebLogic libraries.
1.1.3
-
Add the Administration Server URL parameter to the StartManagedServer procedure.
-
Fixed minor issues.
1.1.0
-
Add the CheckPageStatus procedure.
-
Modify the CheckServerProcedure procedure. CURL is not needed and parameters were changed.
-
Fix minor bugs.
-
Remove the CURL dependency.
-
Add new
postp
matchers.