Export-R1DirectoryLdif
Export-R1DirectoryLdif
SYNOPSIS
Exports directory entries to an LDIF file on the server.
SYNTAX
Export-R1DirectoryLdif [-sourceDn] <String> [-scope] <String> [-fileName] <String> [[-targetDn] <String>]
[[-maxEntries] <Int32>] [[-isExportForReplication] <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Exports the entries beneath a DN to an LDIF file held on the server. Use Get-R1DirectoryLdifFile to list what has been exported, or Save-R1DirectoryLdif to download instead of storing.
EXAMPLES
Example 1
Export-R1DirectoryLdif -sourceDn 'o=companydirectory' -scope 'SUB' -fileName 'companydirectory.ldif'
Exports a subtree to a file on the server.
Example 2
Export-R1DirectoryLdif -sourceDn 'o=companydirectory' -scope 'SUB' -fileName 'companydirectory.ldif'
do { Start-Sleep -Seconds 5 } until (Get-R1DirectoryLdifFile | Where-Object { $PSItem -eq 'companydirectory.ldif' })
Exports a subtree and waits for the file to appear. The export runs in the background, so the file is not listed straight away.
Example 3
Export-R1DirectoryLdif -sourceDn 'o=companydirectory' -scope 'SUB' -fileName 'copy.ldif' -targetDn 'o=copy'
Exports a subtree, rewriting the entries under a different DN.
PARAMETERS
-sourceDn
The DN to export from.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-scope
How far beneath the DN to search. BASE returns the entry alone, ONE its children, SUB the whole subtree.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-fileName
The name of the LDIF file, which must end .ldif or .ldifz.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-targetDn
The DN to rewrite the exported entries under.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-maxEntries
The greatest number of entries to export.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-isExportForReplication
Produces an export suitable for seeding a replica.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
None
OUTPUTS
System.Void
NOTES
The export runs asynchronously. The file does not appear in the output of Get-R1DirectoryLdifFile until the server has finished writing it.