• msgType(required): string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

  The REST message type
• searchResultEntries(required): array searchResultEntries
  Number of search result entries returned after the LDAP operation.
• totalResults(required): 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:SearchResponse",
            "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"
            }
        }
    }
}

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

• attributes(required): object SNMP Connection Handler Properties
• dn(required): 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"
        }
    }
}

• cn: string
  CN (common name) of the entry
• ds-cfg-allowed-client: 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: 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: 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: 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: 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(required): boolean
  Indicates whether the Connection Handler is enabled.
• ds-cfg-java-class(required): 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: 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(required): integer(int32)
  Specifies the port number on which the SNMP Connection Handler will listen for connections from clients.
• ds-cfg-registered-mbean: 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: string
  Default Value: config/snmp/security/oud-snmp.security

  Specifies the USM security configuration to receive authenticated only SNMP requests.
• ds-cfg-security-level: 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(required): integer(int32)
  Specifies the port to use to send SNMP Traps.
• ds-cfg-traps-community: 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: array ds-cfg-traps-destination
  Specifies the hosts to which V1 traps will be sent. V1 Traps are sent to every host listed.
• objectclass(required): 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"
            }
        }
    }
}

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

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

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

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

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

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

• Array of: string

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

• ldapErrorCode: integer(int32)
  Specifies the LDAP error code returned for the operation.
• message(required): string
  Error message returned returned for the operation.
• msgType(required): 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."
        }
    }
}