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.
Policy Configuration Keys can be used to store arbitrary policy keys in the configuration that will store its corresponding value in obscured form. Policy Configuration Keys are decrypted to plaintext when viewing in user interfaces. This may be particularly useful when creating policies that may need to store credentials used to access external systems or other sensitive information.
Name represents as the key property that must be unique from other Policy Configuration Keys. Value represents as the stored encrypted value. Value doesn't not have to be unique and is encrypted when stored.
↓Relations to This Component
↓Properties
↓dsconfig Usage
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ policy-configuration-value |
| Description | A description for this Policy Configuration Key |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Policy Configuration value |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | The Directory Server must be restarted for changes to this setting to take effect. Changes to this property will not take effect immediately until the server is restarted. |
To list the configured Policy Configuration Keys:
dsconfig list-policy-configuration-keys
[--property {propertyName}] ...
To view the configuration for an existing Policy Configuration Key:
dsconfig get-policy-configuration-key-prop
--key-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Policy Configuration Key:
dsconfig set-policy-configuration-key-prop
--key-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Policy Configuration Key:
dsconfig create-policy-configuration-key
--key-name {name}
--set policy-configuration-value:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Policy Configuration Key:
dsconfig delete-policy-configuration-key
--key-name {name}