< Back
Add-ArchivialNetworkSource
Post
NAME Add-ArchivialNetworkSource
SYNOPSIS
Adds a network (UNC path) folder to the Archivial backup folders list.
SYNTAX
Add-ArchivialNetworkSource -Priority <string> -Revisions <int> -UncPath <string> [-CredentialName <string>]
[-MatchFilter <string>] [<CommonParameters>]
DESCRIPTION
A Network Source is a folder on your network (referenced by UNC Path) that you would like Archivial to backup and
automatically monitor for new and updated files.
Network Sources can be authenticated (require username/password), or unauthenticated (open access). If this
Network Source requires authenticated access, you must provide the name of an already saved Network Credential
(see examples). Network sources can use either a DNS or IP Address for the host.
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
-UncPath <string>
Specify the UNC 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
-CredentialName <string>
Optionally specify the name of a stored credential to authenticate this share with.
Required? false
Position? named
Default value
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-ArchivialNetworkSource -UncPath "\\\\drobo-nas-device\\public\\media\\music" -Priority Medium -Revisions 1
Adds the specified unauthenticated network share to backup.
---------- EXAMPLE 2 ----------
C:\\> Set-ArchivialNetworkCredential -CredentialName "drobo-device" -ShareUser "drobo-private-user" -SharePassword
****; Add-ArchivialNetworkSource -UncPath "\\\\drobo-nas-device\\private\\documents\\taxes" -CredentialName
"drobo-device" -Priority Medium -Revisions 4 -MatchFilter *.pdf
Encrypts and stores the network resource credentials, and then adds the specified authenticated network share to
backup.
RELATED LINKS
SYNOPSIS
Adds a network (UNC path) folder to the Archivial backup folders list.
SYNTAX
Add-ArchivialNetworkSource -Priority <string> -Revisions <int> -UncPath <string> [-CredentialName <string>]
[-MatchFilter <string>] [<CommonParameters>]
DESCRIPTION
A Network Source is a folder on your network (referenced by UNC Path) that you would like Archivial to backup and
automatically monitor for new and updated files.
Network Sources can be authenticated (require username/password), or unauthenticated (open access). If this
Network Source requires authenticated access, you must provide the name of an already saved Network Credential
(see examples). Network sources can use either a DNS or IP Address for the host.
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
-UncPath <string>
Specify the UNC 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
-CredentialName <string>
Optionally specify the name of a stored credential to authenticate this share with.
Required? false
Position? named
Default value
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-ArchivialNetworkSource -UncPath "\\\\drobo-nas-device\\public\\media\\music" -Priority Medium -Revisions 1
Adds the specified unauthenticated network share to backup.
---------- EXAMPLE 2 ----------
C:\\> Set-ArchivialNetworkCredential -CredentialName "drobo-device" -ShareUser "drobo-private-user" -SharePassword
****; Add-ArchivialNetworkSource -UncPath "\\\\drobo-nas-device\\private\\documents\\taxes" -CredentialName
"drobo-device" -Priority Medium -Revisions 4 -MatchFilter *.pdf
Encrypts and stores the network resource credentials, and then adds the specified authenticated network share to
backup.
RELATED LINKS