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

## Name

dsconfig create-schema-provider — Creates Schema Providers

## Synopsis

`dsconfig create-schema-provider` {options}

## Description

Creates Schema Providers.

## Options

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

`--provider-name {name}`

  The name of the new Schema Provider.

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

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

  core-schema

    Default {name}: Core Schema

    Enabled by default: true

    See the section called “Core Schema” for the properties of this Schema Provider type.

  json-schema

    Default {name}: Json Schema

    Enabled by default: true

    See the section called “Json Schema” for the properties of this Schema 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.

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

`-t | --type {type}`

  The type of Schema Provider which should be created (Default: generic). The value for TYPE can be one of: core-schema | generic | json-schema.

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

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

  core-schema

    Default {type}: Core Schema

    Enabled by default: true

    See the section called “Core Schema” for the properties of this Schema Provider type.

  json-schema

    Default {type}: Json Schema

    Enabled by default: true

    See the section called “Json Schema” for the properties of this Schema Provider type.

## Core Schema

Schema Providers of type core-schema have the following properties:

allow-attribute-types-with-no-sup-or-syntax
  Description

    Indicates whether the schema should allow attribute type definitions that do not declare a superior attribute type or syntax When set to true, invalid attribute type definitions will use the default syntax.

  Default Value

    true

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

allow-zero-length-values-directory-string
  Description

    Indicates whether zero-length (that is, an empty string) values are allowed for directory string. This is technically not allowed by the revised LDAPv3 specification, but some environments may require it for backward compatibility with servers that do allow it.

  Default Value

    false

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

disabled-matching-rule
  Description

    The set of disabled matching rules. Matching rules must be specified using the syntax: OID, or use the default value 'NONE' to specify no value.

  Default Value

    NONE

  Allowed Values

    The OID of the disabled matching rule.

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

disabled-syntax
  Description

    The set of disabled syntaxes. Syntaxes must be specified using the syntax: OID, or use the default value 'NONE' to specify no value.

  Default Value

    NONE

  Allowed Values

    The OID of the disabled syntax, or NONE

  Multi-valued

    Yes

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

enabled
  Description

    Indicates whether the Schema 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 Core Schema implementation.

  Default Value

    org.opends.server.schema.CoreSchemaProvider

  Allowed Values

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

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

json-validation-policy
  Description

    Specifies the policy that will be used when validating JSON syntax values.

  Default Value

    strict

  Allowed Values
    disabled

      JSON syntax values will not be validated and, as a result any sequence of bytes will be acceptable.

    lenient

      JSON syntax values must comply with RFC 7159 except: 1) comments are allowed, 2) single quotes may be used instead of double quotes, and 3) unquoted control characters are allowed in strings.

    strict

      JSON syntax values must strictly conform to RFC 7159.

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

strict-format-certificates
  Description

    Indicates whether X.509 Certificate values are required to strictly comply with the standard definition for this syntax. When set to false, certificates will not be validated and, as a result any sequence of bytes will be acceptable.

  Default Value

    true

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

strict-format-country-string
  Description

    Indicates whether country code values are required to strictly comply with the standard definition for this syntax. When set to false, country codes will not be validated and, as a result any string containing 2 characters will be acceptable.

  Default Value

    true

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

strict-format-jpeg-photos
  Description

    Indicates whether to require JPEG values to strictly comply with the standard definition for this syntax.

  Default Value

    false

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

strict-format-telephone-numbers
  Description

    Indicates whether to require telephone number values to strictly comply with the standard definition for this syntax.

  Default Value

    false

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

strip-syntax-min-upper-bound-attribute-type-description
  Description

    Indicates whether the suggested minimum upper bound appended to an attribute's syntax OID in it's schema definition Attribute Type Description is stripped off. When retrieving the server's schema, some APIs (JNDI) fail in their syntax lookup methods, because they do not parse this value correctly. This configuration option allows the server to be configured to provide schema definitions these APIs can parse correctly.

  Default Value

    false

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

## Json Schema

Schema Providers of type json-schema have the following properties:

case-sensitive-strings
  Description

    Indicates whether JSON string comparisons should be case-sensitive.

  Default Value

    false

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

enabled
  Description

    Indicates whether the Schema 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

ignore-white-space
  Description

    Indicates whether JSON string comparisons should ignore white-space. When enabled all leading and trailing white space will be removed and intermediate white space will be reduced to a single character.

  Default Value

    true

  Allowed Values

    true

    false

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

indexed-field
  Description

    Specifies which JSON fields should be indexed. A field will be indexed if it matches any of the configured field patterns.

  Default Value

    All JSON fields will be indexed.

  Allowed Values

    A JSON pointer which may include wild-cards. A single '*' wild-card matches at most a single path element, whereas a double '**' matches zero or more path elements.

  Multi-valued

    Yes

  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 Json Schema implementation.

  Default Value

    org.opends.server.schema.JsonSchemaProvider

  Allowed Values

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

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    Yes (Use --advanced in interactive mode.)

  Read-only

    No

matching-rule-name
  Description

    The name of the custom JSON matching rule.

  Default Value

    The matching rule will not have a name.

  Allowed Values

    A String

  Multi-valued

    No

  Required

    No

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

matching-rule-oid
  Description

    The numeric OID of the custom JSON matching rule.

  Default Value

    None

  Allowed Values

    The OID of the matching rule.

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

  Advanced Property

    No

  Read-only

    No

Prev | Up | Next
dsconfig create-sasl-mechanism-handler | Home | dsconfig create-service-discovery-mechanism