Sun Java System Directory Server Enterprise Edition 6.2 Administration Guide

Chapter 20 LDAP Data Sources and Data Source Pools

This chapter describes how to use the dpconf command to create and configure LDAP data sources and data source pools. For reference information about these topics, see LDAP Data Sources in Sun Java System Directory Server Enterprise Edition 6.2 Reference.

This chapter covers the following topics:

Creating and Configuring LDAP Data Sources

For information about how to create and configure LDAP data sources, see the following procedures.

ProcedureTo Create an LDAP Data Source

You can use DSCC to perform this task. For information, see Directory Service Control Center Interface and the DSCC online help.

  1. Create the data source.


    $ dpconf create-ldap-data-source -h host -p port source-name host:port
    

    In this command, source-name is a name that you assign to the new data source. host and port refer to the host and port on which the LDAP server is running. Note that the data source does not use SSL by default.

    If the host is specified by an IP V6 address, you need to use the IP V6 reference when you create the data source. For example, if Directory Proxy Server will bind to a host with the IP V6 address fe80::209:3dff:fe00:8c93 on port 2389, use the following command to create the data source:


    $ dpconf create-ldap-data-source -h host1 -p 1389 ipv6-host \
     [fe80::209:3dff:fe00:8c93]:2389

    If you use the console to create the data source, you must specify the actual IP V6 address (without the square brackets).

    For information about how to modify the properties of an LDAP data source, see To Configure an LDAP Data Source.

  2. (Optional) View the list of data sources.


    $ dpconf list-ldap-data-sources -h host -p port
    

ProcedureTo Configure an LDAP Data Source

This procedure configures authorization between Directory Proxy Server and an LDAP data source. The procedure also configures how Directory Proxy Server monitors an LDAP data source.

You can use DSCC to perform this task. For information, see Directory Service Control Center Interface and the DSCC online help.

  1. View the properties of the data source by using this command syntax:


    dpconf get-ldap-data-source-prop -h host -p port [-M unit] [-Z unit] source-name [property...]

    In this command, -M and -Z refer to the units in which you want data to be displayed. The M option specifies the unit of time. The value for -M can be M, w, d, h, m, s, or ms, to represent months, weeks, days, hours, minutes, seconds, or miliseconds. The -Z option specifies the data size unit. The value for -Z can be T, G, M, k, or b, to represent Terabytes, Gigabytes, Megabytes, kilobytes, or bytes.

    If you do not specify a property, all properties are displayed. The default properties of an LDAP data source are as follows:


    bind-dn                        :  -
    bind-pwd                       :  -
    client-cred-mode               :  use-client-identity
    connect-timeout                :  10s
    description                    :  -
    is-enabled                     :  false
    is-read-only                   :  true
    ldap-address                   :  host
    ldap-port                      :  port
    ldaps-port                     :  ldaps
    monitoring-bind-timeout        :  5s
    monitoring-entry-dn            :  ""
    monitoring-entry-timeout       :  5s
    monitoring-inactivity-timeout  :  2m
    monitoring-interval            :  30s
    monitoring-mode                :  proactive
    monitoring-search-filter       :  (|(objectClass=*)(objectClass=ldapSubEntry))
    num-bind-incr                  :  10
    num-bind-init                  :  10
    num-bind-limit                 :  1024
    num-read-incr                  :  10
    num-read-init                  :  10
    num-read-limit                 :  1024
    num-write-incr                 :  10
    num-write-init                 :  10
    num-write-limit                :  1024
    proxied-auth-check-timeout     :  1.8s
    proxied-auth-use-v1            :  false
    ssl-policy                     :  never
    use-tcp-no-delay               :  true
  2. Enable the data source.


    $ dpconf set-ldap-data-source-prop -h host -p port source-name is-enabled:true
  3. Configure all the properties that are listed in Step 1, if you want to change the default settings.


    $ dpconf set-ldap-data-source-prop -h host -p port source-name property:value
    

    For example, if you want to modify entries on a data source, configure the data source to allow write operations.


    $ dpconf set-ldap-data-source-prop -h host -p port source-name is-read-only:false

    To find information about a property used in a subcommand, run this command:


    $ dpconf help-properties ldap-data-source property
    

    To list the key properties for data sources, use the verbose option -v with the list subcommand.


    $ dpconf list-ldap-data-sources -v
    Name         is-enabled  ldap-address  ldap-port  ldaps-port  description
    -----------  ----------  ------------  ---------  ----------  -----------
    datasource0  true        myHost        myPort     ldaps       -
    datasource1  true        myHost        myPort     ldaps       -
  4. If necessary, restart the instance of Directory Proxy Server for the changes to take effect.

    For information about restarting Directory Proxy Server, see To Restart Directory Proxy Server. For a list of configuration changes that require a server restart, see Configuration Changes Requiring Server Restart.

Creating and Configuring LDAP Data Source Pools

For information about how to create and configure data source pools, see the following procedures:

ProcedureTo Create an LDAP Data Source Pool

You can use DSCC to perform this task. For information, see Directory Service Control Center Interface and the DSCC online help.

  1. Create one or more data source pools.


    $ dpconf create-ldap-data-source-pool -h host -p port pool-name
    

    Additional data source pools can be specified after the first pool-name. For information about how to modify the properties of a data source pool, see To Configure an LDAP Data Source Pool.

  2. (Optional) View the list of data source pools.


    $ dpconf list-ldap-data-source-pools -h host -p port
    

ProcedureTo Configure an LDAP Data Source Pool

You can use DSCC to perform this task. For information, see Directory Service Control Center Interface and the DSCC online help.

  1. View the properties of the data source pool by using this command syntax:


    dpconf get-ldap-data-source-pool-prop -h host -p port [-M unit] [-Z unit] \
     pool-name [property...]

    In this command, -M and -Z refer to the units in which you want data to be displayed. The M option specifies the unit of time. The value for -M can be M, w, d, h, m, s, or ms, to represent months, weeks, days, hours, minutes, seconds, or miliseconds. The -Z option specifies the data size unit. The value for -Z can be T, G, M, k, or b, to represent Terabytes, Gigabytes, Megabytes, kilobytes, or bytes.

    If you do not specify a property, all properties are displayed. The default properties of an LDAP data source pool are as follows:


    client-affinity-policy    :  write-affinity-after-write  
    client-affinity-timeout   :  20s  
    description               :  -  
    enable-client-affinity    :  false  
    load-balancing-algorithm  :  proportional  
  2. Configure the properties that are listed in Step 1.


    $ dpconf set-ldap-data-source-pool-prop -h host -p port pool-name \
     property:value
    

    For information about how to configure the properties of a data source pool for load balancing and client affinity, see Chapter 21, Directory Proxy Server Load Balancing and Client Affinity.

Attaching LDAP Data Sources to a Data Source Pool

A data source that is attached to a data source pool is called an attached data source. The properties of an attached data source determine the load balancing configuration of the data source pool. When you configure the weights of an attached data source, consider the weights of all of the attached data sources in a data source pool. Ensure that the weights work together as required. For information about how to configure weights for load balancing, see To Configure Weights for Load Balancing.

ProcedureTo Attach an LDAP Data Source to a Data Source Pool

You can use DSCC to perform this task. For information, see Directory Service Control Center Interface and the DSCC online help.

  1. Attach one or more data sources to a data source pool.


    $ dpconf attach-ldap-data-source -h host -p port pool-name \
     source-name [source-name ...]
  2. (Optional) View the list of attached data sources for a given data source pool.


    $ dpconf list-attached-ldap-data-sources -h host -p port -E pool-name
    

    In this command, -E is optional, and modifies the display output to show one property value per line.

  3. (Optional) View the key properties of the attached data sources for a given data source pool.


    $ dpconf list-attached-ldap-data-sources -h host -p port -v pool-name
    

    In this command, -v specifies verbose output. For example, view the properties of an example data source pool.


    $ dpconf list-attached-ldap-data-sources -h host1 -p 1389 -v My-pool
    Name         add-weight  bind-weight  compare-weight  
    -----------  ----------  -----------  --------------  
    datasource0  disabled    disabled     disabled        
    datasource1  disabled    disabled     disabled        
    
    delete-weight  modify-dn-weight  modify-weight  search-weight
    -------------  ----------------  -------------  -------------
    disabled       disabled          disabled       disabled
    disabled       disabled          disabled       disabled
  4. (Optional) View the properties of an attached data source by using the following command syntax:


    $ dpconf get-attached-ldap-data-source-prop -h host -p port [-M unit] [-Z unit] \
     pool-name source-name [property...]

    In this command, -M and -Z refer to the units in which you want data to be displayed. The M option specifies the unit of time. The value for -M can be M, w, d, h, m, s, or ms, to represent months, weeks, days, hours, minutes, seconds, or miliseconds. The -Z option specifies the data size unit. The value for -Z can be T, G, M, k, or b, to represent Terabytes, Gigabytes, Megabytes, kilobytes, or bytes.

    If you do not specify a property, all properties are displayed.

    The properties of an attached data source define the weight for each type of operation in load balancing. The default weights of an attached data source are as follows:


    add-weight        :  disabled  
    bind-weight       :  disabled  
    compare-weight    :  disabled  
    delete-weight     :  disabled  
    modify-dn-weight  :  disabled  
    modify-weight     :  disabled  
    search-weight     :  disabled 

    For information about how to configure weights of an attached data source for load balancing, see To Configure Weights for Load Balancing.