ジャンプ先

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

この組込みLDAPの表示

get

/management/weblogic/{version}/serverConfig/embeddedLDAP

この組込みLDAPを表示します。

リクエスト

パス・パラメータ

• 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レスポンス

この組込みLDAPを返します。

本文()

ルート・スキーマ: 組込みLDAP

型: object

ソースの表示

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

  組込みLDAPサーバーで匿名の接続を許可するかどうかを指定します。

• backupCopies(optional): integer(int32)
  最小値: 0

  最大値: 65534

  デフォルト値: 7

  組込みLDAPサーバー用に作成される必要のあるバックアップ・コピーの最大数。

  この値により、ldap/backupディレクトリ内のzipファイル数が制限されます。

• backupHour(optional): integer(int32)
  最小値: 0

  最大値: 23

  デフォルト値: 23

  組込みLDAPサーバーをバックアップする時間。

  「バックアップ時刻(時)」の値は「バックアップ時刻(分)」の値と組み合せて使用され、組込みLDAPサーバーのデータ・ファイルをバックアップする時刻を決定します。指定された時間になると、組込みLDAPサーバーへの書込みがサスペンドされ、データ・ファイルがzipファイルの形でldap/backupディレクトリにバックアップされてから、書込みが再開されます。

• backupMinute(optional): integer(int32)
  最小値: 0

  最大値: 59

  デフォルト値: 5

  組込みLDAPサーバーをバックアップする時間(分)。

  「バックアップ時刻」の値は「バックアップ時刻(時)」の値と組み合せて使用され、組込みLDAPサーバーのデータ・ファイルをバックアップする時刻を決定します。

• cacheEnabled(optional): boolean
  デフォルト値: true

  組込みLDAPサーバーでキャッシュを使用するかどうかを指定します。

  このキャッシュは、管理対象サーバーが、管理サーバー上で動作しているマスター組込みLDAPサーバーに対して読取りまたは書込みを行うときに使用されます。

• cacheSize(optional): integer(int32)
  最小値: 0

  デフォルト値: 32

  組込みLDAPサーバーで使用するキャッシュのサイズ(KB)。

• cacheTTL(optional): integer(int32)
  最小値: 0

  デフォルト値: 60

  組込みLDAPサーバーで使用するキャッシュの存続時間(秒)。

• credential(optional): string(password)

  組込みLDAPサーバーに接続するための資格証明(通常はパスワード)。

  この資格証明が設定されていない場合、起動時にパスワードが生成されて属性が初期化され、config.xmlに構成が保存されます。外部LDAPブラウザと組込みLDAPの管理者アカウント(cn=Admin)を使用して組込みLDAPサーバーに接続する場合は、この属性を、生成された値から変更します。

  8.1 sp4以降、この属性の値を取得する際、WebLogic Serverは次の処理を行います。

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

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

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

  1. 値を暗号化します。

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

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

  この属性を使用するかわりに、CredentialEncryptedを使用します

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

  デフォルト値: false

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

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

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

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

  ソケット接続でキープ・アライブが有効かどうか

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

  管理対象サーバーが、(管理対象サーバーにある)ローカルのレプリケートされたLDAPサーバーではなく、常に(管理サーバーにある)マスターLDAPサーバーに接続するかどうかを指定します。

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

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

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

  Name=user-specified-name

  制約

  • 有効なnull
• notes(optional): string

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

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

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

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

  管理対象サーバーが、すべてのレプリケートされたデータを起動時にリフレッシュするかどうかを指定します。(これは、管理対象サーバーがアクティブでないときに大量の変更を行った際に、各変更を管理サーバーから管理対象サーバーに送るのではなく、レプリカ全体をダウンロードする場合に役立ちます。)

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

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

• timeout(optional): integer(int32)
  最小値: 0

  デフォルト値: 0

  タイムアウトするまでに組込みLDAPサーバーからの結果を待機する最大秒数を指定します。このオプションが0に設定されている場合、時間に上限はありません。

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

  MBeanのタイプを戻します。

  制約

  • 収集不可

{
    "type":"object",
    "properties":{
        "anonymousBindAllowed":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether the embedded LDAP server should allow anonymous connections.</p>"
        },
        "backupCopies":{
            "default":7,
            "minimum":0,
            "maximum":65534,
            "type":"integer",
            "format":"int32",
            "description":"<p>The maximum number of backup copies that should be made for the embedded LDAP server.</p><p>This value limits the number of zip files in the ldap/backup directory.</p>"
        },
        "backupHour":{
            "default":23,
            "minimum":0,
            "maximum":23,
            "type":"integer",
            "format":"int32",
            "description":"<p>The hour at which the embedded LDAP server should be backed up.</p><p>The Backup Hour value is used in conjunction with the Backup Minute value to determine the time at which the embedded LDAP server data files are backed up. At the specified time, WebLogic Server suspends writes to the embedded LDAP server, backs up the data files into a zip files in the ldap/backup directory, and then resumes writes.</p>"
        },
        "backupMinute":{
            "default":5,
            "minimum":0,
            "maximum":59,
            "type":"integer",
            "format":"int32",
            "description":"<p>The minute at which the embedded LDAP server should be backed up.</p><p>The Backup Minute value is used in conjunction with the Back Up Hour value to determine the time at which the embedded LDAP server data files are backed up</p>"
        },
        "cacheEnabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether a cache is used with the embedded LDAP server.</p><p>This cache is used when a managed server is reading or writing to the master embedded LDAP server that is running on the Administration server.</p>"
        },
        "cacheSize":{
            "default":32,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>The size of the cache (in kilobytes) that is used with the embedded LDAP server.</p>"
        },
        "cacheTTL":{
            "default":60,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>The time-to-live of the cache (in seconds) that is used with the embedded LDAP server.</p>"
        },
        "credential":{
            "type":"string",
            "format":"password",
            "description":"<p>The credential (usually a password) used to connect to the embedded LDAP server.</p><p>If this credential has not been set, WebLogic Server generates a password at startup, initializes the attribute, and saves the configuration to the config.xml file. If you want to connect to the embedded LDAP server using an external LDAP browser and the embedded LDAP administrator account (cn=Admin), change this attribute from the generated value.</p><p>As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:</p><ol><li><p>Retrieves the value of the <code>CredentialEncrypted</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>CredentialEncrypted</code> attribute to the encrypted value.</p></li></ol><p>Using the <code>Credential</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.</p><p>Instead of using this attribute, use <code>CredentialEncrypted()</code></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>"
        },
        "keepAliveEnabled":{
            "default":false,
            "type":"boolean",
            "description":"<p>Whether keep alive is enabled in the socket connection</p>"
        },
        "masterFirst":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether a Managed Server should always connect to the master LDAP server (contained in the Administration Server), instead of connecting to the local replicated LDAP server (contained in the Managed Server).</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>"
        },
        "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>"
        },
        "refreshReplicaAtStartup":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether a Managed Server should refresh all replicated data at boot time. (This is useful if you have made a large amount of changes when the Managed Server was not active, and you want to download the entire replica instead of having the Administration Server push each change to the Managed Server.)</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "timeout":{
            "default":0,
            "minimum":0,
            "type":"integer",
            "format":"int32",
            "description":"<p>Specifies the maximum number of seconds to wait for results from the embedded LDAP server before timing out. If this option is set to 0, there is no maximum time limit.</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>"
        }
    },
    "description":""
}

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

型: array

タイトル: Items

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

ソースの表示

• 配列: string

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

先頭に戻る