Data Governance Broker Documentation Index
Configuration Reference Home

Broker 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 UnboundID 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.

The Broker Server Instance represents a single server within the system with the Data Governance Broker installed on it.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Broker Server Instance component inherits from the Server Instance

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ server-instance-name ↓ inter-server-certificate
↓ cluster-name
↓ server-instance-type
↓ server-instance-location
↓ hostname
↓ server-root

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
Broker
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

server-instance-type (Read-Only)

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

proxy - Represents a Directory Proxy Server instance.

broker - Represents a Data Governance Broker 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


Advanced Properties

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}] ...