ジャンプ先

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

DNによるJMX接続ハンドラの変更

PATCH

/rest/v1/admin/{dn}

DNによるJMX接続ハンドラの変更

リクエスト

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

• application/json

パス・パラメータ

• dn(required): string
  変更するエントリのLDAP DN。

本文 ()

変更する必要があるJMX接続ハンドラ

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• controls: array controls
  LDAP変更操作のためにサーバーに送信するLDAP制御。
• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

  RESTメッセージ・タイプ
• operations(必須): array operations
  エントリに対して実行する変更(パッチ操作)。

{
    "type":"object",
    "required":[
        "msgType",
        "operations"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest",
            "type":"string"
        },
        "operations":{
            "type":"array",
            "description":"Modifications (Patch operations) to be performed on the entry.",
            "items":{
                "$ref":"#/definitions/PatchOperation"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for LDAP modify operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: controls

型: array

LDAP変更操作のためにサーバーに送信するLDAP制御。

ソースを表示

• 配列: 文字列

{
    "description":"LDAP controls to be sent to server for LDAP modify operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: operations

型: array

エントリに対して実行する変更(パッチ操作)。

ソースを表示

• 配列: オブジェクト PatchOperation

{
    "type":"array",
    "description":"Modifications (Patch operations) to be performed on the entry.",
    "items":{
        "$ref":"#/definitions/PatchOperation"
    }
}

ネストされたスキーマ: PatchOperation

型: object

ソースを表示

• attribute(required): string
  変更するエントリ属性。
• opType(required): string
  指定可能な値: [ "add", "delete", "replace", "increment" ]

  パッチ操作のタイプ。
• values: array values
  更新する属性値。

{
    "type":"object",
    "required":[
        "opType",
        "attribute"
    ],
    "properties":{
        "opType":{
            "description":"The type of the Patch Operation.",
            "type":"string",
            "enum":[
                "add",
                "delete",
                "replace",
                "increment"
            ]
        },
        "attribute":{
            "type":"string",
            "description":"The entry attribute to be modified."
        },
        "values":{
            "type":"array",
            "description":"The attribute values to be updated.",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: values

型: array

更新する属性値。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"The attribute values to be updated.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: JMX接続ハンドラのPatchSuccessResponse

型: object

ソースを表示

• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse

  RESTメッセージ・タイプ
• searchResultEntries(required): array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults(required): integer(int32)
  作成され、返されるエントリの数を指定します。

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/JMX Connection Handler SearchResultEntry"
            }
        }
    }
}

ネストされたスキーマ: searchResultEntries

型: array

LDAP操作後に返される検索結果エントリの数。

ソースを表示

• 配列: オブジェクト JMX接続ハンドラのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/JMX Connection Handler SearchResultEntry"
    }
}

ネストされたスキーマ: JMX接続ハンドラのSearchResultEntry

型: object

ソースを表示

• attributes(required): object JMX接続ハンドラのプロパティ
• dn(required): string
  作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/JMX Connection Handler Properties"
        }
    }
}

ネストされたスキーマ: 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
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-listen-port",
        "ds-cfg-enabled"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the JMX Connection Handler implementation. ",
            "readOnly":false,
            "default":"org.opends.server.protocols.jmx.JmxConnectionHandler",
            "type":"string"
        },
        "ds-cfg-denied-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-listen-address":{
            "description":"Specifies the address or set of addresses on which this JMX Connection Handler should listen for connections from SNMP clients. ",
            "readOnly":true,
            "default":[
                "0.0.0.0"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname (also called the alias) of the certificate that the JMX Connection Handler should use when performing SSL communication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-listen-port":{
            "description":"Specifies the port number on which the JMX Connection Handler will listen for connections from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-use-ssl":{
            "description":"Indicates whether the JMX Connection Handler should use SSL. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Connection Handler is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that should be used with this JMX Connection Handler . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-allowed-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: ds-cfg-allowed-client

型: array

この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-denied-client

型: array

この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-listen-address

型: array

読取り専用: true

JMX接続ハンドラがSNMPクライアントからの接続をリスニングする必要があるアドレスまたは一連のアドレスを指定します。

デフォルト値: [ "0.0.0.0" ]

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the address or set of addresses on which this JMX Connection Handler should listen for connections from SNMP clients. ",
    "readOnly":true,
    "default":[
        "0.0.0.0"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: objectclass

型: array

このエントリが属するオブジェクト・クラス。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

400レスポンス

ERROR

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode: integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message(required): string
  操作に対して返されるエラー・メッセージ。
• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  RESTメッセージ・タイプ

{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}

先頭に戻る