Jump to

• Request
• Response

Modify This Node Manager

post

/management/weblogic/{version}/edit/machines/{name}/nodeManager

Modify this node manager.

Request

Supported Media Types

• application/json

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Header Parameters

• X-Requested-By: string
  The 'X-Requested-By' header is used to protect against Cross-Site Request Forgery (CSRF) attacks. The value is an arbitrary name such as 'MyClient'.

Body ()

Must contain the modified node manager model.

Root Schema : Node Manager

Type: object

Show Source

• adapter(optional): string

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

• adapterName(optional): string

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

• adapterVersion(optional): string

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

• debugEnabled(optional): boolean
  Default Value: false

  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(optional): boolean
  Read Only: true

  Default Value: false

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

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

• listenAddress(optional): string
  Default Value: localhost

  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.

  Constraints

  • doc only secure default : "127.0.0.1 or ::1"
• listenPort(optional): integer(int32)
  Minimum Value: 1

  Maximum Value: 65534

  Default Value: 5556

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

• name(optional): string
  Read Only: true

  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

  Constraints

  • legal null
• NMSocketCreateTimeoutInMillis(optional): integer(int32)
  Minimum Value: 0

  Default Value: 180000

  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(optional): string
  Default Value: SSL

  Allowed Values: [ "SSH", "RSH", "Plain", "SSL", "ssh", "rsh", "ssl", "plain" ]

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

• nodeManagerHome(optional): string

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

• notes(optional): string

  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.

• password(optional): string(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.

• shellCommand(optional): string

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

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• userName(optional): string

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

{
    "type":"object",
    "properties":{
        "NMSocketCreateTimeoutInMillis":{
            "default":180000,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>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.</p>"
        },
        "NMType":{
            "default":"SSL",
            "enum":[
                "SSH",
                "RSH",
                "Plain",
                "SSL",
                "ssh",
                "rsh",
                "ssl",
                "plain"
            ],
            "type":"string",
            "description":"<p>Returns the node manager type for the server or clients on the server to use when connecting to the NodeManager instance.</p>"
        },
        "adapter":{
            "type":"string",
            "description":"<p>Gets the node manager client adapter name_version when using a VMM adapter to connect to OVM or other VMM adapter providers</p>"
        },
        "adapterName":{
            "type":"string",
            "description":"<p>Gets the node manager client adapter name when using a VMM adapter to connect to OVM or other VMM adapters providers</p>"
        },
        "adapterVersion":{
            "type":"string",
            "description":"<p>Gets the node manager client adapter version when using a VMM adapter to connect to OVM or other VMM adapters providers</p>"
        },
        "debugEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>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.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "listenAddress":{
            "x-weblogic-docOnlySecureDefault":"127.0.0.1 or ::1",
            "default":"localhost",
            "type":"string",
            "description":"<p>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. </p><p><h5>Constraints</h5></p><ul><li>doc only secure default : \"127.0.0.1 or ::1\"</li></ul>"
        },
        "listenPort":{
            "default":5556,
            "minimum":1,
            "maximum":65534,
            "type":"integer",
            "format":"int32",
            "description":"<p>The port number of the NodeManager for the server or clients on the server to use when connecting to the NodeManager instance. </p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "nodeManagerHome":{
            "type":"string",
            "description":"<p>Returns the node manager home directory that will be used to substitute for the shell command template</p>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "password":{
            "type":"string",
            "format":"password",
            "description":"<p>The password used by a Node Manager client to connect to the underlying service to which the Node Manager client delegates operations.</p><p>When you get the value of this attribute, WebLogic Server does the following:</p><ol><li><p>Retrieves the value of the <code>PasswordEncrypted</code> attribute.</p></li><li><p>Decrypts the value and returns the unencrypted password as a String.</p></li></ol><p>When you set the value of this attribute, WebLogic Server does the following:</p><ol><li><p>Encrypts the value.</p></li><li><p>Sets the value of the <code>PasswordEncrypted</code> attribute to the encrypted value.</p></li></ol><p><b>Caution:</b> Using the (<code>Password</code>) 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 <code>PasswordEncrypted()</code> attribute instead.</p>"
        },
        "shellCommand":{
            "type":"string",
            "description":"<p>Returns the local command line to use when invoking SSH or RSH node manager functions.</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "userName":{
            "type":"string",
            "description":"<p>The Node Manager client user name used to connect to the underlying service to which the client delegates operations. </p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.

Back to Top

Response

200 Response

Back to Top