< Back
Find-ArchivialFilesToRestore
Post
NAME Find-ArchivialFilesToRestore
SYNOPSIS
Finds backup files that are available to restore.
SYNTAX
Find-ArchivialFilesToRestore -Source <SourceLocation> [-LimitResults <int>] [<CommonParameters>]
Find-ArchivialFilesToRestore -FileHash <string> [-LimitResults <int>] [<CommonParameters>]
Find-ArchivialFilesToRestore -MatchFilter <string> [-LimitResults <int>] [<CommonParameters>]
Find-ArchivialFilesToRestore -All <SwitchParameter> [<CommonParameters>]
DESCRIPTION
Backup files are available to restore if they have completed an upload to at least one cloud storage provider
account.
This command searches the backup index to find files that are eligible for restore and filters the result using
the specified options.
The output from this command can be passed into Start-ArchivialFileRestore, which is used to initiate the restore.
PARAMETERS
-Source <SourceLocation>
Specify a source location to search for files that can be restored.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-FileHash <string>
Specify a file hash to search for files that can be restored.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MatchFilter <string>
Specify a directory/file path filter to search for files that can be restored. This match behaves similar to a
'Contains' operation and supports the * wildcard.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LimitResults <int>
Optionally specify the maximum number of results to return from a search.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-All <SwitchParameter>
Specify this option to return all files eligible for restore, without any filtering.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
ArchivialLibrary.Folders.SourceLocation
Specify a source location to search for files that can be restored.
OUTPUTS
---------- EXAMPLE 1 ----------
C:\\> Find-ArchivialFilesToRestore -MatchFilter "*.docx" -LimitResults 100
Searches for any files that match the extension filter and limits the results to no more than 100 items.
---------- EXAMPLE 2 ----------
C:\\> Find-ArchivialFilesToRestore -MatchFilter "D:\\music\\*"
Searches for any files that contain a match to the specified path. Does not limit the number of results returned.
---------- EXAMPLE 3 ----------
C:\\> Get-ArchivialNetworkSource | Where Path -like "*\\\\drobo-nas\\documents*" | Find-ArchivialFilesToRestore
Searches for any files that originated from a Network source that matches the documents path filter.
---------- EXAMPLE 4 ----------
C:\\> Get-ArchivialLocalSource | Find-ArchivialFilesToRestore
Searches for any files that originated from any of the Local sources.
---------- EXAMPLE 5 ----------
C:\\> Find-ArchivialFilesToRestore -FileHash "A37CC82F2876DB6CF59BA29B4EB148C7BF5CC920"
Searches for any files that match the provided file hash.
RELATED LINKS
SYNOPSIS
Finds backup files that are available to restore.
SYNTAX
Find-ArchivialFilesToRestore -Source <SourceLocation> [-LimitResults <int>] [<CommonParameters>]
Find-ArchivialFilesToRestore -FileHash <string> [-LimitResults <int>] [<CommonParameters>]
Find-ArchivialFilesToRestore -MatchFilter <string> [-LimitResults <int>] [<CommonParameters>]
Find-ArchivialFilesToRestore -All <SwitchParameter> [<CommonParameters>]
DESCRIPTION
Backup files are available to restore if they have completed an upload to at least one cloud storage provider
account.
This command searches the backup index to find files that are eligible for restore and filters the result using
the specified options.
The output from this command can be passed into Start-ArchivialFileRestore, which is used to initiate the restore.
PARAMETERS
-Source <SourceLocation>
Specify a source location to search for files that can be restored.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-FileHash <string>
Specify a file hash to search for files that can be restored.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MatchFilter <string>
Specify a directory/file path filter to search for files that can be restored. This match behaves similar to a
'Contains' operation and supports the * wildcard.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LimitResults <int>
Optionally specify the maximum number of results to return from a search.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-All <SwitchParameter>
Specify this option to return all files eligible for restore, without any filtering.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
ArchivialLibrary.Folders.SourceLocation
Specify a source location to search for files that can be restored.
OUTPUTS
---------- EXAMPLE 1 ----------
C:\\> Find-ArchivialFilesToRestore -MatchFilter "*.docx" -LimitResults 100
Searches for any files that match the extension filter and limits the results to no more than 100 items.
---------- EXAMPLE 2 ----------
C:\\> Find-ArchivialFilesToRestore -MatchFilter "D:\\music\\*"
Searches for any files that contain a match to the specified path. Does not limit the number of results returned.
---------- EXAMPLE 3 ----------
C:\\> Get-ArchivialNetworkSource | Where Path -like "*\\\\drobo-nas\\documents*" | Find-ArchivialFilesToRestore
Searches for any files that originated from a Network source that matches the documents path filter.
---------- EXAMPLE 4 ----------
C:\\> Get-ArchivialLocalSource | Find-ArchivialFilesToRestore
Searches for any files that originated from any of the Local sources.
---------- EXAMPLE 5 ----------
C:\\> Find-ArchivialFilesToRestore -FileHash "A37CC82F2876DB6CF59BA29B4EB148C7BF5CC920"
Searches for any files that match the provided file hash.
RELATED LINKS