Directory Server Documentation Index
Configuration Reference Home

HTTP Server Instance Listener

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.

Note: this component stores topology administrative data and is mirrored across all servers in the topology. It is not intended to be modified directly and is instead managed by the setup and uninstall tools.

Note: changes to topology configuration objects are immediately and automatically mirrored across all servers, so offline changes are not supported.

HTTP Server Instance Listeners are used to identify listeners to changes related to HTTP server instances defined within the system.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The HTTP Server Instance Listener component inherits from the Server Instance Listener

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ purpose  None
↓ listen-address
↓ server-http-port
↓ connection-security

Basic Properties

purpose

Description
Identifies the purpose of this Server Instance Listener.
Default Value
mirrored-config
Allowed Values
mirrored-config - Specifies that this Server Instance Listener is to be used for listening to changes to mirrored data. Mirrored data pertains to cluster-wide configuration data that is mirrored across servers in a topology. It also includes meta-data pertaining to the servers in the topology.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

listen-address

Description
If the server is listening on a particular address different from the hostname, then this property may be used to specify the address on which to listen for connections from HTTP clients.
Default Value
None
Allowed Values
An IP address
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

server-http-port

Description
The TCP port number on which the HTTP server is listening.
Default Value
8080
Allowed Values
An integer value. Lower limit is 1. Upper limit is 65535 .
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

connection-security

Description
Specifies the mechanism to use for securing connections to the server.
Default Value
none
Allowed Values
none - Connections to the server will not be secured.

ssl - Connections to the server will be secured using SSL.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Server Instance Listeners:

dsconfig list-server-instance-listeners
     [--property {propertyName}] ...

To view the configuration for an existing Server Instance Listener:

dsconfig get-server-instance-listener-prop
     --listener-name {name}
     --instance-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Server Instance Listener:

dsconfig set-server-instance-listener-prop
     --listener-name {name}
     --instance-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...