Jump to

• Request
• Response

Add, Search, Compare or Delete High Etime File Based Access Log Publisher

post

/rest/v1/admin

Add, Search, Compare or Delete High Etime File Based Access Log Publisher

Request

Supported Media Types

• application/json

Body ()

High Etime File Based Access Log Publisher that needs to be created

Root Schema : High Etime File Based Access Log Publisher POSTRequest

Type: object

Show Source

• assertion(optional): string
  Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.
• attributes(optional): object High Etime File Based Access Log Publisher Properties
• base(optional): string
  Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation
• controls(optional): array controls
  LDAP controls to be sent to server for the LDAP operation.
• dn(optional): string
  LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.
• filter(optional): string
  Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
• msgType: string
  Allowed Values: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]

  The REST message type
• requiredAttributes(optional): array requiredAttributes
  List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
• scope(optional): string
  Allowed Values: [ "base", "sub", "one" ]

  Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.

{
    "type":"object",
    "required":[
        "msgType"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest"
            ]
        },
        "dn":{
            "description":"LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/High Etime File Based Access Log Publisher Properties"
        },
        "base":{
            "description":"Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation",
            "type":"string"
        },
        "scope":{
            "description":"Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string",
            "enum":[
                "base",
                "sub",
                "one"
            ]
        },
        "filter":{
            "description":"Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string"
        },
        "requiredAttributes":{
            "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for the LDAP operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assertion":{
            "description":"Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.",
            "type":"string"
        }
    }
}

Nested Schema : High Etime File Based Access Log Publisher Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-append(optional): boolean
  Default Value: true

  Specifies whether to append to existing log files.
• ds-cfg-asynchronous: boolean
  Default Value: true

  Indicates whether the File Based Access Log Publisher will publish records asynchronously.
• ds-cfg-auto-flush(optional): boolean
  Default Value: true

  Specifies whether to flush the writer after every log record.
• ds-cfg-buffer-size(optional): string
  Default Value: 64kb

  Specifies the log file buffer size.
• ds-cfg-enabled: boolean
  Indicates whether the Log Publisher is enabled for use.
• ds-cfg-java-class: string
  Default Value: org.opends.server.loggers.HighEtimeAccessLogPublisher

  The fully-qualified name of the Java class that provides the High Etime File Based Access Log Publisher implementation.
• ds-cfg-log-controls(optional): boolean
  Default Value: false

  Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications.
• ds-cfg-log-file: string
  The file name to use for the log files generated by the File Based Access Log Publisher. The path to the file is relative to the server root.
• ds-cfg-log-file-permissions: string
  Default Value: 640

  The UNIX permissions of the log files created by this File Based Access Log Publisher.
• ds-cfg-log-file-use-local-time(optional): boolean
  Default Value: false

  Specifies whether to use local time or GMT for the name of the rotated files.
• ds-cfg-log-high-etime-limit: string
  Default Value: 10 milliseconds

  Specifies the high etime limit in milliseconds. etime equal to or above this value will be logged by High etime Access Log Publisher.
• ds-cfg-log-qtime(optional): boolean
  Default Value: false

  Logs the time spent in preprocessing queue for an operation.
• ds-cfg-operations-to-log(optional): array ds-cfg-operations-to-log
  Indicates which operations has to be logged.
• ds-cfg-queue-size(optional): integer(int32)
  Default Value: 5000

  The maximum number of log records that can be stored in the asynchronous queue.
• ds-cfg-retention-policy(optional): array ds-cfg-retention-policy
  The retention policy to use for the File Based Access Log Publisher .
• ds-cfg-rotation-policy(optional): array ds-cfg-rotation-policy
  The rotation policy to use for the File Based Access Log Publisher .
• ds-cfg-time-interval(optional): string
  Default Value: 5s

  Specifies the interval at which to check whether the log files need to be rotated.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-log-high-etime-limit",
        "ds-cfg-enabled",
        "ds-cfg-asynchronous",
        "ds-cfg-log-file",
        "ds-cfg-log-file-permissions"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"The fully-qualified name of the Java class that provides the High Etime File Based Access Log Publisher implementation. ",
            "readOnly":false,
            "default":"org.opends.server.loggers.HighEtimeAccessLogPublisher",
            "type":"string"
        },
        "ds-cfg-log-file-use-local-time":{
            "description":"Specifies whether to use local time or GMT for the name of the rotated files. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-log-high-etime-limit":{
            "description":"Specifies the high etime limit in milliseconds. etime equal to or above this value will be logged by High etime Access Log Publisher. ",
            "readOnly":false,
            "default":"10 milliseconds",
            "type":"string"
        },
        "ds-cfg-rotation-policy":{
            "description":"The rotation policy to use for the File Based Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-buffer-size":{
            "description":"Specifies the log file buffer size. ",
            "readOnly":false,
            "default":"64kb",
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Log Publisher is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-log-qtime":{
            "description":"Logs the time spent in preprocessing queue for an operation. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-operations-to-log":{
            "description":"Indicates which operations has to be logged. ",
            "readOnly":false,
            "default":[
                "administration",
                "user",
                "adminbrowsing",
                "synchronization"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "adminbrowsing",
                "administration",
                "all",
                "internal",
                "synchronization",
                "user"
            ]
        },
        "ds-cfg-asynchronous":{
            "description":"Indicates whether the File Based Access Log Publisher will publish records asynchronously. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-auto-flush":{
            "description":"Specifies whether to flush the writer after every log record. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-queue-size":{
            "description":"The maximum number of log records that can be stored in the asynchronous queue. ",
            "readOnly":false,
            "default":5000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-time-interval":{
            "description":"Specifies the interval at which to check whether the log files need to be rotated. ",
            "readOnly":false,
            "default":"5s",
            "type":"string"
        },
        "ds-cfg-log-file":{
            "description":"The file name to use for the log files generated by the File Based Access Log Publisher. The path to the file is relative to the server root. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-log-controls":{
            "description":"Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-log-file-permissions":{
            "description":"The UNIX permissions of the log files created by this File Based Access Log Publisher. ",
            "readOnly":false,
            "default":"640",
            "type":"string"
        },
        "ds-cfg-append":{
            "description":"Specifies whether to append to existing log files. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-retention-policy":{
            "description":"The retention policy to use for the File Based Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : controls

Type: array

LDAP controls to be sent to server for the LDAP operation.

Show Source

• [0]: string

{
    "description":"LDAP controls to be sent to server for the LDAP operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : requiredAttributes

Type: array

List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.

Show Source

• [0]: string

{
    "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-operations-to-log

Type: array

Indicates which operations has to be logged.

Default Value: [ "administration", "user", "adminbrowsing", "synchronization" ]

Allowed Values: [ "adminbrowsing", "administration", "all", "internal", "synchronization", "user" ]

Show Source

• [0]: string

{
    "description":"Indicates which operations has to be logged. ",
    "readOnly":false,
    "default":[
        "administration",
        "user",
        "adminbrowsing",
        "synchronization"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "adminbrowsing",
        "administration",
        "all",
        "internal",
        "synchronization",
        "user"
    ]
}

Nested Schema : ds-cfg-retention-policy

Type: array

The retention policy to use for the File Based Access Log Publisher .

Show Source

• [0]: string

{
    "description":"The retention policy to use for the File Based Access Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-rotation-policy

Type: array

The rotation policy to use for the File Based Access Log Publisher .

Show Source

• [0]: string

{
    "description":"The rotation policy to use for the File Based Access Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• [0]: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : High Etime File Based Access Log Publisher SuccessResponse

Type: object

Show Source

• compareResult(optional): boolean
  Indicates the result of LDAP compare operation.
• msgType: string
  Allowed Values: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]

  The REST message type
• searchResultEntries: array searchResultEntries
  Number of search result entries returned after the LDAP operation.
• totalResults: integer(int32)
  Specifies the number of entries created, and returned.

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse"
            ]
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/High Etime File Based Access Log Publisher SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• [0]: object High Etime File Based Access Log Publisher SearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/High Etime File Based Access Log Publisher SearchResultEntry"
    }
}

Nested Schema : High Etime File Based Access Log Publisher SearchResultEntry

Type: object

Show Source

• attributes: object High Etime File Based Access Log Publisher Properties
• dn: string
  LDAP DN of the entry to be created

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/High Etime File Based Access Log Publisher Properties"
        }
    }
}

Nested Schema : High Etime File Based Access Log Publisher Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-append(optional): boolean
  Default Value: true

  Specifies whether to append to existing log files.
• ds-cfg-asynchronous: boolean
  Default Value: true

  Indicates whether the File Based Access Log Publisher will publish records asynchronously.
• ds-cfg-auto-flush(optional): boolean
  Default Value: true

  Specifies whether to flush the writer after every log record.
• ds-cfg-buffer-size(optional): string
  Default Value: 64kb

  Specifies the log file buffer size.
• ds-cfg-enabled: boolean
  Indicates whether the Log Publisher is enabled for use.
• ds-cfg-java-class: string
  Default Value: org.opends.server.loggers.HighEtimeAccessLogPublisher

  The fully-qualified name of the Java class that provides the High Etime File Based Access Log Publisher implementation.
• ds-cfg-log-controls(optional): boolean
  Default Value: false

  Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications.
• ds-cfg-log-file: string
  The file name to use for the log files generated by the File Based Access Log Publisher. The path to the file is relative to the server root.
• ds-cfg-log-file-permissions: string
  Default Value: 640

  The UNIX permissions of the log files created by this File Based Access Log Publisher.
• ds-cfg-log-file-use-local-time(optional): boolean
  Default Value: false

  Specifies whether to use local time or GMT for the name of the rotated files.
• ds-cfg-log-high-etime-limit: string
  Default Value: 10 milliseconds

  Specifies the high etime limit in milliseconds. etime equal to or above this value will be logged by High etime Access Log Publisher.
• ds-cfg-log-qtime(optional): boolean
  Default Value: false

  Logs the time spent in preprocessing queue for an operation.
• ds-cfg-operations-to-log(optional): array ds-cfg-operations-to-log
  Indicates which operations has to be logged.
• ds-cfg-queue-size(optional): integer(int32)
  Default Value: 5000

  The maximum number of log records that can be stored in the asynchronous queue.
• ds-cfg-retention-policy(optional): array ds-cfg-retention-policy
  The retention policy to use for the File Based Access Log Publisher .
• ds-cfg-rotation-policy(optional): array ds-cfg-rotation-policy
  The rotation policy to use for the File Based Access Log Publisher .
• ds-cfg-time-interval(optional): string
  Default Value: 5s

  Specifies the interval at which to check whether the log files need to be rotated.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-log-high-etime-limit",
        "ds-cfg-enabled",
        "ds-cfg-asynchronous",
        "ds-cfg-log-file",
        "ds-cfg-log-file-permissions"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"The fully-qualified name of the Java class that provides the High Etime File Based Access Log Publisher implementation. ",
            "readOnly":false,
            "default":"org.opends.server.loggers.HighEtimeAccessLogPublisher",
            "type":"string"
        },
        "ds-cfg-log-file-use-local-time":{
            "description":"Specifies whether to use local time or GMT for the name of the rotated files. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-log-high-etime-limit":{
            "description":"Specifies the high etime limit in milliseconds. etime equal to or above this value will be logged by High etime Access Log Publisher. ",
            "readOnly":false,
            "default":"10 milliseconds",
            "type":"string"
        },
        "ds-cfg-rotation-policy":{
            "description":"The rotation policy to use for the File Based Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-buffer-size":{
            "description":"Specifies the log file buffer size. ",
            "readOnly":false,
            "default":"64kb",
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Log Publisher is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-log-qtime":{
            "description":"Logs the time spent in preprocessing queue for an operation. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-operations-to-log":{
            "description":"Indicates which operations has to be logged. ",
            "readOnly":false,
            "default":[
                "administration",
                "user",
                "adminbrowsing",
                "synchronization"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "adminbrowsing",
                "administration",
                "all",
                "internal",
                "synchronization",
                "user"
            ]
        },
        "ds-cfg-asynchronous":{
            "description":"Indicates whether the File Based Access Log Publisher will publish records asynchronously. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-auto-flush":{
            "description":"Specifies whether to flush the writer after every log record. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-queue-size":{
            "description":"The maximum number of log records that can be stored in the asynchronous queue. ",
            "readOnly":false,
            "default":5000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-time-interval":{
            "description":"Specifies the interval at which to check whether the log files need to be rotated. ",
            "readOnly":false,
            "default":"5s",
            "type":"string"
        },
        "ds-cfg-log-file":{
            "description":"The file name to use for the log files generated by the File Based Access Log Publisher. The path to the file is relative to the server root. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-log-controls":{
            "description":"Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-log-file-permissions":{
            "description":"The UNIX permissions of the log files created by this File Based Access Log Publisher. ",
            "readOnly":false,
            "default":"640",
            "type":"string"
        },
        "ds-cfg-append":{
            "description":"Specifies whether to append to existing log files. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-retention-policy":{
            "description":"The retention policy to use for the File Based Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-operations-to-log

Type: array

Indicates which operations has to be logged.

Default Value: [ "administration", "user", "adminbrowsing", "synchronization" ]

Allowed Values: [ "adminbrowsing", "administration", "all", "internal", "synchronization", "user" ]

Show Source

• [0]: string

{
    "description":"Indicates which operations has to be logged. ",
    "readOnly":false,
    "default":[
        "administration",
        "user",
        "adminbrowsing",
        "synchronization"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "adminbrowsing",
        "administration",
        "all",
        "internal",
        "synchronization",
        "user"
    ]
}

Nested Schema : ds-cfg-retention-policy

Type: array

The retention policy to use for the File Based Access Log Publisher .

Show Source

• [0]: string

{
    "description":"The retention policy to use for the File Based Access Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-rotation-policy

Type: array

The rotation policy to use for the File Based Access Log Publisher .

Show Source

• [0]: string

{
    "description":"The rotation policy to use for the File Based Access Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• [0]: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

201 Response

Created

Body ()

Root Schema : High Etime File Based Access Log Publisher ADDResponse

Type: object

Show Source

• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse

  The REST message type
• searchResultEntries: array searchResultEntries
• totalResults: integer(int32)
  Specifies the number of entries created, and returned.

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/High Etime File Based Access Log Publisher SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Show Source

• [0]: object High Etime File Based Access Log Publisher SearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/High Etime File Based Access Log Publisher SearchResultEntry"
    }
}

Nested Schema : High Etime File Based Access Log Publisher SearchResultEntry

Type: object

Show Source

• attributes: object High Etime File Based Access Log Publisher Properties
• dn: string
  LDAP DN of the entry to be created

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/High Etime File Based Access Log Publisher Properties"
        }
    }
}

Nested Schema : High Etime File Based Access Log Publisher Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-append(optional): boolean
  Default Value: true

  Specifies whether to append to existing log files.
• ds-cfg-asynchronous: boolean
  Default Value: true

  Indicates whether the File Based Access Log Publisher will publish records asynchronously.
• ds-cfg-auto-flush(optional): boolean
  Default Value: true

  Specifies whether to flush the writer after every log record.
• ds-cfg-buffer-size(optional): string
  Default Value: 64kb

  Specifies the log file buffer size.
• ds-cfg-enabled: boolean
  Indicates whether the Log Publisher is enabled for use.
• ds-cfg-java-class: string
  Default Value: org.opends.server.loggers.HighEtimeAccessLogPublisher

  The fully-qualified name of the Java class that provides the High Etime File Based Access Log Publisher implementation.
• ds-cfg-log-controls(optional): boolean
  Default Value: false

  Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications.
• ds-cfg-log-file: string
  The file name to use for the log files generated by the File Based Access Log Publisher. The path to the file is relative to the server root.
• ds-cfg-log-file-permissions: string
  Default Value: 640

  The UNIX permissions of the log files created by this File Based Access Log Publisher.
• ds-cfg-log-file-use-local-time(optional): boolean
  Default Value: false

  Specifies whether to use local time or GMT for the name of the rotated files.
• ds-cfg-log-high-etime-limit: string
  Default Value: 10 milliseconds

  Specifies the high etime limit in milliseconds. etime equal to or above this value will be logged by High etime Access Log Publisher.
• ds-cfg-log-qtime(optional): boolean
  Default Value: false

  Logs the time spent in preprocessing queue for an operation.
• ds-cfg-operations-to-log(optional): array ds-cfg-operations-to-log
  Indicates which operations has to be logged.
• ds-cfg-queue-size(optional): integer(int32)
  Default Value: 5000

  The maximum number of log records that can be stored in the asynchronous queue.
• ds-cfg-retention-policy(optional): array ds-cfg-retention-policy
  The retention policy to use for the File Based Access Log Publisher .
• ds-cfg-rotation-policy(optional): array ds-cfg-rotation-policy
  The rotation policy to use for the File Based Access Log Publisher .
• ds-cfg-time-interval(optional): string
  Default Value: 5s

  Specifies the interval at which to check whether the log files need to be rotated.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-log-high-etime-limit",
        "ds-cfg-enabled",
        "ds-cfg-asynchronous",
        "ds-cfg-log-file",
        "ds-cfg-log-file-permissions"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"The fully-qualified name of the Java class that provides the High Etime File Based Access Log Publisher implementation. ",
            "readOnly":false,
            "default":"org.opends.server.loggers.HighEtimeAccessLogPublisher",
            "type":"string"
        },
        "ds-cfg-log-file-use-local-time":{
            "description":"Specifies whether to use local time or GMT for the name of the rotated files. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-log-high-etime-limit":{
            "description":"Specifies the high etime limit in milliseconds. etime equal to or above this value will be logged by High etime Access Log Publisher. ",
            "readOnly":false,
            "default":"10 milliseconds",
            "type":"string"
        },
        "ds-cfg-rotation-policy":{
            "description":"The rotation policy to use for the File Based Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-buffer-size":{
            "description":"Specifies the log file buffer size. ",
            "readOnly":false,
            "default":"64kb",
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Log Publisher is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-log-qtime":{
            "description":"Logs the time spent in preprocessing queue for an operation. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-operations-to-log":{
            "description":"Indicates which operations has to be logged. ",
            "readOnly":false,
            "default":[
                "administration",
                "user",
                "adminbrowsing",
                "synchronization"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "adminbrowsing",
                "administration",
                "all",
                "internal",
                "synchronization",
                "user"
            ]
        },
        "ds-cfg-asynchronous":{
            "description":"Indicates whether the File Based Access Log Publisher will publish records asynchronously. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-auto-flush":{
            "description":"Specifies whether to flush the writer after every log record. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-queue-size":{
            "description":"The maximum number of log records that can be stored in the asynchronous queue. ",
            "readOnly":false,
            "default":5000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-time-interval":{
            "description":"Specifies the interval at which to check whether the log files need to be rotated. ",
            "readOnly":false,
            "default":"5s",
            "type":"string"
        },
        "ds-cfg-log-file":{
            "description":"The file name to use for the log files generated by the File Based Access Log Publisher. The path to the file is relative to the server root. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-log-controls":{
            "description":"Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-log-file-permissions":{
            "description":"The UNIX permissions of the log files created by this File Based Access Log Publisher. ",
            "readOnly":false,
            "default":"640",
            "type":"string"
        },
        "ds-cfg-append":{
            "description":"Specifies whether to append to existing log files. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-retention-policy":{
            "description":"The retention policy to use for the File Based Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-operations-to-log

Type: array

Indicates which operations has to be logged.

Default Value: [ "administration", "user", "adminbrowsing", "synchronization" ]

Allowed Values: [ "adminbrowsing", "administration", "all", "internal", "synchronization", "user" ]

Show Source

• [0]: string

{
    "description":"Indicates which operations has to be logged. ",
    "readOnly":false,
    "default":[
        "administration",
        "user",
        "adminbrowsing",
        "synchronization"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "adminbrowsing",
        "administration",
        "all",
        "internal",
        "synchronization",
        "user"
    ]
}

Nested Schema : ds-cfg-retention-policy

Type: array

The retention policy to use for the File Based Access Log Publisher .

Show Source

• [0]: string

{
    "description":"The retention policy to use for the File Based Access Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-rotation-policy

Type: array

The rotation policy to use for the File Based Access Log Publisher .

Show Source

• [0]: string

{
    "description":"The rotation policy to use for the File Based Access Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• [0]: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

204 Response

No content

406 Response

Not Acceptable

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• ldapErrorCode(optional): integer(int32)
  Specifies the LDAP error code returned for the operation.
• message: string
  Error message returned returned for the operation.
• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  The REST message type

{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}

Back to Top