Data Sync Server Documentation Index
Configuration Reference Home

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

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

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

Direct Subcomponents

The following Server Instance Listeners are available in the server :

These Server Instance Listeners inherit from the properties described below.

Relations from This Component

The following components have a direct composition relation from Server Instance Listeners:

Relations to This Component

The following components have a direct composition relation to Server Instance Listeners:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ purpose  None

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


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