Overview

Allows you to manage a WebLogic cluster in a WebLogic domain.

Here is an example on how you should use this:

wls_cluster { 'WlsCluster':
  ensure           => 'present',
  messagingmode    => 'unicast',
  migrationbasis   => 'consensus',
  servers          => ['wlsServer3','wlsServer4'],
  multicastaddress => '239.192.0.0',
  multicastport    => '7001',
}

In this example you are managing a server in the default domain. When you want to manage a cluster in a specific domain, you can use:

wls_cluster { 'MuDomain/WlsCluster':
  ensure           => 'present',
  messagingmode    => 'unicast',
  migrationbasis   => 'consensus',
  servers          => ['wlsServer3','wlsServer4'],
  multicastaddress => '239.192.0.0',
  multicastport    => '7001',
}

Check the Oracle Weblogic documentation for more documentation about setting up and managing a WebLogic cluster.

Attributes

Attribute Name Short Description
additional_auto_migration_attempts A migratable server could fail to come up on every possible configured machine.
async_session_queue_timeout Interval in seconds until the producer thread will wait for the AsyncSessionQueue to become unblocked.
auto_migration_table_name Return the name of the table to be used for server migration.
client_cert_proxy_enabled Specifies whether to honor the WL-Proxy-Client-Cert header coming with the request or not.
cluster_address The address that forms a portion of the URL a client uses to connect to this cluster, and that is used for generating EJB handles and entity EJB failover addresses.
cluster_broadcast_channel Specifies the channel used to handle communications within a cluster.
cluster_messaging_mode Specifies the messaging type used in the cluster.
cluster_name The cluster name.
cluster_type Optimizes cross-cluster replication for the type of network that servers in the clusters use for administrative communication.
clusteraddress The address that forms a portion of the URL a client uses to connect to this cluster, and that is used for generating EJB handles and entity EJB failover addresses.
data_source_for_automatic_migration The data source used by servers in the cluster during migration.
data_source_for_job_scheduler Data source required to support persistence of jobs scheduled with the job scheduler
   
data_source_for_session_persistence To support HTTP Session failover across data centers, a datasource is required to dump session state on disk.
database_leasing_basis_connection_retry_count The maximum number of times Database Leasing will try to obtain a valid connection from the Data Source.
database_leasing_basis_connection_retry_delay The length of time, in milliseconds,Database Leasing will wait before attempting to obtain a new connection from the Data Source when a connection has failed.
datasourceforjobscheduler Data source required to support persistence of jobs scheduled with the job scheduler
   
default_load_algorithm Defines the algorithm to be used for load-balancing between replicated services if none is specified for a particular service.
domain With this parameter, you identify the domain, where your objects is in.
ensure The basic property that the resource should be in.
fencing_grace_period_millis During automatic migration, if the Cluster Master determines a server to be dead, it waits for this period of time (in milliseconds) before the Cluster Master migrates the service to another server in the cluster.
frontend_host The name of the host to which all redirected URLs will be sent.
frontend_http_port The name of the HTTP port to which all redirected URLs will be sent.
frontend_https_port The name of the secure HTTP port to which all redirected URLs will be sent.
frontendhost The name of the host to which all redirected URLs will be sent.
frontendhttpport The name of the HTTP port to which all redirected URLs will be sent.
frontendhttpsport The name of the secure HTTP port to which all redirected URLs will be sent.
greedy_session_flush_interval Interval in seconds until HTTP Sessions are periodically flushed to secondary server.
health_check_interval_millis Interval in milliseconds at which Migratable Servers and Cluster Masters prove their liveness via the database.
health_check_periods_until_fencing Maximum number of periods that a cluster member will wait before timing out a Cluster Master and also the maximum number of periods the Cluster Master will wait before timing out a Migratable Server.
http_trace_support_enabled Returns the value of HttpTraceSupportEnabled.
idle_periods_until_timeout Maximum number of periods that a cluster member will wait before timing out a member of a cluster.
inter_cluster_comm_link_health_check_interval If the cluster link between two clusters goes down, a trigger will run periodically to see if the link is restored.
job_scheduler_table_name The table name to use for storing timers active with the job scheduler
   
member_death_detector_enabled Enables faster Automatic Service Migration times with Database Leasing Basis.
member_warmup_timeout_seconds Maximum number of seconds that a cluster member will wait to discover and synchronize with other servers in the cluster.
message_ordering_enabled Forces unicast messages to be processed in order.
messagingmode Specifies the messaging type used in the cluster.
migration_basis Controls the mechanism used for server and service migration.
migration_datasource The data source used by servers in the cluster during migration.
migration_table_name Return the name of the table to be used for server migration.
migrationbasis Controls the mechanism used for server and service migration.
millis_to_sleep_between_auto_migration_attempts Controls how long of a pause there should be between the migration attempts described in getAdditionalAutoMigrationAttempts().
multicast_address The multicast address used by cluster members to communicate with each other.
multicast_buffer_size The multicast socket send/receive buffer size (at least 64 kilobytes).
multicast_data_encryption Enables multicast data to be encrypted.
multicast_port The multicast port (between 1 and 65535) used by cluster members to communicate with each other.
multicast_send_delay The amount of time (between 0 and 250 milliseconds) to delay sending message fragments over multicast in order to avoid OS-level buffer overflow.
multicast_ttl The number of network hops (between 1 and 255) that a cluster multicast message is allowed to travel.
multicastaddress The multicast address used by cluster members to communicate with each other.
multicastport The multicast port (between 1 and 65535) used by cluster members to communicate with each other.
name The name.
notes Optional information that you can include to describe this configuration.
number_of_servers_in_cluster_address Number of servers to be listed from this cluster when generating a cluster address automatically.
one_way_rmi_for_replication_enabled Indicates if one-way RMI is being used for replication.
persist_sessions_on_shutdown When shutting down servers, sessions are not updated.
provider resource.
remote_cluster_address Set the foreign cluster.
replication_channel The channel name to be used for replication traffic.
replication_timeout_enabled Indicates if timeout should be applied to session replication calls.
secure_replication_enabled Servers in a cluster replicate session data.
securereplication Servers in a cluster replicate session data.
servers The WebLogic servers which are part of this cluster.
service_activation_request_response_timeout The maximum time, in milliseconds seconds, for services to wait for response from cluster members.
service_age_threshold_seconds The number of seconds (between 0 and 65534) by which the age of two conflicting services must differ before one is considered older than the other.
session_flush_interval Interval in seconds until HTTP Sessions are periodically flushed to the backup cluster to dump session state on disk.
session_flush_threshold When number of sessions to be flushed reaches this threshold limit, sessions will be flushed to the backup cluster before the flush interval.
session_lazy_deserialization_enabled Enables increased efficiency with session replication.
session_state_query_protocol_enabled Indicates if session state query protocol is enabled.
session_state_query_request_timeout The maximum time, in seconds, for session state query request to wait for response from cluster members.
tags Return all tags on this Configuration MBean.
timeout Timeout for applying a resource.
txn_affinity_enabled If enabled, a server’s transaction requests go to servers in the cluster that are already participating in the global transaction.
unicastbroadcastchannel Specifies the channel used to handle communications within a cluster.
wan_session_persistence_table_name Return the name of the table to be used for WAN session persistence.
weblogic_plugin_enabled Specifies whether the proprietary WL-Proxy-Client-IP header should be used.

additional_auto_migration_attempts

A migratable server could fail to come up on every possible configured machine. This attribute controls how many further attempts, after the first one, should be tried. Note that each attempt specified here indicates another full circuit of migrations amongst all the configured machines. So for a 3-server cluster, and the default value of 3, a total of 9 migrations will be attempted. If it is set to -1, migrations will go on forever until the server starts.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   additional_auto_migration_attempts => '3'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:additional_auto_migration_attempts']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

async_session_queue_timeout

Interval in seconds until the producer thread will wait for the AsyncSessionQueue to become unblocked. Should be similar to the RequestTimeOut as that will determine the longest that the queue should remain full.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   async_session_queue_timeout => '30'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:async_session_queue_timeout']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

auto_migration_table_name

Return the name of the table to be used for server migration.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   auto_migration_table_name => 'ACTIVE'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:auto_migration_table_name']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

client_cert_proxy_enabled

Specifies whether to honor the WL-Proxy-Client-Cert header coming with the request or not.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   client_cert_proxy_enabled => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:client_cert_proxy_enabled']
   ...
}

This help text generated from MBean text of the WebLogic server.

Valid values are absent, 0, 1. Back to overview of wls_cluster

cluster_address

The address that forms a portion of the URL a client uses to connect to this cluster, and that is used for generating EJB handles and entity EJB failover addresses. (This address may be either a DNS host name that maps to multiple IP addresses or a comma-separated list of single address host names or IP addresses.) Defines the address to be used by clients to connect to this cluster. This address may be either a DNS host name that maps to multiple IP addresses or a comma separated list of single address host names or IP addresses. If network channels are configured, it is possible to set the cluster address on a per channel basis.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   cluster_address => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:cluster_address']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

cluster_broadcast_channel

Specifies the channel used to handle communications within a cluster. If no channel is specified the default channel is used. ClusterBroadcastChannel is only are supported if the unicast messaging type is used.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   cluster_broadcast_channel => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:cluster_broadcast_channel']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

cluster_messaging_mode

Specifies the messaging type used in the cluster. Multicast messaging is provided for backwards compatibility.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   cluster_messaging_mode => 'unicast'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:cluster_messaging_mode']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

cluster_name

The cluster name. This must be an alphanumeric string.

To identify an cluster, use:

wls_cluster { 'domain_name/TheClusterName':
...
}

Back to overview of wls_cluster

cluster_type

Optimizes cross-cluster replication for the type of network that servers in the clusters use for administrative communication. To enhance the reliability of HTTP sessions, you can configure servers in one cluster to replicate the session data to servers in a different cluster. In such an environment, configure the clusters to be one of the following types: <ul> <li>man If the clustered servers can send their data through a metro area network (man) in which latency is negligible. With this ClusterType value, servers replicate session state synchronously and in memory only. For example, when serverA in cluster1 starts an HTTP session, its backup server, serverB in cluster2, immediately replicates this session in memory to Server B. </li> <li>wan If the clusters are far apart or send their data through a wide area network (wan) that experiences significant network latency. With this ClusterType value, a server replicates session state synchronously to the backup server in the same cluster and asynchronously to a server in the remote cluster. For example, when serverA in cluster1 starts an HTTP session, it sends the data to serverB in cluster1 and then asynchronously sends data to serverX in cluster 2. ServerX will persist the session state in the database. If you persist session data in a replicating database, and if you prefer to use the database to replicate the data instead of WebLogic Server, choose a cluster type of wan and leave the remote cluster address undefined. WebLogic Server saves the session data to the local database and assumes that the database replicates data as needed. </li> </ul>

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   cluster_type => 'none'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:cluster_type']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

clusteraddress

The address that forms a portion of the URL a client uses to connect to this cluster, and that is used for generating EJB handles and entity EJB failover addresses. (This address may be either a DNS host name that maps to multiple IP addresses or an array of single address host names or IP addresses.) Defines the address to be used by clients to connect to this cluster. This address may be either a DNS host name that maps to multiple IP addresses or a comma separated list of single address host names or IP addresses. If network channels are configured, it is possible to set the cluster address on a per channel basis.

An example on how to use this:

  wls_cluster { 'aCluster':
    ...
    clusteraddress => '10.10.10.30',
    ...
  }

or use a host name like this:

  wls_cluster { 'aCluster':
    ...
    clusteraddress => 'myhost.exaqmple.com',
    ...
  }

Back to overview of wls_cluster

data_source_for_automatic_migration

The data source used by servers in the cluster during migration. (You must configure each Migratable Server within the cluster to use this data source.)

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   data_source_for_automatic_migration => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:data_source_for_automatic_migration']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

data_source_for_job_scheduler

Data source required to support persistence of jobs scheduled with the job scheduler

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   data_source_for_job_scheduler => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:data_source_for_job_scheduler']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

data_source_for_session_persistence

To support HTTP Session failover across data centers, a datasource is required to dump session state on disk.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   data_source_for_session_persistence => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:data_source_for_session_persistence']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

database_leasing_basis_connection_retry_count

The maximum number of times Database Leasing will try to obtain a valid connection from the Data Source.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   database_leasing_basis_connection_retry_count => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:database_leasing_basis_connection_retry_count']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

database_leasing_basis_connection_retry_delay

The length of time, in milliseconds,Database Leasing will wait before attempting to obtain a new connection from the Data Source when a connection has failed.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   database_leasing_basis_connection_retry_delay => '1000'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:database_leasing_basis_connection_retry_delay']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

datasourceforjobscheduler

Data source required to support persistence of jobs scheduled with the job scheduler

An example on how to use this:

  wls_cluster { 'aCluster':
    ...
    datasourceforjobscheduler => 'schedulerDatasource',
    ...
  }

Back to overview of wls_cluster

default_load_algorithm

Defines the algorithm to be used for load-balancing between replicated services if none is specified for a particular service. The round-robin algorithm cycles through a list of WebLogic Server instances in order. Weight-based load balancing improves on the round-robin algorithm by taking into account a pre-assigned weight for each server. In random load balancing, requests are routed to servers at random.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   default_load_algorithm => 'round-robin'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:default_load_algorithm']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

domain

With this parameter, you identify the domain, where your objects is in.

The domain name is part of the full qualified name of any WebLogic object on a system. Let’s say we want to describe a WebLogic server. The full qualified name is:

wls_server{'domain_name/server_name':
  ensure => present,
  ...
}

When you don’t specify a domain name, Puppet will use default as domain name. For every domain you want to manage, you’ll have to put a wls_settings in your manifest.

Back to overview of wls_cluster

ensure

The basic property that the resource should be in.

Valid values are present, absent. Back to overview of wls_cluster

fencing_grace_period_millis

During automatic migration, if the Cluster Master determines a server to be dead, it waits for this period of time (in milliseconds) before the Cluster Master migrates the service to another server in the cluster.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   fencing_grace_period_millis => '30000'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:fencing_grace_period_millis']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

frontend_host

The name of the host to which all redirected URLs will be sent. Sets the HTTP FrontendHost for the default webserver (not virtual hosts) for all the servers in the cluster. Provides a method to ensure that the webapp will always have the correct HOST information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place, when constructing the absolute urls for redirects.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   frontend_host => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:frontend_host']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

frontend_http_port

The name of the HTTP port to which all redirected URLs will be sent. Sets the FrontendHTTPPort for the default webserver (not virtual hosts) for all the servers in the cluster. Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place, when constructing the absolute urls for redirects.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   frontend_http_port => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:frontend_http_port']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

frontend_https_port

The name of the secure HTTP port to which all redirected URLs will be sent. Sets the FrontendHTTPSPort for the default webserver (not virtual hosts) for all the servers in the cluster. Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place, when constructing the absolute urls for redirects.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   frontend_https_port => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:frontend_https_port']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

frontendhost

The name of the host to which all redirected URLs will be sent. Sets the HTTP FrontendHost for the default webserver (not virtual hosts) for all the servers in the cluster. Provides a method to ensure that the webapp will always have the correct HOST information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place, when constructing the absolute urls for redirects.

Here is an example on how to use this:

wls_cluster { 'aCluster':
  ...
  frontendhost => '10.10.10.30',
  ...
}

or use a host name like this:

wls_cluster { 'aCluster':
  ...
  frontendhost => 'myhost.exaqmple.com',
  ...
}

Back to overview of wls_cluster

frontendhttpport

The name of the HTTP port to which all redirected URLs will be sent. Sets the FrontendHTTPPort for the default webserver (not virtual hosts) for all the servers in the cluster. Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place, when constructing the absolute urls for redirects.

Here is an example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   frontend_http_port => 'a_value'
   ...
}

Back to overview of wls_cluster

frontendhttpsport

The name of the secure HTTP port to which all redirected URLs will be sent. Sets the FrontendHTTPSPort for the default webserver (not virtual hosts) for all the servers in the cluster. Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place, when constructing the absolute urls for redirects.

Here is an example on how to use this:

wls_cluster { 'aCluster':
  ...
  frontendhttpport => '9000',
  ...
}

Back to overview of wls_cluster

greedy_session_flush_interval

Interval in seconds until HTTP Sessions are periodically flushed to secondary server.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   greedy_session_flush_interval => '3'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:greedy_session_flush_interval']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

health_check_interval_millis

Interval in milliseconds at which Migratable Servers and Cluster Masters prove their liveness via the database.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   health_check_interval_millis => '10000'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:health_check_interval_millis']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

health_check_periods_until_fencing

Maximum number of periods that a cluster member will wait before timing out a Cluster Master and also the maximum number of periods the Cluster Master will wait before timing out a Migratable Server.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   health_check_periods_until_fencing => '3'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:health_check_periods_until_fencing']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

http_trace_support_enabled

Returns the value of HttpTraceSupportEnabled.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   http_trace_support_enabled => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:http_trace_support_enabled']
   ...
}

This help text generated from MBean text of the WebLogic server.

Valid values are absent, 0, 1. Back to overview of wls_cluster

idle_periods_until_timeout

Maximum number of periods that a cluster member will wait before timing out a member of a cluster. Maximum number of periods that a cluster member will wait before timing out a member of a cluster.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   idle_periods_until_timeout => '3'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:idle_periods_until_timeout']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

inter_cluster_comm_link_health_check_interval

If the cluster link between two clusters goes down, a trigger will run periodically to see if the link is restored. The duration is specified in milliseconds.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   inter_cluster_comm_link_health_check_interval => '30000'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:inter_cluster_comm_link_health_check_interval']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

job_scheduler_table_name

The table name to use for storing timers active with the job scheduler

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   job_scheduler_table_name => 'weblogic_timers'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:job_scheduler_table_name']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

member_death_detector_enabled

Enables faster Automatic Service Migration times with Database Leasing Basis.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   member_death_detector_enabled => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:member_death_detector_enabled']
   ...
}

This help text generated from MBean text of the WebLogic server.

Valid values are absent, 0, 1. Back to overview of wls_cluster

member_warmup_timeout_seconds

Maximum number of seconds that a cluster member will wait to discover and synchronize with other servers in the cluster. Normally, the member will be able to sync in 30 seconds. If the value of this attribute is higher, that does not necessarily mean that it will take longer for the member to warmup. Instead it defines an upper bound on the time that a server will wait to sync with the servers that it has discovered. If the value is set 0, servers will not attempt to discover other running server in the cluster during server initialization

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   member_warmup_timeout_seconds => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:member_warmup_timeout_seconds']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

message_ordering_enabled

Forces unicast messages to be processed in order. There are scenarios where JMS may update JNDI very frequently. It will result in a lot of messages over unicast. Due to the close proximity of messages the probability of out of order handling of messages increases which would trigger frequent state dumps. Frequent JNDI tree refresh may result in NameNotFoundException. Use this property to prevent out of order handling of messages.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   message_ordering_enabled => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:message_ordering_enabled']
   ...
}

This help text generated from MBean text of the WebLogic server.

Valid values are absent, 0, 1. Back to overview of wls_cluster

messagingmode

Specifies the messaging type used in the cluster. Multicast messaging is provided for backwards compatibility.

Here is an example on how to use this: wls_cluster { ‘aCluster’: … messagingmode => ‘multicast’, … }

Valid values are absent, multicast, unicast. Back to overview of wls_cluster

migration_basis

Controls the mechanism used for server and service migration. <ul> <li>Database – Requires the availability of a high-availability database, such as Oracle RAC, to store leasing information. <li>Consensus – Stores the leasing information in-memory within a cluster member. This option requires Node Manager to be configured and running. </ul> Note: Within a WebLogic Server installation, you can only use one type of leasing. Although it is possible to implement multiple features that use leasing within your environment, each must use the same kind of leasing.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   migration_basis => 'database'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:migration_basis']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

migration_datasource

The data source used by servers in the cluster during migration. (You must configure each Migratable Server within the cluster to use this data source.)

Here is an example on how to use this:

wls_cluster { 'aCluster':
  ...
  migration_datasource => 'mydatasourcename',
  ...
}

Back to overview of wls_cluster

migration_table_name

Return the name of the table to be used for server migration.

Here is an example on how to use this:

wls_cluster { 'aCluster':
  ...
  migration_table_name => 'MYTABLE',
  ...
}

Back to overview of wls_cluster

migrationbasis

Controls the mechanism used for server and service migration. <ul> <li>Database – Requires the availability of a high-availability database, such as Oracle RAC, to store leasing information. <li>Consensus – Stores the leasing information in-memory within a cluster member. This option requires Node Manager to be configured and running. </ul> Note: Within a WebLogic Server installation, you can only use one type of leasing. Although it is possible to implement multiple features that use leasing within your environment, each must use the same kind of leasing.

Here is an example on how to use this:

wls_cluster { 'aCluster':
  ...
  migrationbasis => 'database',
  ...
}

Valid values are absent, consensus, database. Back to overview of wls_cluster

millis_to_sleep_between_auto_migration_attempts

Controls how long of a pause there should be between the migration attempts described in getAdditionalAutoMigrationAttempts(). Note that this delay only happens when the server has failed to come up on every machine.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   millis_to_sleep_between_auto_migration_attempts => '180000'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:millis_to_sleep_between_auto_migration_attempts']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

multicast_address

The multicast address used by cluster members to communicate with each other. The valid range is from from 224.0.0.0 to 239.255.255.255. The default value used by WebLogic Server is 239.192.0.0. You should avoid using multicast addresses in the range x.0.0.1 This address should be unique to this cluster and should not be shared by other applications.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   multicast_address => '239.192.0.0'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:multicast_address']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

multicast_buffer_size

The multicast socket send/receive buffer size (at least 64 kilobytes). Returns the multicast socket send/receive buffer size.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   multicast_buffer_size => '64'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:multicast_buffer_size']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

multicast_data_encryption

Enables multicast data to be encrypted. Only the multicast data is encrypted. Multicast header information is not encrypted.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   multicast_data_encryption => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:multicast_data_encryption']
   ...
}

This help text generated from MBean text of the WebLogic server.

Valid values are absent, 0, 1. Back to overview of wls_cluster

multicast_port

The multicast port (between 1 and 65535) used by cluster members to communicate with each other. Defines the multicast port used by cluster members to communicate with each other.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   multicast_port => '7001'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:multicast_port']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

multicast_send_delay

The amount of time (between 0 and 250 milliseconds) to delay sending message fragments over multicast in order to avoid OS-level buffer overflow. Defines the number of milliseconds to delay sending message fragments over multicast in order to avoid OS-level buffer overflow.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   multicast_send_delay => '3'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:multicast_send_delay']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

multicast_ttl

The number of network hops (between 1 and 255) that a cluster multicast message is allowed to travel. Defines the number of network hops that a cluster multicast message is allowed to travel. 1 restricts the cluster to one subnet.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   multicast_ttl => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:multicast_ttl']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

multicastaddress

The multicast address used by cluster members to communicate with each other. The valid range is from from 224.0.0.0 to 239.255.255.255. The default value used by WebLogic Server is 239.192.0.0. You should avoid using multicast addresses in the range x.0.0.1 This address should be unique to this cluster and should not be shared by other applications.

You can use an ip address like this:

wls_cluster { 'aCluster':
  ...
  multicastaddress => '10.10.10.30',
  ...
}

or use a host name like this:

wls_coherence_cluster { 'aCluster':
  ...
  multicastaddress => 'myhost.exaqmple.com',
  ...
}

Back to overview of wls_cluster

multicastport

The multicast port (between 1 and 65535) used by cluster members to communicate with each other. Defines the multicast port used by cluster members to communicate with each other.

Here is an example on how to use this on a regular WebLogic cluster:

wls_cluster { 'aCluster':
  ...
  multicastport => '9000',
  ...
}

Back to overview of wls_cluster

name

The name.

Back to overview of wls_cluster

notes

Optional information that you can include to describe this configuration. WebLogic Server saves this note in the domain’s configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. Carriage returns/line feeds are preserved. <dl> <dt>Note:</dt> <dd> If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds. </dd> </dl>

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   notes => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:notes']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

number_of_servers_in_cluster_address

Number of servers to be listed from this cluster when generating a cluster address automatically. This setting has no effect if Cluster Address is explicitly set.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   number_of_servers_in_cluster_address => '3'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:number_of_servers_in_cluster_address']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

one_way_rmi_for_replication_enabled

Indicates if one-way RMI is being used for replication. One-way RMI also requires configuring replication ports on each server in the cluster.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   one_way_rmi_for_replication_enabled => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:one_way_rmi_for_replication_enabled']
   ...
}

This help text generated from MBean text of the WebLogic server.

Valid values are absent, 0, 1. Back to overview of wls_cluster

persist_sessions_on_shutdown

When shutting down servers, sessions are not updated. If the primary and secondary servers of a session are shut down with no session updates, the session will be lost. Turning on PersistSessionsOnShutdown will save any active sessions to the database specified in {@link ClusterMBean#getDataSourceForSessionPersistence()} when a server is shutdown. The sessions will not be written at any other time. (For example, they are not saved via this mechanism if there is a server crash.) This attribute is applicable both to session persistence on server shutdown or session persistence across a WAN. Rolling upgrade can potentially have a bad interaction with traditional in-memory session replication. As managed servers are shutdown and upgraded, in-memory servlet sessions will be lost if both primary and secondary are rebooted before a new request arrives for the session.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   persist_sessions_on_shutdown => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:persist_sessions_on_shutdown']
   ...
}

This help text generated from MBean text of the WebLogic server.

Valid values are absent, 0, 1. Back to overview of wls_cluster

provider

The specific backend to use for this wls_cluster resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.Available providers are:

simple
Manage a cluster in an WebLogic domain via regular WLST

Back to overview of wls_cluster

remote_cluster_address

Set the foreign cluster. Cluster infrastructure uses this address to connect to foreign cluster for HTTP Session WAN/MAN failover.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   remote_cluster_address => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:remote_cluster_address']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

replication_channel

The channel name to be used for replication traffic. Cluster infrastructure uses this channel to send updates for HTTP sessions and stateful session beans. If none is set then the default channel will be used. In order for this feature to work, the named channel must exist on all members of the cluster and must be configured to use the same protocol. It is valid for the selected channel to be configured to use a secure protocol.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   replication_channel => 'ReplicationChannel'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:replication_channel']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

replication_timeout_enabled

Indicates if timeout should be applied to session replication calls.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   replication_timeout_enabled => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:replication_timeout_enabled']
   ...
}

This help text generated from MBean text of the WebLogic server.

Valid values are absent, 0, 1. Back to overview of wls_cluster

secure_replication_enabled

Servers in a cluster replicate session data. If a replication channel is defined then the session data will be sent using the replication channel protocol and secured replication settings will be ignored. If no replication channel is defined and secured replication is enabled then session data for in-memory replication will be sent over SSL using the default secured channel. However, this added security for replication traffic comes with a significant cluster performance degradation. It should only be enabled if security is of greater concern than performance degradation.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   secure_replication_enabled => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:secure_replication_enabled']
   ...
}

This help text generated from MBean text of the WebLogic server.

Valid values are absent, 0, 1. Back to overview of wls_cluster

securereplication

Servers in a cluster replicate session data. If a replication channel is defined then the session data will be sent using the replication channel protocol and secured replication settings will be ignored. If no replication channel is defined and secured replication is enabled then session data for in-memory replication will be sent over SSL using the default secured channel. However, this added security for replication traffic comes with a significant cluster performance degradation. It should only be enabled if security is of greater concern than performance degradation.

Here is an example on how to use this: wls_cluster { ‘aCluster’: … securereplication => ‘1’, … }

Valid values are absent, 1, 0. Back to overview of wls_cluster

servers

The WebLogic servers which are part of this cluster. Here is an example on how to use this:

wls_cluster { 'aCluster':
  ...
  servers => ['server_1','server_2],
  ...
}

Back to overview of wls_cluster

service_activation_request_response_timeout

The maximum time, in milliseconds seconds, for services to wait for response from cluster members.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   service_activation_request_response_timeout => '10000'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:service_activation_request_response_timeout']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

service_age_threshold_seconds

The number of seconds (between 0 and 65534) by which the age of two conflicting services must differ before one is considered older than the other. Defines the number of seconds by which the age of two conflicting services must differ before one is considered older than the other.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   service_age_threshold_seconds => '180'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:service_age_threshold_seconds']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

session_flush_interval

Interval in seconds until HTTP Sessions are periodically flushed to the backup cluster to dump session state on disk.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   session_flush_interval => '180'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:session_flush_interval']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

session_flush_threshold

When number of sessions to be flushed reaches this threshold limit, sessions will be flushed to the backup cluster before the flush interval. This helps the server to flush sessions faster under load.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   session_flush_threshold => '10000'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:session_flush_threshold']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

session_lazy_deserialization_enabled

Enables increased efficiency with session replication. Enabling this attribute should be used only when configuring a WebLogic domain for Oracle Exalogic.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   session_lazy_deserialization_enabled => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:session_lazy_deserialization_enabled']
   ...
}

This help text generated from MBean text of the WebLogic server.

Valid values are absent, 0, 1. Back to overview of wls_cluster

session_state_query_protocol_enabled

Indicates if session state query protocol is enabled. The Session State Query protocol will query the local cluster for the location of a session state instance if a request arrives at a server that is neither the primary or secondary server.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   session_state_query_protocol_enabled => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:session_state_query_protocol_enabled']
   ...
}

This help text generated from MBean text of the WebLogic server.

Valid values are absent, 0, 1. Back to overview of wls_cluster

session_state_query_request_timeout

The maximum time, in seconds, for session state query request to wait for response from cluster members.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   session_state_query_request_timeout => '30'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:session_state_query_request_timeout']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

tags

Return all tags on this Configuration MBean.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   tags => 'a_value'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:tags']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

timeout

Timeout for applying a resource.

To be sure no Puppet operation, hangs a Puppet daemon, all operations have a timeout. When this timeout expires, Puppet will abort the current operation and signal an error in the Puppet run.

With this parameter, you can specify the length of the timeout. The value is specified in seconds. In this example, the timeout is set to 600 seconds.

wls_server{'my_server':
  ...
  timeout => 600,
}

The default value for timeout is 120 seconds.

Back to overview of wls_cluster

txn_affinity_enabled

If enabled, a server’s transaction requests go to servers in the cluster that are already participating in the global transaction.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   txn_affinity_enabled => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:txn_affinity_enabled']
   ...
}

This help text generated from MBean text of the WebLogic server.

Valid values are absent, 0, 1. Back to overview of wls_cluster

unicastbroadcastchannel

Specifies the channel used to handle communications within a cluster. If no channel is specified the default channel is used. ClusterBroadcastChannel is only are supported if the unicast messaging type is used.

Here is an example on how to use this: wls_cluster { ‘aCluster’: … unicastbroadcastchannel => ‘my_cluster_channel’, … }

Back to overview of wls_cluster

wan_session_persistence_table_name

Return the name of the table to be used for WAN session persistence.

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   wan_session_persistence_table_name => 'WLS_WAN_PERSISTENCE_TABLE'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:wan_session_persistence_table_name']
   ...
}

This help text generated from MBean text of the WebLogic server.

Back to overview of wls_cluster

weblogic_plugin_enabled

Specifies whether the proprietary WL-Proxy-Client-IP header should be used. (This needed only when WebLogic plugins are configured.) Gets the weblogicPluginEnabled attribute of the ClusterMBean object

An example on how to use this:

wls_cluster {a_wls_cluster :
   ...
   weblogic_plugin_enabled => '1'
   ...
}

This is an extended property. Before you can use it add it to the wls_settings property extra_properties.

wls_setting{'domain':
   ...
  extra_properties => ['wls_cluster:weblogic_plugin_enabled']
   ...
}

This help text generated from MBean text of the WebLogic server.

Valid values are absent, 0, 1. Back to overview of wls_cluster