Oracle Unified Directoryの管理REST API: DNによるSNMP接続ハンドラの変更

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

PATCH

/rest/v1/admin/{dn}

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

リクエスト

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

application/json

パス・パラメータ

dn: string

変更するエントリのLDAP DN。

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

ルート・スキーマ: PatchRequest

型: object

ソースを表示

controls(optional): array controls

LDAP変更操作のためにサーバーに送信するLDAP制御。
msgType: 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制御。

ソースを表示

[0]: string

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

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

型: array

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

ソースを表示

[0]: object PatchOperation

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

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

型: object

ソースを表示

attribute: string

変更するエントリ属性。
opType: string

指定可能な値: [ "add", "delete", "replace", "increment" ]

パッチ操作のタイプ。
values(optional): 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

更新する属性値。

ソースを表示

[0]: string

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

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

型: object

ソースを表示

msgType: string

デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse

RESTメッセージ・タイプ
searchResultEntries: array searchResultEntries

LDAP操作後に返される検索結果エントリの数。
totalResults: 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/SNMP Connection Handler SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

[0]: object SNMP接続ハンドラのSearchResultEntry

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

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

型: object

ソースを表示

attributes: object SNMP接続ハンドラのプロパティ
dn: string

作成するエントリのLDAP DN。

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

ネストされたスキーマ: SNMP接続ハンドラのプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-allowed-client(optional): array ds-cfg-allowed-client

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

アクセス権限が付与されるマネージャのホストを指定します。このプロパティは、SNMP v1およびv2のセキュリティ構成に必要です。アスタリスク(*)を指定すると、すべてのマネージャに対してアクセスが開きます。
ds-cfg-allowed-user(optional): array ds-cfg-allowed-user

アクセス権限が付与されるユーザーを指定します。このプロパティは、SNMP v3のセキュリティ構成に必要です。アスタリスク(*)を指定すると、すべてのユーザーに対してアクセスが開きます。
ds-cfg-community(optional): string

デフォルト値: OUD

MIB 2605モニタリング情報またはUSM MIBへのアクセスが許可されているv1、v2のコミュニティまたはv3のコンテキスト名を指定します。コミュニティとコンテキスト名の間のマッピングが設定されます。
ds-cfg-denied-client(optional): array ds-cfg-denied-client

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

接続ハンドラが使用可能かどうかを示します。
ds-cfg-java-class: string

デフォルト値: org.opends.server.snmp.SNMPConnectionHandler

SNMP接続ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-listen-address(optional): array ds-cfg-listen-address

読取り専用: true

SNMP接続ハンドラがSNMPクライアントからの接続をリスニングするアドレスまたはアドレスのセットを指定します。
ds-cfg-listen-port: integer(int32)

SNMP接続ハンドラがクライアントからの接続をリスニングするポート番号を指定します。
ds-cfg-registered-mbean(optional): boolean

デフォルト値: false

SNMPオブジェクトをディレクトリ・サーバーのMBeanServerに登録する必要があるのか、RMIコネクタが有効な場合でもRMIコネクタを使用したSNMPオブジェクトへのアクセスが許可されないのかを示します。
ds-cfg-security-agent-file(optional): string

デフォルト値: config/snmp/security/oud-snmp.security

認証済のSNMPリクエストのみを受信するUSMセキュリティ構成を指定します。
ds-cfg-security-level(optional): string

デフォルト値: authnopriv

指定可能な値: [ "authnopriv", "authpriv", "noauthnopriv" ]

セキュリティ・レベルのタイプを指定します。NoAuthNoPrivの場合、セキュリティ・メカニズムはアクティブになりません。AuthNoPrivの場合、プライバシのない認証がアクティブになります。AuthPrivの場合、プライバシのある認証がアクティブになります。このプロパティは、SNMP V3のセキュリティ構成に必要です。
ds-cfg-trap-port: integer(int32)

SNMPトラップの送信に使用するポートを指定します。
ds-cfg-traps-community(optional): string

デフォルト値: OUD

マネージャを定義するために送信されたトラップに組み込む必要があるコミュニティ文字列を指定します(trap-destinations)。このプロパティは、SNMP v1、v2およびv3のコンテキストで使用されます。
ds-cfg-traps-destination(optional): array ds-cfg-traps-destination

V1のトラップが送信されるホストを指定します。一覧表示されているすべてのホストにV1のトラップが送信されます。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-trap-port",
        "ds-cfg-listen-port"
    ],
    "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 SNMP Connection Handler implementation. ",
            "readOnly":false,
            "default":"org.opends.server.snmp.SNMPConnectionHandler",
            "type":"string"
        },
        "ds-cfg-security-level":{
            "description":"Specifies the type of security level : NoAuthNoPriv : No security mechanisms activated, AuthNoPriv : Authentication activated with no privacy, AuthPriv : Authentication with privacy activated. This property is required for SNMP V3 security configuration. ",
            "readOnly":false,
            "default":"authnopriv",
            "type":"string",
            "enum":[
                "authnopriv",
                "authpriv",
                "noauthnopriv"
            ]
        },
        "ds-cfg-listen-address":{
            "description":"Specifies the address or set of addresses on which this SNMP Connection Handler should listen for connections from SNMP clients. ",
            "readOnly":true,
            "default":[
                "0.0.0.0"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-manager":{
            "description":"Specifies the hosts of the managers to be granted the access rights. This property is required for SNMP v1 and v2 security configuration. An asterisk (*) opens access to all managers. ",
            "readOnly":false,
            "default":[
                "*"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-community":{
            "description":"Specifies the v1,v2 community or the v3 context name allowed to access the MIB 2605 monitoring information or the USM MIB. The mapping between \"community\" and \"context name\" is set. ",
            "readOnly":false,
            "default":"OUD",
            "type":"string"
        },
        "ds-cfg-registered-mbean":{
            "description":"Indicates whether the SNMP objects have to be registered in the Directory Server MBeanServer or not allowing to access SNMP Objects with RMI connector if enabled. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Connection Handler is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-traps-destination":{
            "description":"Specifies the hosts to which V1 traps will be sent. V1 Traps are sent to every host listed. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-trap-port":{
            "description":"Specifies the port to use to send SNMP Traps. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "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-security-agent-file":{
            "description":"Specifies the USM security configuration to receive authenticated only SNMP requests. ",
            "readOnly":false,
            "default":"config/snmp/security/oud-snmp.security",
            "type":"string"
        },
        "ds-cfg-allowed-user":{
            "description":"Specifies the users to be granted the access rights. This property is required for SNMP v3 security configuration. An asterisk (*) opens access to all users. ",
            "readOnly":false,
            "default":[
                "*"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-traps-community":{
            "description":"Specifies the community string that must be included in the traps sent to define managers (trap-destinations). This property is used in the context of SNMP v1, v2 and v3. ",
            "readOnly":false,
            "default":"OUD",
            "type":"string"
        },
        "ds-cfg-listen-port":{
            "description":"Specifies the port number on which the SNMP Connection Handler will listen for connections from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "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

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

ソースを表示

[0]: string

{
    "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-manager

型: array

アクセス権限が付与されるマネージャのホストを指定します。このプロパティは、SNMP v1およびv2のセキュリティ構成に必要です。アスタリスク(*)を指定すると、すべてのマネージャに対してアクセスが開きます。

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

ソースを表示

[0]: string

{
    "description":"Specifies the hosts of the managers to be granted the access rights. This property is required for SNMP v1 and v2 security configuration. An asterisk (*) opens access to all managers. ",
    "readOnly":false,
    "default":[
        "*"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

アクセス権限が付与されるユーザーを指定します。このプロパティは、SNMP v3のセキュリティ構成に必要です。アスタリスク(*)を指定すると、すべてのユーザーに対してアクセスが開きます。

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

ソースを表示

[0]: string

{
    "description":"Specifies the users to be granted the access rights. This property is required for SNMP v3 security configuration. An asterisk (*) opens access to all users. ",
    "readOnly":false,
    "default":[
        "*"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

SNMP接続ハンドラがSNMPクライアントからの接続をリスニングするアドレスまたはアドレスのセットを指定します。

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

ソースを表示

[0]: string

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

ネストされたスキーマ: ds-cfg-traps-destination

型: array

V1のトラップが送信されるホストを指定します。一覧表示されているすべてのホストにV1のトラップが送信されます。

ソースを表示

[0]: string

{
    "description":"Specifies the hosts to which V1 traps will be sent. V1 Traps are sent to every host listed. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

400レスポンス

ERROR

406レスポンス

受入れできません

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

ldapErrorCode(optional): integer(int32)

操作に対して返されるLDAPエラー・コードを指定します。
message: string

操作に対して返されるエラー・メッセージ。
msgType: 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."
        }
    }
}

先頭に戻る