wls saf imported destination object

Overview

This resource allows you to manage a SAF imported destinations object in a JMS Module of a WebLogic domain.

Here is an example on how you should use this:

wls_saf_imported_destination_object { 'jmsClusterModule:SAFImportedDestinations-0:SAFDemoQueue':
  ensure               => 'present',
  nonpersistentqos     => 'Exactly-Once',
  object_type          => 'queue',
  remotejndiname       => 'jms/DemoQueue',
  unitoforderrouting   => 'Hash',
  usetimetolivedefault => '0',
}

In this example you are managing a SAF imported destination object in the default domain. When you want to manage a SAF imported destination object in a specific domain, you can use:

wls_saf_imported_destination_object { 'my_domain/jmsClusterModule:SAFImportedDestinations-0:SAFDemoTopic':
  ensure               => 'present',
  nonpersistentqos     => 'Exactly-Once',
  object_type          => 'topic',
  remotejndiname       => 'jms/DemoTopic',
  timetolivedefault    => '100000000',
  unitoforderrouting   => 'Hash',
  usetimetolivedefault => 1,
}

Experience the Power of Puppet for WebLogic

If you want to play and experiment with Puppet and WebLogic, please take a look at our playgrounds. At our playgrounds, we provide you with a pre-installed environment, where you experiment fast and easy.

For WebLogic   here at our playground...

Attributes

disable_autorequire

Puppet supports automatic ordering of resources by autorequire. Sometimes, however, this causes issues. Setting this parameter to true, disables autorequiring for this specific resource.

USE WITH CAUTION!!

Here is an example on hopw to use this:

...{'domain_name/...':
  disableautorequire => true,
  ...
}

Back to overview of wls_saf_imported_destination_object

disable_corrective_change

Disable the modification of a resource when Puppet decides it is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet Server, Puppet knows about adaptive and corrective changes. A corrective change is when Puppet notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet is managing. The normal Puppet process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_change parameter, you can disable corrective changes on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ...
  disable_corrective_change => true,
  ...
}

When a corrective ensure does happen on the resource Puppet will not modify the resource and signal an error:

    Error: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/parameter: change from '10' to '20' failed: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change. (corrective)

Back to overview of wls_saf_imported_destination_object

disable_corrective_ensure

Disable the creation or removal of a resource when Puppet decides is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet Server, Puppet knows about adaptive and corrective changes. A corrective change is when Puppet notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet is managing. The normal Puppet process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_ensure parameter, you can disable corrective ensure present or ensure absent actions on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ensure                    => 'present',
  ...
  disable_corrective_ensure => true,
  ...
}

When a corrective ensure does happen on the resource Puppet will not create or remove the resource and signal an error:

    Error: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure.
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/ensure: change from 'absent' to 'present' failed: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure. (corrective)

Back to overview of wls_saf_imported_destination_object

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_saf_imported_destination_object

ensure

The basic property that the resource should be in.

Valid values are present, absent.

Back to overview of wls_saf_imported_destination_object

imported_destination

SAF imported destination name

Back to overview of wls_saf_imported_destination_object

jmsmodule

The JMS module name.

Back to overview of wls_saf_imported_destination_object

local_jndi_name

The local JNDI name of the remote destination.

An example on how to use this:

wls_saf_imported_destination_object {a_wls_saf_imported_destination_object :
   ...
   local_jndi_name => '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_saf_imported_destination_object:local_jndi_name']
   ...
}

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

Back to overview of wls_saf_imported_destination_object

localjndiname

The Local JNDI of the SAF imported destination object

Back to overview of wls_saf_imported_destination_object

log_message_logging_enabled

Specifies whether the module logs information about the message life cycle.

An example on how to use this:

wls_saf_imported_destination_object {a_wls_saf_imported_destination_object :
   ...
   log_message_logging_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_saf_imported_destination_object:log_message_logging_enabled']
   ...
}

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

Valid values are absent, 1, 0.

Back to overview of wls_saf_imported_destination_object

log_message_logging_format

Defines which information about the message is logged. Valid values are: <ul> <li> %header% - All JMS header fields are logged. <li> %properties% - All user-defined properties are logged. <li> JMSDeliveryTime - This WebLogic JMS-specific extended header field is logged. <li> JMSRedeliveryLimit - This WebLogic JMS-specific extended header field is logged. <li> foo - Any valid JMS header field or user-defined property is logged. </ul> When specifying multiple values, enter them as a comma-separated list. The %header% and %properies% values are not case sensitive. For example, you could use “%header%,%properties%” for all the JMS header fields and user properties. However, the enumeration of individual JMS header fields and user-defined properties are case sensitive. To enumerate only individual JMS header fields you could use “%header, name, address, city, state, zip” . Note: The JMSMessageID field is always logged and cannot be turned off. Therefore, if the Message Logging Format is not defined (i.e., null) or is defined as an empty string, then the output to the log file contains only the JMSMessageID of the message. Gets the “message-logging-format” element

An example on how to use this:

wls_saf_imported_destination_object {a_wls_saf_imported_destination_object :
   ...
   log_message_logging_format => '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_saf_imported_destination_object:log_message_logging_format']
   ...
}

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

Back to overview of wls_saf_imported_destination_object

log_template_bean

Finds the template bean for this destination.

An example on how to use this:

wls_saf_imported_destination_object {a_wls_saf_imported_destination_object :
   ...
   log_template_bean => '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_saf_imported_destination_object:log_template_bean']
   ...
}

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

Back to overview of wls_saf_imported_destination_object

name

The name.

Back to overview of wls_saf_imported_destination_object

non_persistent_qos

Specifies the quality-of-service for non-persistent messages. <ul> <li> Exactly-Once indicates that messages will be forwarded to the remote side once and only once except for any occurrence of server crashes. </li> <li> At-Least-Once indicates that messages will be forwarded to the remote side at least once. No message will be lost except for any occurrence of server crashes. However, messages may appear in the remote endpoint more than once. </li> <li> At-Most-Once indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost. </li> </ul> Any change to this parameter affects only incoming messages; stored messages are not affected.

An example on how to use this:

wls_saf_imported_destination_object {a_wls_saf_imported_destination_object :
   ...
   non_persistent_qos => 'At-Least-Once'
   ...
}

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_saf_imported_destination_object:non_persistent_qos']
   ...
}

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

Back to overview of wls_saf_imported_destination_object

nonpersistentqos

The QoS non persistent of the SAF imported destination object

Valid values are absent, Exactly-Once, At-Least-Once, At-Most-Once.

Back to overview of wls_saf_imported_destination_object

notes

Optional information that you can include to describe this named JMS descriptor bean. JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. 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_saf_imported_destination_object {a_wls_saf_imported_destination_object :
   ...
   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_saf_imported_destination_object:notes']
   ...
}

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

Back to overview of wls_saf_imported_destination_object

object_name

SAF imported destination Object name

Back to overview of wls_saf_imported_destination_object

object_type

The object_type of the SAF imported destination object

Valid values are queue, topic.

Back to overview of wls_saf_imported_destination_object

persistent_qos

Specifies the quality-of-service for persistent messages. <ul> <li> Exactly-Once indicates that messages will be forwarded to the remote side once and only once </li> <li> At-Least-Once indicates that messages will be forwarded to the remote side at least once. Messages may appear in the remote endpoint more than once. </li> <li> At-Most-Once indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost. </li> </ul> Any change to this parameter affects only incoming messages; stored messages are not affected.

An example on how to use this:

wls_saf_imported_destination_object {a_wls_saf_imported_destination_object :
   ...
   persistent_qos => 'Exactly-Once'
   ...
}

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_saf_imported_destination_object:persistent_qos']
   ...
}

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

Back to overview of wls_saf_imported_destination_object

provider

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

simple

saf imported destination Queue or Topic in a JMS module of an WebLogic domain via regular WLST

Back to overview of wls_saf_imported_destination_object

remote_jndi_name

The remote JNDI name of the remote destination.

An example on how to use this:

wls_saf_imported_destination_object {a_wls_saf_imported_destination_object :
   ...
   remote_jndi_name => '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_saf_imported_destination_object:remote_jndi_name']
   ...
}

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

Back to overview of wls_saf_imported_destination_object

remotejndiname

The Remote JNDI of the SAF imported destination object

Back to overview of wls_saf_imported_destination_object

saf_error_handling

Specifies the error handling configuration used by this SAF destination. Any change to this parameter affects only incoming messages; stored messages are not affected.

An example on how to use this:

wls_saf_imported_destination_object {a_wls_saf_imported_destination_object :
   ...
   saf_error_handling => '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_saf_imported_destination_object:saf_error_handling']
   ...
}

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

Back to overview of wls_saf_imported_destination_object

time_to_live_default

Specifies the default Time-to-Live value (expiration time), in milliseconds, for imported JMS messages. The expiration time set on JMS messages will override this value unless the SAF Default Time-to-Live Enabled field is switched on, which then overrides the expiration time in JMS messages on imported destinations. Any change to this value affects only incoming messages; stored messages are not affected.

An example on how to use this:

wls_saf_imported_destination_object {a_wls_saf_imported_destination_object :
   ...
   time_to_live_default => '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_saf_imported_destination_object:time_to_live_default']
   ...
}

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

Back to overview of wls_saf_imported_destination_object

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_saf_imported_destination_object

timetolivedefault

the SAF time to live default of this SAF imported destination

Back to overview of wls_saf_imported_destination_object

unit_of_order_routing

Specifies the type of routing used to find a SAF agent when using the message Unit-of-Order feature. <ul> <li>Hash indicates that producers use the hash code of a message Unit-of-Order to find a SAF agent. </li> <li>PathService indicates that producers use the Path Service to find a SAF agent. </li> </ul>

An example on how to use this:

wls_saf_imported_destination_object {a_wls_saf_imported_destination_object :
   ...
   unit_of_order_routing => '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_saf_imported_destination_object:unit_of_order_routing']
   ...
}

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

Back to overview of wls_saf_imported_destination_object

unitoforderrouting

The unit of order routing of the SAF imported destination object

Valid values are Hash, PathService.

Back to overview of wls_saf_imported_destination_object

use_saf_time_to_live_default

Controls whether the Time-to-Live (expiration time) value set on imported JMS messages will be overridden by the value specified in the SAF Default Time-to-Live field. Any change to this parameter affects only incoming messages; stored messages are not affected.

An example on how to use this:

wls_saf_imported_destination_object {a_wls_saf_imported_destination_object :
   ...
   use_saf_time_to_live_default => 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_saf_imported_destination_object:use_saf_time_to_live_default']
   ...
}

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

Valid values are absent, 1, 0.

Back to overview of wls_saf_imported_destination_object

usetimetolivedefault

use time to live default of this SAF imported destination

Valid values are absent, 1, 0.

Back to overview of wls_saf_imported_destination_object