Overview

This resource allows you to manage a coherence server in an WebLogic domain.

Here is an example on how you should use this:

wls_coherence_server { 'default':
  ensure         => 'present',
  server         => 'LocalMachine',
  unicastaddress => 'localhost',
  unicastport    => '8888',
}

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

wls_coherence_server { 'my_domain/default':
  ensure         => 'present',
  server         => 'LocalMachine',
  unicastaddress => 'localhost',
  unicastport    => '8888',
}

Check the Oracle Weblogic documentation for more documentation about setting up and managing a coherence server.

Attributes

Attribute Name Short Description
autorestart Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly.
classpath The coherence machine classpath.
coherence_cluster_system_resource The system-level Coherence cluster resource associated with this server.
coherence_server_name The coherence server name.
domain With this parameter, you identify the domain, where your objects is in.
ensure The basic property that the resource should be in.
machine The machine of the server.
name The name.
nm_socket_create_timeout_in_millis Returns the timeout value to be used by NodeManagerRuntime when creating a socket connection to the agent.
notes Optional information that you can include to describe this configuration.
provider resource.
restart_delay_seconds The number of seconds the Node Manager should wait before restarting this server.
restart_interval_seconds The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.
restart_max The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.
restartdelay The number of seconds the Node Manager should wait before restarting this server.
restartinterval The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.
restartmax The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.
start_arguments The arguments to use when starting this server.
start_bea_home The BEA home directory (path on the machine running Node Manager) to use when starting this server.
start_class_path The classpath (path on the machine running Node Manager) to use when starting this server.
start_java_home The Java home directory (path on the machine running Node Manager) to use when starting this server.
start_java_vendor The Java Vendor value to use when starting this server.
start_mw_home The MWHome directory (path on the machine running Node Manager) to use when starting this server.
start_notes Optional information that you can include to describe this configuration.
start_root_directory The directory that this server uses as its root directory.
start_tags Return all tags on this Configuration MBean
   
tags Return all tags on this Configuration MBean
   
unicast_listen_address The IP address for the cluster unicast listener.
unicast_listen_port The port for the cluster unicast listener.
unicast_port_auto_adjust Specifies whether the unicast port will be automatically incremented if the port cannot be bound because it is already in use.
unicast_port_auto_adjust_attempts Gets the upper bound of the unicast port.
unicastaddress The IP address for the cluster unicast listener.
unicastport The port for the cluster unicast listener.

autorestart

Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   auto_restart => '1'
   ...
}

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

classpath

The coherence machine classpath.

Here is an example on how to use this:

wls_coherence_server{ 'my_coherence_server':
  ...
  classpath => 'myClasspath',
  ...
}

Back to overview of wls_coherence_server

coherence_cluster_system_resource

The system-level Coherence cluster resource associated with this server.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   coherence_cluster_system_resource => '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_coherence_server:coherence_cluster_system_resource']
   ...
}

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

Back to overview of wls_coherence_server

coherence_server_name

The coherence server name.

To identify a coherence server, use:

wls_coherence_server{'domain_name/TheServerName':
...
}

Back to overview of wls_coherence_server

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_coherence_server

ensure

The basic property that the resource should be in.

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

machine

The machine of the server.

Here is an example on how to use this:

wls_coherence_server{ 'my_coherence_server':
  ...
  machine => 'machine_1',
  ...
}

Back to overview of wls_coherence_server

name

The name.

Back to overview of wls_coherence_server

nm_socket_create_timeout_in_millis

Returns the timeout value to be used by NodeManagerRuntime when creating a socket connection to the agent. Default set high as SSH agent may require a high connection establishment time.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   nm_socket_create_timeout_in_millis => '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_coherence_server:nm_socket_create_timeout_in_millis']
   ...
}

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

Back to overview of wls_coherence_server

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_coherence_server {a_wls_coherence_server :
   ...
   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_coherence_server:notes']
   ...
}

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

Back to overview of wls_coherence_server

provider

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

simple
Manage coherence server

Back to overview of wls_coherence_server

restart_delay_seconds

The number of seconds the Node Manager should wait before restarting this server. After killing a server process, the system might need several seconds to release the TCP port(s) the server was using. If Node Manager attempts to restart the Managed Server while its ports are still active, the startup attempt fails. If AutoMigration is enabled and RestartDelaySeconds is 0, the RestartDelaySeconds is automatically set to the lease time. This prevents the server from failing to restart after migration when the previous lease is still valid.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   restart_delay_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_coherence_server:restart_delay_seconds']
   ...
}

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

Back to overview of wls_coherence_server

restart_interval_seconds

The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   restart_interval_seconds => '3600'
   ...
}

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_coherence_server:restart_interval_seconds']
   ...
}

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

Back to overview of wls_coherence_server

restart_max

The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   restart_max => '2'
   ...
}

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_coherence_server:restart_max']
   ...
}

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

Back to overview of wls_coherence_server

restartdelay

The number of seconds the Node Manager should wait before restarting this server. After killing a server process, the system might need several seconds to release the TCP port(s) the server was using. If Node Manager attempts to restart the Managed Server while its ports are still active, the startup attempt fails. If AutoMigration is enabled and RestartDelaySeconds is 0, the RestartDelaySeconds is automatically set to the lease time. This prevents the server from failing to restart after migration when the previous lease is still valid.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   restartdelay => 'a_value'
   ...
}

Back to overview of wls_coherence_server

restartinterval

The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server : … restartinterval => ‘3600’ … }

Back to overview of wls_coherence_server

restartmax

The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   restartmax => '2'
   ...
}

Back to overview of wls_coherence_server

start_arguments

The arguments to use when starting this server. These are the first arguments appended immediately after java portion of the startup command. For example, you can set Java heap memory or specify any weblogic.nodemanager.server.provider.WeblogicCacheServer option. Separate arguments with a space.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   start_arguments => '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_coherence_server:start_arguments']
   ...
}

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

Back to overview of wls_coherence_server

start_bea_home

The BEA home directory (path on the machine running Node Manager) to use when starting this server. Specify the directory on the Node Manager machine under which all of Oracle’s BEA products were installed. For example, c:&#92Oracle&#92Middleware&#92.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   start_bea_home => '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_coherence_server:start_bea_home']
   ...
}

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

Back to overview of wls_coherence_server

start_class_path

The classpath (path on the machine running Node Manager) to use when starting this server. If you need to add user classes to the classpath, in addition you will need to add the following: FEATURES_HOME/weblogic.server.modules.coherence.server_10.3.4.0.jar:COHERENCE_HOME/lib/coherence.jar where FEATURES_HOME is the features directory (typically $MW_HOME/modules/features) and COHERENCE_HOME the coherence directory (typically $MW_HOME/coherence_3.6) on the Node Manager machine. If you do not specify a classpath the above will be used automatically. The operating system determines which character separates path elements. On Windows, use a semicolon (;). On UNIX a colon (:).

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   start_class_path => '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_coherence_server:start_class_path']
   ...
}

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

Back to overview of wls_coherence_server

start_java_home

The Java home directory (path on the machine running Node Manager) to use when starting this server. Specify the parent directory of the JDK’s bin directory. For example, c:\bea\jdk141.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   start_java_home => '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_coherence_server:start_java_home']
   ...
}

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

Back to overview of wls_coherence_server

start_java_vendor

The Java Vendor value to use when starting this server. If the server is part of a cluster and configured for automatic migration across possibly different platforms with different vendors providing the JDKs, then, both JavaVendor and JavaHome should be set in the generated configuration file instead.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   start_java_vendor => '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_coherence_server:start_java_vendor']
   ...
}

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

Back to overview of wls_coherence_server

start_mw_home

The MWHome directory (path on the machine running Node Manager) to use when starting this server. Specify the directory on the Node Manager machine under which all of Oracle’s MW products were installed. For example, c:\Oracle\Middleware\.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   start_mw_home => '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_coherence_server:start_mw_home']
   ...
}

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

Back to overview of wls_coherence_server

start_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_coherence_server {a_wls_coherence_server :
   ...
   start_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_coherence_server:start_notes']
   ...
}

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

Back to overview of wls_coherence_server

start_root_directory

The directory that this server uses as its root directory. This directory must be on the computer that hosts the Node Manager. If you do not specify a Root Directory value, the domain directory is used by default.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   start_root_directory => '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_coherence_server:start_root_directory']
   ...
}

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

Back to overview of wls_coherence_server

start_tags

Return all tags on this Configuration MBean

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   start_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_coherence_server:start_tags']
   ...
}

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

Back to overview of wls_coherence_server

tags

Return all tags on this Configuration MBean

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   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_coherence_server:tags']
   ...
}

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

Back to overview of wls_coherence_server

unicast_listen_address

The IP address for the cluster unicast listener. This attribute may be used to override the value of the referenced Coherence cluster.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   unicast_listen_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_coherence_server:unicast_listen_address']
   ...
}

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

Back to overview of wls_coherence_server

unicast_listen_port

The port for the cluster unicast listener.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   unicast_listen_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_coherence_server:unicast_listen_port']
   ...
}

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

Back to overview of wls_coherence_server

unicast_port_auto_adjust

Specifies whether the unicast port will be automatically incremented if the port cannot be bound because it is already in use.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   unicast_port_auto_adjust => '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_coherence_server:unicast_port_auto_adjust']
   ...
}

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

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

unicast_port_auto_adjust_attempts

Gets the upper bound of the unicast port. A positive value indicates the unicast port is automatically incremented if the specified port cannot be bound because it is already in use.

An example on how to use this:

wls_coherence_server {a_wls_coherence_server :
   ...
   unicast_port_auto_adjust_attempts => '65535'
   ...
}

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_coherence_server:unicast_port_auto_adjust_attempts']
   ...
}

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

Back to overview of wls_coherence_server

unicastaddress

The IP address for the cluster unicast listener. This attribute may be used to override the value of the referenced Coherence cluster.

Here is an example on using the unicast address on a coherence cluster. You can use an ip address like this:

wls_coherence_cluster{'my_coherence_cluster':
  ...
  unicastaddress => '10.10.10.30',
  ...
}

or use a host name like this:

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

Back to overview of wls_coherence_server

unicastport

The port for the cluster unicast listener.

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

wls_coherence_cluster{'my_coherence_cluster':
  ...
  unicastport => '9000',
  ...
}

Back to overview of wls_coherence_server