Server administration control

Edit online

The Server administration control explains its use with the server and provides the results.

Description
Allows an update operation by the administrator under conditions when the operation is normally refused. For example, the server is quiesced, the server is a read-only replica, and others).

This control can be specified on an update operation (add, modify, modRdn, modDn, delete) by a client that is bound as an administrator. This control can also be specified on a bind-related operation. On a bind operation, this control specifies that it is an administrative connection and the connection must not be dropped when the idle connections are cleaned. This control is only recognized if a client is bound as a primary directory administrator, global admin group member, or member of the administrative group with any role other than the “NoAdmin” role. When present, a server that would normally refuse updates (quiesced server, forwarder, or replica), allows the update. The updates are replicated like other updates.

Note: This control requires to be used with user discretion. With the control, entry updates are allowed under unusual circumstances. Therefore, it is the responsibility of the user to ensure the server that is updated ends up in a state consistent with the other servers. For example, the timestamp of an entry which is used as the base for replication conflict resolution in IBM® Verify Directory, version 6.0 and later. The timestamp might be different on different servers if the entry gets updated individually on those servers with this control.
OID
1.3.18.0.2.10.15
Syntax
This control has no value.
Behavior
This control is registered for the following operations:
  • Add
  • Delete
  • Modify
  • Modrdn
  • Moddn
  • Bind
  • Unbind
  • Search
Administrator Server supports the following extended operations:
  • Attribute type
  • DN normalization
  • Dynamic update requests
  • Get lines
  • Get number of lines
  • LDAP trace facility
  • LogMgmtControl
  • ServerBackupRestore
  • Start, stop server
  • Start TLS
  • User type
Administrator Server supports the following controls:
  • Audit
  • Password policy request
  • Server administration
The following persons are enabled to send the control:
  • Primary Directory Administrator
  • Local Administration Group Member
  • Global Administration Group Member
Note: If the control is sent by a user who does not have access, LDAP_INSUFFICIENT_ACCESS is returned.
Scope
The control lasts for one operation. When the control is received, a server knows that a gateway server is bound as a supplier. Depending on the supplier information, the server can decide to which consumers an entry is to be replicated.