HOME | NEXT | PREVIOUS |
The LDSU Configuration file (by default, named ldsu_config.dat) is the configuration file for each LDSU synch instance. LDSU can run in four modes: Import, Transaction, Export, Changes. Each mode has a different set of configuration parameters. In addition, Export and Changes modes have two types of operations explained below.
This section first contains a list of the syntax rules for ldsu_config.dat files following by a list of the parameters for each of the LDSU modes with brief explanations for each parameter.
There is also a table containing all LDSU_CONFIG.DAT parameters in alphabetical order with more detailed explanations.
The following table lists the parameters used in IMPORT mode.
This mode compares an input file against an LDAP directory and
updates the LDAP directory as needed using Add, Modify, and Delete
transactions.
The following table lists the parameters used in TRANSACTION mode.
This mode applies transactions contained in the ADD, MODIFY, and/or
DELETE input files against an LDAP directory. One, two, or all three
of the input files may be specified.
The following table lists the parameters used in basic EXPORT mode.
This mode extracts records from an LDAP directory, based on a search base and
search filters, and writes the records to a formatted output file.
The following table lists the parameters used in EXPORT1 mode.
This mode extracts records from an LDAP directory, which are identified
in an input file, and writes the records to a formatted output file.
The following table lists the parameters used in basic CHANGES mode.
This mode compares an extract of records from an LDAP directory, based on a
search base and search filters, with a previous extract and writes the changes
to formatted ADD, DELETE, and (optional) MODIFY output files.
The following table lists the parameters used in CHANGES1 mode.
This mode compares an extract of records from an LDAP directory, based on a
search base and search filters, with an input file containing a full export
from a foreign directory and writes the changes to formatted ADD, DELETE, and
(optional) MODIFY output files to be applied against the foreign directory.
The following list contains a detailed explanation of all ldsu_config.dat
parameters used for all modes in alphabetical order.
If big_search_type is A, the single extract of big_search_field=* is
replaced by 26 extracts of big_search_field=a*, big_search_field=b*, etc.
(Note: LDAP filters are case insensitive).
The big_search_type can also end with an optional dollar
sign ($) which can be used if the distribution of values for
the big_search_field is more evenly distributed by the last
character instead of the first character.
For example, if big_search_field is a numeric badge number
where more than half start with a 1, but the last character
is evenly distributed between 0-9, then big_search_type
should be set to "N$" instead of "N". This will create 10
extracts of big_search_field=*0, big_search_field=*1, etc.
LDSU_CONFIG.DAT Syntax Rules
LDSU_CONFIG.DAT IMPORT Parameters
Parameter Default Short Explanation
synch_type
REQUIRED
LDSU Mode. Must be IMPORT.
synch_label
LDSU
Label for log files. Suggested value: subdirectory name.
layout_file
ldsu_layout.dat in parent directory
File containing LDAP Directory RDN and Attributes Definitions
bind_server
REQUIRED
Host name of LDAP Directory Server
bind_port
389
TCP port number for LDAP Directory Server
bind_name
 
DN to bind to the LDAP Directory with if not using an Anonymous bind.
bind_password
 
Password to bind to the LDAP Directory with if not using an Anonymous bind.
input_rdf
REQUIRED
Name of input rdf file. Suggested value: import.rdf or LDIF
input_file
REQUIRED
Name of directory input file. Suggested value: import.txt
input_lines_per_record
1
#lines in input_file per entry
input_field_separator
"<TAB>",""
Primary and Secondary input_file field separator optionally used by input_rdf
input_num_header_lines
0
Number of lines in the input_file to skip at the head of the file.
input_metafile
 
Temporary file. Only specify if this needs to be on a different disk.
output_metafile
 
Temporary file. Only specify if this needs to be on a different disk.
log_file
ldsu_log.log
Name of transaction log file. Suggested value: import.log
verbose
N
Set to Y to get extra diagnostic output.
max_transactions
 
LDSU transaction limit between running max_trans_file and re-binding.
max_trans_file
 
Procedure to run every max_transactions.
max_fail_transactions
 
#failed LDAP add, modify, or delete transactions allowed before LDSU exits.
max_add_transactions
 
Cause LDSU to exit if this many LDAP add transactions would occur.
max_delete_transactions
 
Cause LDSU to exit if this many LDAP delete transactions would occur.
dn_sequence
RDN order from ldsu_layout.dat
Set to comma separated list of RDN's to override layout file sequence.
create_root
 
Set to RDN in dn_sequence where LDSU can create parent entries up to.
search_context
RECOMMENDED
DN search base for extracting existing LDAP records
synch_object
REQUIRED
Comma separated list of objectclass attribute values for Add entries.
synch_id_field
 
LDAP attribute to hold synch_id_value
synch_id_value
LDSU
Value to place in synch_id_field attribute for every Add entry
gid_field
REQUIRED
LDAP attribute to hold Group ID (gid_value)
gid_value
REQUIRED
Value to place in gid_field attribute for every Add entry
unique_search_context
 
DN search base for performing unique searches. Usually same as search_context.
unique_fields
 
List of attributes (or sets of attributes) that must be unique.
make_unique_field
 
Attribute which is made unique if not unique
make_unique_field_len
 
Length of make_unique_field. Default is length in layout file.
make_unique_truncate
 
Set to NUMBER or leave blank
make_unique_separator
 
Separator between original field value and suffix string to make unique.
make_unique_program
 
User-defined procedure to run to produce unique values
make_unique_params
 
Fields to pass to make_unique_program as parameters.
gen_profs_alias_fields
 
Fields used to generate a unique ID
gen_snads_alias_fields
 
Fields used to generate a unique ID
recognize_case_changes
Y
Set to N to treat case changes in the input file as not being changed.
add_only_fields
 
Comma separated list of attributes which are only added and never modified.
mark_for_delete_field
 
Attribute to modify instead of deleting a record if no longer in the input_file.
mark_for_delete_value
 
Value to place in the mark_for_delete_field when marking a record for delete
big_search_field
 
Attribute to search on when LDAP directory extract needs to be segmented.
big_search_type
 
Type of data in big_search_field: A, AN, N, IA5, PRINT (with optional $)
read_only_test
N
Set to Y to NOT update LDAP directory (run in test mode).
LDSU_CONFIG.DAT TRANSACTION Parameters
Parameter Default Short Explanation
synch_type
REQUIRED
LDSU Mode. Must be TRANSACTION.
synch_label
LDSU
Label for log files. Suggested value: subdirectory name.
layout_file
ldsu_layout.dat in parent directory
File containing LDAP Directory RDN and Attributes Definitions
bind_server
REQUIRED
Host name of LDAP Directory Server
bind_port
389
TCP port number for LDAP Directory Server
bind_name
 
DN to bind to the LDAP Directory with if not using an Anonymous bind.
bind_password
 
Password to bind to the LDAP Directory with if not using an Anonymous bind.
input_rdf
REQUIRED if next 3 rdf files not specified
Name of rdf file for all input files. Suggested value: import.rdf or LDIF
input_add_rdf
REQUIRED if input_add_file and not input_rdf specified
Name of rdf file for input_add_file. Suggested value: import_add.rdf
input_mod_rdf
REQUIRED if input_mod_file and not input_rdf specified
Name of rdf file for input_mod_file. Suggested value: import_mod.rdf
input_del_rdf
REQUIRED if input_del_file and not input_rdf specified
Name of rdf file for input_del_file. Suggested value: import_del.rdf
input_file
 
Name of directory input file if input_rdf=LDIF. Suggested value: import.txt
input_add_file
 
Name of directory input add file. Suggested value: import_add.txt
input_mod_file
 
Name of directory input modify file. Suggested value: import_mod.txt
input_del_file
 
Name of directory input delete file. Suggested value: import_del.txt
input_lines_per_record
1
Used if input_rdf specified. #lines per entry in all input files
input_add_lines_per_record
1
Used if input_add_rdf specified. #lines per entry in input_add_file
input_mod_lines_per_record
1
Used if input_mod_rdf specified. #lines per entry in input_mod_file
input_del_lines_per_record
1
Used if input_del_rdf specified. #lines per entry in input_del_file
input_field_separator
"<TAB>",""
Primary and Secondary input file field separator optionally used by input rdf files.
input_num_header_lines
0
Number of lines in an input file to skip at the head of the file.
input_metafile
 
Temporary file. Only specify if this needs to be on a different disk.
log_file
ldsu_log.log
Name of transaction log file. Suggested value: import.log
mod_or_add_flag
N
Set to Y to treat input_mod_file as a "Modify or Add" Input File
mod_hidden_flag
N
Set to Y to force input_mod_file records to be modified even if they cannot be read
verbose
N
Set to Y to get extra diagnostic output.
max_transactions
 
LDSU transaction limit between running max_trans_file and re-binding.
max_trans_file
 
Procedure to run every max_transactions.
max_fail_transactions
 
#failed LDAP add, modify, or delete transactions allowed before LDSU exits.
dn_sequence
RDN order from ldsu_layout.dat
Set to comma separated list of RDN's to override layout file sequence.
Not used for MOD and DEL files if key_fields specified
create_root
 
Set to RDN in dn_sequence where LDSU can create parent entries up to.
search_context
RECOMMENDED if key_fields defined
Used for search base if key_fields specified for MOD and DEL files
key_fields
 
Optional comma separated list of attributes used to identify records in MOD and DEL files instead of dn_sequence
synch_object
REQUIRED if input_add_file specified.
Comma separated list of objectclass attribute values for Add entries.
synch_id_field
 
LDAP attribute to hold synch_id_value
synch_id_value
LDSU
Value to place in synch_id_field attribute for every Add entry
gid_field
 
LDAP attribute to hold Group ID (gid_value)
gid_value
 
Value to place in gid_field attribute for every Add entry
unique_search_context
 
DN search base for performing unique searches.
unique_fields
 
List of attributes (or sets of attributes) that must be unique.
make_unique_field
 
Attribute which is made unique if not unique
make_unique_field_len
 
Length of make_unique_field. Default is length in layout file.
make_unique_truncate
 
Set to NUMBER or leave blank
make_unique_separator
 
Separator between original field value and suffix string to make unique.
make_unique_program
 
User-defined procedure to run to produce unique values
make_unique_params
 
Fields to pass to make_unique_program as parameters.
gen_profs_alias_fields
 
Fields used to generate a unique ID
gen_snads_alias_fields
 
Fields used to generate a unique ID
recognize_case_changes
Y
Set to N to treat case changes in the input mod file as not being changed.
read_only_test
N
Set to Y to NOT update LDAP directory (run in test mode).
LDSU_CONFIG.DAT EXPORT Parameters
Parameter Default Short Explanation
synch_type
REQUIRED
LDSU Mode. Must be EXPORT.
synch_label
LDSU
Label for log files. Suggested value: subdirectory name.
layout_file
ldsu_layout.dat in parent directory
File containing LDAP Directory RDN and Attributes Definitions
bind_server
REQUIRED
Host name of LDAP Directory Server
bind_port
389
TCP port number for LDAP Directory Server
bind_name
 
DN to bind to the LDAP Directory with if not using an Anonymous bind.
bind_password
 
Password to bind to the LDAP Directory with if not using an Anonymous bind.
output_rdf
REQUIRED
Name of output rdf file. Suggested value: export.rdf or LDIF
output_file
REQUIRED
Name of directory output file. Suggested value: export.txt
output_lines_per_record
1
#lines in output_file per entry
output_header_file
 
Name of optional file containing lines to prefix output records in output_file
output_field_separator
"<TAB>"
Output_file field separator optionally used by output_rdf
output_metafile
 
Temporary file. Only specify if this needs to be on a different disk.
verbose
N
Set to Y to get extra diagnostic output.
search_context
RECOMMENDED
DN search base for extracting LDAP records
synch_id_field
 
LDAP attribute which holds synch_id_value. Used as an export filter
synch_id_value
LDSU
Value to use with synch_id_field attribute export filter
gid_field
REQUIRED
LDAP attribute which holds Group ID (gid_value). Used as an export filter
gid_value
REQUIRED
Value of one or more Group ID's to extract. Or * for all or if using gid_exclude
gid_exclude
 
If gid_value is *, value of one or more Group ID's NOT to extract.
get_field
 
LDAP attribute to hold get_value. Used as an export filter.
get_value
*
Value to use with get_field attribute export filter.
custom_filter
 
Use to specify an additional filter in LDAP filter syntax
big_search_field
 
Attribute to search on when LDAP directory extract needs to be segmented.
big_search_type
 
Type of data in big_search_field: A, AN, N, IA5, PRINT (with optional $)
LDSU_CONFIG.DAT EXPORT1 Parameters
Parameter Default Short Explanation
synch_type
REQUIRED
LDSU Mode. Must be EXPORT.
synch_label
LDSU
Label for log files. Suggested value: subdirectory name.
layout_file
ldsu_layout.dat in parent directory
File containing LDAP Directory RDN and Attributes Definitions
bind_server
REQUIRED
Host name of LDAP Directory Server
bind_port
389
TCP port number for LDAP Directory Server
bind_name
 
DN to bind to the LDAP Directory with if not using an Anonymous bind.
bind_password
 
Password to bind to the LDAP Directory with if not using an Anonymous bind.
output_rdf
REQUIRED
Name of output rdf file. Suggested value: export_output.rdf or LDIF
output_file
REQUIRED
Name of directory output file. Suggested value: export_output.txt
output_lines_per_record
1
#lines in output_file per entry
output_header_file
 
Name of optional file containing lines to prefix output records in output_file
output_field_separator
"<TAB>"
Output_file field separator optionally used by output_rdf
output_metafile
 
Temporary file. Only specify if this needs to be on a different disk.
input_rdf
REQUIRED
Name of input rdf file. Suggested value: export_input.rdf
input_file
REQUIRED
Name of directory input file identifying records to export. Suggested value: export_input.txt
input_lines_per_record
1
#lines in input_file per entry
input_field_separator
"<TAB>",""
Primary and Secondary input_file field separator optionally used by input_rdf
input_num_header_lines
0
Number of lines in the input_file to skip at the head of the file.
verbose
N
Set to Y to get extra diagnostic output.
search_context
RECOMMENDED
DN search base for extracting LDAP directory records
gid_field
REQUIRED
LDAP attribute which holds Group ID (gid_value)
gid_value
REQUIRED
Group ID value
dn_sequence
RDN order from ldsu_layout.dat
Set to comma separated list of RDN's to override layout file sequence.
Not used if key_fields specified
key_fields
 
Optional comma separated list of attributes used to identify records instead of dn_sequence
LDSU_CONFIG.DAT CHANGES Parameters
Parameter Default Short Explanation
synch_type
REQUIRED
LDSU Mode. Must be CHANGES.
synch_label
LDSU
Label for log files. Suggested value: subdirectory name.
layout_file
ldsu_layout.dat in parent directory
File containing LDAP Directory RDN and Attributes Definitions
bind_server
REQUIRED
Host name of LDAP Directory Server
bind_port
389
TCP port number for LDAP Directory Server
bind_name
 
DN to bind to the LDAP Directory with if not using an Anonymous bind.
bind_password
 
Password to bind to the LDAP Directory with if not using an Anonymous bind.
output_rdf
REQUIRED if next 3 rdf files not specified
Name of rdf file for all output files. Suggested value: export.rdf or LDIF
output_add_rdf
REQUIRED if output_rdf not specified
Name of rdf file for output_add_file. Suggested value: export_add.rdf
output_mod_rdf
REQUIRED if output_rdf not specified
Name of rdf file for output_mod_file. Suggested value: export_mod.rdf
output_del_rdf
REQUIRED if output_rdf not specified
Name of rdf file for output_del_file. Suggested value: export_del.rdf
output_file
REQUIRED if next 3 files not specified
Name of export file to contain all changes. Suggested value: export.txt
output_add_file
REQUIRED if output_file not specified
Name of add changes export file. Suggested value: export_add.txt
output_mod_file
OPTIONAL
Name of modify changes export file. Changed records written to delete and
add file if not specified. Suggested value: export_mod.txt
output_del_file
REQUIRED if output_file not specified
Name of delete changes export file. Suggested value: export_del.txt
output_lines_per_record
1
Used if output_rdf specified. #lines per entry in all output files
output_add_lines_per_record
1
Used if output_add_rdf specified. #lines per entry in all output_add_file
output_mod_lines_per_record
1
Used if output_mod_rdf specified. #lines per entry in all output_mod_file
output_del_lines_per_record
1
Used if output_del_rdf specified. #lines per entry in all output_del_file
output_header_file
 
Name of optional file containing lines to prefix output records in output files
output_field_separator
"<TAB>"
Output_file field separator optionally used by output rdf file(s)
output_metafile
REQUIRED
Current extract of records to compare. Copy this file to input_metafile
for next run if changes applied successfully. Suggested value: export.new
input_metafile
REQUIRED
Previous extract of records to compare. Copied from output_metafile for
previous run. Suggested value: export.old
log_file
ldsu_log.log
Log of what changed in the LDAP directory to cause add, modify, and delete
records to be exported. Suggested value: export.log
verbose
N
Set to Y to get extra diagnostic output.
search_context
RECOMMENDED
DN search base for extracting LDAP directory records
synch_id_field
 
LDAP attribute which holds synch_id_value. Used as an export filter
synch_id_value
LDSU
Value to use with synch_id_field attribute export filter
gid_field
REQUIRED
LDAP attribute which holds Group ID (gid_value). Used as an export filter
gid_value
REQUIRED
Value of one or more Group ID's to extract. Or * for all or if using gid_exclude
gid_exclude
 
If gid_value is *, value of one or more Group ID's NOT to extract.
get_field
 
LDAP attribute to hold get_value. Used as an export filter.
get_value
*
Value to use with get_field attribute export filter.
custom_filter
 
Use to specify an additional filter in LDAP filter syntax
big_search_field
 
Attribute to search on when LDAP directory extract needs to be segmented.
big_search_type
 
Type of data in big_search_field: A, AN, N, IA5, PRINT (with optional $)
recognize_case_changes
Y
Set to N to cause case changes not to write a change to the output mod file
LDSU_CONFIG.DAT CHANGES1 Parameters
Parameter Default Short Explanation
synch_type
REQUIRED
LDSU Mode. Must be CHANGES.
synch_label
LDSU
Label for log files. Suggested value: subdirectory name.
layout_file
ldsu_layout.dat in parent directory
File containing LDAP Directory RDN and Attributes Definitions
bind_server
REQUIRED
Host name of LDAP Directory Server
bind_port
389
TCP port number for LDAP Directory Server
bind_name
 
DN to bind to the LDAP Directory with if not using an Anonymous bind.
bind_password
 
Password to bind to the LDAP Directory with if not using an Anonymous bind.
output_rdf
REQUIRED if next 3 rdf files not specified
Name of rdf file for all output files. Suggested value: export.rdf or LDIF
output_add_rdf
REQUIRED if output_rdf not specified
Name of rdf file for output_add_file. Suggested value: export_add.rdf
output_mod_rdf
REQUIRED if output_rdf not specified
Name of rdf file for output_mod_file. Suggested value: export_mod.rdf
output_del_rdf
REQUIRED if output_rdf not specified
Name of rdf file for output_del_file. Suggested value: export_del.rdf
output_file
REQUIRED if next 3 files not specified
Name of export file to contain all changes. Suggested value: export.txt
output_add_file
REQUIRED if output_file not specified
Name of add changes export file. Suggested value: export_add.txt
output_mod_file
OPTIONAL
Name of modify changes export file. Changed records written to delete and
add file if not specified. Suggested value: export_mod.txt
output_del_file
REQUIRED if output_file not specified
Name of delete changes export file. Suggested value: export_del.txt
output_lines_per_record
1
Used if output_rdf specified. #lines per entry in all output files
output_add_lines_per_record
1
Used if output_add_rdf specified. #lines per entry in all output_add_file
output_mod_lines_per_record
1
Used if output_mod_rdf specified. #lines per entry in all output_mod_file
output_del_lines_per_record
1
Used if output_del_rdf specified. #lines per entry in all output_del_file
output_header_file
 
Name of optional file containing lines to prefix output records in output files
output_field_separator
"<TAB>"
Output_file field separator optionally used by output rdf file(s)
output_metafile
 
Temporary file. Only specify if this needs to be on a different disk.
input_rdf
REQUIRED
Name of input rdf file. Suggested value: export_input.rdf
input_file
REQUIRED
Name of input file to compare with LDAP directory to generate changes. Suggested value: export_input.txt
input_lines_per_record
1
#lines in input_file per entry
input_field_separator
"<TAB>",""
Primary and Secondary input_file field separator optionally used by input_rdf
input_num_header_lines
0
Number of lines in the input_file to skip at the head of the file.
input_metafile
 
Temporary file. Only specify if this needs to be on a different disk.
log_file
ldsu_log.log
Log of what changed in the LDAP directory to cause add, modify, and delete
records to be exported. Suggested value: export.log
verbose
N
Set to Y to get extra diagnostic output.
dn_sequence
RDN order from ldsu_layout.dat
For input_file. Set to comma separated list of RDN's to override layout file sequence.
Not used if key_fields specified
key_fields
 
For input_file. Optional comma separated list of attributes used to identify records instead of dn_sequence
search_context
RECOMMENDED
DN search base for extracting LDAP directory records
synch_id_field
 
LDAP attribute which holds synch_id_value. Used as an export filter
synch_id_value
LDSU
Value to use with synch_id_field attribute export filter
gid_field
REQUIRED
LDAP attribute which holds Group ID (gid_value). Used as an export filter
gid_value
REQUIRED
Value of one or more Group ID's to extract. Or * for all or if using gid_exclude
gid_exclude
 
If gid_value is *, value of one or more Group ID's NOT to extract.
get_field
 
LDAP attribute to hold get_value. Used as an export filter.
get_value
*
Value to use with get_field attribute export filter.
custom_filter
 
Use to specify an additional filter in LDAP filter syntax
big_search_field
 
Attribute to search on when LDAP directory extract needs to be segmented.
big_search_type
 
Type of data in big_search_field: A, AN, N, IA5, PRINT (with optional $)
recognize_case_changes
Y
Set to N to cause case changes not to write a change to the output mod file
All LDSU_CONFIG.DAT Parameters
A Alphabetic (A-Z)
AN AlphaNumneric (A-Z, 0-9)
N Numeric (0-9)
IA5 IA5 Syntax (e.g. rfc822Mailbox)
PRINT Printable String Syntax
Double quotes must be used for the value if the filter contains an
exclamation point (!) character (which means NOT EQUAL).
Example values for this parameter would be emailPRUSERNAME, emailPRLOCATION,
givenName, surname.
In the Transaction ldsu_config.dat file, specify the badge number attribute
as a key_field, and LDSU will access the field using the badge number in
search filter instead of using the DN. A combination of fields can also
be supplied. If, for example, the badge number is only unique for a given
department, then specify both the department and badge number fields as
key fields. Separate multiple fields with a comma when specifying the
key_fields parameter.
No limit to the number unique fields or sets exists, though this may slow down
the time it takes to add or modify entries. If the LDAP directory supports it,
any attribute used for unique searching should be "indexed". Refer to the LDAP
directory for more information on indexing.
HOME | NEXT | PREVIOUS |
Copyright © Digital Equipment Corporation 1998