PingDirectory API Reference

Assured replication request control

This control may be included in an add, delete, modify, or modify DN request to indicate that the server should delay the response for that operation until it has satisfied certain replication requirements. The control has an OID of 1.3.6.1.4.1.30221.2.5.28, and it takes a value. The following fields may be present in the value-json representation of the value:

  • minimum-local-level: An optional string field whose value is the name of the minimum assurance level desired for replicas in the same location as the target server. The value may be one of "none", "received-any-server", or "processed-all-servers". If this is not specified, then the server will choose an appropriate minimum local assurance level based on its configuration.

  • maximum-local-level: An optional string field whose value is the name of the maximum assurance level desired for local replicas. If specified (with a value of "none", "received-any-server", or "processed-all-servers"), it may cause the server to use a lower local assurance level than it may have otherwise chosen based on configuration. If this is not specified, then the server will choose an appropriate maximum local assurance level based on its configuration and the minimum local assurance level.

  • minimum-remote-level: An optional string field whose value is the name of the minimum assurance level desired for replicas in a different location from the target server. The value may be one of "none", "received-any-remote-location", "received-all-remote-locations", or "processed-all-remote-servers". If this is not specified, then the server will choose an appropriate minimum remote assurance level based on its configuration.

  • maximum-remote-level: An optional string field whose value is the name of the maximum assurance level desired for remote replicas. If specified (with a value of "none", "received-any-remote-location", "received-all-remote-locations", or "processed-all-remote-servers"), it may cause the server to use a lower remote assurance level than it may have otherwise chosen based on configuration. If this is not specified, then the server will choose an appropriate maximum remote assurance level based on its configuration and the minimum remote assurance level.

  • timeout-millis: An optional integer field whose value specifies the maximum length of time in milliseconds that the server should wait for assurance to be satisfied. If this is not specified, then the server will choose an appropriate timeout.

  • send-response-immediately: A Boolean field that indicates whether the server should return the response to the client immediately after applying the change locally, even if it has not yet been replicated. Sending the response immediately is primarily useful if the client will monitor the replication status for the operation.

The following sample shows the JSON encoding for the control:

{ "oid":"1.3.6.1.4.1.30221.2.5.28",
  "control-name":"Assured Replication Request Control",
  "criticality":false,
  "value-json":{ "minimum-local-level":"received-any-server",
                 "minimum-remote-level":"received-any-remote-location",
                 "timeout-millis":1000
    }
}