1.3 Source Handler Options

The source handler option (-S) determines the source of the import data.Only one of the following can be specified on the command line.

Table 1-2 Source Handler Options

Option

Description

-SLDIF

Specifies that the source is an LDIF file.

For a list of supported LDIF options, see LDIF Source Options.

-SLDAP

Specifies that the source is an LDAP server.

For a list of supported LDAP options, see LDAP Source Options

-SDELIM

Specifies that the source is a comma-delimited data file.

For a list of supported DELIM options, see DELIM Source Options.

-SLOAD

Specifies that the source is a DirLoad template.

For a list of supported LOAD options, see Section 1.6, DirLoad Driver.

Specific source handler options are listed in the following sections:

1.3.1 LDIF Source Options

The LDIF source handler reads data from an LDIF file then sends it to the destination handler.

Table 1-3 LDIF Source Options

Option

Description

-f <LDIF file>

Specifies a filename containing LDIF records read by the LDIF source handler and sent to the destination handler.

-a

If the records in the LDIF file are content records (that is, they contain no changetypes), they will be treated as records with a change type of add.

-c

Prevents the LDIF source handler from stopping on errors. This includes errors on parsing LDIF and errors sent back from the destination handler. When this option is set and an error occurs, the LDIF source handler reports the error, finds the next record in the LDIF file, and goes on.

-n

Does not perform update operations, but prints what would be done. When this option is set, the LDIF source handler parses the LDIF file but does not send any records to the destination handler.

-v

Enables the verbose mode of the handler.

-k

Generates the LDIF file in the current system locale.

-g <value>

Language of the LDIF file.

1.3.2 LDAP Source Options

The LDAP source handler reads data from an LDAP server by sending a search request to the server. It then sends the search entries it receives from the search operation to the destination handler.

Table 1-4 LDAP Source Options

Option

Description

-s <server name>

Specifies the DNS name or IP address of the LDAP server to which the handler binds and sends a search request.

If this option is omitted, it defaults to the local host (127.0.0.1).

-p <port>

Specifies the integer port number of the LDAP server specified by the -s option.

If this option is omitted, it defaults to 389.

-d <DN>

Specifies the distinguished name of the entry that should be used when binding to the server.

If this option is omitted, the handler performs an anonymous bind.

-w <password>

Specifies the password attribute of the entry specified by the -d option.

-F <search filter>

Specifies an RFC 2254 compliant search filter. If this option is omitted, the search filter defaults to objectclass=*.

If the filter includes characters that have special meaning to your command line shell, such as (,), &, and |, you may need to enclose the filter in double quotes.

For more information on the format of the search filter, see LDAP Search Filters in LDAP and eDirectory.

-n

Specifies not to perform the search, but to show what search would be performed.

-a <attribute list>

Specifies a comma-separated list of attributes to retrieve as part of the search. In addition to an attribute list, the option supports the following values:

  • 1.1—Get no attributes
  • *—Get all non-operational attributes

An empty list gets all non-operational attributes.

Operational attributes must be listed by name. To get all standard attributes and a few operational attributes, use the * with a list of the names of the operational attributes.

If this option is omitted, the attribute list defaults to the empty list.

-o <attribute list>

Specifies a comma-separated list of attributes to be omitted from the search results received from the LDAP server before they are sent to the destination handler. This option is very useful in cases where you want to use a wildcard with the -a option to get all attributes of some class and then remove a few of them from the search results before passing the data on to the destination handler.

For example, -a* -otelephoneNumber searches for all attributes and then filters the telephoneNumber from the results.

-R

Disables the automatic following of referrals.

-e <value>

Specifies which debugging flags should be enabled in the LDAP client SDK. (See the SDK for supported flags.)

-b <base DN>

Specifies the distinguished name of the entry where the search request begins.

If this option is omitted, the base DN defaults to ""(empty string) and the tree root is used as the base DN for the search.

-c <search scope>

Specifies the scope of the search request. The option supports the following values:

  • One—search only the immediate subordinates of the base object.

  • Base—search only the base object.

  • Sub—search the base object and all of its subordinates.

If this option is omitted, the search scope defaults to subtree.

-r <deref aliases>

Specifies the way aliases should be dereferenced during the search operation. The option supports the following values:

  • Never—aliases are never dereferenced when locating the base object or searching.

  • Always—aliases are always dereferenced when locating the base object and searching.

  • Search—aliases are dereferenced when searching subordinates of the base object but not when locating the base object.

  • Find—aliases are dereferenced when locating the base object but not when search the subordinates of the base object.

If this option is omitted, the alias dereferencing behavior defaults to never.

-l <time limit>

Specifies, in seconds, the time limit for the search.

-z <size limit>

Specifies the maximum number of entries to be returned by the search.

-V <version>

Specifies the LDAP protocol version to be used for the connection. It must be 2 or 3. If this option is omitted, the default is 3.

-v

Enables verbose mode of the handler.

-L <filename>

Specifies a file in DER format containing a server key to use for SSL authentication.

-A

Retrieves attribute names only. Attribute values are not returned by the search operation.

-Y <value>

Use SASL authentication (DIGEST-MD5 is the only supported mechanism currently).

1.3.3 DELIM Source Options

The DELIM source handler reads data from a comma-delimited data file then sends it to the destination handler.

Table 1-5 DELIM Source Options

Option

Description

-f <filename>

Specifies a filename containing comma-delimited records read by the DELIM source handler and sent to the destination handler.

-F <value>

Specifies a filename containing the attribute data order for the file specified by -f. If this option is not specified, you must enter this information directly using -t. See Performing a Comma-Delimited Import for more information.

-t <value>

Comma-delimited list of attributes specifying the attribute data order for the file specified by -f. Either this option or -F must be specified. See Performing a Comma-Delimited Import for more information.

-c

Prevents the DELIM source handler from stopping on errors. This includes errors on parsing comma-delimited data files and errors sent back from the destination handler. When this option is set and an error occurs, the DELIM source handler reports the error, finds the next record in the comma-delimited data file, and goes on.

-n <value>

Specifies the LDAP naming attribute for the new object. This attribute must be contained in the attribute data you specify using -F or -t.

-l <value>

Specifies the path to append the RDN to (such as o=myCompany). If you are passing the DN this value is not necessary.

-o <value>

Comma-delimited list of object classes (if none are contained in your input file), or additional object classes such as auxiliary classes. The default value is inetorgperson.

-i <value>

Comma-delimited list of columns to skip. This value is an integer specifying the number of the column to skip. For example, to skip the third and fifth columns you would pass -i3,5.

-d <value>

Specifies the delimiter. The default delimiter is a comma ( , ). The following values are special case delimeters: [q] = quote (a single " as the delimeter) [t] = tab For example, to specify a tab as a delimiter, you would pass: -d[t]

-q <value>

Specifies the secondary delimiter. The default secondary delimiter is a single double quote ("). The following values are special case delimeters: [q] = quote (a single " as the delimeter) [t] = tab For example, to specify a tab as a delimiter, you would pass: -d[t]

1.3.4 LOAD Source Options

Table 1-6 LOAD Source Options

Option

Description

-f <filename>

Specifies the template file containing all attribute specification and all control information for running the program.

This is mandatory. See the DirLoad driver section for details on using this source handler.

-c

Continue to the next record if error is reported.

-v

Verbose messages.

-r

Change the request to a delete request so the data is deleted instead of added. This allows you to remove records that were added using a DirLoad template.

-m

Indicates that modify requests will be in the template file.