dsconfig set-trust-manager-provider-prop
Prev | dsconfig Subcommands Reference | Next

## Name

dsconfig set-trust-manager-provider-prop — Modifies Trust Manager Provider properties

## Synopsis

`dsconfig set-trust-manager-provider-prop` {options}

## Description

Modifies Trust Manager Provider properties.

## Options

The dsconfig set-trust-manager-provider-prop command takes the following options:

`--provider-name {name}`

  The name of the Trust Manager Provider.

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

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

  blind-trust-manager-provider

    Default {name}: Blind Trust Manager Provider

    Enabled by default: true

    See the section called “Blind Trust Manager Provider” for the properties of this Trust Manager Provider type.

  file-based-trust-manager-provider

    Default {name}: File Based Trust Manager Provider

    Enabled by default: true

    See the section called “File Based Trust Manager Provider” for the properties of this Trust Manager Provider type.

  ldap-trust-manager-provider

    Default {name}: LDAP Trust Manager Provider

    Enabled by default: true

    See the section called “LDAP Trust Manager Provider” for the properties of this Trust Manager Provider type.

  pkcs11-trust-manager-provider

    Default {name}: PKCS11 Trust Manager Provider

    Enabled by default: true

    See the section called “PKCS11 Trust Manager Provider” for the properties of this Trust Manager 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.

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

`--reset {property}`

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

  Trust Manager Provider properties depend on the Trust Manager Provider type, which depends on the `--provider-name {name}` 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.

  Trust Manager Provider properties depend on the Trust Manager Provider type, which depends on the `--provider-name {name}` 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.

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

## Blind Trust Manager Provider

Trust Manager Providers of type blind-trust-manager-provider have the following properties:

enabled
  Description

    Indicate whether the Trust Manager 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

    The fully-qualified name of the Java class that provides the Blind Trust Manager Provider implementation.

  Default Value

    org.opends.server.extensions.BlindTrustManagerProvider

  Allowed Values

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

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

## File Based Trust Manager Provider

Trust Manager Providers of type file-based-trust-manager-provider have the following properties:

enabled
  Description

    Indicate whether the Trust Manager 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

    The fully-qualified name of the Java class that provides the File Based Trust Manager Provider implementation.

  Default Value

    org.opends.server.extensions.FileBasedTrustManagerProvider

  Allowed Values

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

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

trust-store-file
  Description

    Specifies the path to the file containing the trust information. It can be an absolute path or a path that is relative to the OpenDJ instance root. Changes to this configuration attribute take effect the next time that the trust manager is accessed.

  Default Value

    None

  Allowed Values

    An absolute path or a path that is relative to the OpenDJ directory server instance root.

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

trust-store-pin
  Description

    Specifies the clear-text PIN needed to access the File Based Trust Manager Provider .

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property will take effect the next time that the File Based Trust Manager Provider is accessed.

  Advanced Property

    No

  Read-only

    No

trust-store-pin-environment-variable
  Description

    Specifies the name of the environment variable that contains the clear-text PIN needed to access the File Based Trust Manager Provider .

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property will take effect the next time that the File Based Trust Manager Provider is accessed.

  Advanced Property

    No

  Read-only

    No

trust-store-pin-file
  Description

    Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the File Based Trust Manager Provider .

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property will take effect the next time that the File Based Trust Manager Provider is accessed.

  Advanced Property

    No

  Read-only

    No

trust-store-pin-property
  Description

    Specifies the name of the Java property that contains the clear-text PIN needed to access the File Based Trust Manager Provider .

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property will take effect the next time that the File Based Trust Manager Provider is accessed.

  Advanced Property

    No

  Read-only

    No

trust-store-type
  Description

    Specifies the format for the data in the trust store file. Valid values always include 'JKS' and 'PKCS12', but different implementations can allow other values as well. If no value is provided, then the JVM default value is used. Changes to this configuration attribute take effect the next time that the trust manager is accessed.

  Default Value

    None

  Allowed Values

    Any key store format supported by the Java runtime environment. The "JKS" and "PKCS12" formats are typically available in Java environments.

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

## LDAP Trust Manager Provider

Trust Manager Providers of type ldap-trust-manager-provider have the following properties:

base-dn
  Description

    The base DN beneath which LDAP key store entries are located.

  Default Value

    None

  Allowed Values

    A valid DN.

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

enabled
  Description

    Indicate whether the Trust Manager 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

    The fully-qualified name of the Java class that provides the LDAP Trust Manager Provider implementation.

  Default Value

    org.opends.server.extensions.LDAPTrustManagerProvider

  Allowed Values

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

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

trust-store-pin
  Description

    Specifies the clear-text PIN needed to access the LDAP Trust Manager Provider .

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property will take effect the next time that the LDAP Trust Manager Provider is accessed.

  Advanced Property

    No

  Read-only

    No

trust-store-pin-environment-variable
  Description

    Specifies the name of the environment variable that contains the clear-text PIN needed to access the LDAP Trust Manager Provider .

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property will take effect the next time that the LDAP Trust Manager Provider is accessed.

  Advanced Property

    No

  Read-only

    No

trust-store-pin-file
  Description

    Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the LDAP Trust Manager Provider .

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property will take effect the next time that the LDAP Trust Manager Provider is accessed.

  Advanced Property

    No

  Read-only

    No

trust-store-pin-property
  Description

    Specifies the name of the Java property that contains the clear-text PIN needed to access the LDAP Trust Manager Provider .

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property will take effect the next time that the LDAP Trust Manager Provider is accessed.

  Advanced Property

    No

  Read-only

    No

## PKCS11 Trust Manager Provider

Trust Manager Providers of type pkcs11-trust-manager-provider have the following properties:

enabled
  Description

    Indicate whether the Trust Manager 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

    The fully-qualified name of the Java class that provides the PKCS11 Trust Manager Provider implementation.

  Default Value

    org.opends.server.extensions.PKCS11TrustManagerProvider

  Allowed Values

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

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

trust-store-pin
  Description

    Specifies the clear-text PIN needed to access the PKCS11 Trust Manager Provider .

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property will take effect the next time that the PKCS11 Trust Manager Provider is accessed.

  Advanced Property

    No

  Read-only

    No

trust-store-pin-environment-variable
  Description

    Specifies the name of the environment variable that contains the clear-text PIN needed to access the PKCS11 Trust Manager Provider .

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property will take effect the next time that the PKCS11 Trust Manager Provider is accessed.

  Advanced Property

    No

  Read-only

    No

trust-store-pin-file
  Description

    Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the PKCS11 Trust Manager Provider .

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property will take effect the next time that the PKCS11 Trust Manager Provider is accessed.

  Advanced Property

    No

  Read-only

    No

trust-store-pin-property
  Description

    Specifies the name of the Java property that contains the clear-text PIN needed to access the PKCS11 Trust Manager Provider .

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

    Changes to this property will take effect the next time that the PKCS11 Trust Manager Provider is accessed.

  Advanced Property

    No

  Read-only

    No

Prev | Up | Next
dsconfig set-synchronization-provider-prop | Home | dsconfig set-virtual-attribute-prop