Configuration Reference Home
Oracle Unified Directory - Gateway Domain

Gateway Domain

A Gateway Domain comprises of several DSEE and Oracle Unified Directorys sharing the same synchronized set of data.

Relations From this Component

The following components have a direct AGGREGATION relation FROM Gateway Domains :

Relations To this Component

The following components have a direct COMPOSITION relation TO Gateway Domains :

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ base-dn ↓ changetime-heartbeat-interval
↓ dsee-auth-protocol ↓ dscc-address
↓ dsee-purge-delay ↓ dscc-admin-dn
↓ dsee-server ↓ dsee-bind-dn
↓ dsee-user-password ↓ dsee-group-size
↓ replicate-oud-changes ↓ dsee-ssl-rsa-cert-name
↓ replication-server ↓ dsee-window-size
↓ server-id ↓ group-id
↓ handshake-timeout
↓ heartbeat-interval
↓ key-manager-provider
↓ repl-bind-dn
↓ trust-manager-provider
↓ window-size

Basic Properties

base-dn

Description
Specifies the base DN of the replicated data.
Default Value
None
Allowed Values
A valid DN.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
Yes

dsee-auth-protocol

Description
Specifies the behavior that the backend should use when processing write operations.
Default Value
clear
Allowed Values
clear - Use clear text password authentication.

ssl-client - Use SSL client authentication.

ssl-simple - Use SSL simple authentication.


Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

dsee-purge-delay

Description
Specifies in seconds the purge delay defined on the DSEE server this replication gateway is connected to.
Default Value
604800s
Allowed Values
A duration Syntax. Lower limit is 0 seconds.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

dsee-server

Description
Specifies the address of the DSEE Replication Server within the Gateway Domain to which the Replication Gateway Server should try to connect and update. Address must be specified using the syntax: hostname:port
Default Value
None
Allowed Values
A host name followed by a ":" and a port number.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

dsee-user-password

Description
The password used to authenticate the Replication Gateway by the DSEE Replication Servers.
Default Value
None
Allowed Values
Unknown
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

replicate-oud-changes

Description
Indicates whether the Gateway Domain is replicating changes from the Oracle Unified Directory topology. If set to FALSE, only DSEE updates are propagated through the gateway.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

replication-server

Description
Specifies the addresses of the Replication Servers within the Gateway Domain to which the Directory Server should try to connect at startup time. Addresses must be specified using the syntax: hostname:port
Default Value
None
Allowed Values
A host name followed by a ":" and a port number.
Multi-valued
Yes
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

server-id

Description
Specifies a unique identifier for the Directory Server within the Gateway Domain. Each Directory Server within the same Gateway Domain must have a different server ID. A Directory Server which is a member of multiple Gateway Domains may use the same server ID for each of its Gateway Domain configurations.
Default Value
None
Allowed Values
An integer value. Lower value is 1. Upper value is 32767 .
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
Yes


Advanced Properties

changetime-heartbeat-interval

Description
Specifies the heart-beat interval that the Replication Gateway will use when sending its local change time to the Replication Server. The Replication Gateway sends a regular heart-beat to the Replication within the specified interval. The heart-beat indicates the change time of the Replication Gateway to the Replication Server.
Default Value
1000ms
Allowed Values
A duration Syntax. Lower limit is 100 milliseconds.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

dscc-address

Description
Specifies the host name and port number where the Oracle Directory Service Control Center Registry is deployed. Address must be specified using the syntax: hostname:port.
Default Value
None
Allowed Values
A host name followed by a ":" and a port number.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
Yes

dscc-admin-dn

Description
The Directory Service Manager user name used to authenticate through the Oracle Directory Service Control Center. This value defines the distinguish name of the Directory service Manager allowed to bind the Oracle Directory Service Control Center.
Default Value
cn=admin,cn=Administrators,cn=dscc
Allowed Values
A valid DN.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
Yes

dsee-bind-dn

Description
Attribute specifying which bind dn is to be used to connect the DSEE consumer.
Default Value
cn=replication manager,cn=replication,cn=config
Allowed Values
A valid DN.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

dsee-group-size

Description
Specifies the group size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol.
Default Value
10
Allowed Values
An integer value. Lower value is 1. Upper value is 255 .
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

dsee-ssl-rsa-cert-name

Description
Attribute specifying which certificate alias to send to the DSEE Consumer while using client authentication
Default Value
server-cert
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

dsee-window-size

Description
Specifies the window size that the Replication Gateway will use when communicating with a DSEE LDAP Server using the DSEE replication transport protocol.
Default Value
100
Allowed Values
An integer value. Lower value is 1. Upper value is 65535 .
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

group-id

Description
The group id associated with this replicated domain. This value defines the group id of the replicated domain. The replication system will preferably connect and send updates to replicate to a replication server with the same group id as him.
Default Value
1
Allowed Values
An integer value. Lower value is 1. Upper value is 127 .
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

handshake-timeout

Description
Specifies the handshake-timeout interval for the handshake between the replication servers. The soTimeout value to be used at the time of handshake phase with the Replicaton Server. It requires the server to be restarted.
Default Value
4000ms
Allowed Values
A duration Syntax. Lower limit is 0 milliseconds.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

heartbeat-interval

Description
Specifies the heart-beat interval that the Directory Server will use when communicating with Replication Servers. The Directory Server expects a regular heart-beat coming from the Replication Server within the specified interval. If a heartbeat is not received within the interval, the Directory Server closes its connection and connects to another Replication Server.
Default Value
10000ms
Allowed Values
A duration Syntax. Lower limit is 100 milliseconds.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

key-manager-provider

Description
Specifies the name of the key manager that should be used with this Gateway Domain .
Default Value
JKS
Allowed Values
The DN of any Key Manager Provider. The referenced key manager provider must be enabled when the Gateway Domain is enabled and configured to use SSL or Client Authentication.
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.
Advanced Property
Yes
Read-only
No

repl-bind-dn

Description
Allowed replication manager DN(s) to bind for replication purpose. This value defines the distinguish names of the DSEE replication manager allowed to bind the replication gateway.
Default Value
cn=replication manager,cn=replication,cn=config
Allowed Values
A valid DN.
Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

trust-manager-provider

Description
Specifies the name of the trust manager that should be used with the Gateway Domain .
Default Value
JKS
Allowed Values
The DN of any Trust Manager Provider. The referenced trust manager provider must be enabled when the Gateway Domain is enabled and configured to use SSL or StartTLS.
Multi-valued
No
Required
No
Admin Action Required
None. Changes to this property take effect immediately, but only for subsequent attempts to access the trust manager provider for associated client connections.
Advanced Property
Yes
Read-only
No

window-size

Description
Specifies the window size that the Directory Server will use when communicating with Replication Servers.
Default Value
100
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No


Copyright © 2017, 2020, Oracle and/or its affiliates. All rights reserved.