Access Log Field Mapping
Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact UnboundID support in order to understand the potential impact of that change.
The Access Log Field Mapping provides a mapping to column names in a table used to store access log elements.
↓Parent Component
↓Relations to This Component
↓Properties
↓dsconfig Usage
Parent Component
The Access Log Field Mapping component inherits from the Log Field Mapping
Properties
The properties supported by this managed object are as follows:
Basic Properties
description
Description
| A description for this Log Field Mapping
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-timestamp
Description
| The time that the operation was processed.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-connection-id
Description
| The connection ID assigned to the client connection.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-startupid
Description
| The startup ID for the Metrics Engine. A different value will be generated each time the server is started, and it may be used to distinguish between operations with the same connection ID and operation ID across server restarts.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-product-name
Description
| The name for this Metrics Engine product, which may be used to identify which product was used to log the message if multiple products log to the same database table.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-instance-name
Description
| A name that uniquely identifies this Metrics Engine instance, which may be used to identify which instance was used to log the message if multiple server instances log to the same database table.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-operation-id
Description
| The operation ID for the operation processed by the server.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-message-type
Description
| The type of log message. Message types may include "CONNECT", "DISCONNECT", "FORWARD", "RESULT", "ENTRY", or "REFERENCE".
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-operation-type
Description
| The type of operation that was processed.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-message-id
Description
| The message ID included in the client request.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-result-code
Description
| The numeric result code for the operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-message
Description
| The diagnostic message for the operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-origin
Description
| The origin for the operation. Values may include "replication" (if the operation was received via replication), "internal" (if it was an internal operation processed by a server component), or "external" (if it was a request from a client).
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-requester-dn
Description
| The DN of the user that requested the operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-disconnect-reason
Description
| The reason that the client connection was closed.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-delete-old-rdn
Description
| Indicates whether the old RDN values should be removed from an entry while processing a modify DN operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-authenticated-user-dn
Description
| The DN of the user that authenticated to the server.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-processing-time
Description
| The length of time (in milliseconds with microsecond accuracy) required to process the operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-requested-attributes
Description
| The set of requested attributes for the search operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-sasl-mechanism-name
Description
| The name of the SASL mechanism used to authenticate.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-new-rdn
Description
| The new RDN to use for a modify DN operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-base-dn
Description
| The base DN for a search operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-bind-dn
Description
| The bind DN for a bind operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-matched-dn
Description
| The DN of the superior entry closest to the DN specified by the client.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-requester-ip-address
Description
| The IP address of the client that requested the operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-authentication-type
Description
| The type of authentication requested by the client.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-new-superior-dn
Description
| The new superior DN from a modify DN operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-filter
Description
| The filter from a search operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-alternate-authorization-dn
Description
| The DN of the alternate authorization identity used when processing the operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-entry-dn
Description
| The DN of the entry targeted by the operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-entries-returned
Description
| The number of search result entries returned to the client.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-authentication-failure-id
Description
| The numeric identifier for the authentication failure reason.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-request-oid
Description
| The OID of an extended request.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-response-oid
Description
| The OID of an extended response.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-target-protocol
Description
| The protocol used when forwarding the request to a backend server.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-target-port
Description
| The network port of the Metrics Engine to which the client connection has been established, or of the backend server to which the request has been forwarded.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-target-address
Description
| The network address of the Metrics Engine to which the client connection has been established.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-target-attribute
Description
| The name of the attribute targeted by a compare operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-target-host
Description
| The address of the server to which the request has been forwarded.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-protocol-version
Description
| The protocol version used by the client when communicating with the Metrics Engine.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-protocol-name
Description
| The name of the protocol the client is using to communicate with the Metrics Engine.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-authentication-failure-reason
Description
| A message explaining the reason that the authentication attempt failed.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-additional-information
Description
| Additional information about the operation that was processed which was not returned to the client.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-unindexed
Description
| Indicates whether the requested search operation was unindexed.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-scope
Description
| The scope for the search operation.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-referral-urls
Description
| The referral URLs returned to the client.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-source-address
Description
| The address of the client from which the connection was established.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-message-id-to-abandon
Description
| The message ID of the operation to be abandoned.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-response-controls
Description
| The OIDs of the response controls returned to the client.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-request-controls
Description
| The OIDs of the request controls returned to the client.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-intermediate-client-result
Description
| The contents of the intermediate client response control returned to the client.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-intermediate-client-request
Description
| The contents of the intermediate client request control provided by the client.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
log-field-replication-change-id
Description
| The replication change ID.
|
Default Value
| None
|
Allowed Values
| A string
|
Multi-Valued
| No
|
Required
| No
|
Admin Action Required
| None. Modification requires no further action
|
dsconfig Usage
To list the configured Log Field Mappings:
dsconfig list-log-field-mappings
[--property {propertyName}] ...
To view the configuration for an existing Log Field Mapping:
dsconfig get-log-field-mapping-prop
--mapping-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Log Field Mapping:
dsconfig set-log-field-mapping-prop
--mapping-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Access Log Field Mapping:
dsconfig create-log-field-mapping
--mapping-name {name}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Log Field Mapping:
dsconfig delete-log-field-mapping
--mapping-name {name}