dsconfig delete-service-discovery-mechanism
Prev | dsconfig Subcommands Reference | Next

## Name

dsconfig delete-service-discovery-mechanism — Deletes Service Discovery Mechanisms

## Synopsis

`dsconfig delete-service-discovery-mechanism` {options}

## Description

Deletes Service Discovery Mechanisms.

## Options

The dsconfig delete-service-discovery-mechanism command takes the following options:

`--mechanism-name {name}`

  The name of the Service Discovery Mechanism.

  Service Discovery Mechanism properties depend on the Service Discovery Mechanism type, which depends on the {name} you provide.

  By default, OpenDJ directory server supports the following Service Discovery Mechanism types:

  replication-service-discovery-mechanism

    Default {name}: Replication Service Discovery Mechanism

    Enabled by default: false

    See the section called “Replication Service Discovery Mechanism” for the properties of this Service Discovery Mechanism type.

  static-service-discovery-mechanism

    Default {name}: Static Service Discovery Mechanism

    Enabled by default: false

    See the section called “Static Service Discovery Mechanism” for the properties of this Service Discovery Mechanism type.

`-f | --force`

  Ignore non-existent Service Discovery Mechanisms.

  Service Discovery Mechanism properties depend on the Service Discovery Mechanism type, which depends on the null you provide.

  By default, OpenDJ directory server supports the following Service Discovery Mechanism types:

  replication-service-discovery-mechanism

    Default null: Replication Service Discovery Mechanism

    Enabled by default: false

    See the section called “Replication Service Discovery Mechanism” for the properties of this Service Discovery Mechanism type.

  static-service-discovery-mechanism

    Default null: Static Service Discovery Mechanism

    Enabled by default: false

    See the section called “Static Service Discovery Mechanism” for the properties of this Service Discovery Mechanism type.

## Replication Service Discovery Mechanism

Service Discovery Mechanisms of type replication-service-discovery-mechanism have the following properties:

bind-dn
  Description

    The bind DN for periodically reading replication server configurations The bind DN must be present on all replication servers and directory servers, it must be able to read the server configuration.

  Default Value

    None

  Allowed Values

    A valid DN.

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

bind-password
  Description

    The bind password for periodically reading replication server configurations The bind password must be the same on all replication and directory servers

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

discovery-interval
  Description

    Interval between two replication server configuration discovery queries. Specifies how frequently to query a replication server configuration in order to discover information about available directory server replicas.

  Default Value

    60s

  Allowed Values

    Some property values take a time duration. Durations are expressed as numbers followed by units. For example `1 s` means one second, and `2 w` means two weeks. Some durations have minimum granularity or maximum units, so you cannot necessary specify every duration in milliseconds or weeks for example. Some durations allow you to use a special value to mean unlimited. Units are specified as follows.

    - `ms`: milliseconds

    - `s`: seconds

    - `m`: minutes

    - `h`: hours

    - `d`: days

    - `w`: weeks

    Lower limit is 1 seconds.

  Multi-valued

    No

  Required

    No

  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 Replication Service Discovery Mechanism implementation.

  Default Value

    org.opends.server.backends.proxy.ReplicationServiceDiscoveryMechanism

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.backends.proxy.ServiceDiscoveryMechanism

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Service Discovery Mechanism must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

key-manager-provider
  Description

    Specifies the name of the key manager that should be used with this Service Discovery Mechanism.

  Default Value

    None

  Allowed Values

    The DN of any Key Manager Provider. The referenced key manager provider must be enabled when the Service Discovery Mechanism is enabled and configured to use SSL or StartTLS.

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property take effect immediately, but only for subsequent attempts to access the key manager provider for associated client connections.

  Advanced Property

    No

  Read-only

    No

primary-group-id
  Description

    Replication domain group ID of preferred directory server replicas. Directory server replicas with this replication domain group ID will be preferred over other directory server replicas. Secondary server replicas will only be used when all primary server replicas become unavailable.

  Default Value

    All the server replicas will be treated the same.

  Allowed Values

    An integer value. Lower value is 0.

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

replication-server
  Description

    Specifies the list of replication servers to contact periodically when discovering server replicas.

  Default Value

    None

  Allowed Values

    A host name followed by a ":" and a port number.

  Multi-valued

    Yes

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

ssl-cert-nickname
  Description

    Specifies the nicknames (also called the aliases) of the keys or key pairs that the Service Discovery Mechanism should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key. This is only applicable when the Service Discovery Mechanism is configured to use SSL.

  Default Value

    Let the server decide.

  Allowed Values

    A String

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    The Service Discovery Mechanism must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    No

  Read-only

    No

trust-manager-provider
  Description

    Specifies the name of the trust manager that should be used with the Service Discovery Mechanism.

  Default Value

    Use the trust manager provided by the JVM.

  Allowed Values

    The DN of any Trust Manager Provider. The referenced trust manager provider must be enabled when the Service Discovery Mechanism is enabled and configured to use SSL or StartTLS.

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property take effect immediately, but only for subsequent attempts to access the trust manager provider for associated client connections.

  Advanced Property

    No

  Read-only

    No

use-ssl
  Description

    Indicates whether the Service Discovery Mechanism should use SSL. If enabled, the Service Discovery Mechanism will use SSL to encrypt communication with the clients.

  Default Value

    false

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    The Service Discovery Mechanism must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    No

  Read-only

    No

use-start-tls
  Description

    Indicates whether the Service Discovery Mechanism should use Start TLS. If enabled, the Service Discovery Mechanism will use Start TLS to encrypt communication with remote servers.

  Default Value

    false

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    The Service Discovery Mechanism must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    No

  Read-only

    No

## Static Service Discovery Mechanism

Service Discovery Mechanisms of type static-service-discovery-mechanism have the following properties:

discovery-interval
  Description

    Interval between two server configuration discovery executions. Specifies how frequently to read the configuration of the servers in order to discover their new information.

  Default Value

    60s

  Allowed Values

    Some property values take a time duration. Durations are expressed as numbers followed by units. For example `1 s` means one second, and `2 w` means two weeks. Some durations have minimum granularity or maximum units, so you cannot necessary specify every duration in milliseconds or weeks for example. Some durations allow you to use a special value to mean unlimited. Units are specified as follows.

    - `ms`: milliseconds

    - `s`: seconds

    - `m`: minutes

    - `h`: hours

    - `d`: days

    - `w`: weeks

    Lower limit is 1 seconds.

  Multi-valued

    No

  Required

    No

  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 Static Service Discovery Mechanism implementation.

  Default Value

    org.opends.server.backends.proxy.StaticServiceDiscoveryMechanism

  Allowed Values

    A Java class that implements or extends the class(es): org.opends.server.backends.proxy.ServiceDiscoveryMechanism

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The Service Discovery Mechanism must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

key-manager-provider
  Description

    Specifies the name of the key manager that should be used with this Service Discovery Mechanism.

  Default Value

    None

  Allowed Values

    The DN of any Key Manager Provider. The referenced key manager provider must be enabled when the Service Discovery Mechanism is enabled and configured to use SSL or StartTLS.

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property take effect immediately, but only for subsequent attempts to access the key manager provider for associated client connections.

  Advanced Property

    No

  Read-only

    No

primary-server
  Description

    Specifies a list of servers that will be used in preference to secondary servers when available.

  Default Value

    None

  Allowed Values

    A host name followed by a ":" and a port number.

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

secondary-server
  Description

    Specifies a list of servers that will be used in place of primary servers when all primary servers are unavailable.

  Default Value

    None

  Allowed Values

    A host name followed by a ":" and a port number.

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

ssl-cert-nickname
  Description

    Specifies the nicknames (also called the aliases) of the keys or key pairs that the Service Discovery Mechanism should use when performing SSL communication. The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key. This is only applicable when the Service Discovery Mechanism is configured to use SSL.

  Default Value

    Let the server decide.

  Allowed Values

    A String

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    The Service Discovery Mechanism must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    No

  Read-only

    No

trust-manager-provider
  Description

    Specifies the name of the trust manager that should be used with the Service Discovery Mechanism.

  Default Value

    Use the trust manager provided by the JVM.

  Allowed Values

    The DN of any Trust Manager Provider. The referenced trust manager provider must be enabled when the Service Discovery Mechanism is enabled and configured to use SSL or StartTLS.

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property take effect immediately, but only for subsequent attempts to access the trust manager provider for associated client connections.

  Advanced Property

    No

  Read-only

    No

use-ssl
  Description

    Indicates whether the Service Discovery Mechanism should use SSL. If enabled, the Service Discovery Mechanism will use SSL to encrypt communication with the clients.

  Default Value

    false

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    The Service Discovery Mechanism must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    No

  Read-only

    No

use-start-tls
  Description

    Indicates whether the Service Discovery Mechanism should use Start TLS. If enabled, the Service Discovery Mechanism will use Start TLS to encrypt communication with remote servers.

  Default Value

    false

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    The Service Discovery Mechanism must be disabled and re-enabled for changes to this setting to take effect

  Advanced Property

    No

  Read-only

    No

Prev | Up | Next
dsconfig delete-schema-provider | Home | dsconfig delete-synchronization-provider