Find JMX Connection Handler by DN
get
/rest/v1/admin/{dn}
Returns an JMX Connection Handler by DN
Request
Supported Media Types
- application/json
Path Parameters
-
dn: string
LDAP DN of the entry to be fetched.
Query Parameters
- attributes: array
- controls: array
-
filter: string
Search filter for the LDAP search operation. Should follow LDAP search filter syntax.
-
scope: string
Scope for the LDAP search operation.Allowed Values:
[ "base", "sub", "one" ]
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : JMX Connection Handler GetSuccessResponse
Type:
Show Source
object
-
msgType:
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse
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.
Nested Schema : searchResultEntries
Type:
array
Number of search result entries returned after the LDAP operation.
Show Source
Nested Schema : JMX Connection Handler SearchResultEntry
Type:
Show Source
object
-
attributes:
object JMX Connection Handler Properties
-
dn:
string
LDAP DN of the entry to be created
Nested Schema : JMX Connection Handler Properties
Type:
Show Source
object
-
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-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.protocols.jmx.JmxConnectionHandler
Specifies the fully-qualified name of the Java class that provides the JMX Connection Handler implementation. -
ds-cfg-key-manager-provider(optional):
string
Specifies the name of the key manager that should be used with this JMX Connection Handler .
-
ds-cfg-listen-address(optional):
array ds-cfg-listen-address
Read Only:
true
Specifies the address or set of addresses on which this JMX Connection Handler should listen for connections from SNMP clients. -
ds-cfg-listen-port:
integer(int32)
Specifies the port number on which the JMX Connection Handler will listen for connections from clients.
-
ds-cfg-ssl-cert-nickname(optional):
string
Specifies the nickname (also called the alias) of the certificate that the JMX Connection Handler should use when performing SSL communication.
-
ds-cfg-use-ssl(optional):
boolean
Default Value:
false
Indicates whether the JMX Connection Handler should use SSL. -
objectclass:
array objectclass
Objectclass(es) which this entry belongs to.
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
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
Nested Schema : ds-cfg-listen-address
Type:
array
Read Only:
true
Specifies the address or set of addresses on which this JMX Connection Handler should listen for connections from SNMP clients.
Default Value:
Show Source
[
"0.0.0.0"
]
406 Response
Not Acceptable
Root Schema : ErrorResponse
Type:
Show Source
object
-
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