Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.
Locations are used to define collections of servers which may have similar performance characteristics when accessed from this Metrics Engine. For example, a separate Location may be defined for each data center.
This Metrics Engine instance may be assigned a location in the global configuration. Components which use Locations should generally prefer accessing other servers in the same Location. Each configured Location may have an ordered list of failover Locations that may be tried if none of the servers in the same Location are available.
↓Relations From this Component
↓Relations To this Component
↓Properties
↓dsconfig Usage
The following components have a direct aggregation relation from Locations:
The following components have a direct aggregation relation to Locations:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ preferred-failover-location |
| Description | A description for this Location |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies a set of alternate Locations in which servers may be accessed if no servers in this Location are available. If multiple values are provided, then the order in which the Locations are listed is the order in which they should be tried. |
| Default Value | None |
| Allowed Values | The DN of any Location. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Locations:
dsconfig list-locations
[--property {propertyName}] ...
To view the configuration for an existing Location:
dsconfig get-location-prop
--location-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Location:
dsconfig set-location-prop
--location-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Location:
dsconfig create-location
--location-name {name}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Location:
dsconfig delete-location
--location-name {name}