Previous Topic: Tree Delete ControlNext Topic: Routing LDAP Controls


Virtual List View (VLV) Control

CA Directory supports the Virtual List View (VLV) control, which is described in the Virtual List View IETF draft. This control lets a client search a directory and return a subset of the results, starting from a particular point in the results.

When you use the VLV control, also use the server-side sorting control.

This control is useful for a directory that contains entries for millions of entries.

To use this control, include the following line in a request:

virtual-list-view before = number after = number offset = number content-count = number greater-or-equal = number };
before

Defines the number of entries before the target entry that the client requests the server to send.

after

Defines the number of entries after the target entry that the client requests the server to send.

offset

Defines the target entry.

content-count

Defines the number of entries in the result set.

greater-or-equal

Defines the target entry by comparing it to the values of the attribute specified.

Note: You can use the set excluded-controls command to prevent this control from being used.

Example: Using a greater-than-or-equal to match

The client provides a greater-than-or-equal to match-value defining a position in the desired page.

In this example, the server returns the page starting with an entry where the attribute, such as myattr1 has a value greater than or equal to 499.

search-req base-object=<> whole-subtree
controls = { server-side-sort myattr1
virtual-list-view before = 1 after = 3 greater-or-equal = 0000000499 };
wait;

Example: Specifying an entry number

The server returns the page defined by an ordinal offset, when there is no matching value.

In this example, the server returns the page that starts with entry 2000.The request can only be handled by assembling the entire result set, sorting it, and moving to the 2000th entry.

search-req base-object=<> whole-subtree
controls = { server-side-sort myattr1
virtual-list-view before = 1 after = 3 offset = 2000 content-count = 6000 };
wait;