LogMgmtControl extended operation

Edit online

The LogMgmtControl extended operation explains its use with the server and provides the results.

Description
The LogMgmtControl extended operation is used to start, stop, and query the status of the log management for a directory server instance and proxy server instance that are running on a system.
Request
OID
1.3.18.0.2.12.70
Syntax
    requestValue ::= SEQUENCE {
            action              ActionValue,
            commandLineOptions  LDAPString OPTIONAL
    }
     ActionValue ::= ENUMERATED {
       start    (1),
       stop     (2),
       status   (3)
     }
Response
Syntax
   ResponseValue ::= SEQUENCE {
       resultCode       ENUMERATED {
            success                    (0),
            insufficientAccessRights   (1),
            operationsError            (2),
            logmgmtRunningStatus       (3),
            logmgmtStoppedStatus       (4)
		   }
  }
The possible return codes for the LDAP result value and the enabling conditions are as follows:
Table 1. Possible return codes
LDAP Result Value Conditions
Success (0) Issued command to idslogmgmt successfully.
Insufficient Access Rights (1) User is not the server administrator or an administrative group member.
Operations Error (2) Bad action value or any other error.
Log Management Running Status (3) The log management for the directory server instance is running.
Log Management Stopped Status (4) The log management for the directory server instance is stopped.
Behavior
The LogMgmtControl extended operation can be used to start or stop the log management for a directory server instance and proxy server instance. This extended operation also provides the status of the log management that indicates whether it is running or not.
The following have the authority to call this extended operation:
  • Primary Directory Administrator
  • Local Administration Group members with AuditAdmin and ServerConfigGroupMember roles

This extended operation is supported by Administration Server and has the same behavior as in a directory server.

Scope
Only the current server session is affected by this operation.