< Back

Remove-ArchivialLocalSource

Fri Jan 10, 2020 8:44 pm

NAME Remove-ArchivialLocalSource



SYNOPSIS

Removes the specified Local Source.





SYNTAX

Remove-ArchivialLocalSource -SourceID <int> [<CommonParameters>]



Remove-ArchivialLocalSource -LocalSource <LocalSourceLocation> [<CommonParameters>]





DESCRIPTION

A Local Source is a folder on your computer (or a directly attached external drive) that Archivial backs up and

automatically monitors for new and updated files.



Removing a Local Source means that new or updated files from that location will not be backed up anymore, but

existing files already backed up to cloud storage will remain.



To view existing Local Sources, run Get-ArchivialLocalSource. This command supports piping from

Get-ArchivialLocalSource or manual invoke from the specified source ID.





PARAMETERS

-SourceID <int>

Specify the ID of the Local Source to remove.



Required? true

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-LocalSource <LocalSourceLocation>

Specify the object (from pipeline) to remove.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

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.LocalSourceLocation

Specify the object (from pipeline) to remove.





OUTPUTS



---------- EXAMPLE 1 ----------



C:\\> Remove-ArchivialLocalSource -ID 3



Removes the Local Source with the specified ID.



---------- EXAMPLE 2 ----------



C:\\> Get-ArchivialLocalSource | Where Path -like "*C:\\users\\test\\documents*" | Remove-ArchivialLocalSource



Removes any configured Local Source that matches a path containing the specified filter (using the pipeline

scenario).





RELATED LINKS