The JMX Connection Handler is used to interact with clients using the Java Management Extensions (JMX) protocol.
↓Parent Component
↓Relations from This Component
↓Properties
↓dsconfig Usage
The JMX Connection Handler component inherits from the Connection Handler
The following components have a direct aggregation relation from JMX Connection Handlers:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ allowed-client | |
| ↓ denied-client | |
| ↓ listen-port | |
| ↓ use-ssl | |
| ↓ ssl-cert-nickname | |
| ↓ key-manager-provider |
| Description | A description for this Connection Handler |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Connection Handler is enabled. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies a set of address masks that determines the addresses of the clients that are allowed to establish connections to this connection handler. |
| Default Value | All clients with addresses that do not match an address on the deny list are allowed. If there is no deny list, then all clients are allowed. |
| Allowed Values | An IP address mask |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Changes to this configuration attribute take effect immediately and do not interfere with connections that may have already been established. |
| Description | Specifies a set of address masks that determines the addresses of the clients that are not allowed to establish connections to this connection handler. If both allowed and denied client masks are defined and a client connection matches one or more masks in both lists, then the connection is denied. If only a denied list is specified, then any client not matching a mask in that list is allowed. |
| Default Value | If an allow list is specified, then only clients with addresses on the allow list are allowed. Otherwise, all clients are allowed. |
| Allowed Values | An IP address mask |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Changes to this configuration attribute take effect immediately and do not interfere with connections that may have already been established. |
| Description | Specifies the port number on which the JMX Connection Handler will listen for connections from clients. Only a single port number may be provided. |
| Default Value | None |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 65535 . |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | The JMX Connection Handler must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server |
| Description | Indicates whether the JMX Connection Handler should use SSL. If enabled, the JMX Connection Handler will use SSL to encrypt communication with the clients. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The JMX Connection Handler must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server |
| Description | Specifies the nickname (also called the alias) of the certificate that the JMX Connection Handler should use when performing SSL communication. This is only applicable when the JMX Connection Handler is configured to use SSL. |
| Default Value | Let the server decide. |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The JMX Connection Handler must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server |
| Description | Specifies the name of the key manager that should be used with this JMX Connection Handler . |
| Default Value | None |
| Allowed Values | The DN of any Key Manager Provider. The referenced key manager provider must be enabled when the JMX Connection Handler is enabled and configured to use SSL. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Changes to this property take effect immediately, but only for subsequent attempts to access the key manager provider for associated client connections. |
To list the configured Connection Handlers:
dsconfig list-connection-handlers
[--property {propertyName}] ...
To view the configuration for an existing Connection Handler:
dsconfig get-connection-handler-prop
--handler-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Connection Handler:
dsconfig set-connection-handler-prop
--handler-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new JMX Connection Handler:
dsconfig create-connection-handler
--handler-name {name}
--type jmx
--set enabled:{propertyValue}
--set listen-port:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Connection Handler:
dsconfig delete-connection-handler
--handler-name {name}