NodeManagerMBean

Overview

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

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

AdapterName

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

AdapterVersion

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

CachingDisabled

Private property that disables caching in proxies.

DebugEnabled

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.

DynamicallyCreated

Return whether the MBean was created dynamically or is persisted to config.xml

Id

Return the unique id of this MBean instance

InstalledVMMAdapters

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

Deprecated. VMM client support is removed since 12.1.2

ListenAddress

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.

ListenPort

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

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

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

NMSocketCreateTimeoutInMillis

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

NMType

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

NodeManagerHome

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

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.

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

ObjectName

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

Deprecated.

Parent

Return the immediate parent for this MBean

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:

• getPasswordEncrypted

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.

Registered

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

Deprecated.

ShellCommand

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

Tags

Return all tags on this Configuration MBean

Type

Returns the type of the MBean.

UserName

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

Operations

This section describes the following operations:

addTag

Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

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

getInheritedProperties

Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

isInherited

Check if the value of a property is inherited from template mbean or not.

isSet

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

removeTag

Remove a tag from this Configuration MBean

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

unSet

Restore the given property to its default value.