PingDirectory API Reference

Assured replication response control

This control may be used to convey the results of processing for an assured replication request control. The control has an OID of 1.3.6.1.4.1.30221.2.5.29, and it takes a value. The following fields may be present in the value-json representation of the value:

  • local-level: An optional string field that specifies the local assurance level used for the operation. If present, its value will be one of "none", "received-any-server", or "processed-all-servers".

  • local-assurance-satisfied: A Boolean field that indicates whether the local assurance requirement was satisfied for the operation.

  • local-assurance-message: An optional string field that provides additional information about the local assurance processing for the operation.

  • remote-level: An optional string field that specifies the remote assurance level used for the operation. If present, its value will be one of "none", "received-any-remote-location", "received-all-remote-locations", or "processed-all-remote-servers".

  • remote-assurance-satisfied: A Boolean field that indicates whether the remote assurance requirement was satisfied for the operation.

  • remote-assurance-message: An optional string field that provides additional information about the remote assurance processing for the operation.

  • csn: An optional string field that provides the change sequence number (CSN) that the server assigned for the operation.

  • server-results: An optional array of JSON objects that provides individual results from the local and/or remote servers used in replication assurance processing. These JSON objects may include the following fields:

    • result-code-value: An integer field that specifies the numeric value for the result code for server assurance processing.

    • result-code-name: An optional string field whose value is the name of the result code for server assurance processing.

    • replication-server-id: An optional integer field that specifies the server ID for the associated replication server.

    • replica-id: An optional integer field that specifies the replica ID for the associated replica.

At present, the defined set of result codes that may be used in assured replication server results are:

  • complete (0): Indicates that the replicated operation completed successfully.

  • timeout (1): Indicates that the replicated operation did not complete within the associated timeout period.

  • conflict (2): Indicates that assurance was not satisfied because a conflict was detected.

  • server-shutdown (3): Indicates that assurance was not satisfied because the server was shutting down.

  • unavailable (4): Indicates that assurance was not satisfied because the server was not available.

  • duplicate (5): Indicates that the server determined that the operation was a duplicate of another operation.

The following represents an example JSON encoding for the control:

{ "oid":"1.3.6.1.4.1.30221.2.5.29",
  "control-name":"Assured Replication Response Control",
  "criticality":false,
  "value-json":{ "local-level":"received-any-server",
                 "local-assurance-satisfied":true,
                 "remote-level":"received-any-remote-location",
                 "remote-assurance-satisfied":true,
                 "csn":"1234567890ABCDEF1234567890AB",
                 "server-results":[ { "result-code-value":0,
                                      "result-code-name":"complete",
                                      "replication-server-id":1234 },
                                    { "result-code-value":0,
                                      "result-code-name":"complete",
                                      "replication-server-id":5678 }
                                     ]
                    }
    }