Note: this component stores cluster-wide configuration data and is mirrored across all servers in the topology within the the same cluster.
Note: changes to cluster-wide configuration objects are immediately and automatically mirrored across all servers within the same cluster, so offline changes are not supported.
Delegated Admin Correlated REST Resources link REST resources based on common attribute values.
↓Relations from This Component
↓Relations to This Component
↓Properties
↓dsconfig Usage
The following components have a direct aggregation relation from Delegated Admin Correlated REST Resources:
The following components have a direct composition relation to Delegated Admin Correlated REST Resources:
The properties supported by this managed object are as follows:
Basic Properties: | Advanced Properties: |
---|---|
↓ display-name | None |
↓ correlated-rest-resource | |
↓ primary-rest-resource-correlation-attribute | |
↓ secondary-rest-resource-correlation-attribute | |
↓ use-secondary-value-for-linking |
Description | A human readable display name for this Delegated Admin Correlated REST Resource. |
Default Value | None |
Allowed Values | A string |
Multi-Valued | No |
Required | Yes |
Admin Action Required | None. Modification requires no further action |
Description | The REST Resource Type that will be linked to this REST Resource Type. |
Default Value | None |
Allowed Values | The DN of any REST Resource Type. The referenced resource type must be enabled. |
Multi-Valued | No |
Required | Yes |
Admin Action Required | None. Modification requires no further action |
primary-rest-resource-correlation-attribute
Description | The LDAP attribute from the parent REST Resource Type whose value will be used to match objects in the Delegated Admin Correlated REST Resource. This attribute must be writeable when use-secondary-value-for-linking is enabled. |
Default Value | None |
Allowed Values | The name or OID of an attribute type defined in the server schema. |
Multi-Valued | No |
Required | Yes |
Admin Action Required | None. Modification requires no further action |
secondary-rest-resource-correlation-attribute
Description | The LDAP attribute from the Delegated Admin Correlated REST Resource whose value will be matched with the primary-rest-resource-correlation-attribute. This attribute must be writeable when use-secondary-value-for-linking is disabled. |
Default Value | None |
Allowed Values | The name or OID of an attribute type defined in the server schema. |
Multi-Valued | No |
Required | Yes |
Admin Action Required | None. Modification requires no further action |
use-secondary-value-for-linking
Description | Indicates whether links should be created using the secondary correlation attribute value. If this setting is disabled, then the primary and secondary objects will be linked by assigning the value of the primary correlation attribute to the secondary correlation attribute. If this setting is enabled, then the value of the secondary correlation attribute will be assigned to the primary correlation attribute. |
Default Value | false |
Allowed Values | true false |
Multi-Valued | No |
Required | No |
Admin Action Required | None. Modification requires no further action |
To list the configured Delegated Admin Correlated REST Resources:
dsconfig list-delegated-admin-correlated-rest-resources [--property {propertyName}] ...
To view the configuration for an existing Delegated Admin Correlated REST Resource:
dsconfig get-delegated-admin-correlated-rest-resource-prop --resource-name {name} --type-name {name} [--tab-delimited] [--script-friendly] [--property {propertyName}] ...
To update the configuration for an existing Delegated Admin Correlated REST Resource:
dsconfig set-delegated-admin-correlated-rest-resource-prop --resource-name {name} --type-name {name} (--set|--add|--remove) {propertyName}:{propertyValue} [(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Delegated Admin Correlated REST Resource:
dsconfig create-delegated-admin-correlated-rest-resource --resource-name {name} --type-name {name} --set display-name:{propertyValue} --set correlated-rest-resource:{propertyValue} --set primary-rest-resource-correlation-attribute:{propertyValue} --set secondary-rest-resource-correlation-attribute:{propertyValue} [--set {propertyName}:{propertyValue}] ...
To delete an existing Delegated Admin Correlated REST Resource:
dsconfig delete-delegated-admin-correlated-rest-resource --resource-name {name} --type-name {name}