Data Governance Server Documentation Index
Configuration Reference Home

Server Instance

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 is an abstract component that cannot be instantiated.

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.

The Server Instance represents a single server within the system that has one of the UnboundID products installed on it.

↓Direct Subcomponents
↓Relations from This Component
↓Relations to This Component
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following Server Instances are available in the server :

These Server Instances inherit from the properties described below.

Relations from This Component

The following components have a direct composition relation from Server Instances:

Relations to This Component

The following components have a direct aggregation relation to Server Instances:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ server-instance-name ↓ server-version
↓ cluster-name ↓ server-admin-id
↓ server-instance-type ↓ inter-server-certificate
↓ server-instance-location
↓ hostname
↓ server-root
↓ ldap-port
↓ ldaps-port
↓ http-port
↓ https-port
↓ replication-port
↓ replication-server-id
↓ replication-domain-server-id
↓ jmx-port
↓ jmxs-port
↓ preferred-security
↓ start-tls-enabled
↓ base-dn
↓ member-of-server-group

Basic Properties

server-instance-name (Read-Only)

Description
The name of this Server Instance. The instance name needs to be unique if this server will be part of a topology of servers that are connected to each other. Once set, it may not be changed.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

cluster-name

Description
The name of the cluster to which this Server Instance belongs. Server instances within the same cluster will share the same cluster-wide configuration.
Default Value
Governance
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

server-instance-type (Read-Only)

Description
Specifies the type of server installation.
Default Value
None
Allowed Values
ds - Represents a Directory Server instance.

proxy - Represents a Directory Proxy Server instance.

governance - Represents a Data Governance Server instance.

metrics - Represents a Data Metrics Server instance.

sync - Represents a Data Sync Server instance.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

server-instance-location

Description
Specifies the location for the Server Instance.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

hostname

Description
The name of the host where this Server Instance is installed.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

server-root

Description
The file system path where this Server Instance is installed.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

ldap-port

Description
The TCP port on which this server is listening for LDAP connections.
Default Value
None
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

ldaps-port

Description
The TCP port on which this server is listening for LDAP secure connections.
Default Value
None
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

http-port

Description
The TCP port on which this server is listening for HTTP connections.
Default Value
None
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

https-port

Description
The TCP port on which this server is listening for HTTPS connections.
Default Value
None
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

replication-port (Read-Only)

Description
The replication TCP port.
Default Value
None
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

replication-server-id (Read-Only)

Description
Specifies a unique identifier for the replication server on this server instance.
Default Value
None
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

replication-domain-server-id (Read-Only)

Description
Specifies a unique identifier for the Data Governance Server within the replication domain. Each Data Governance Server within the same replication domain must have a different server ID. A Data Governance Server which is a member of multiple replication domains may use the same server ID for each of its replication domain configurations.
Default Value
None
Allowed Values
An integer value. Lower limit is 1. Upper limit is 65535 .
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

jmx-port

Description
The TCP port on which this server is listening for JMX connections.
Default Value
None
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

jmxs-port

Description
The TCP port on which this server is listening for JMX secure connections.
Default Value
None
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

preferred-security

Description
Specifies the preferred 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.

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

start-tls-enabled

Description
Indicates whether StartTLS is enabled on this server.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

base-dn

Description
The set of base DNs under the root DSE.
Default Value
None
Allowed Values
A valid DN.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

member-of-server-group (Read-Only)

Description
The set of groups of which this server is a member.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


Advanced Properties

server-version (Advanced Property)

Description
The version of the server.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

server-admin-id (Advanced Property, Read-Only)

Description
The ID of the server in the admin backend, if this server was updated from an old version that supported the admin backend.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

inter-server-certificate (Advanced Property)

Description
The public component of the certificate used by this instance to protect inter-server communication and to perform server-specific encryption. This will generally be managed by the server and should only be altered by administrators under explicit direction from Ping Identity support personnel. The value of this property should be the PEM-encoded representation of the certificate used for inter-server authentication and security, including the "-----BEGIN CERTIFICATE-----" header and the "-----END CERTIFICATE" footer.
In the event that the inter-server certificate ever needs to change, then it may be necessary for this property to temporarily include information about multiple certificates. That can be accomplished by including information about both certificates in the same file, each with their own begin and end headers and footers.
Blank lines, and lines that start with the octothorpe character (#) will be ignored.
Default Value
None
Allowed Values
application/x-x509-server-cert
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Server Instances:

dsconfig list-server-instances
     [--property {propertyName}] ...

To view the configuration for an existing Server Instance:

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

To update the configuration for an existing Server Instance:

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