ArchivialPowerShell.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>ArchivialPowerShell</name> </assembly> <members> <member name="T:ArchivialPowerShell.Functions.Public.GetArchivialCloudBackupOptionsCommand"> <summary> <para type="synopsis">Gets the application options for Archivial Cloud Backup.</para> <para type="description">Gets the application options for Archivial Cloud Backup. To change existing options, run Set-ArchivialCloudBackupOptions</para> </summary> <example> <code>C:\> Get-ArchivialCloudBackupOptions</code> <para>Returns the application options for Archivial Cloud Backup.</para> <para></para> </example> </member> <member name="M:ArchivialPowerShell.Functions.Public.GetArchivialCloudBackupOptionsCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.GetArchivialCloudBackupOptionsCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.GetArchivialCloudBackupStatusCommand"> <summary> <para type="synopsis">Returns the current status of the cloud backup progress.</para> <para type="description">Returns the current status of the cloud backup progress. It includes details such as how many files are backed up, remaining, and percentage complete.</para> </summary> <example> <code>C:\> Get-ArchivialCloudBackupStatus</code> <para>Returns the current status of the cloud backup progress.</para> <para></para> </example> </member> <member name="M:ArchivialPowerShell.Functions.Public.GetArchivialCloudBackupStatusCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.GetArchivialCloudBackupStatusCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.GetArchivialNetworkCredentialsCommand"> <summary> <para type="synopsis">Returns all of the saved Network Credentials used to connect to Network Sources.</para> <para type="description">Some Network Sources (UNC Paths) being monitored for backup will require authentication (username and password). This command will return the list of named credentials that have been saved.</para> <para type="description">Note: Only the name of the credential will be returned. The encrypted username and password values will not be returned in the output.</para> <para type="description">The output from this command can be piped to the Remove-ArchivialNetworkCredential cmdlet.</para> </summary> <example> <code>C:\> Get-ArchivialNetworkCredentials</code> <para>Returns all of the configured Network Credentials saved in the system.</para> <para></para> </example> </member> <member name="M:ArchivialPowerShell.Functions.Public.GetArchivialNetworkCredentialsCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.GetArchivialNetworkCredentialsCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.GetArchivialProvidersCommand"> <summary> <para type="synopsis">Returns all of the configured Archivial Providers.</para> <para type="description">Returns all of the configured Archivial Providers. An Archivial Provider is a connection to an external service for either cloud storage (ex: Azure, AWS) or message notifications (ex: Sendgrid email, Twilio SMS/text).</para> <para type="description">Note: Only the name and ID of the provider will be returned. The encrypted secure setting values will not returned in the output.</para> <para type="description">The output from this command can be piped to the Remove-ArchivialProvider cmdlet.</para> </summary> <example> <code>C:\> Get-ArchivialProviders</code> <para>Returns all of the configured Archivial Providers.</para> <para></para> </example> </member> <member name="M:ArchivialPowerShell.Functions.Public.GetArchivialProvidersCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.GetArchivialProvidersCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.RemoveArchivialLocalSourceCommand"> <summary> <para type="synopsis">Removes the specified Local Source.</para> <para type="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.</para> <para type="description">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.</para> <para type="description">To view existing Local Sources, run Get-ArchivialLocalSource. This command supports piping from Get-ArchivialLocalSource or manual invoke from the specified source ID.</para> </summary> <example> <code>C:\> Remove-ArchivialLocalSource -ID 3</code> <para>Removes the Local Source with the specified ID.</para> <para></para> </example> <example> <code>C:\> Get-ArchivialLocalSource | Where Path -like "*C:\users\test\documents*" | Remove-ArchivialLocalSource</code> <para>Removes any configured Local Source that matches a path containing the specified filter (using the pipeline scenario).</para> <para></para> </example> </member> <member name="P:ArchivialPowerShell.Functions.Public.RemoveArchivialLocalSourceCommand.SourceID"> <summary> <para type="description">Specify the ID of the Local Source to remove.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.RemoveArchivialLocalSourceCommand.LocalSource"> <summary> <para type="description">Specify the object (from pipeline) to remove.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.RemoveArchivialLocalSourceCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.RemoveArchivialLocalSourceCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.RemoveArchivialNetworkCredentialCommand"> <summary> <para type="synopsis">Removes the stored network credential used for connecting to network resources.</para> <para type="description">Authenticated Network Source locations have an encrypted credential stored with them. This command is used to remove that stored credential.</para> <para type="description">To view existing network credentials, run Get-ArchivialNetworkCredentials. This command supports piping from Get-ArchivialNetworkCredentials or manual invoke from credential name</para> </summary> <example> <code>C:\> Remove-ArchivialNetworkCredential -CredentialName "drobo-nas"</code> <para>Removes the stored network credential with the specified name.</para> <para></para> </example> <example> <code>C:\> Get-ArchivialNetworkCredentials | Where CredentialName -eq "drobo-nas" | Remove-ArchivialNetworkCredential</code> <para>Removes the stored network credential, but using the pipeline scenario.</para> <para></para> </example> </member> <member name="P:ArchivialPowerShell.Functions.Public.RemoveArchivialNetworkCredentialCommand.CredentialName"> <summary> <para type="description">Specify the name of the credential to remove.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.RemoveArchivialNetworkCredentialCommand.NetCredential"> <summary> <para type="description">Specify the object (from pipeline) to remove.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.RemoveArchivialNetworkCredentialCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.RemoveArchivialNetworkCredentialCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.RemoveArchivialNetworkSourceCommand"> <summary> <para type="synopsis">Removes the specified Network Source.</para> <para type="description">A Network Source is a folder on your network (referenced by UNC Path) that Archivial backs up and automatically monitors for new and updated files.</para> <para type="description">Removing a Network 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.</para> <para type="description">To view existing Network Sources, run Get-ArchivialNetworkSource. This command supports piping from Get-ArchivialNetworkSource or manual invoke from the specified source ID.</para> </summary> <example> <code>C:\> Remove-ArchivialNetworkSource -ID 3</code> <para>Removes the Network Source with the specified ID.</para> <para></para> </example> <example> <code>C:\> Get-ArchivialNetworkSource | Where Path -like "*\\drobo-nas\documents*" | Remove-ArchivialNetworkSource</code> <para>Removes any configured Network Source that matches a path containing the specified filter (using the pipeline scenario).</para> <para></para> </example> </member> <member name="P:ArchivialPowerShell.Functions.Public.RemoveArchivialNetworkSourceCommand.SourceID"> <summary> <para type="description">Specify the ID of the Network Source to remove.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.RemoveArchivialNetworkSourceCommand.NetworkSource"> <summary> <para type="description">Specify the object (from pipeline) to remove.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.RemoveArchivialNetworkSourceCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.RemoveArchivialNetworkSourceCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.RemoveArchivialProviderCommand"> <summary> <para type="synopsis">Removes the configured storage or messaging provider.</para> <para type="description">Providers are used to connect to external services for cloud storage backup or message notifications.</para> <para type="description">Removing a cloud storage provider means that new or updated files will not be backed up to that provider anymore, but existing files stored at that provider will remain.</para> <para type="description">To view existing configured providers, run Get-ArchivialProviders. This command supports piping from Get-ArchivialProviders or manual invoke from the provider name.</para> </summary> <example> <code>C:\> Remove-ArchivialProvider -ProviderName "Azure"</code> <para>Removes the configured Azure provider.</para> <para></para> </example> <example> <code>C:\> Get-ArchivialProvider | Where Name -eq "Azure" | Remove-ArchivialProvider</code> <para>Removes the configured Azure provider, but using the pipeline scenario.</para> <para></para> </example> </member> <member name="P:ArchivialPowerShell.Functions.Public.RemoveArchivialProviderCommand.ProviderName"> <summary> <para type="description">Specify the name of the provider to remove.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.RemoveArchivialProviderCommand.Provider"> <summary> <para type="description">Specify the object (from pipeline) to remove.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.RemoveArchivialProviderCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.RemoveArchivialProviderCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.SetArchivialCloudBackupOptionsCommand"> <summary> <para type="synopsis">Sets one or more application options for Archivial Cloud Backup.</para> <para type="description">Specify at least one option to change. To see existing options, run Get-ArchivialCloudBackupOptions</para> </summary> <example> <code>C:\> Set-ArchivialCloudBackupOptions -LogFilesRetentionInDays 60</code> <para>Sets the local log file retention to 60 days.</para> <para></para> </example> <example> <code>C:\> Set-ArchivialCloudBackupOptions -LowPriorityScanFrequencyInHours 4 -MedPriorityScanFrequencyInHours 2</code> <para>Sets low priority and medium priority scanning frequencies.</para> <para></para> </example> <example> <code>C:\> Set-ArchivialCloudBackupOptions -StatusUpdateSchedule "0 8 * * *"</code> <para>Sets the status update notification schedule to once per day at 8am.</para> <para></para> </example> <example> <code>C:\> Set-ArchivialCloudBackupOptions -MasterExclusionMatches "^._",".DS_Store"</code> <para>Sets the master exclusions to exlude Mac OS related file system metadata files.</para> <para></para> </example> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialCloudBackupOptionsCommand.LogFilesRetentionInDays"> <summary> <para type="description">Optionally specify the length of time (in days) that locally stored log files should be retained.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialCloudBackupOptionsCommand.DatabaseBackupsRetentionInDays"> <summary> <para type="description">Optionally specify the length of time (in days) that locally stored database backups should be retrained.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialCloudBackupOptionsCommand.BackupEngineInstancesCount"> <summary> <para type="description">Optionally specify the number of concurrent backup engine instances to run.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialCloudBackupOptionsCommand.LowPriorityScanFrequencyInHours"> <summary> <para type="description">Optionally specify how often (in hours) that low-priority folder scans should be performed.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialCloudBackupOptionsCommand.MedPriorityScanFrequencyInHours"> <summary> <para type="description">Optionally specify how often (in hours) that medium-priority folder scans should be performed.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialCloudBackupOptionsCommand.HighPriorityScanFrequencyInHours"> <summary> <para type="description">Optionally specify how often (in hours) that high-priority folder scans should be performed.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialCloudBackupOptionsCommand.ProtectionIV"> <summary> <para type="description">Optionally specify the local encryption initialization vector key. Key should be a crypto-random 16-byte array, expressed as a base64 encoded string.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialCloudBackupOptionsCommand.StatusUpdateSchedule"> <summary> <para type="description">Optionally specify the schedule for when status notification messages should be sent. Expressed as a cron schedule.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialCloudBackupOptionsCommand.MasterExclusionMatches"> <summary> <para type="description">Optionally specify a set of regex match exclusions that should apply to all scanned folders.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.SetArchivialCloudBackupOptionsCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.SetArchivialCloudBackupOptionsCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.SetArchivialAzureProviderOptionsCommand"> <summary> <para type="synopsis">Configures the Azure cloud storage provider as a backup destination.</para> <para type="description">In order to backup files to the cloud, at least one cloud storage provider must be configured. This command will enable the Azure cloud storage provider for this purpose.</para> <para type="description">This command assumes that you have already deployed an Azure storage account and have the access token ready.</para> <para type="description">If your access token has changed, you can safely re-run this command with the new token, and then restart the Archivial Cloud Backup service for the changes to take effect.</para> <para type="description">If you would like to disable this provider, please run the Remove-ArchivialProvider cmdlet.</para> <para type="description">All provided options here (account name and token) are encrypted before saving to the database.</para> </summary> <example> <code>C:\> Set-ArchivialAzureProviderOptions -AzureStorageAccountName "myaccount" -AzureStorageAccountToken "--my token--"</code> <para>Configures Azure as a cloud storage backup destination.</para> <para></para> </example> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialAzureProviderOptionsCommand.AzureStorageAccountName"> <summary> <para type="description">Specify the name of the Azure storage account to upload backup data to.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialAzureProviderOptionsCommand.AzureStorageAccountToken"> <summary> <para type="description">Specify the access token of the Azure storage account.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.SetArchivialAzureProviderOptionsCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.SetArchivialAzureProviderOptionsCommand.#ctor(ArchivialLibrary.Database.IClientDatabase,ArchivialLibrary.Secrets.ISecretStore)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> <param name="secretStore"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.SetArchivialTwilioProviderOptionsCommand"> <summary> <para type="synopsis">Configures the Twilio messaging provider as a status update recipient.</para> <para type="description">Messaging providers are an optional way to be automatically notified of your backup status/progress. This command configures the Twilio (SMS/Text) provider for that purpose.</para> <para type="description">This command assumes that you have already setup a Twilio account, phone number, and have the required access token details ready. Twilio expects phone numbers to be provided in the E.164 format.</para> <para type="description">If your access token has changed, you can safely re-run this command with the new token, and then restart the Archivial Cloud Backup service for the changes to take effect.</para> <para type="description">If you would like to disable this provider, please run the Remove-ArchivialProvider cmdlet.</para> <para type="description">All provided options here (ex: account name, token, phone numbers) are encrypted before saving to the database.</para> </summary> <example> <code>C:\> Set-ArchivialTwilioProviderOptions -TwilioAccountID "myaccount" -TwilioAuthToken "--token--" -TwilioSourcePhone "+12065551234" -TwilioDestinationPhones @("+12065554567","+12065556789")</code> <para>Configures Twilio as a status messaging recipient.</para> <para></para> </example> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialTwilioProviderOptionsCommand.TwilioAccountID"> <summary> <para type="description">Specify the Twilio Account ID.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialTwilioProviderOptionsCommand.TwilioAuthToken"> <summary> <para type="description">Specify the Twilio Authentication token.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialTwilioProviderOptionsCommand.TwilioSourcePhone"> <summary> <para type="description">Specify the Twilio phone number (sender).</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialTwilioProviderOptionsCommand.TwilioDestinationPhones"> <summary> <para type="description">Specify the phone number(s) to send updates to.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.SetArchivialTwilioProviderOptionsCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.SetArchivialTwilioProviderOptionsCommand.#ctor(ArchivialLibrary.Database.IClientDatabase,ArchivialLibrary.Secrets.ISecretStore)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> <param name="secretStore"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.StartArchivialLocalSourceRescanCommand"> <summary> <para type="synopsis">Forces the re-scan of a Local Source being monitored by Archivial.</para> <para type="description">All sources are monitored for new or updated files on a regular schedule. This cmdlet is used to request an immediate rescan, outside of its regular schedule. The rescan will start as soon as there is scanning engine availability.</para> <para type="description">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.</para> <para type="description">Please see the Get-ArchivialLocalSources command to find the ID of an existing source you would like to rescan.</para> </summary> <example> <code>C:\> Start-ArchivialLocalSourceRescan -SourceID 2</code> <para>Forces a rescan of the Local Source with the specified ID.</para> <para></para> </example> <example> <code>C:\> Get-ArchivialLocalSources | Start-ArchivialLocalSourceRescan</code> <para>Forces a rescan of all defined Local Sources being monitored by Archivial.</para> <para></para> </example> <example> <code>C:\> Get-ArchivialLocalSources | Where Path -like "*D:\temp*" | Start-ArchivialLocalSourceRescan</code> <para>Forces a rescan of any Local Sources that match the path filter.</para> <para></para> </example> </member> <member name="P:ArchivialPowerShell.Functions.Public.StartArchivialLocalSourceRescanCommand.SourceID"> <summary> <para type="description">Specify the ID of the Local Source to rescan.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.StartArchivialLocalSourceRescanCommand.LocalSource"> <summary> <para type="description">Specify the Local Source object to rescan.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.StartArchivialLocalSourceRescanCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.StartArchivialLocalSourceRescanCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.StartArchivialNetworkSourceRescanCommand"> <summary> <para type="synopsis">Forces the re-scan of a Network Source being monitored by Archivial.</para> <para type="description">All sources are monitored for new or updated files on a regular schedule. This cmdlet is used to request an immediate rescan, outside of its regular schedule. The rescan will start as soon as there is scanning engine availability.</para> <para type="description">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.</para> <para type="description">Please see the Get-ArchivialNetworkSources command to find the ID of an existing source you would like to rescan.</para> </summary> <example> <code>C:\> Start-ArchivialNetworkSourceRescan -SourceID 2</code> <para>Forces a rescan of the Network Source with the specified ID.</para> <para></para> </example> <example> <code>C:\> Get-ArchivialNetworkSources | Start-ArchivialNetworkSourceRescan</code> <para>Forces a rescan of all defined Network Sources being monitored by Archivial.</para> <para></para> </example> <example> <code>C:\> Get-ArchivialNetworkSources | Where Path -like "*\\drobo-nas\*" | Start-ArchivialNetworkSourceRescan</code> <para>Forces a rescan of any Network Sources that match the path filter.</para> <para></para> </example> </member> <member name="P:ArchivialPowerShell.Functions.Public.StartArchivialNetworkSourceRescanCommand.SourceID"> <summary> <para type="description">Specify the ID of the Network Source to rescan.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.StartArchivialNetworkSourceRescanCommand.NetworkSource"> <summary> <para type="description">Specify the Network Source object to rescan.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.StartArchivialNetworkSourceRescanCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.StartArchivialNetworkSourceRescanCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.AddArchivialLocalSourceCommand"> <summary> <para type="synopsis">Adds a local folder to the Archivial backup folders list.</para> <para type="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.</para> <para type="description">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.</para> <para type="description">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.</para> </summary> <example> <code>C:\> Add-ArchivialLocalSource -FolderPath "C:\users\test\documents" -Priority High -Revisions 3</code> <para>Adds the specified folder to backup with high priority, and to retain up to 3 revisions of file history.</para> <para></para> </example> <example> <code>C:\> Add-ArchivialLocalSource -FolderPath "C:\users\test\music\playlists" -Priority High -Revisions 3 -MatchFilter *.m3u</code> <para>Adds the specified folder to backup with high priority, but only files that match the wildcard extension filter.</para> <para></para> </example> </member> <member name="P:ArchivialPowerShell.Functions.Public.AddArchivialLocalSourceCommand.FolderPath"> <summary> <para type="description">Specify the folder path that should be backed up and monitored.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.AddArchivialLocalSourceCommand.Priority"> <summary> <para type="description">Specify the priority of this source (which determines how frequently it will be scanned for changes).</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.AddArchivialLocalSourceCommand.Revisions"> <summary> <para type="description">Specify the maximum number of revisions to store in the cloud for the files in this folder.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.AddArchivialLocalSourceCommand.MatchFilter"> <summary> <para type="description">Optionally specify a wildcard expression to filter the files to be backed up or monitored.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.AddArchivialLocalSourceCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.AddArchivialLocalSourceCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="M:ArchivialPowerShell.Functions.Public.AddArchivialLocalSourceCommand.ProcessRecord"> <summary> Cmdlet invocation. </summary> </member> <member name="T:ArchivialPowerShell.Functions.Public.SetArchivialNetworkCredentialCommand"> <summary> <para type="synopsis">Saves the credentials required to connect to an authenticated network resource (such as a UNC path share).</para> <para type="description">Network Sources can be authenticated (require username/password), or unauthenticated (open access). If this Network Source requires authenticated access, you must provide use this command to pre-store the authentication details so the backup engine can connect to the resource.</para> <para type="description">The credential username and password are both encrypted and saved to the database.</para> </summary> <example> <code>C:\> Set-ArchivialNetworkCredential -CredentialName "drobo-device" -ShareUser "drobo-private-user" -SharePassword ****</code> <para>Encrypts and stores the network resource credentials in the database.</para> <para></para> </example> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialNetworkCredentialCommand.CredentialName"> <summary> <para type="description">Specify the friendly name (description) to refer to this stored credential.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialNetworkCredentialCommand.ShareUsername"> <summary> <para type="description">Specify the username required to connect to the network resource.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.SetArchivialNetworkCredentialCommand.SharePassword"> <summary> <para type="description">Specify the password required to connect to the network resource.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.SetArchivialNetworkCredentialCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.SetArchivialNetworkCredentialCommand.#ctor(ArchivialLibrary.Database.IClientDatabase,ArchivialLibrary.Secrets.ISecretStore)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> <param name="secretStore"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.AddArchivialNetworkSourceCommand"> <summary> <para type="synopsis">Adds a network (UNC path) folder to the Archivial backup folders list.</para> <para type="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.</para> <para type="description">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.</para> <para type="description">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.</para> <para type="description">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.</para> </summary> <example> <code>C:\> Add-ArchivialNetworkSource -UncPath "\\drobo-nas-device\public\media\music" -Priority Medium -Revisions 1</code> <para>Adds the specified unauthenticated network share to backup.</para> <para></para> </example> <example> <code>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</code> <para>Encrypts and stores the network resource credentials, and then adds the specified authenticated network share to backup.</para> <para></para> </example> </member> <member name="P:ArchivialPowerShell.Functions.Public.AddArchivialNetworkSourceCommand.UncPath"> <summary> <para type="description">Specify the UNC folder path that should be backed up and monitored.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.AddArchivialNetworkSourceCommand.Priority"> <summary> <para type="description">Specify the priority of this source (which determines how frequently it will be scanned for changes).</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.AddArchivialNetworkSourceCommand.Revisions"> <summary> <para type="description">Specify the maximum number of revisions to store in the cloud for the files in this folder.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.AddArchivialNetworkSourceCommand.CredentialName"> <summary> <para type="description">Optionally specify the name of a stored credential to authenticate this share with.</para> </summary> </member> <member name="P:ArchivialPowerShell.Functions.Public.AddArchivialNetworkSourceCommand.MatchFilter"> <summary> <para type="description">Optionally specify a wildcard expression to filter the files to be backed up or monitored.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.AddArchivialNetworkSourceCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.AddArchivialNetworkSourceCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.GetArchivialLocalSourcesCommand"> <summary> <para type="synopsis">Returns all of the Local Source folders being monitored by Archivial.</para> <para type="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.</para> <para type="description">The output from this command can be piped to the Remove-ArchivialLocalSource cmdlet.</para> </summary> <example> <code>C:\> Get-ArchivialLocalSources</code> <para>Returns all of the Local Source folders being monitored by Archivial.</para> <para></para> </example> </member> <member name="M:ArchivialPowerShell.Functions.Public.GetArchivialLocalSourcesCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.GetArchivialLocalSourcesCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.GetArchivialNetworkSourcesCommand"> <summary> <para type="synopsis">Returns all of the Network Source folders being monitored by Archivial.</para> <para type="description">A Network Source is a folder on your network (referenced by UNC Path) that Archivial backs up and automatically monitors for new and updated files.</para> <para type="description">The output from this command can be piped to the Remove-ArchivialNetworkSource cmdlet.</para> </summary> <example> <code>C:\> Get-ArchivialNetworkSources</code> <para>Returns all of the Network Source folders being monitored by Archivial.</para> <para></para> </example> </member> <member name="M:ArchivialPowerShell.Functions.Public.GetArchivialNetworkSourcesCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.GetArchivialNetworkSourcesCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Functions.Public.InstallArchivialCloudBackupCommand"> <summary> <para type="synopsis">Installs the Archivial Cloud Backup software on this computer.</para> <para type="description">Installs the Archivial Cloud Backup software on this computer. The default installation will be placed in the Program Files directory, but this can optionally be changed by specifying the -InstallDirectory parameter.</para> <para type="description">This command requires an elevated (run-as administrator) PowerShell prompt to complete. It will also prompt for comfirmation unless the -Force switch is applied.</para> </summary> <example> <code>C:\> Install-ArchivialCloudBackup</code> <para>Starts the installation with default options. The user will be prompted for confirmation.</para> <para></para> </example> <example> <code>C:\> Install-ArchivialCloudBackup -InstallDirectory "D:\Applications\Archivial Cloud Backup" -Force</code> <para>Starts the installation to the custom directory and suppresses the confirmation prompt.</para> <para></para> </example> </member> <member name="P:ArchivialPowerShell.Functions.Public.InstallArchivialCloudBackupCommand.InstallDirectory"> <summary> <para type="description">Specify a custom installation directory, otherwise the default Program Files location will be used.</para> </summary> </member> <member name="F:ArchivialPowerShell.Functions.Public.InstallArchivialCloudBackupCommand.Force"> <summary> <para type="description">Suppresses the confirmation prompt.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.InstallArchivialCloudBackupCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="T:ArchivialPowerShell.Functions.Public.UninstallArchivialCloudBackupCommand"> <summary> <para type="synopsis">Uninstalls the Archivial Cloud Backup software from this computer.</para> <para type="description">Uninstalls the Archivial Cloud Backup software from this computer. This will permenantly delete the installation folder, state database, and log files. This action is not reversable.</para> <para type="description">Although all local installation data is deleted, any of the data already backed up to a cloud provider will not be removed. You must remove that manually if you wish to delete that data.</para> <para type="description">This command requires an elevated (run-as administrator) PowerShell prompt to complete. It will also prompt for comfirmation unless the -Force switch is applied.</para> </summary> <example> <code>C:\> Uninstall-ArchivialCloudBackup</code> <para>Starts the uninstallation process. The user will be prompted for confirmation.</para> <para></para> </example> <example> <code>C:\> Uninstall-ArchivialCloudBackup -Force</code> <para>Starts the uninstallation and suppresses the confirmation prompt.</para> <para></para> </example> </member> <member name="F:ArchivialPowerShell.Functions.Public.UninstallArchivialCloudBackupCommand.Force"> <summary> <para type="description">Suppresses the confirmation prompt.</para> </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.UninstallArchivialCloudBackupCommand.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Functions.Public.UninstallArchivialCloudBackupCommand.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> A secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="T:ArchivialPowerShell.Utility.BaseArchivialCmdlet"> <summary> A base cmdlet object that provides common functionality. </summary> </member> <member name="P:ArchivialPowerShell.Utility.BaseArchivialCmdlet.Database"> <summary> A reference to the client database. </summary> </member> <member name="P:ArchivialPowerShell.Utility.BaseArchivialCmdlet.SecretStore"> <summary> A reference to the secret store. </summary> </member> <member name="P:ArchivialPowerShell.Utility.BaseArchivialCmdlet.ActivityName"> <summary> The name of this cmdlet activity for progress tracking. </summary> </member> <member name="P:ArchivialPowerShell.Utility.BaseArchivialCmdlet.ActivityID"> <summary> The name of this cmdlet activity ID for progress tracking. </summary> </member> <member name="M:ArchivialPowerShell.Utility.BaseArchivialCmdlet.WriteProgress(System.Int32,System.String)"> <summary> Writes progress output. </summary> <param name="Percentage"></param> <param name="Description"></param> </member> <member name="M:ArchivialPowerShell.Utility.BaseArchivialCmdlet.WriteVerboseAndProgress(System.Int32,System.String)"> <summary> Writes progress output and verbose logs at the same time. </summary> <param name="Percentage"></param> <param name="Description"></param> </member> <member name="M:ArchivialPowerShell.Utility.BaseArchivialCmdlet.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:ArchivialPowerShell.Utility.BaseArchivialCmdlet.#ctor(ArchivialLibrary.Database.IClientDatabase)"> <summary> Secondary constructor for dependency injection. </summary> <param name="database"></param> </member> <member name="M:ArchivialPowerShell.Utility.BaseArchivialCmdlet.#ctor(ArchivialLibrary.Database.IClientDatabase,ArchivialLibrary.Secrets.ISecretStore)"> <summary> Secondary constructor for dependency injection. </summary> <param name="database"></param> <param name="secretStore"></param> </member> <member name="M:ArchivialPowerShell.Utility.BaseArchivialCmdlet.GetDatabaseConnection"> <summary> Returns the database connection. </summary> <returns></returns> </member> <member name="M:ArchivialPowerShell.Utility.BaseArchivialCmdlet.GetSecretStore"> <summary> Returns the secret store. </summary> <returns></returns> </member> <member name="M:ArchivialPowerShell.Utility.Installation.CreateCoreSettings(System.String)"> <summary> Sets the core application settings. </summary> <param name="installationDirectory"></param> </member> <member name="M:ArchivialPowerShell.Utility.Installation.CreateEventLogSource"> <summary> Creates a custom event log and event source. </summary> </member> <member name="M:ArchivialPowerShell.Utility.Installation.CreateInstallationDirectories"> <summary> Creates the installation directories. </summary> </member> <member name="M:ArchivialPowerShell.Utility.Installation.CopyProgramFiles"> <summary> Copies the program files to the installation directory. </summary> </member> <member name="M:ArchivialPowerShell.Utility.Installation.CreateClientService"> <summary> Creates the client windows service. </summary> </member> <member name="M:ArchivialPowerShell.Utility.Installation.StartClientService"> <summary> Starts the client service. </summary> </member> <member name="M:ArchivialPowerShell.Utility.Installation.WaitForFirstTimeSetup"> <summary> Waits until the first time setup/init is completed. </summary> <remarks> First time setup is done once the database is initialized, so check for the required publish flag/option state. </remarks> </member> <member name="M:ArchivialPowerShell.Utility.Uninstallation.StopClientService"> <summary> Stops the client windows service. </summary> </member> <member name="M:ArchivialPowerShell.Utility.Uninstallation.DeleteClientService"> <summary> Removes the client windows service. </summary> </member> <member name="M:ArchivialPowerShell.Utility.Uninstallation.DeleteInstallationDirectories"> <summary> Removes the installation directories. </summary> </member> <member name="M:ArchivialPowerShell.Utility.Uninstallation.DeleteEventLogContents"> <summary> Removes the event log source. </summary> </member> <member name="M:ArchivialPowerShell.Utility.Uninstallation.DeleteCoreSettings"> <summary> Removes the core settings. </summary> </member> </members> </doc> |