---
title: Monitor Backend
description: The Monitor Backend allows clients to access the information made available by directory server monitor providers.
component: pingds
version: 8.1
page_id: pingds:configref:objects-monitor-backend
canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-monitor-backend.html
section_ids:
  parent: Parent
  monitor_backend_properties: Monitor Backend properties
  basic_properties: Basic properties
  backend-id: backend-id
  enabled: enabled
  writability-mode: writability-mode
  advanced_properties: Advanced properties
  java-class: java-class
---

# Monitor Backend

The Monitor Backend allows clients to access the information made available by directory server monitor providers.

## Parent

The Monitor Backend object inherits from [Local Backend](objects-local-backend.html).

## Monitor Backend properties

You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html).

| Basic Properties                                                                    | Advanced Properties       |
| ----------------------------------------------------------------------------------- | ------------------------- |
| [backend-id](#backend-id) [enabled](#enabled) [writability-mode](#writability-mode) | [java-class](#java-class) |

### Basic properties

Use the `--advanced` option to access advanced properties.

### backend-id

|                         |                                                                                                                                                                                                      |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Synopsis*              | Specifies a name to identify the associated backend.                                                                                                                                                 |
| *Description*           | The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server.                                                              |
| *Default value*         | None                                                                                                                                                                                                 |
| *Allowed values*        | A string.                                                                                                                                                                                            |
| *Multi-valued*          | No                                                                                                                                                                                                   |
| *Required*              | Yes                                                                                                                                                                                                  |
| *Admin action required* | NoneNo base entry has been created as part of this process. A base entry needs to be created before adding further entries to the backend. Please refer to the documentation to create a base entry. |
| *Advanced*              | No                                                                                                                                                                                                   |
| *Read-only*             | Yes                                                                                                                                                                                                  |

### enabled

|                         |                                                                                               |
| ----------------------- | --------------------------------------------------------------------------------------------- |
| *Synopsis*              | Indicates whether the backend is enabled in the server.                                       |
| *Description*           | If a backend is not enabled, then its contents are not accessible when processing operations. |
| *Default value*         | None                                                                                          |
| *Allowed values*        | truefalse                                                                                     |
| *Multi-valued*          | No                                                                                            |
| *Required*              | Yes                                                                                           |
| *Admin action required* | None                                                                                          |
| *Advanced*              | No                                                                                            |
| *Read-only*             | No                                                                                            |

### writability-mode

|                         |                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Synopsis*              | Specifies the behavior that the backend should use when processing write operations.                                                                                                                                                                                                                                                                                                                                                        |
| *Default value*         | disabled                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| *Allowed values*        | * disabled: Causes all write attempts to fail.

* enabled: Allows write operations to be performed in that backend (if the requested operation is valid, the user has permission to perform the operation, the backend supports that type of write operation, and the global writability-mode property is also enabled).

* internal-only: Causes external write attempts to fail but allows writes by replication and internal operations. |
| *Multi-valued*          | No                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| *Required*              | Yes                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| *Admin action required* | None                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| *Advanced*              | No                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| *Read-only*             | No                                                                                                                                                                                                                                                                                                                                                                                                                                          |

## Advanced properties

Use the `--advanced` option to access advanced properties.

### java-class

|                         |                                                                                                |
| ----------------------- | ---------------------------------------------------------------------------------------------- |
| *Synopsis*              | Specifies the fully-qualified name of the Java class that provides the backend implementation. |
| *Default value*         | org.opends.server.backends.MonitorBackend                                                      |
| *Allowed values*        | A Java class that extends or implements:- org.opends.server.api.Backend                        |
| *Multi-valued*          | No                                                                                             |
| *Required*              | Yes                                                                                            |
| *Admin action required* | The object must be disabled and re-enabled for changes to take effect.                         |
| *Advanced*              | Yes                                                                                            |
| *Read-only*             | No                                                                                             |