NodeManagerMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This bean is represents a Node Manager that is associated with a machine.

   
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.NodeManagerMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.


Attributes

This section describes the following attributes:


Adapter

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

       
Privileges Read/Write
Typejava.lang.String

AdapterName

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

       
Privileges Read/Write
Typejava.lang.String

AdapterVersion

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

       
Privileges Read/Write
Typejava.lang.String

CachingDisabled

Private property that disables caching in proxies.

       
Privileges Read only
Typeboolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

DebugEnabled

Specifies whether communication with this Node Manager needs to be debugged. When enabled, Node Manager provides more information about request processing. This information is sent to the log of the server making requests to Node Manager.

       
Privileges Read/Write
Typeboolean

InstalledVMMAdapters

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

       
Privileges Read only
Typeclass java.lang.String[]
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

ListenAddress

The host name or IP address where Node Manager listens for connection requests.

       
Privileges Read/Write
Typejava.lang.String
Default Valuelocalhost
Secure value127.0.0.1

ListenPort

The port number where Node Manager listens for connection requests.

       
Privileges Read/Write
Typeint
Default Value5556
Minimum value1
Maximum value65534

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

       
Privileges Read only
Typejavax.management.MBeanInfo
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:
Name=user-specified-name

       
Privileges Read/Write
Typejava.lang.String

NMType

Returns the node manager type.

       
Privileges Read/Write
Typejava.lang.String
Default ValueSSL
Legal Values
  • SSH
  • RSH
  • Plain
  • SSL
  • ssh
  • rsh
  • ssl
  • plain
  • VMM
  • vmm
  • VMMS
  • vmms

NodeManagerHome

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

       
Privileges Read/Write
Typejava.lang.String

Notes

Optional information that you can include to describe this configuration.

WebLogic Sever 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.

Note:

If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

       
Privileges Read/Write
Typejava.lang.String

ObjectName

Returns the ObjectName under which this MBean is registered in the MBean server.

Deprecated.

       
Privileges Read only
Typeweblogic.management.WebLogicObjectName
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

Parent

Return the immediate parent for this MBean

       
Privileges Read/Write
Type

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:

  1. Retrieves the value of the PasswordEncrypted attribute.

  2. Decrypts the value and returns the unencrypted password as a String.

When you set the value of this attribute, WebLogic Server does the following:

  1. Encrypts the value.

  2. Sets the value of the PasswordEncrypted attribute to the encrypted value.

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.

For more information, see:

       
Privileges Read/Write
Typejava.lang.String
Encryptedtrue

PasswordEncrypted

The encrypted Node Manager client user password.

To set this attribute, use weblogic.management.EncryptionHelper.encrypt() to encrypt the value. Then set this attribute to the output of the encrypt() method.

To compare a password that a user enters with the encrypted value of this attribute, go to the same WebLogic Server instance that you used to set and encrypt this attribute and use weblogic.management.EncryptionHelper.encrypt() to encrypt the user-supplied password. Then compare the encrypted values.

       
Privileges Read/Write
Typebyte[]
Encryptedtrue

Registered

Returns false if the MBean represented by this object has been unregistered.

Deprecated.

       
Privileges Read only
Typeboolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

ShellCommand

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

       
Privileges Read/Write
Typejava.lang.String

Type

Returns the type of the MBean.

       
Privileges Read only
Typejava.lang.String
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

UserName

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

       
Privileges Read/Write
Typejava.lang.String


Operations

This section describes the following operations:


freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note:

To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

   
Operation Name"freezeCurrentValue"
ParametersObject [] {  attributeName }

where:

  • attributeName is an object of type java.lang.String that specifies:

    attributeName

SignatureString [] { "java.lang.String" }
Returns void
Exceptions
  • javax.management.AttributeNotFoundException
  • javax.management.MBeanException

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

   
Operation Name"isSet"
ParametersObject [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to check

SignatureString [] { "java.lang.String" }
Returns boolean

restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

   
Operation Name"restoreDefaultValue"
ParametersObject [] {  attributeName }

where:

  • attributeName is an object of type java.lang.String that specifies:

    attributeName

SignatureString [] { "java.lang.String" }
Returns void
Exceptions
  • javax.management.AttributeNotFoundException

unSet

Restore the given property to its default value.

   
Operation Name"unSet"
ParametersObject [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to restore

SignatureString [] { "java.lang.String" }
Returns void