dsconfig create-monitor-provider
Prev | dsconfig Subcommands Reference | Next

## Name

dsconfig create-monitor-provider — Creates Monitor Providers

## Synopsis

`dsconfig create-monitor-provider` {options}

## Description

Creates Monitor Providers.

## Options

The dsconfig create-monitor-provider command takes the following options:

`--provider-name {name}`

  The name of the new 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.

`--set {PROP:VALUE}`

  Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it.

  Monitor Provider properties depend on the Monitor Provider type, which depends on the `--provider-name {name}` option.

`-t | --type {type}`

  The type of Monitor Provider which should be created. The value for TYPE can be one of: client-connection | custom | entry-cache | memory-usage | stack-trace | system-info | version.

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

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

  client-connection-monitor-provider

    Default {type}: 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 {type}: 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 {type}: 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 {type}: 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 {type}: 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 {type}: 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

Prev | Up | Next
dsconfig create-log-rotation-policy | Home | dsconfig create-password-generator