dsexport.1   [plain text]

.\"Modified from man(1) of FreeBSD, the NetBSD mdoc.template, and mdoc.samples.
.\"See Also:
.\"man mdoc.samples for a complete listing of options
.\"man mdoc for the short list of editing options
.Dd Fri Apr 7 2006               \" DATE 
.Dt dsexport 1      \" Program name and manual section number 
.Os MacOSX
.Sh NAME                 \" Section Header - required - don't modify 
.Nm dsexport
.\" The following lines are read in generating the apropos(man -k) database. Use only key
.\" words here as the database is built based on the words here and in the .ND line. 
.\".Nm Other_name_for_same_program(),
.\".Nm Yet another name for the same program.
.\" Use .Nm macro to designate other names for the documented program.
.\".Nd This line parsed for whatis database.
.Sh SYNOPSIS             \" Section Header - required - don't modify
.Ar filePath DSNodePath recordType 
.Op <options>
.Op <DSProxy>
The first three arguments are required and order dependent. All other arguments may or may not be required, depending on what operation the tool is performing.
.Sh DESCRIPTION          \" Section Header - required - don't modify
is a tool for exporting records from Open Directory.
.Bl -tag -width stringtosetspacing12
.It filePath
is a path to the file to be created and in which the data should be exported to. If the file already exists it will be overwritten.
.It DSNodePath
is the path to the DS node where the records will be read from.
.It recordType
is the type of DS record to be exported from the node. If the record type does not have a 'dsRecTypeStandard:' or a 'dsRecTypeNative:' prefix the tool will search the node to see if the record type is a supported standard attribute and if this is the case it will export those records. If not the record type is considered to be native. Standard Record types are defined in 
.Pa DirServicesConst.h
.It Op -r <recordName>
is a list of the DS recordNames we wish to export from the Node. The names are to be separated by a comma (","). If no record names are specified the tool exports all the records on the specified node. Example: '-r admin, root, user1'
.It Op -e <attributesToBeExcluded>
is a list of attribute types that should not be exported for every record. The attributes types are to be separated by a comma (","). 
The following record types are always excluded: 'dsAttrTypeStandard:AppleMetaNodeLocation, dsAttrTypeStandard:RecordType, dsAttrTypeNative:objectClass'
.It Fl -N 
is the flag to tell the tool to export the native attributes as well as the standard attributes. By default the tool only exports standard attributes.
This is to be used in order to connect to a proxy machine. All three options are needed. If you do not specify the password as an argument the tool will prompt you for it.
.Bl -tag -width stringtosetspacing12
.It Op -a <proxyAddress>
is the address of the proxy machine the user wishes to use.
.It Op -u <proxyUser> 
Specifies user name to use for the proxy connection
.It Op -p <proxyPassword>
Specifies password to use for the proxy connection. For proxy connections name/password are required. If the this option is not specified and the user has specified a proxy machine and username the tool will prompt the user for the password.
When using an LDAP node please be aware that this tool can only export as many records as the LDAP server is willing to return. This means that if you have several thousand users you might want to raise the maximum number of search results that the server returns. This can be done in Server Admin (my.server.com>OpenDirectory>Settings> Protocols tab). By default this is set to 11000 results.
Export all userRecords from the local node to export.out: 
.Dl $ dsexport export.out /Local/Default dsRecTypeStandard:Users
Export the group records for admin and staff from the LDAPv3 Node on a proxy machine 'proxy.machine.com': 
.Dl $ dsexport export.out /LDAPv3/ dsRecTypeStandard:Groups -r admin, staff -a proxy.machine.com -u diradmin -p pass
.\"The action of each command is described below.
.\" .Sh ENVIRONMENT      \" May not be needed
.\" .Bl -tag -width "ENV_VAR_1" -indent \" ENV_VAR_1 is width of the string ENV_VAR_1
.\" .It Ev ENV_VAR_1
.\" Description of ENV_VAR_1
.\" .It Ev ENV_VAR_2
.\" Description of ENV_VAR_2
.\" .El                      
.Sh FILES                \" File used or created by the topic of the man page
.\".Bl -tag -width "~/Library/Logs/ImportExport" -compact
.\".It Pa /usr/bin/dsimport
.\".It Pa ~/Library/Logs/ImportExport
.\"slapconfig description
.\" .Sh DIAGNOSTICS       \" May not be needed
.\" .Bl -diag
.\" .It Diagnostic Tag
.\" Diagnostic informtion here.
.\" .It Diagnostic Tag
.\" Diagnostic informtion here.
.\" .El
.\" List links in ascending order by section, alphabetically within a section.
.\" Please do not reference files that do not exist without filing a bug report
.Xr DirectoryService 1
.\" .Sh BUGS              \" Document known, unremedied bugs 
.\" .Sh HISTORY           \" Document history if command behaves in a unique manner