Proxy back-end server resume role extended operation

Edit online

The proxy back-end server resume role extended operation explains its use with the server and provides the results.

Description
This extended operation enables a proxy server to resume the configured role of a back-end server in a distributed directory environment.
Request
OID
1.3.18.0.2.12.65
Syntax
requestValue ::= SEQUENCE {
		action					ENUMERATED {
	                         All (0), 
                         Partition (1), 
                         Server (2), 
                         ServerInAPartition (3)
									};
		PartitionName       DirectoryString;
		ServerURL           DirectoryString;
}
Response
OID
1.3.18.0.2.12.65
Syntax
responseValue ::= SEQUENCE {
		numObjectsImpacted      INTEGER 
}
Behavior
This extended operation tells a proxy server to bring a back-end server back to its configured role. The proxy server resumes only a back-end server role if the back-end server is online and accepting connections from the proxy server. The extended operation uses the 5 second reconnect interval or the health check thread to connect with the back-end server.
The following are authorized to call this extended operation:
  • Primary Directory Administrator
  • Local Administration Group members with DirDataAdmin role
  • Global Administration Group members
Note: If this extended operation is called by a user who does not have access, LDAP_INSUFFICIENT_ACCESS is returned.
This extended operation has the following possible return codes:
  • LDAP_SUCCESS - Server matched the request, and no internal errors were encountered.
  • LDAP_PROTOCOL_ERROR - If there is an error in the format of the request.
  • LDAP_INSUFFICIENT_ACCESS - If the request is from a user who does not have the required access.
  • LDAP_OPERATIONS_ERROR
  • LDAP_NO_SUCH_OBJECT - If the requested target does not exist.
  • LDAP_INVALID_SYNTAX - If the format of the URL or partition name is invalid.
This extended operation is not supported by the Administration Server.
Scope
This extended operation affects requests are routed through the proxy server.
Auditing
The additional information added to audit log by the proxy back-end server resume role extended operation are: 
RequestType: Type
where Type is one of the following types:
  • All
  • Partition
  • Server
  • ServerInAPartition
Partition: PartitionName

Server: ServerURL
Note: If PartitionName or ServerURL is not specified in the request, None is audited.