JMX接続ハンドラの追加、検索、比較または削除
POST
/rest/v1/admin
JMX接続ハンドラの追加、検索、比較または削除
リクエスト
サポートされているメディア・タイプ
- application/json
作成する必要があるJMX接続ハンドラ
ルート・スキーマ: JMX接続ハンドラのPOSTRequest
型:
ソースを表示
object
- assertion: string
LDAP比較操作用のアサーション文字列。ノート: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
- attributes: object JMX接続ハンドラのプロパティ
- base: string
LDAP検索操作に使用する検索ベースDN。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。このような操作の場合も必須です
- controls: array controls
LDAP操作のためにサーバーに送信するLDAP制御。
- dn: string
作成、削除または比較するエントリのLDAP DN。ノート: LDAPの追加、削除または比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest、urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequestまたはurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。このような操作の場合に必須です。
- filter: string
LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。ノート: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- msgType(required): string
指定可能な値:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]
RESTメッセージ・タイプ - requiredAttributes: array requiredAttributes
エントリに対してフェッチする属性のリスト。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- scope: string
指定可能な値:
[ "base", "sub", "one" ]
LDAP検索操作の範囲。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ネストされたスキーマ: JMX接続ハンドラのプロパティ
型:
ソースを表示
object
- cn: string
エントリのCN (共通名)
- ds-cfg-allowed-client: array ds-cfg-allowed-client
この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
- ds-cfg-denied-client: array ds-cfg-denied-client
この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
- ds-cfg-enabled(required): boolean
接続ハンドラが使用可能かどうかを示します。
- ds-cfg-java-class(required): string
デフォルト値:
org.opends.server.protocols.jmx.JmxConnectionHandler
JMX接続ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-key-manager-provider: string
このJMX接続ハンドラで使用する必要があるキー・マネージャの名前を指定します。
- ds-cfg-listen-address: array ds-cfg-listen-address
読取り専用:
true
JMX接続ハンドラがSNMPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。 - ds-cfg-listen-port(required): integer(int32)
JMX接続ハンドラがクライアントからの接続をリスニングするポート番号を指定します。
- ds-cfg-ssl-cert-nickname: string
JMX接続ハンドラがSSL通信の実行時に使用する必要がある証明書のニックネーム(エイリアスとも呼ばれます)を指定します。
- ds-cfg-use-ssl: boolean
デフォルト値:
false
JMX接続ハンドラがSSLを使用するかどうかを示します。 - objectclass(required): array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: requiredAttributes
型:
array
エントリに対してフェッチする属性のリスト。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ソースを表示
ネストされたスキーマ: ds-cfg-allowed-client
型:
array
この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-denied-client
型:
array
この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-listen-address
型:
array
読取り専用:
true
JMX接続ハンドラがSNMPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。
デフォルト値:
ソースを表示
[ "0.0.0.0" ]
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: JMX接続ハンドラのSuccessResponse
型:
ソースを表示
object
- compareResult: boolean
LDAP比較操作の結果を示します。
- msgType(required): string
指定可能な値:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]
RESTメッセージ・タイプ - searchResultEntries(required): array searchResultEntries
LDAP操作後に返される検索結果エントリの数。
- totalResults(required): integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: JMX接続ハンドラのSearchResultEntry
型:
ソースを表示
object
- attributes(required): object JMX接続ハンドラのプロパティ
- dn(required): string
作成するエントリのLDAP DN。
ネストされたスキーマ: JMX接続ハンドラのプロパティ
型:
ソースを表示
object
- cn: string
エントリのCN (共通名)
- ds-cfg-allowed-client: array ds-cfg-allowed-client
この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
- ds-cfg-denied-client: array ds-cfg-denied-client
この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
- ds-cfg-enabled(required): boolean
接続ハンドラが使用可能かどうかを示します。
- ds-cfg-java-class(required): string
デフォルト値:
org.opends.server.protocols.jmx.JmxConnectionHandler
JMX接続ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-key-manager-provider: string
このJMX接続ハンドラで使用する必要があるキー・マネージャの名前を指定します。
- ds-cfg-listen-address: array ds-cfg-listen-address
読取り専用:
true
JMX接続ハンドラがSNMPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。 - ds-cfg-listen-port(required): integer(int32)
JMX接続ハンドラがクライアントからの接続をリスニングするポート番号を指定します。
- ds-cfg-ssl-cert-nickname: string
JMX接続ハンドラがSSL通信の実行時に使用する必要がある証明書のニックネーム(エイリアスとも呼ばれます)を指定します。
- ds-cfg-use-ssl: boolean
デフォルト値:
false
JMX接続ハンドラがSSLを使用するかどうかを示します。 - objectclass(required): array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-allowed-client
型:
array
この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-denied-client
型:
array
この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-listen-address
型:
array
読取り専用:
true
JMX接続ハンドラがSNMPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。
デフォルト値:
ソースを表示
[ "0.0.0.0" ]
201レスポンス
作成済
ルート・スキーマ: JMX接続ハンドラのADDResponse
型:
ソースを表示
object
- msgType(required): string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse
RESTメッセージ・タイプ - searchResultEntries(required): array searchResultEntries
- totalResults(required): integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: JMX接続ハンドラのSearchResultEntry
型:
ソースを表示
object
- attributes(required): object JMX接続ハンドラのプロパティ
- dn(required): string
作成するエントリのLDAP DN。
ネストされたスキーマ: JMX接続ハンドラのプロパティ
型:
ソースを表示
object
- cn: string
エントリのCN (共通名)
- ds-cfg-allowed-client: array ds-cfg-allowed-client
この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
- ds-cfg-denied-client: array ds-cfg-denied-client
この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
- ds-cfg-enabled(required): boolean
接続ハンドラが使用可能かどうかを示します。
- ds-cfg-java-class(required): string
デフォルト値:
org.opends.server.protocols.jmx.JmxConnectionHandler
JMX接続ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-key-manager-provider: string
このJMX接続ハンドラで使用する必要があるキー・マネージャの名前を指定します。
- ds-cfg-listen-address: array ds-cfg-listen-address
読取り専用:
true
JMX接続ハンドラがSNMPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。 - ds-cfg-listen-port(required): integer(int32)
JMX接続ハンドラがクライアントからの接続をリスニングするポート番号を指定します。
- ds-cfg-ssl-cert-nickname: string
JMX接続ハンドラがSSL通信の実行時に使用する必要がある証明書のニックネーム(エイリアスとも呼ばれます)を指定します。
- ds-cfg-use-ssl: boolean
デフォルト値:
false
JMX接続ハンドラがSSLを使用するかどうかを示します。 - objectclass(required): array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: ds-cfg-allowed-client
型:
array
この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-denied-client
型:
array
この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
ソースを表示
ネストされたスキーマ: ds-cfg-listen-address
型:
array
読取り専用:
true
JMX接続ハンドラがSNMPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。
デフォルト値:
ソースを表示
[ "0.0.0.0" ]
204レスポンス
コンテンツがありません
406レスポンス
受入れできません
ルート・スキーマ: ErrorResponse
型:
ソースを表示
object
- ldapErrorCode: integer(int32)
操作に対して返されるLDAPエラー・コードを指定します。
- message(required): string
操作に対して返されるエラー・メッセージ。
- msgType(required): string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
RESTメッセージ・タイプ