dsconfig create-backend-vlv-index
Prev | dsconfig Subcommands Reference | Next

## Name

dsconfig create-backend-vlv-index — Creates Backend VLV Indexes

## Synopsis

`dsconfig create-backend-vlv-index` {options}

## Description

Creates Backend VLV Indexes.

## Options

The dsconfig create-backend-vlv-index command takes the following options:

`--backend-name {name}`

  The name of the Pluggable Backend.

  Backend VLV Index properties depend on the Backend VLV Index type, which depends on the {name} you provide.

  By default, OpenDJ directory server supports the following Backend VLV Index types:

  backend-vlv-index

    Default {name}: Backend VLV Index

    Enabled by default: false

    See the section called “Backend VLV Index” for the properties of this Backend VLV Index type.

`--index-name {STRING}`

  The name of the new Backend VLV Index which will also be used as the value of the "name" property: Specifies a unique name for this VLV index.

  Backend VLV Index properties depend on the Backend VLV Index type, which depends on the {STRING} you provide.

  By default, OpenDJ directory server supports the following Backend VLV Index types:

  backend-vlv-index

    Default {STRING}: Backend VLV Index

    Enabled by default: false

    See the section called “Backend VLV Index” for the properties of this Backend VLV Index 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.

  Backend VLV Index properties depend on the Backend VLV Index type, which depends on the `--index-name {STRING}` option.

## Backend VLV Index

Backend VLV Indexes of type backend-vlv-index have the following properties:

base-dn
  Description

    Specifies the base DN used in the search query that is being indexed.

  Default Value

    None

  Allowed Values

    A valid DN.

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The index must be rebuilt after modifying this property.

  Advanced Property

    No

  Read-only

    No

filter
  Description

    Specifies the LDAP filter used in the query that is being indexed.

  Default Value

    None

  Allowed Values

    A valid LDAP search filter.

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The index must be rebuilt after modifying this property.

  Advanced Property

    No

  Read-only

    No

name
  Description

    Specifies a unique name for this VLV index.

  Default Value

    None

  Allowed Values

    A String

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    None

    The VLV index name cannot be altered after the index is created.

  Advanced Property

    No

  Read-only

    Yes

scope
  Description

    Specifies the LDAP scope of the query that is being indexed.

  Default Value

    None

  Allowed Values
    base-object

      Search the base object only.

    single-level

      Search the immediate children of the base object but do not include any of their descendants or the base object itself.

    subordinate-subtree

      Search the entire subtree below the base object but do not include the base object itself.

    whole-subtree

      Search the base object and the entire subtree below the base object.

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The index must be rebuilt after modifying this property.

  Advanced Property

    No

  Read-only

    No

sort-order
  Description

    Specifies the names of the attributes that are used to sort the entries for the query being indexed. Multiple attributes can be used to determine the sort order by listing the attribute names from highest to lowest precedence. Optionally, + or - can be prefixed to the attribute name to sort the attribute in ascending order or descending order respectively.

  Default Value

    None

  Allowed Values

    Valid attribute types defined in the schema, separated by a space and optionally prefixed by + or -.

  Multi-valued

    No

  Required

    Yes

  Admin Action Required

    The index must be rebuilt after modifying this property.

  Advanced Property

    No

  Read-only

    No

Prev | Up | Next
dsconfig create-backend-index | Home | dsconfig create-certificate-mapper