Jump to

• Request
• Response

Add, Search, Compare or Delete SNMP Connection Handler

post

/rest/v1/admin

Add, Search, Compare or Delete SNMP Connection Handler

Request

Supported Media Types

• application/json

Body ()

SNMP Connection Handler that needs to be created

Root Schema : SNMP Connection Handler POSTRequest

Type: object

Show Source

• assertion(optional): string
  Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.
• attributes(optional): object SNMP Connection Handler Properties
• base(optional): string
  Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation
• controls(optional): array controls
  LDAP controls to be sent to server for the LDAP operation.
• dn(optional): string
  LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.
• filter(optional): string
  Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
• msgType: string
  Allowed Values: [ "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" ]

  The REST message type
• requiredAttributes(optional): array requiredAttributes
  List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
• scope(optional): string
  Allowed Values: [ "base", "sub", "one" ]

  Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.

{
    "type":"object",
    "required":[
        "msgType"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "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"
            ]
        },
        "dn":{
            "description":"LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/SNMP Connection Handler Properties"
        },
        "base":{
            "description":"Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation",
            "type":"string"
        },
        "scope":{
            "description":"Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string",
            "enum":[
                "base",
                "sub",
                "one"
            ]
        },
        "filter":{
            "description":"Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string"
        },
        "requiredAttributes":{
            "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for the LDAP operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assertion":{
            "description":"Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.",
            "type":"string"
        }
    }
}

Nested Schema : SNMP Connection Handler Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-allowed-client(optional): array ds-cfg-allowed-client
  Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler.
• ds-cfg-allowed-manager(optional): array ds-cfg-allowed-manager
  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.
• ds-cfg-allowed-user(optional): array ds-cfg-allowed-user
  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.
• ds-cfg-community(optional): string
  Default Value: OUD

  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.
• ds-cfg-denied-client(optional): array ds-cfg-denied-client
  Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler.
• ds-cfg-enabled: boolean
  Indicates whether the Connection Handler is enabled.
• ds-cfg-java-class: string
  Default Value: org.opends.server.snmp.SNMPConnectionHandler

  Specifies the fully-qualified name of the Java class that provides the SNMP Connection Handler implementation.
• ds-cfg-listen-address(optional): array ds-cfg-listen-address
  Read Only: true

  Specifies the address or set of addresses on which this SNMP Connection Handler should listen for connections from SNMP clients.
• ds-cfg-listen-port: integer(int32)
  Specifies the port number on which the SNMP Connection Handler will listen for connections from clients.
• ds-cfg-registered-mbean(optional): boolean
  Default Value: false

  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.
• ds-cfg-security-agent-file(optional): string
  Default Value: config/snmp/security/oud-snmp.security

  Specifies the USM security configuration to receive authenticated only SNMP requests.
• ds-cfg-security-level(optional): string
  Default Value: authnopriv

  Allowed Values: [ "authnopriv", "authpriv", "noauthnopriv" ]

  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.
• ds-cfg-trap-port: integer(int32)
  Specifies the port to use to send SNMP Traps.
• ds-cfg-traps-community(optional): string
  Default Value: OUD

  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.
• ds-cfg-traps-destination(optional): array ds-cfg-traps-destination
  Specifies the hosts to which V1 traps will be sent. V1 Traps are sent to every host listed.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

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

Nested Schema : controls

Type: array

LDAP controls to be sent to server for the LDAP operation.

Show Source

• Array of: string

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

Nested Schema : requiredAttributes

Type: array

List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.

Show Source

• Array of: string

{
    "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-allowed-client

Type: array

Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler.

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-allowed-manager

Type: array

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.

Default Value: [ "*" ]

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-allowed-user

Type: array

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.

Default Value: [ "*" ]

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-denied-client

Type: array

Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler.

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-listen-address

Type: array

Read Only: true

Specifies the address or set of addresses on which this SNMP Connection Handler should listen for connections from SNMP clients.

Default Value: [ "0.0.0.0" ]

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-traps-destination

Type: array

Specifies the hosts to which V1 traps will be sent. V1 Traps are sent to every host listed.

Show Source

• Array of: 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"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : SNMP Connection Handler SuccessResponse

Type: object

Show Source

• compareResult(optional): boolean
  Indicates the result of LDAP compare operation.
• msgType: string
  Allowed Values: [ "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" ]

  The REST message type
• searchResultEntries: array searchResultEntries
  Number of search result entries returned after the LDAP operation.
• totalResults: integer(int32)
  Specifies the number of entries created, and returned.

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "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"
            ]
        },
        "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"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• Array of: object SNMP Connection Handler SearchResultEntry

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

Nested Schema : SNMP Connection Handler SearchResultEntry

Type: object

Show Source

• attributes: object SNMP Connection Handler Properties
• dn: string
  LDAP DN of the entry to be created

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

Nested Schema : SNMP Connection Handler Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-allowed-client(optional): array ds-cfg-allowed-client
  Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler.
• ds-cfg-allowed-manager(optional): array ds-cfg-allowed-manager
  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.
• ds-cfg-allowed-user(optional): array ds-cfg-allowed-user
  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.
• ds-cfg-community(optional): string
  Default Value: OUD

  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.
• ds-cfg-denied-client(optional): array ds-cfg-denied-client
  Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler.
• ds-cfg-enabled: boolean
  Indicates whether the Connection Handler is enabled.
• ds-cfg-java-class: string
  Default Value: org.opends.server.snmp.SNMPConnectionHandler

  Specifies the fully-qualified name of the Java class that provides the SNMP Connection Handler implementation.
• ds-cfg-listen-address(optional): array ds-cfg-listen-address
  Read Only: true

  Specifies the address or set of addresses on which this SNMP Connection Handler should listen for connections from SNMP clients.
• ds-cfg-listen-port: integer(int32)
  Specifies the port number on which the SNMP Connection Handler will listen for connections from clients.
• ds-cfg-registered-mbean(optional): boolean
  Default Value: false

  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.
• ds-cfg-security-agent-file(optional): string
  Default Value: config/snmp/security/oud-snmp.security

  Specifies the USM security configuration to receive authenticated only SNMP requests.
• ds-cfg-security-level(optional): string
  Default Value: authnopriv

  Allowed Values: [ "authnopriv", "authpriv", "noauthnopriv" ]

  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.
• ds-cfg-trap-port: integer(int32)
  Specifies the port to use to send SNMP Traps.
• ds-cfg-traps-community(optional): string
  Default Value: OUD

  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.
• ds-cfg-traps-destination(optional): array ds-cfg-traps-destination
  Specifies the hosts to which V1 traps will be sent. V1 Traps are sent to every host listed.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

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

Nested Schema : ds-cfg-allowed-client

Type: array

Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler.

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-allowed-manager

Type: array

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.

Default Value: [ "*" ]

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-allowed-user

Type: array

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.

Default Value: [ "*" ]

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-denied-client

Type: array

Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler.

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-listen-address

Type: array

Read Only: true

Specifies the address or set of addresses on which this SNMP Connection Handler should listen for connections from SNMP clients.

Default Value: [ "0.0.0.0" ]

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-traps-destination

Type: array

Specifies the hosts to which V1 traps will be sent. V1 Traps are sent to every host listed.

Show Source

• Array of: 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"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• Array of: string

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

201 Response

Created

Body ()

Root Schema : SNMP Connection Handler ADDResponse

Type: object

Show Source

• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse

  The REST message type
• searchResultEntries: array searchResultEntries
• totalResults: integer(int32)
  Specifies the number of entries created, and returned.

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

Nested Schema : searchResultEntries

Type: array

Show Source

• Array of: object SNMP Connection Handler SearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SNMP Connection Handler SearchResultEntry"
    }
}

Nested Schema : SNMP Connection Handler SearchResultEntry

Type: object

Show Source

• attributes: object SNMP Connection Handler Properties
• dn: string
  LDAP DN of the entry to be created

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

Nested Schema : SNMP Connection Handler Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-allowed-client(optional): array ds-cfg-allowed-client
  Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler.
• ds-cfg-allowed-manager(optional): array ds-cfg-allowed-manager
  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.
• ds-cfg-allowed-user(optional): array ds-cfg-allowed-user
  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.
• ds-cfg-community(optional): string
  Default Value: OUD

  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.
• ds-cfg-denied-client(optional): array ds-cfg-denied-client
  Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler.
• ds-cfg-enabled: boolean
  Indicates whether the Connection Handler is enabled.
• ds-cfg-java-class: string
  Default Value: org.opends.server.snmp.SNMPConnectionHandler

  Specifies the fully-qualified name of the Java class that provides the SNMP Connection Handler implementation.
• ds-cfg-listen-address(optional): array ds-cfg-listen-address
  Read Only: true

  Specifies the address or set of addresses on which this SNMP Connection Handler should listen for connections from SNMP clients.
• ds-cfg-listen-port: integer(int32)
  Specifies the port number on which the SNMP Connection Handler will listen for connections from clients.
• ds-cfg-registered-mbean(optional): boolean
  Default Value: false

  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.
• ds-cfg-security-agent-file(optional): string
  Default Value: config/snmp/security/oud-snmp.security

  Specifies the USM security configuration to receive authenticated only SNMP requests.
• ds-cfg-security-level(optional): string
  Default Value: authnopriv

  Allowed Values: [ "authnopriv", "authpriv", "noauthnopriv" ]

  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.
• ds-cfg-trap-port: integer(int32)
  Specifies the port to use to send SNMP Traps.
• ds-cfg-traps-community(optional): string
  Default Value: OUD

  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.
• ds-cfg-traps-destination(optional): array ds-cfg-traps-destination
  Specifies the hosts to which V1 traps will be sent. V1 Traps are sent to every host listed.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

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

Nested Schema : ds-cfg-allowed-client

Type: array

Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler.

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-allowed-manager

Type: array

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.

Default Value: [ "*" ]

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-allowed-user

Type: array

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.

Default Value: [ "*" ]

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-denied-client

Type: array

Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler.

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-listen-address

Type: array

Read Only: true

Specifies the address or set of addresses on which this SNMP Connection Handler should listen for connections from SNMP clients.

Default Value: [ "0.0.0.0" ]

Show Source

• Array of: 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"
    }
}

Nested Schema : ds-cfg-traps-destination

Type: array

Specifies the hosts to which V1 traps will be sent. V1 Traps are sent to every host listed.

Show Source

• Array of: 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"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• Array of: string

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

204 Response

No content

406 Response

Not Acceptable

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• ldapErrorCode(optional): integer(int32)
  Specifies the LDAP error code returned for the operation.
• message: string
  Error message returned returned for the operation.
• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  The REST message type

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

Back to Top