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
/SCOPE=keyword /SCOPE=LOCAL
/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 A1, CC, COMMA, DDS, LDAP, LDIF, MSMAIL, and TRUELDIF. In the case of CC, COMMA, LDIF, MSMAIL, and TRUELDIF, the keyword takes a required 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 A1, CC, COMMA, DB, DDS, LDAP, LDIF, MSMAIL, and TRUELDIF. In the case of CC, COMMA, LDIF, MSMAIL, and TRUELDIF, the keyword takes a required 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 ALL-IN-1, cc:Mail, PMDF databases, the DDS, comma-separated fields, LDAP, Microsoft Mail, and standard LDIF. 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-13. 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-13 Valid PMDF DIRSYNC/CONVERT Qualifier Combinations
Source Destination Valid qualifiers
ALL-IN-1
A1 LDIF= file-spec /DEBUG /NODEBUG
    /OPTION  
LDIF= file-spec A1 /DEBUG /NODEBUG
    /OPTION  
cc:Mail
CC= file-spec LDIF= file-spec /DEBUG /NODEBUG
    /DOMAIN  
    /FNF /NOFNF
LDIF= file-spec CC= file-spec /DEBUG /NODEBUG
Comma-separated fields
COMMA= file-spec LDIF= file-spec /ATTRIBUTES  
    /DEBUG /NODEBUG
    /DN  
    /HEADER /NOHEADER
    /SPACE  
LDIF= file-spec COMMA= file-spec /ATTRIBUTES  
    /DEBUG /NODEBUG
    /HEADER /NOHEADER
    /SPACE  
Database
LDIF= file-spec DB /DEBUG /NODEBUG
    /REBUILD /NOREBUILD
DDS
DDS LDIF= file-spec /DEBUG /NODEBUG
    /SCOPE  
LDIF= file-spec DDS /DEBUG /NODEBUG
Microsoft Mail
MSMAIL= file-spec LDIF= file-spec /DEBUG /NODEBUG
LDIF= file-spec MSMAIL= file-spec /DEBUG /NODEBUG
LDAP or X.500
LDAP LDIF= file-spec /DEBUG /NODEBUG
    /OPTION  
LDIF= file-spec LDAP /DEBUG /NODEBUG
    /OPTION  
Standard LDIF
TRUELDIF= file-spec LDIF= file-spec /DEBUG /NODEBUG
LDIF= file-spec TRUELDIF= file-spec /DEBUG /NODEBUG
    /DELTA /NODELTA
    /VERBOSE  

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 /DESTINATION or /SOURCE is COMMA, and in such cases either /ATTRIBUTES=attribute-list or /HEADER must be specified. This option specifies the LDIF file attributes to be written to or read from the comma-separated fields file.

/DEBUG

/NODEBUG (default)

The option enables debugging.

/DELTA

/NODELTA (default)

These qualifiers are valid when /DESTINATION=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 /DESTINATION is not explicitly specified, the default is /DESTINATION=LDIF.

/DN=attribute-list

This qualifier is valid---and indeed mandatory---in conjunction with /SOURCE=COMMA. This mandatory option specifies the attributes to use for constructing a distinguished name.

/DOMAIN=cc-domain

This qualifier is valid when /SOURCE=CCMAIL. This optional qualifier specifies the pseudodomain name associated with the cc:Mail users.

/FNF

/NOFNF (default)

This qualifier is valid in conjunction with /SOURCE=CCMAIL. 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 in conjunction with /DESTINATION=COMMA or /SOURCE=COMMA, and in such cases either /HEADER or /ATTRIBUTES=attribute-list 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=file-spec

When the source or destination is A1 or LDAP, then this option is mandatory. 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 A1 or LDAP extraction or updating, and the 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.

/SCOPE=keyword

This qualifier is valid in conjunction with /SOURCE=DDS. This option controls the DDS search scope. Allowed values are LOCAL, WORLD, or CACHE.

/SOURCE=keyword

Valid keywords are A1, CCMAIL, COMMA, DDS, 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 /SOURCE is not explicitly specified, the default is /SOURCE=LDIF.

/SPACE=substitution-character

This qualifier is valid in conjunction with /DESTINATION=COMMA or /SOURCE=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 character specified with /SPACE in the attribute names.

/VERBOSE=value

The qualifier is valid in conjunction with /SOURCE=LDAP or /DESTINATION=LDAP. value is an integer specifying the level of verbosity.


Previous Next Contents Index