ジャンプ先

• リクエスト
• レスポンス

このノード・マネージャの表示

get

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

このノード・マネージャを表示します。

リクエスト

パス・パラメータ

• name: string
  コレクション内のインスタンスのnameプロパティ。
• version: string
  WebLogic RESTインタフェースのバージョン。

問合せパラメータ

• excludeFields(optional): string
  'excludeFields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前がリストにないフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('fields'問合せパラメータが指定されていない場合)。ノート: 'excludeFields'が指定されている場合、'fields'を指定しないでください。
• excludeLinks(optional): string
  'excludeLinks'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名がリストにないリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('links'問合せパラメータが指定されていない場合)。ノート: 'excludeLinks'が指定されている場合、'links'を指定しないでください。
• fields(optional): string
  'fields'問合せパラメータは、レスポンスで返されるフィールドを制限するために使用します。これは、フィールド名のカンマ区切りリストです。存在する場合は、名前が一致するフィールドのみが返されます。存在しない場合は、すべてのフィールドが返されます('excludeFields'問合せパラメータが指定されていない場合)。ノート: 'fields'が指定されている場合、'excludeFields'を指定しないでください。
• links(optional): string
  'links'問合せパラメータは、レスポンスで返されるリンクを制限するために使用します。これは、リンク関係名のカンマ区切りリストです。存在する場合は、関係名が一致するリンクのみが返されます。存在しない場合は、すべてのリンクが返されます('excludeLinks'問合せパラメータが指定されていない場合)。ノート: 'links'が指定されている場合、'excludeLinks'を指定しないでください。

セキュリティ

• Admin: basic
  型: Basic

  説明: A user in the Admin security role.
• デプロイヤ: 基本
  型: Basic

  説明: A user in the Deployer security role.
• モニター: 基本
  型: Basic

  説明: A user in the Monitor security role.
• オペレータ: 基本
  型: Basic

  説明: A user in the Operator security role.

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

このノード・マネージャを返します。

本文()

ルート・スキーマ: ノード・マネージャ

型: object

ソースの表示

• adapter(optional): string

  VMMアダプタを使用してOVMまたはその他のVMMアダプタ・プロバイダに接続する場合に、ノード・マネージャ・クライアント・アダプタのname_versionを取得します

• adapterName(optional): string

  VMMアダプタを使用してOVMまたはその他のVMMアダプタ・プロバイダに接続する場合に、ノード・マネージャ・クライアント・アダプタ名を取得します

• adapterVersion(optional): string

  VMMアダプタを使用してOVMまたはその他のVMMアダプタ・プロバイダに接続する場合に、ノード・マネージャ・クライアント・アダプタ・バージョンを取得します

• debugEnabled(optional): boolean
  デフォルト値: false

  このノード・マネージャとの通信をデバッグするかどうかを指定します。有効にすると、サーバーまたはサーバー上のクライアントからノード・マネージャへの接続が、サーバー・ログに送信される詳細情報になります。

• dynamicallyCreated(optional): boolean
  読取り専用: true

  デフォルト値: false

  MBeanが動的に作成されたか、config.xmlに対して永続化されているかが返されます

• id(optional): integer(int64)
  読取り専用: true

  このMBeanインスタンスの一意のIDを返します

• listenAddress(optional): string
  デフォルト値: localhost

  NodeManagerインスタンスへの接続時に使用するサーバーまたはサーバー上のクライアントのノード・マネージャのホスト名またはIPアドレス。

  制約

  • ドキュメントのみのセキュア・デフォルト: "127.0.0.1 or ::1"
• listenPort(optional): integer(int32)
  最小値: 1

  最大値: 65534

  デフォルト値: 5556

  NodeManagerインスタンスへの接続時に使用するサーバーまたはサーバー上のクライアントのノード・マネージャのポート番号。

• name(optional): string
  読取り専用: true

  このMBeanインスタンスのユーザー定義の名前。

  この名前は、MBeanのjavax.management.ObjectNameに、主要なプロパティとして含まれています

  Name=user-specified-name

  制約

  • 有効なnull
• NMSocketCreateTimeoutInMillis(optional): integer(int32)
  最小値: 0

  デフォルト値: 180000

  エージェントへのソケット接続を作成する際にNodeManagerRuntimeで使用されるタイムアウト値を返します。SSHエージェントへの接続を確立するまでに長時間かかる場合があるため、デフォルトで最大に設定されます。

• NMType(optional): string
  デフォルト値: SSL

  使用可能な値: [ "SSH", "RSH", "Plain", "SSL", "ssh", "rsh", "ssl", "plain" ]

  NodeManagerインスタンスへの接続時に使用するサーバーまたはサーバー上のクライアントのノード・マネージャ・タイプを戻します。

• nodeManagerHome(optional): string

  シェル・コマンド・テンプレートのかわりに使用されるノード・マネージャ・ホーム・ディレクトリを返します

• notes(optional): string

  この構成の説明として任意に入力できる情報。

  WebLogic Serverは、ドメインの構成ファイル(config.xml)に、このノートをXML PCDATAとして保存します。すべての左山カッコ(<) are converted to the xml entity <)は、xmlエンティティに変換されます。キャリッジ・リターンとライン・フィードは維持されます。

  ノート: 管理コンソールからノートを作成または編集した場合、キャリッジ・リターンとライン・フィードは維持されません。

• password(optional): string(password)

  ノード・マネージャ・クライアントが基になるサービスへの接続に使用するパスワード。このノード・マネージャ・クライアントの操作はこのサービスに委任されます。

  この属性の値を取得すると、WebLogic Serverは次の処理を実行します。

  1. PasswordEncrypted属性の値を取得します。

  2. 値を復号化し、暗号化されていないパスワードをString型で戻します。

  この属性の値を設定すると、WebLogic Serverは次の処理を実行します。

  1. 値を暗号化します。

  2. PasswordEncrypted属性の値を、暗号化した値に設定します。

  警告: 属性(Password)を使用すると、暗号化されていないパスワードを格納するString型のオブジェクトが、ガベージ・コレクションによって削除され、メモリーの再割当てが行われるまでJVMのメモリー内に留まるため、潜在的なセキュリティ上のリスクにつながります。JVM内でメモリーがどのように割り当てられているかによっては、この暗号化されていないデータがメモリーから削除されるまでに、かなりの時間が経過する可能性があります。したがって、PasswordEncrypted()属性をかわりに使用する必要があります。

• shellCommand(optional): string

  SSHまたはRSHノード・マネージャ機能を呼び出す際に使用するローカルのコマンドラインを戻します。

• tags(optional): array 項目
  タイトル: Items

  この構成MBeanのすべてのタグを返します

• type(optional): string
  読取り専用: true

  MBeanのタイプを戻します。

  制約

  • 収集不可
• userName(optional): string

  ノード・マネージャ・クライアントが基になるサービスへの接続に使用するユーザー名。このクライアントの操作はこのサービスに委任されます。

{
    "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":""
}

ネストされたスキーマ: 項目

型: array

タイトル: Items

この構成MBeanのすべてのタグを返します

ソースの表示

• 配列: string

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

先頭に戻る