Name

dsconfig set-administration-connector-prop — Modifies Administration Connector properties

Synopsis

dsconfig set-administration-connector-prop {options}

Description

Modifies Administration Connector properties.

Options

The dsconfig set-administration-connector-prop command takes the following options:

--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.

Administration Connector properties depend on the Administration Connector type, which depends on the null option.

--reset {property}

Resets a property back to its default values where PROP is the name of the property to be reset.

Administration Connector properties depend on the Administration Connector type, which depends on the null option.

--add {PROP:VALUE}

Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added.

Administration Connector properties depend on the Administration Connector type, which depends on the null option.

--remove {PROP:VALUE}

Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed.

Administration Connector properties depend on the Administration Connector type, which depends on the null option.

Administration Connector

Administration Connectors of type administration-connector have the following properties:

key-manager-provider
Description

Specifies the name of the key manager that is used with the Administration Connector .

Default Value

None

Allowed Values

The DN of any Key Manager Provider. The referenced key manager provider must be enabled.

Multi-valued

No

Required

Yes

Admin Action Required

Restart the server

Advanced Property

No

Read-only

No

listen-address
Description

Specifies the address or set of addresses on which this Administration Connector should listen for connections from LDAP clients. Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the Administration Connector listens on all interfaces.

Default Value

0.0.0.0

Allowed Values

An IP address

Multi-valued

Yes

Required

No

Admin Action Required

Restart the server

Advanced Property

No

Read-only

No

listen-port
Description

Specifies the port number on which the Administration Connector will listen for connections from clients. Only a single port number may be provided.

Default Value

None

Allowed Values

An integer value. Lower value is 1. Upper value is 65535.

Multi-valued

No

Required

Yes

Admin Action Required

The Administration Connector must be disabled and re-enabled for changes to this setting to take effect

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 Administration Connector 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.

Default Value

Let the server decide.

Allowed Values

A String

Multi-valued

Yes

Required

Yes

Admin Action Required

Restart the server

Advanced Property

No

Read-only

No

ssl-cipher-suite
Description

Specifies the names of the SSL cipher suites that are allowed for use in SSL communication.

Default Value

Uses the default set of SSL cipher suites provided by the server's JVM.

Allowed Values

A String

Multi-valued

Yes

Required

No

Admin Action Required

None

Changes to this property take effect immediately but will only impact new SSL/TLS-based sessions created after the change.

Advanced Property

No

Read-only

No

ssl-protocol
Description

Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication.

Default Value

Uses the default set of SSL protocols provided by the server's JVM.

Allowed Values

A String

Multi-valued

Yes

Required

No

Admin Action Required

None

Changes to this property take effect immediately but only impact new SSL/TLS-based sessions created after the change.

Advanced Property

No

Read-only

No

trust-manager-provider
Description

Specifies the name of the trust manager that is used with the Administration Connector .

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.

Multi-valued

No

Required

No

Admin Action Required

Restart the server

Advanced Property

No

Read-only

No