wls machine

Overview

This resource allows you to manage machine in an WebLogic domain.

Here is an example on how you should use this:

wls_machine { 'test2':
  ensure        => 'present',
  listenaddress => '10.10.10.10',
  listenport    => '5556',
  machinetype   => 'UnixMachine',
  nmtype        => 'SSL',
}

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

wls_machine { 'my_domain/test2':
  ensure        => 'present',
  listenaddress => '10.10.10.10',
  listenport    => '5556',
  machinetype   => 'UnixMachine',
  nmtype        => 'SSL',
}

Attributes

adapter

Gets the node manager client adapter name_version when using a VMM adapter to connect to OVM or other VMM adapter providers

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   adapter => '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_machine:adapter']
   ...
}

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

Back to overview of wls_machine

adapter_name

Gets the node manager client adapter name when using a VMM adapter to connect to OVM or other VMM adapters providers

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   adapter_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_machine:adapter_name']
   ...
}

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

Back to overview of wls_machine

adapter_version

Gets the node manager client adapter version when using a VMM adapter to connect to OVM or other VMM adapters providers

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   adapter_version => '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_machine:adapter_version']
   ...
}

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

Back to overview of wls_machine

addresses

The addresses by which this machine is known. May be either host names or literal IP addresses.

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   addresses => '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_machine:addresses']
   ...
}

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

Back to overview of wls_machine

debug_enabled

Specifies whether communication with this Node Manager needs to be debugged. When enabled, connections to the NodeManager from the server or clients on the server will result in more information sent to the server log.

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   debug_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_machine:debug_enabled']
   ...
}

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

Valid values are absent, 1, 0.

Back to overview of wls_machine

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_machine

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_machine

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_machine

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_machine

ensure

The basic property that the resource should be in.

Valid values are present, absent.

Back to overview of wls_machine

installed_vmm_adapters

Gets a list of the names and versions of the installed Virtual Machine Manager (VMM) adapters

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   installed_vmm_adapters => '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_machine:installed_vmm_adapters']
   ...
}

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

Back to overview of wls_machine

listen_address

The host name or IP address of the NodeManager for the server or clients on the server to use when connecting to the NodeManager instance.

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   listen_address => 'localhost'
   ...
}

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_machine:listen_address']
   ...
}

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

Back to overview of wls_machine

listen_port

The port number of the NodeManager for the server or clients on the server to use when connecting to the NodeManager instance.

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   listen_port => '5556'
   ...
}

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_machine:listen_port']
   ...
}

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

Back to overview of wls_machine

listenaddress

The listenaddress of the machine

Back to overview of wls_machine

listenport

The listenport of the machine

Back to overview of wls_machine

machine_name

The machine name

Back to overview of wls_machine

machinetype

The machine type

Valid values are absent, Machine, UnixMachine.

Back to overview of wls_machine

name

The name.

Back to overview of wls_machine

nm_type

Returns the node manager type for the server or clients on the server to use when connecting to the NodeManager instance.

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   nm_type => 'SSL'
   ...
}

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_machine:nm_type']
   ...
}

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

Back to overview of wls_machine

nmtype

The nmtype of the machine

Valid values are absent, SSL, Plain, SSH, RSH.

Back to overview of wls_machine

node_manager_home

Returns the node manager home directory that will be used to substitute for the shell command template

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   node_manager_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_machine:node_manager_home']
   ...
}

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

Back to overview of wls_machine

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 <. 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_machine {a_wls_machine :
   ...
   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_machine:notes']
   ...
}

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

Back to overview of wls_machine

password

The password used by a Node Manager client to connect to the underlying service to which the Node Manager client delegates operations. When you get the value of this attribute, WebLogic Server does the following: <ol> <li>Retrieves the value of the PasswordEncrypted attribute.</li> <li>Decrypts the value and returns the unencrypted password as a String.</li> </ol> When you set the value of this attribute, WebLogic Server does the following: <ol> <li>Encrypts the value.</li> <li>Sets the value of the PasswordEncrypted attribute to the encrypted value.</li> </ol> Caution: Using the (Password) attribute is a potential security risk because the String object (which contains the unencrypted password), remains in the JVM’s memory until garbage collection removes it and the memory is reallocated. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory. Therefore, you should use the PasswordEncrypted() attribute instead.

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   password => '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_machine:password']
   ...
}

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

Back to overview of wls_machine

post_bind_gid

The UNIX group ID (GID) that a server running on this machine will run under after it has carried out all privileged startup actions. Otherwise, the server will continue to run under the group under which it was started.(Requires that you enable Post-Bind GID.)

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   post_bind_gid => 'nobody'
   ...
}

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_machine:post_bind_gid']
   ...
}

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

Back to overview of wls_machine

post_bind_gid_enabled

Specifies whether a server running on this machine binds to a UNIX Group ID (GID) after it has carried out all privileged startup actions.

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   post_bind_gid_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_machine:post_bind_gid_enabled']
   ...
}

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

Valid values are absent, 1, 0.

Back to overview of wls_machine

post_bind_uid

The UNIX user ID (UID) that a server running on this machine will run under after it has carried out all privileged startup actions. Otherwise, the server will continue to run under the account under which it was started.(Requires that you enable Post-Bind UID.)

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   post_bind_uid => 'nobody'
   ...
}

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_machine:post_bind_uid']
   ...
}

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

Back to overview of wls_machine

post_bind_uid_enabled

Specifies whether a server running on this machine binds to a UNIX User ID (UID) after it has carried out all privileged startup actions.

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   post_bind_uid_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_machine:post_bind_uid_enabled']
   ...
}

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

Valid values are absent, 1, 0.

Back to overview of wls_machine

provider

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

simple

Manage machine in an WebLogic domain via regular WLST

Back to overview of wls_machine

shell_command

Returns the local command line to use when invoking SSH or RSH node manager functions.

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   shell_command => '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_machine:shell_command']
   ...
}

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

Back to overview of wls_machine

tags

Return all tags on this Configuration MBean

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   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_machine:tags']
   ...
}

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

Back to overview of wls_machine

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_machine

user_name

The Node Manager client user name used to connect to the underlying service to which the client delegates operations.

An example on how to use this:

wls_machine {a_wls_machine :
   ...
   user_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_machine:user_name']
   ...
}

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

Back to overview of wls_machine