| Platform SDK: Exchange Server |
Most DIRSYNC command-line flags correspond to values in the Windows NT Registry. When an instance is selected, the key values found in the registry are used to perform the DIRSYNC function. Command-line parameters override the registry (instance) values. Command-line flags can also be used to change the registry values if the /SET flag is used. The following table shows the corresponding registry values for DIRSYNC command-line flags. Any value listed as mandatory is required and can be supplied either from the registry or on a command line. Values listed as optional are not required and must be supplied from the registry.
The following command-line flags can be stored as part of the Windows NT Registry key. This key has the following path: HKEY_LOCAL_MACHINE\SOFTWARE\MS Exchange SDK Samples\DIRSYNC\<Instance>
Command-Line Flags Corresponding to the Instance Registry Key
| Key Value | Command-Line Flag | Setting |
|---|---|---|
| Basepoint | /BASEPOINT= | Mandatory. Distinguished name (DN) of place in directory information tree (DIT) from which to start export—usually the DN of the Microsoft Exchange Server site. Example: /o=Organization/ou=Site. |
| Container | /CONTAINER= | Mandatory. Relative distinguished name (RDN) of container below the Basepoint from which to start the export. For example: Recipients. |
| DSA | /DSA= | Mandatory. Directory service agent (DSA) to which DIRSYNC should connect for import or export. Usually same as Microsoft Exchange Server name. |
| Export File | /EXPFILE= | Mandatory for export. Fully qualified name of file to which export information is written. |
| Export List | /EXPLIST= | Optional. Schema attributes to be exported, expressed as a comma-separated list. Example: Obj-Class,Common-Name,Display-Name. If this flag is not specified, only the DN for an object is exported. |
| Full Export | /EXPFULL
/NOEXPFULL |
Optional. Boolean flag indicating that the entire set of recipients should be exported, regardless of when objects were last changed. /NOEXPFULL = Exports changed objects (default) /EXPFULL = Exports all objects |
| Home Server | /HOMESERVER= | Optional. Specifies the default server to which imported mailbox information is to be added. |
| Import File | /IMPFILE= | Mandatory for import. Fully qualified name of file from which import information is read. |
| MV Append | /MVAPPEND
/NOMVAPPEND |
Optional. Boolean flag indicating that newly imported values for multivalued properties are to be appended to the existing properties.
/NOMVAPPEND = Overwrites existing multivalued properties with new values. Default, /MVAPPEND = Appends new multivalued properties to existing ones. |
| NT Create | /NTCREATE
/NONTCREATE |
Optional. /NTCREATE creates a new Windows NT account for each added mailbox. If the Assoc-NT-Account attribute is specified, then that name is used. Otherwise, a default name is generated. The password is the same as the account name, padded with x if necessary to bring the length to the minimum required by the system. If no domain is given, the logon domain is used. /NONTCREATE negates /NTCREATE. |
| NT Delete | /NTDELETE
/NONTDELETE |
Optional. /NTDELETE deletes the associated Windows NT account of every mailbox that is being deleted. If the mailbox has no associated account, no account is deleted but the mailbox is still deleted. /NONTDELETE does not delete the mailboxes. Default. |
| Object Type | /OBJCLASS= | Optional. Type of directory objects created by import operations.
Remote = Creates custom recipients (default) Mailbox = Creates a mailbox object |
| Progress Dialog | /PROGRESS
/NOPROGRESS |
Optional. Boolean flag indicating that a progress dialog should be displayed. Affects export only because import operations do not support a progress dialog /NOPROGRESS = No progress dialog (default) /PROGRESS = Display progress dialog |
| Server | /SERVER= | Optional. If set, server from which mailboxes will be exported. |
| Sub-containers | /SUBS
/NOSUBS |
Optional. Boolean flag indicating that export operations should recursively include subcontainers.
/NOSUBS = Only exports specified container (default) /SUBS = Recursively exports all subcontainers starting with specified container |
| Type | /EXPORT /IMPORT /BOTH | Mandatory. Indicates instance type.
No type specified (default) |
The following command-line flags can be stored as part of the instance Windows NT Registry key. This key has the following path: HKEY_LOCAL_MACHINE\SOFTWARE\MS Exchange SDK Samples\DIRSYNC\<Instance>\State.
Command-Line Flags Corresponding to the State Registry Key
| Value | Command-Line Flag | Setting |
|---|---|---|
| Imported Object List | Binary table of imported USNs used to coordinate incremental imports and exports. This table is cleared after every export. | |
| Last USN | /USN | Value of the most recent USN-Changed attribute exported. Setting this value to zero before running DIRSYNC forces the entire container to be exported (as will setting the Full Export flag). |
The following command-line flags can only be entered from the command line.
DIRSYNC Command-Line Flags with No Windows NT Registry Equivalent
| Command-Line Flag | Setting |
|---|---|
| /SET | Creates a new instance or modifies an existing instance. The Windows NT Registry is updated, but no export operation is performed. |
| /KEY=<Registry key> | Specifies an instance with an alternate registry location. Used instead of an instance name. |
| /DISPLAY | Displays the current registry settings for the instance or /KEY. |
| /?
/HELP |
Displays full Help information. |