Name

dsconfig get-monitor-provider-prop — Shows Monitor Provider properties

Synopsis

dsconfig get-monitor-provider-prop {options}

Description

Shows Monitor Provider properties.

Options

The dsconfig get-monitor-provider-prop command takes the following options:

--provider-name {name}

The name of the Monitor Provider.

Monitor Provider properties depend on the Monitor Provider type, which depends on the {name} you provide.

By default, OpenDJ directory server supports the following Monitor Provider types:

client-connection-monitor-provider

Default {name}: Client Connection Monitor Provider

Enabled by default: true

See the section called “Client Connection Monitor Provider” for the properties of this Monitor Provider type.

entry-cache-monitor-provider

Default {name}: Entry Cache Monitor Provider

Enabled by default: true

See the section called “Entry Cache Monitor Provider” for the properties of this Monitor Provider type.

memory-usage-monitor-provider

Default {name}: Memory Usage Monitor Provider

Enabled by default: true

See the section called “Memory Usage Monitor Provider” for the properties of this Monitor Provider type.

stack-trace-monitor-provider

Default {name}: Stack Trace Monitor Provider

Enabled by default: true

See the section called “Stack Trace Monitor Provider” for the properties of this Monitor Provider type.

system-info-monitor-provider

Default {name}: System Info Monitor Provider

Enabled by default: true

See the section called “System Info Monitor Provider” for the properties of this Monitor Provider type.

version-monitor-provider

Default {name}: Version Monitor Provider

Enabled by default: true

See the section called “Version Monitor Provider” for the properties of this Monitor Provider type.

--property {property}

The name of a property to be displayed.

Monitor Provider properties depend on the Monitor Provider type, which depends on the {property} you provide.

By default, OpenDJ directory server supports the following Monitor Provider types:

client-connection-monitor-provider

Default {property}: Client Connection Monitor Provider

Enabled by default: true

See the section called “Client Connection Monitor Provider” for the properties of this Monitor Provider type.

entry-cache-monitor-provider

Default {property}: Entry Cache Monitor Provider

Enabled by default: true

See the section called “Entry Cache Monitor Provider” for the properties of this Monitor Provider type.

memory-usage-monitor-provider

Default {property}: Memory Usage Monitor Provider

Enabled by default: true

See the section called “Memory Usage Monitor Provider” for the properties of this Monitor Provider type.

stack-trace-monitor-provider

Default {property}: Stack Trace Monitor Provider

Enabled by default: true

See the section called “Stack Trace Monitor Provider” for the properties of this Monitor Provider type.

system-info-monitor-provider

Default {property}: System Info Monitor Provider

Enabled by default: true

See the section called “System Info Monitor Provider” for the properties of this Monitor Provider type.

version-monitor-provider

Default {property}: Version Monitor Provider

Enabled by default: true

See the section called “Version Monitor Provider” for the properties of this Monitor Provider type.

-E | --record

Modifies the display output to show one property value per line.

Monitor Provider properties depend on the Monitor Provider type, which depends on the null you provide.

By default, OpenDJ directory server supports the following Monitor Provider types:

client-connection-monitor-provider

Default null: Client Connection Monitor Provider

Enabled by default: true

See the section called “Client Connection Monitor Provider” for the properties of this Monitor Provider type.

entry-cache-monitor-provider

Default null: Entry Cache Monitor Provider

Enabled by default: true

See the section called “Entry Cache Monitor Provider” for the properties of this Monitor Provider type.

memory-usage-monitor-provider

Default null: Memory Usage Monitor Provider

Enabled by default: true

See the section called “Memory Usage Monitor Provider” for the properties of this Monitor Provider type.

stack-trace-monitor-provider

Default null: Stack Trace Monitor Provider

Enabled by default: true

See the section called “Stack Trace Monitor Provider” for the properties of this Monitor Provider type.

system-info-monitor-provider

Default null: System Info Monitor Provider

Enabled by default: true

See the section called “System Info Monitor Provider” for the properties of this Monitor Provider type.

version-monitor-provider

Default null: Version Monitor Provider

Enabled by default: true

See the section called “Version Monitor Provider” for the properties of this Monitor Provider type.

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).

Monitor Provider properties depend on the Monitor Provider type, which depends on the {unit} you provide.

By default, OpenDJ directory server supports the following Monitor Provider types:

client-connection-monitor-provider

Default {unit}: Client Connection Monitor Provider

Enabled by default: true

See the section called “Client Connection Monitor Provider” for the properties of this Monitor Provider type.

entry-cache-monitor-provider

Default {unit}: Entry Cache Monitor Provider

Enabled by default: true

See the section called “Entry Cache Monitor Provider” for the properties of this Monitor Provider type.

memory-usage-monitor-provider

Default {unit}: Memory Usage Monitor Provider

Enabled by default: true

See the section called “Memory Usage Monitor Provider” for the properties of this Monitor Provider type.

stack-trace-monitor-provider

Default {unit}: Stack Trace Monitor Provider

Enabled by default: true

See the section called “Stack Trace Monitor Provider” for the properties of this Monitor Provider type.

system-info-monitor-provider

Default {unit}: System Info Monitor Provider

Enabled by default: true

See the section called “System Info Monitor Provider” for the properties of this Monitor Provider type.

version-monitor-provider

Default {unit}: Version Monitor Provider

Enabled by default: true

See the section called “Version Monitor Provider” for the properties of this Monitor Provider type.

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).

Monitor Provider properties depend on the Monitor Provider type, which depends on the {unit} you provide.

By default, OpenDJ directory server supports the following Monitor Provider types:

client-connection-monitor-provider

Default {unit}: Client Connection Monitor Provider

Enabled by default: true

See the section called “Client Connection Monitor Provider” for the properties of this Monitor Provider type.

entry-cache-monitor-provider

Default {unit}: Entry Cache Monitor Provider

Enabled by default: true

See the section called “Entry Cache Monitor Provider” for the properties of this Monitor Provider type.

memory-usage-monitor-provider

Default {unit}: Memory Usage Monitor Provider

Enabled by default: true

See the section called “Memory Usage Monitor Provider” for the properties of this Monitor Provider type.

stack-trace-monitor-provider

Default {unit}: Stack Trace Monitor Provider

Enabled by default: true

See the section called “Stack Trace Monitor Provider” for the properties of this Monitor Provider type.

system-info-monitor-provider

Default {unit}: System Info Monitor Provider

Enabled by default: true

See the section called “System Info Monitor Provider” for the properties of this Monitor Provider type.

version-monitor-provider

Default {unit}: Version Monitor Provider

Enabled by default: true

See the section called “Version Monitor Provider” for the properties of this Monitor Provider type.

Client Connection Monitor Provider

Monitor Providers of type client-connection-monitor-provider have the following properties:

enabled
Description

Indicates whether the Monitor Provider is enabled for use.

Default Value

None

Allowed Values

true

false

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced Property

No

Read-only

No

java-class
Description

Specifies the fully-qualified name of the Java class that provides the Client Connection Monitor Provider implementation.

Default Value

org.opends.server.monitors.ClientConnectionMonitorProvider

Allowed Values

A Java class that implements or extends the class(es): org.opends.server.api.MonitorProvider

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced Property

Yes (Use --advanced in interactive mode.)

Read-only

No

Entry Cache Monitor Provider

Monitor Providers of type entry-cache-monitor-provider have the following properties:

enabled
Description

Indicates whether the Monitor Provider is enabled for use.

Default Value

None

Allowed Values

true

false

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced Property

No

Read-only

No

java-class
Description

Specifies the fully-qualified name of the Java class that provides the Entry Cache Monitor Provider implementation.

Default Value

org.opends.server.monitors.EntryCacheMonitorProvider

Allowed Values

A Java class that implements or extends the class(es): org.opends.server.api.MonitorProvider

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced Property

Yes (Use --advanced in interactive mode.)

Read-only

No

Memory Usage Monitor Provider

Monitor Providers of type memory-usage-monitor-provider have the following properties:

enabled
Description

Indicates whether the Monitor Provider is enabled for use.

Default Value

None

Allowed Values

true

false

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced Property

No

Read-only

No

java-class
Description

Specifies the fully-qualified name of the Java class that provides the Memory Usage Monitor Provider implementation.

Default Value

org.opends.server.monitors.MemoryUsageMonitorProvider

Allowed Values

A Java class that implements or extends the class(es): org.opends.server.api.MonitorProvider

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced Property

Yes (Use --advanced in interactive mode.)

Read-only

No

Stack Trace Monitor Provider

Monitor Providers of type stack-trace-monitor-provider have the following properties:

enabled
Description

Indicates whether the Monitor Provider is enabled for use.

Default Value

None

Allowed Values

true

false

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced Property

No

Read-only

No

java-class
Description

Specifies the fully-qualified name of the Java class that provides the Stack Trace Monitor Provider implementation.

Default Value

org.opends.server.monitors.StackTraceMonitorProvider

Allowed Values

A Java class that implements or extends the class(es): org.opends.server.api.MonitorProvider

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced Property

Yes (Use --advanced in interactive mode.)

Read-only

No

System Info Monitor Provider

Monitor Providers of type system-info-monitor-provider have the following properties:

enabled
Description

Indicates whether the Monitor Provider is enabled for use.

Default Value

None

Allowed Values

true

false

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced Property

No

Read-only

No

java-class
Description

Specifies the fully-qualified name of the Java class that provides the System Info Monitor Provider implementation.

Default Value

org.opends.server.monitors.SystemInfoMonitorProvider

Allowed Values

A Java class that implements or extends the class(es): org.opends.server.api.MonitorProvider

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced Property

Yes (Use --advanced in interactive mode.)

Read-only

No

Version Monitor Provider

Monitor Providers of type version-monitor-provider have the following properties:

enabled
Description

Indicates whether the Monitor Provider is enabled for use.

Default Value

None

Allowed Values

true

false

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced Property

No

Read-only

No

java-class
Description

Specifies the fully-qualified name of the Java class that provides the Version Monitor Provider implementation.

Default Value

org.opends.server.monitors.VersionMonitorProvider

Allowed Values

A Java class that implements or extends the class(es): org.opends.server.api.MonitorProvider

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced Property

Yes (Use --advanced in interactive mode.)

Read-only

No