PMDF System Manager's Guide


Previous Next Contents Index


dirsync -convert

Convert to or from LDIF format.

Syntax

pmdf dirsync -convert source[=file-spec] destination[=file-spec]

Command Qualifiers Defaults
-attributes=attribute-list See text
-debug -nodebug
-delta -nodelta
-domain=cc-domain See text
-dn=attribute-list See text
-fnf -nofnf
-header -header
-option See text
-rebuild -norebuild
-space=substitution-character See text
-verbose=value See text

Parameters

source

This required parameter is a keyword or keyword=file-spec value specifying the input for the converter. The valid keywords are CC, COMMA, LDAP, LDIF, MSMAIL, and TRUELDIF. Except for LDAP, all other keywords require a file specification value, specifying the name of the directory file to use as input.

destination

This required parameter is a keyword or keyword=file-spec value specifying the output for the converter. The valid keywords are CC, COMMA, DB, LDAP, LDIF, MSMAIL, and TRUELDIF. Except for DB and LDAP, all other keywords require a file specification value, specifying the name of the directory file to output.

Description

The pmdf dirsync -convert command converts between LDIF format and other directory formats, such as cc:Mail, comma-separated list, LDAP, standard LDIF, and Microsoft Mail. The parameters for the command specify from which and to which format to convert, and in the case of file-based formats, the names of the files for input or output. Depending on the values of source and destination parameters, some other qualifiers can be available; see Table 37-14. Note that these qualifiers must appear after the non-LDIF parameter; thus the general place to specify them is at the end of the command line.

Table 37-14 Valid pmdf dirsync -convert Qualifier Combinations
Source Destination Valid qualifiers
cc:Mail
LDIF CC -debug -nodebug
CC LDIF -debug -nodebug
    -domain  
    -fnf -nofnf
Comma-separated fields
LDIF COMMA -attributes  
    -debug -nodebug
    -header -noheader
    -space  
COMMA LDIF -attributes  
    -debug -nodebug
    -dn  
    -header -noheader
    -space  
Database
LDIF DB -debug -nodebug
    -rebuild -norebuild
Microsoft Mail
LDIF MSMAIL -debug -nodebug
MSMAIL LDIF -debug -nodebug
LDAP or X.500
LDIF LDAP -debug -nodebug
    -option  
LDAP LDIF -debug -nodebug
    -option  
Standard LDIF
LDIF TRUELDIF -debug -nodebug
    -delta -nodelta
    -verbose  
TRUELDIF LDIF -debug -nodebug

For instance, to dump an LDAP directory to an LDIF file, the command syntax would be:


% pmdf dirsync -convert LDAP LDIF=ldap.ldif -option=/pmdf/table/sync_ldap_option
where /pmdf/table/sync_ldap_option is a file containing at least the mandatory options LDAP_SERVER, LDAP_USER, LDAP_PASSWORD, and LDAP_BASE. See Section 37.6.1 for a detailed discussion of these options; in brief, LDAP_SERVER specifies the (TCP/IP) name of the LDAP server and the port on which the LDAP server runs, LDAP_USER and LDAP_PASSWORD specify the name and password to use to bind to the LDAP server, and LDAP_BASE specifies the location in the Directory Information Tree of the subtree of information to be extracted.


Command Qualifiers

-attributes =attribute-list

This qualifier is valid when the destination or source is COMMA, and in such cases either this qualifier or the -header qualifier must be specified.

-debug

-nodebug (default)

This option enables debugging.

-delta

-nodelta (default)

These qualifiers are valid when the destination is TRUELDIF, and control the interpretation of the source LDIF file and hence what is generated as the corresponding output true LDIF file. -delta tells PMDF that the LDIF file entries should be interpreted as delta (add) entries; -nodelta tells PMDF that the LDIF file entries should be interpreted as absolute entries.

-destination= keyword

Valid keywords are A1, CCMAIL, COMMA, DDS, FF, LDAP, LDIF, MSMAIL (a synonym for FF), and TRUELDIF. Either this qualifier or the -source qualifier must be specified with a non-LDIF keyword value. If the destination is not explicitly specified, the default is LDIF.

-dn=attribute-list

This qualifier is valid---and indeed mandatory---in conjunction with -source=COMMA.

-domain= cc-domain

This qualifier is valid in conjunction with -source=CCMAIL. This optional qualifier specifies the pseudodomain name associated with the cc:Mail users.

-fnf

-nofnf (default)

This option controls whether entries will be generated in "Last, First" format or in "First Last" format. The default is "Last, First" format.

-header

-noheader (default)

This qualifier is valid when the source or destination is COMMA, and in such cases either this qualifier or the -attributes qualifier must be specified. This qualifier specifies whether a "header" line containing attribute names is to be read from or written to the comma-separated fields file.

-option

This qualifier is required when the source or destination is LDAP. This option specifies the file from which to read option settings such as password, etc.. For instance, if there is a channel that normally performs the LDAP extraction or updating, and the PMDF DIRSYNC/CONVERT pmdf dirsync -convert command is being executed manually to do a manual extract or update, specifying -option=channel-option-file can be appropriate.

-rebuild

-norebuild (default)

When the destination is DB, this option can be used to specify a list of databases which should be rebuilt from scratch (all prior existing entries deleted), rather than merely updated.

-source= keyword

Valid keywords are CCMAIL, COMMA, FF, LDAP, LDIF, MSMAIL (a synonym for FF), and TRUELDIF. Either this qualifier or the -destination qualifier must be specified with a non-LDIF keyword value. If the source is not explicitly specified, the default is LDIF.

-space= substitution-character

This qualifier is valid when the source or destination is COMMA. This optional qualifier specifies the character used in the LDIF file in place of the space character in attribute names (since space is not a legal character in an LDIF attribute name). If the -header qualifier is being used, then the resulting "header" line written to the comma-separated output file will contain the space character in place of any occurrences of the specified character in the attribute names.

-verbose= value

This qualifier is valid in conjunction with source or destination of LDAP. value is an integer specifying the level of verbosity.


Previous Next Contents Index