< Back
Add-ArchivialLocalSource
Post
NAME Add-ArchivialLocalSource
SYNOPSIS
Adds a local folder to the Archivial backup folders list.
SYNTAX
Add-ArchivialLocalSource -FolderPath <string> -Priority <string> -Revisions <int> [-MatchFilter <string>]
[<CommonParameters>]
DESCRIPTION
A Local Source is a folder on your computer (or a directly attached external drive) that you would like Archivial
to backup and automatically monitor for new and updated files.
The priority of the source determines how frequently it will be scanned for changes. The automated scanning
schedule for Low priority sources is once every 48 hours. Medium priority sources are scanned every 12 hours. High
priority sources are scanned every hour.
The optional MatchFilter parameter allows you to narrow the scope of files in the folder to be monitored. For
example, by file extension. Any windows file path wildcard expression will be accepted here.
PARAMETERS
-FolderPath <string>
Specify the folder path that should be backed up and monitored.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Priority <string>
Specify the priority of this source (which determines how frequently it will be scanned for changes).
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Revisions <int>
Specify the maximum number of revisions to store in the cloud for the files in this folder.
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-MatchFilter <string>
Optionally specify a wildcard expression to filter the files to be backed up or monitored.
Required? false
Position? named
Default value
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
OUTPUTS
---------- EXAMPLE 1 ----------
C:\\> Add-ArchivialLocalSource -FolderPath "C:\\users\\test\\documents" -Priority High -Revisions 3
Adds the specified folder to backup with high priority, and to retain up to 3 revisions of file history.
---------- EXAMPLE 2 ----------
C:\\> Add-ArchivialLocalSource -FolderPath "C:\\users\\test\\music\\playlists" -Priority High -Revisions 3 -MatchFilter
*.m3u
Adds the specified folder to backup with high priority, but only files that match the wildcard extension filter.
RELATED LINKS
SYNOPSIS
Adds a local folder to the Archivial backup folders list.
SYNTAX
Add-ArchivialLocalSource -FolderPath <string> -Priority <string> -Revisions <int> [-MatchFilter <string>]
[<CommonParameters>]
DESCRIPTION
A Local Source is a folder on your computer (or a directly attached external drive) that you would like Archivial
to backup and automatically monitor for new and updated files.
The priority of the source determines how frequently it will be scanned for changes. The automated scanning
schedule for Low priority sources is once every 48 hours. Medium priority sources are scanned every 12 hours. High
priority sources are scanned every hour.
The optional MatchFilter parameter allows you to narrow the scope of files in the folder to be monitored. For
example, by file extension. Any windows file path wildcard expression will be accepted here.
PARAMETERS
-FolderPath <string>
Specify the folder path that should be backed up and monitored.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Priority <string>
Specify the priority of this source (which determines how frequently it will be scanned for changes).
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Revisions <int>
Specify the maximum number of revisions to store in the cloud for the files in this folder.
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-MatchFilter <string>
Optionally specify a wildcard expression to filter the files to be backed up or monitored.
Required? false
Position? named
Default value
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
OUTPUTS
---------- EXAMPLE 1 ----------
C:\\> Add-ArchivialLocalSource -FolderPath "C:\\users\\test\\documents" -Priority High -Revisions 3
Adds the specified folder to backup with high priority, and to retain up to 3 revisions of file history.
---------- EXAMPLE 2 ----------
C:\\> Add-ArchivialLocalSource -FolderPath "C:\\users\\test\\music\\playlists" -Priority High -Revisions 3 -MatchFilter
*.m3u
Adds the specified folder to backup with high priority, but only files that match the wildcard extension filter.
RELATED LINKS