ArchivialPowerShell.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Set-ArchivialAzureProviderOptions --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ArchivialAzureProviderOptions</command:name> <command:verb>Set</command:verb> <command:noun>ArchivialAzureProviderOptions</command:noun> <maml:description> <maml:para>Configures the Azure cloud storage provider as a backup destination.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>This command assumes that you have already deployed an Azure storage account and have the access token ready.</maml:para> <maml:para>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.</maml:para> <maml:para>If you would like to disable this provider, please run the Remove-ArchivialProvider cmdlet.</maml:para> <maml:para>All provided options here (account name and token) are encrypted before saving to the database.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ArchivialAzureProviderOptions</maml:name> <!-- Parameter: AzureStorageAccountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AzureStorageAccountName</maml:name> <maml:description> <maml:para>Specify the name of the Azure storage account to upload backup data to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AzureStorageAccountToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AzureStorageAccountToken</maml:name> <maml:description> <maml:para>Specify the access token of the Azure storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AzureStorageAccountName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AzureStorageAccountName</maml:name> <maml:description> <maml:para>Specify the name of the Azure storage account to upload backup data to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AzureStorageAccountToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AzureStorageAccountToken</maml:name> <maml:description> <maml:para>Specify the access token of the Azure storage account.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Set-ArchivialAzureProviderOptions -AzureStorageAccountName "myaccount" -AzureStorageAccountToken "--my token--"</dev:code> <dev:remarks> <maml:para>Configures Azure as a cloud storage backup destination.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Install-ArchivialCloudBackup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Install-ArchivialCloudBackup</command:name> <command:verb>Install</command:verb> <command:noun>ArchivialCloudBackup</command:noun> <maml:description> <maml:para>Installs the Archivial Cloud Backup software on this computer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>This command requires an elevated (run-as administrator) PowerShell prompt to complete. It will also prompt for comfirmation unless the -Force switch is applied.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Install-ArchivialCloudBackup</maml:name> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: InstallDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InstallDirectory</maml:name> <maml:description> <maml:para>Specify a custom installation directory, otherwise the default Program Files location will be used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InstallDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InstallDirectory</maml:name> <maml:description> <maml:para>Specify a custom installation directory, otherwise the default Program Files location will be used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Install-ArchivialCloudBackup</dev:code> <dev:remarks> <maml:para>Starts the installation with default options. The user will be prompted for confirmation.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Install-ArchivialCloudBackup -InstallDirectory "D:\Applications\Archivial Cloud Backup" -Force</dev:code> <dev:remarks> <maml:para>Starts the installation to the custom directory and suppresses the confirmation prompt.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Uninstall-ArchivialCloudBackup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Uninstall-ArchivialCloudBackup</command:name> <command:verb>Uninstall</command:verb> <command:noun>ArchivialCloudBackup</command:noun> <maml:description> <maml:para>Uninstalls the Archivial Cloud Backup software from this computer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>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.</maml:para> <maml:para>This command requires an elevated (run-as administrator) PowerShell prompt to complete. It will also prompt for comfirmation unless the -Force switch is applied.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Uninstall-ArchivialCloudBackup</maml:name> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Suppresses the confirmation prompt.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Uninstall-ArchivialCloudBackup</dev:code> <dev:remarks> <maml:para>Starts the uninstallation process. The user will be prompted for confirmation.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Uninstall-ArchivialCloudBackup -Force</dev:code> <dev:remarks> <maml:para>Starts the uninstallation and suppresses the confirmation prompt.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ArchivialCloudBackupOptions --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ArchivialCloudBackupOptions</command:name> <command:verb>Get</command:verb> <command:noun>ArchivialCloudBackupOptions</command:noun> <maml:description> <maml:para>Gets the application options for Archivial Cloud Backup.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the application options for Archivial Cloud Backup. To change existing options, run Set-ArchivialCloudBackupOptions</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ArchivialCloudBackupOptions</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-ArchivialCloudBackupOptions</dev:code> <dev:remarks> <maml:para>Returns the application options for Archivial Cloud Backup.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-ArchivialCloudBackupOptions --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ArchivialCloudBackupOptions</command:name> <command:verb>Set</command:verb> <command:noun>ArchivialCloudBackupOptions</command:noun> <maml:description> <maml:para>Sets one or more application options for Archivial Cloud Backup.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Specify at least one option to change. To see existing options, run Get-ArchivialCloudBackupOptions</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ArchivialCloudBackupOptions</maml:name> <!-- Parameter: BackupEngineInstancesCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupEngineInstancesCount</maml:name> <maml:description> <maml:para>Optionally specify the number of concurrent backup engine instances to run.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: BackupEngineStartupDelayInSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupEngineStartupDelayInSeconds</maml:name> <maml:description> <maml:para>Optionally specify the time delay in seconds between the startup of each backup engine instance. This helps avoid sudden, excessive filesystem load by staggering the engine startups.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DatabaseBackupsRetentionInDays --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseBackupsRetentionInDays</maml:name> <maml:description> <maml:para>Optionally specify the length of time (in days) that locally stored database backups should be retrained.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: HighPriorityScanFrequencyInHours --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HighPriorityScanFrequencyInHours</maml:name> <maml:description> <maml:para>Optionally specify how often (in hours) that high-priority folder scans should be performed.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: LogFilesRetentionInDays --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogFilesRetentionInDays</maml:name> <maml:description> <maml:para>Optionally specify the length of time (in days) that locally stored log files should be retained.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: LowPriorityScanFrequencyInHours --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LowPriorityScanFrequencyInHours</maml:name> <maml:description> <maml:para>Optionally specify how often (in hours) that low-priority folder scans should be performed.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MasterExclusionMatches --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MasterExclusionMatches</maml:name> <maml:description> <maml:para>Optionally specify a set of regex match exclusions that should apply to all scanned folders.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MedPriorityScanFrequencyInHours --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MedPriorityScanFrequencyInHours</maml:name> <maml:description> <maml:para>Optionally specify how often (in hours) that medium-priority folder scans should be performed.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ProtectionIV --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProtectionIV</maml:name> <maml:description> <maml:para>Optionally specify the local encryption initialization vector key. Key should be a crypto-random 16-byte array, expressed as a base64 encoded string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StatusUpdateSchedule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusUpdateSchedule</maml:name> <maml:description> <maml:para>Optionally specify the schedule for when status notification messages should be sent. Expressed as a cron schedule.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: LogFilesRetentionInDays --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LogFilesRetentionInDays</maml:name> <maml:description> <maml:para>Optionally specify the length of time (in days) that locally stored log files should be retained.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: DatabaseBackupsRetentionInDays --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatabaseBackupsRetentionInDays</maml:name> <maml:description> <maml:para>Optionally specify the length of time (in days) that locally stored database backups should be retrained.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: BackupEngineInstancesCount --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupEngineInstancesCount</maml:name> <maml:description> <maml:para>Optionally specify the number of concurrent backup engine instances to run.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: BackupEngineStartupDelayInSeconds --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>BackupEngineStartupDelayInSeconds</maml:name> <maml:description> <maml:para>Optionally specify the time delay in seconds between the startup of each backup engine instance. This helps avoid sudden, excessive filesystem load by staggering the engine startups.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: LowPriorityScanFrequencyInHours --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LowPriorityScanFrequencyInHours</maml:name> <maml:description> <maml:para>Optionally specify how often (in hours) that low-priority folder scans should be performed.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MedPriorityScanFrequencyInHours --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MedPriorityScanFrequencyInHours</maml:name> <maml:description> <maml:para>Optionally specify how often (in hours) that medium-priority folder scans should be performed.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: HighPriorityScanFrequencyInHours --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HighPriorityScanFrequencyInHours</maml:name> <maml:description> <maml:para>Optionally specify how often (in hours) that high-priority folder scans should be performed.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ProtectionIV --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProtectionIV</maml:name> <maml:description> <maml:para>Optionally specify the local encryption initialization vector key. Key should be a crypto-random 16-byte array, expressed as a base64 encoded string.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: StatusUpdateSchedule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StatusUpdateSchedule</maml:name> <maml:description> <maml:para>Optionally specify the schedule for when status notification messages should be sent. Expressed as a cron schedule.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MasterExclusionMatches --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MasterExclusionMatches</maml:name> <maml:description> <maml:para>Optionally specify a set of regex match exclusions that should apply to all scanned folders.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Set-ArchivialCloudBackupOptions -LogFilesRetentionInDays 60</dev:code> <dev:remarks> <maml:para>Sets the local log file retention to 60 days.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Set-ArchivialCloudBackupOptions -LowPriorityScanFrequencyInHours 4 -MedPriorityScanFrequencyInHours 2</dev:code> <dev:remarks> <maml:para>Sets low priority and medium priority scanning frequencies.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Set-ArchivialCloudBackupOptions -StatusUpdateSchedule "0 8 * * *"</dev:code> <dev:remarks> <maml:para>Sets the status update notification schedule to once per day at 8am.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>C:\> Set-ArchivialCloudBackupOptions -MasterExclusionMatches "^._",".DS_Store"</dev:code> <dev:remarks> <maml:para>Sets the master exclusions to exlude Mac OS related file system metadata files.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ArchivialCloudBackupStatus --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ArchivialCloudBackupStatus</command:name> <command:verb>Get</command:verb> <command:noun>ArchivialCloudBackupStatus</command:noun> <maml:description> <maml:para>Returns the current status of the cloud backup progress.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the current status of the cloud backup progress. It includes details such as how many files are backed up, remaining, and percentage complete.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ArchivialCloudBackupStatus</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-ArchivialCloudBackupStatus</dev:code> <dev:remarks> <maml:para>Returns the current status of the cloud backup progress.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-ArchivialLocalSource --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-ArchivialLocalSource</command:name> <command:verb>Add</command:verb> <command:noun>ArchivialLocalSource</command:noun> <maml:description> <maml:para>Adds a local folder to the Archivial backup folders list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>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.</maml:para> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-ArchivialLocalSource</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Specify the folder path that should be backed up and monitored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specify the priority of this source (which determines how frequently it will be scanned for changes).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Revisions --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Revisions</maml:name> <maml:description> <maml:para>Specify the maximum number of revisions to store in the cloud for the files in this folder.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MatchFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchFilter</maml:name> <maml:description> <maml:para>Optionally specify a wildcard expression to filter the files to be backed up or monitored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Specify the folder path that should be backed up and monitored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specify the priority of this source (which determines how frequently it will be scanned for changes).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Revisions --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Revisions</maml:name> <maml:description> <maml:para>Specify the maximum number of revisions to store in the cloud for the files in this folder.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: MatchFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchFilter</maml:name> <maml:description> <maml:para>Optionally specify a wildcard expression to filter the files to be backed up or monitored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Add-ArchivialLocalSource -FolderPath "C:\users\test\documents" -Priority High -Revisions 3</dev:code> <dev:remarks> <maml:para>Adds the specified folder to backup with high priority, and to retain up to 3 revisions of file history.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Add-ArchivialLocalSource -FolderPath "C:\users\test\music\playlists" -Priority High -Revisions 3 -MatchFilter *.m3u</dev:code> <dev:remarks> <maml:para>Adds the specified folder to backup with high priority, but only files that match the wildcard extension filter.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-ArchivialLocalSource --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-ArchivialLocalSource</command:name> <command:verb>Remove</command:verb> <command:noun>ArchivialLocalSource</command:noun> <maml:description> <maml:para>Removes the specified Local Source.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>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.</maml:para> <maml:para>To view existing Local Sources, run Get-ArchivialLocalSource. This command supports piping from Get-ArchivialLocalSource or manual invoke from the specified source ID.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-ArchivialLocalSource</maml:name> <!-- Parameter: SourceID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specify the ID of the Local Source to remove.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-ArchivialLocalSource</maml:name> <!-- Parameter: LocalSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>LocalSource</maml:name> <maml:description> <maml:para>Specify the object (from pipeline) to remove.</maml:para> </maml:description> <command:parameterValue required="true">LocalSourceLocation</command:parameterValue> <dev:type> <maml:name>ArchivialLibrary.Folders.LocalSourceLocation</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SourceID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specify the ID of the Local Source to remove.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: LocalSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>LocalSource</maml:name> <maml:description> <maml:para>Specify the object (from pipeline) to remove.</maml:para> </maml:description> <command:parameterValue required="true">LocalSourceLocation</command:parameterValue> <dev:type> <maml:name>ArchivialLibrary.Folders.LocalSourceLocation</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>ArchivialLibrary.Folders.LocalSourceLocation</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specify the object (from pipeline) to remove.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Remove-ArchivialLocalSource -ID 3</dev:code> <dev:remarks> <maml:para>Removes the Local Source with the specified ID.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-ArchivialLocalSource | Where Path -like "*C:\users\test\documents*" | Remove-ArchivialLocalSource</dev:code> <dev:remarks> <maml:para>Removes any configured Local Source that matches a path containing the specified filter (using the pipeline scenario).</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-ArchivialLocalSourceRescan --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-ArchivialLocalSourceRescan</command:name> <command:verb>Start</command:verb> <command:noun>ArchivialLocalSourceRescan</command:noun> <maml:description> <maml:para>Forces the re-scan of a Local Source being monitored by Archivial.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>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.</maml:para> <maml:para>Please see the Get-ArchivialLocalSources command to find the ID of an existing source you would like to rescan.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Start-ArchivialLocalSourceRescan</maml:name> <!-- Parameter: SourceID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specify the ID of the Local Source to rescan.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Start-ArchivialLocalSourceRescan</maml:name> <!-- Parameter: LocalSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>LocalSource</maml:name> <maml:description> <maml:para>Specify the Local Source object to rescan.</maml:para> </maml:description> <command:parameterValue required="true">LocalSourceLocation</command:parameterValue> <dev:type> <maml:name>ArchivialLibrary.Folders.LocalSourceLocation</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SourceID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specify the ID of the Local Source to rescan.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: LocalSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>LocalSource</maml:name> <maml:description> <maml:para>Specify the Local Source object to rescan.</maml:para> </maml:description> <command:parameterValue required="true">LocalSourceLocation</command:parameterValue> <dev:type> <maml:name>ArchivialLibrary.Folders.LocalSourceLocation</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>ArchivialLibrary.Folders.LocalSourceLocation</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specify the Local Source object to rescan.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Start-ArchivialLocalSourceRescan -SourceID 2</dev:code> <dev:remarks> <maml:para>Forces a rescan of the Local Source with the specified ID.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-ArchivialLocalSources | Start-ArchivialLocalSourceRescan</dev:code> <dev:remarks> <maml:para>Forces a rescan of all defined Local Sources being monitored by Archivial.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-ArchivialLocalSources | Where Path -like "*D:\temp*" | Start-ArchivialLocalSourceRescan</dev:code> <dev:remarks> <maml:para>Forces a rescan of any Local Sources that match the path filter.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ArchivialLocalSources --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ArchivialLocalSources</command:name> <command:verb>Get</command:verb> <command:noun>ArchivialLocalSources</command:noun> <maml:description> <maml:para>Returns all of the Local Source folders being monitored by Archivial.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>The output from this command can be piped to the Remove-ArchivialLocalSource cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ArchivialLocalSources</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-ArchivialLocalSources</dev:code> <dev:remarks> <maml:para>Returns all of the Local Source folders being monitored by Archivial.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-ArchivialNetworkCredential --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-ArchivialNetworkCredential</command:name> <command:verb>Remove</command:verb> <command:noun>ArchivialNetworkCredential</command:noun> <maml:description> <maml:para>Removes the stored network credential used for connecting to network resources.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Authenticated Network Source locations have an encrypted credential stored with them. This command is used to remove that stored credential.</maml:para> <maml:para>To view existing network credentials, run Get-ArchivialNetworkCredentials. This command supports piping from Get-ArchivialNetworkCredentials or manual invoke from credential name</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-ArchivialNetworkCredential</maml:name> <!-- Parameter: CredentialName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialName</maml:name> <maml:description> <maml:para>Specify the name of the credential to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-ArchivialNetworkCredential</maml:name> <!-- Parameter: NetCredential --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>NetCredential</maml:name> <maml:description> <maml:para>Specify the object (from pipeline) to remove.</maml:para> </maml:description> <command:parameterValue required="true">NetCredential</command:parameterValue> <dev:type> <maml:name>ArchivialLibrary.Secrets.NetCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: CredentialName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialName</maml:name> <maml:description> <maml:para>Specify the name of the credential to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NetCredential --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>NetCredential</maml:name> <maml:description> <maml:para>Specify the object (from pipeline) to remove.</maml:para> </maml:description> <command:parameterValue required="true">NetCredential</command:parameterValue> <dev:type> <maml:name>ArchivialLibrary.Secrets.NetCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>ArchivialLibrary.Secrets.NetCredential</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specify the object (from pipeline) to remove.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Remove-ArchivialNetworkCredential -CredentialName "drobo-nas"</dev:code> <dev:remarks> <maml:para>Removes the stored network credential with the specified name.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-ArchivialNetworkCredentials | Where CredentialName -eq "drobo-nas" | Remove-ArchivialNetworkCredential</dev:code> <dev:remarks> <maml:para>Removes the stored network credential, but using the pipeline scenario.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-ArchivialNetworkCredential --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ArchivialNetworkCredential</command:name> <command:verb>Set</command:verb> <command:noun>ArchivialNetworkCredential</command:noun> <maml:description> <maml:para>Saves the credentials required to connect to an authenticated network resource (such as a UNC path share).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>The credential username and password are both encrypted and saved to the database.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ArchivialNetworkCredential</maml:name> <!-- Parameter: CredentialName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialName</maml:name> <maml:description> <maml:para>Specify the friendly name (description) to refer to this stored credential.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharePassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SharePassword</maml:name> <maml:description> <maml:para>Specify the password required to connect to the network resource.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ShareUsername --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ShareUsername</maml:name> <maml:description> <maml:para>Specify the username required to connect to the network resource.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: CredentialName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialName</maml:name> <maml:description> <maml:para>Specify the friendly name (description) to refer to this stored credential.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ShareUsername --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ShareUsername</maml:name> <maml:description> <maml:para>Specify the username required to connect to the network resource.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SharePassword --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SharePassword</maml:name> <maml:description> <maml:para>Specify the password required to connect to the network resource.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Set-ArchivialNetworkCredential -CredentialName "drobo-device" -ShareUser "drobo-private-user" -SharePassword ****</dev:code> <dev:remarks> <maml:para>Encrypts and stores the network resource credentials in the database.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ArchivialNetworkCredentials --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ArchivialNetworkCredentials</command:name> <command:verb>Get</command:verb> <command:noun>ArchivialNetworkCredentials</command:noun> <maml:description> <maml:para>Returns all of the saved Network Credentials used to connect to Network Sources.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>Note: Only the name of the credential will be returned. The encrypted username and password values will not be returned in the output.</maml:para> <maml:para>The output from this command can be piped to the Remove-ArchivialNetworkCredential cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ArchivialNetworkCredentials</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-ArchivialNetworkCredentials</dev:code> <dev:remarks> <maml:para>Returns all of the configured Network Credentials saved in the system.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-ArchivialNetworkSource --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-ArchivialNetworkSource</command:name> <command:verb>Add</command:verb> <command:noun>ArchivialNetworkSource</command:noun> <maml:description> <maml:para>Adds a network (UNC path) folder to the Archivial backup folders list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>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.</maml:para> <maml:para>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.</maml:para> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-ArchivialNetworkSource</maml:name> <!-- Parameter: Priority --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specify the priority of this source (which determines how frequently it will be scanned for changes).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Revisions --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Revisions</maml:name> <maml:description> <maml:para>Specify the maximum number of revisions to store in the cloud for the files in this folder.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: UncPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UncPath</maml:name> <maml:description> <maml:para>Specify the UNC folder path that should be backed up and monitored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CredentialName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialName</maml:name> <maml:description> <maml:para>Optionally specify the name of a stored credential to authenticate this share with.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchFilter</maml:name> <maml:description> <maml:para>Optionally specify a wildcard expression to filter the files to be backed up or monitored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UncPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>UncPath</maml:name> <maml:description> <maml:para>Specify the UNC folder path that should be backed up and monitored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Priority --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specify the priority of this source (which determines how frequently it will be scanned for changes).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Revisions --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Revisions</maml:name> <maml:description> <maml:para>Specify the maximum number of revisions to store in the cloud for the files in this folder.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: CredentialName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CredentialName</maml:name> <maml:description> <maml:para>Optionally specify the name of a stored credential to authenticate this share with.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MatchFilter --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MatchFilter</maml:name> <maml:description> <maml:para>Optionally specify a wildcard expression to filter the files to be backed up or monitored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Add-ArchivialNetworkSource -UncPath "\\drobo-nas-device\public\media\music" -Priority Medium -Revisions 1</dev:code> <dev:remarks> <maml:para>Adds the specified unauthenticated network share to backup.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev: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</dev:code> <dev:remarks> <maml:para>Encrypts and stores the network resource credentials, and then adds the specified authenticated network share to backup.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-ArchivialNetworkSource --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-ArchivialNetworkSource</command:name> <command:verb>Remove</command:verb> <command:noun>ArchivialNetworkSource</command:noun> <maml:description> <maml:para>Removes the specified Network Source.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>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.</maml:para> <maml:para>To view existing Network Sources, run Get-ArchivialNetworkSource. This command supports piping from Get-ArchivialNetworkSource or manual invoke from the specified source ID.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-ArchivialNetworkSource</maml:name> <!-- Parameter: SourceID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specify the ID of the Network Source to remove.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-ArchivialNetworkSource</maml:name> <!-- Parameter: NetworkSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>NetworkSource</maml:name> <maml:description> <maml:para>Specify the object (from pipeline) to remove.</maml:para> </maml:description> <command:parameterValue required="true">NetworkSourceLocation</command:parameterValue> <dev:type> <maml:name>ArchivialLibrary.Folders.NetworkSourceLocation</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SourceID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specify the ID of the Network Source to remove.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NetworkSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>NetworkSource</maml:name> <maml:description> <maml:para>Specify the object (from pipeline) to remove.</maml:para> </maml:description> <command:parameterValue required="true">NetworkSourceLocation</command:parameterValue> <dev:type> <maml:name>ArchivialLibrary.Folders.NetworkSourceLocation</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>ArchivialLibrary.Folders.NetworkSourceLocation</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specify the object (from pipeline) to remove.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Remove-ArchivialNetworkSource -ID 3</dev:code> <dev:remarks> <maml:para>Removes the Network Source with the specified ID.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-ArchivialNetworkSource | Where Path -like "*\\drobo-nas\documents*" | Remove-ArchivialNetworkSource</dev:code> <dev:remarks> <maml:para>Removes any configured Network Source that matches a path containing the specified filter (using the pipeline scenario).</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Start-ArchivialNetworkSourceRescan --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Start-ArchivialNetworkSourceRescan</command:name> <command:verb>Start</command:verb> <command:noun>ArchivialNetworkSourceRescan</command:noun> <maml:description> <maml:para>Forces the re-scan of a Network Source being monitored by Archivial.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>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.</maml:para> <maml:para>Please see the Get-ArchivialNetworkSources command to find the ID of an existing source you would like to rescan.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Start-ArchivialNetworkSourceRescan</maml:name> <!-- Parameter: SourceID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specify the ID of the Network Source to rescan.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Start-ArchivialNetworkSourceRescan</maml:name> <!-- Parameter: NetworkSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>NetworkSource</maml:name> <maml:description> <maml:para>Specify the Network Source object to rescan.</maml:para> </maml:description> <command:parameterValue required="true">NetworkSourceLocation</command:parameterValue> <dev:type> <maml:name>ArchivialLibrary.Folders.NetworkSourceLocation</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: SourceID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SourceID</maml:name> <maml:description> <maml:para>Specify the ID of the Network Source to rescan.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: NetworkSource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>NetworkSource</maml:name> <maml:description> <maml:para>Specify the Network Source object to rescan.</maml:para> </maml:description> <command:parameterValue required="true">NetworkSourceLocation</command:parameterValue> <dev:type> <maml:name>ArchivialLibrary.Folders.NetworkSourceLocation</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>ArchivialLibrary.Folders.NetworkSourceLocation</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specify the Network Source object to rescan.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Start-ArchivialNetworkSourceRescan -SourceID 2</dev:code> <dev:remarks> <maml:para>Forces a rescan of the Network Source with the specified ID.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-ArchivialNetworkSources | Start-ArchivialNetworkSourceRescan</dev:code> <dev:remarks> <maml:para>Forces a rescan of all defined Network Sources being monitored by Archivial.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>C:\> Get-ArchivialNetworkSources | Where Path -like "*\\drobo-nas\*" | Start-ArchivialNetworkSourceRescan</dev:code> <dev:remarks> <maml:para>Forces a rescan of any Network Sources that match the path filter.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ArchivialNetworkSources --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ArchivialNetworkSources</command:name> <command:verb>Get</command:verb> <command:noun>ArchivialNetworkSources</command:noun> <maml:description> <maml:para>Returns all of the Network Source folders being monitored by Archivial.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>The output from this command can be piped to the Remove-ArchivialNetworkSource cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ArchivialNetworkSources</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-ArchivialNetworkSources</dev:code> <dev:remarks> <maml:para>Returns all of the Network Source folders being monitored by Archivial.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-ArchivialProvider --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-ArchivialProvider</command:name> <command:verb>Remove</command:verb> <command:noun>ArchivialProvider</command:noun> <maml:description> <maml:para>Removes the configured storage or messaging provider.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Providers are used to connect to external services for cloud storage backup or message notifications.</maml:para> <maml:para>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.</maml:para> <maml:para>To view existing configured providers, run Get-ArchivialProviders. This command supports piping from Get-ArchivialProviders or manual invoke from the provider name.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-ArchivialProvider</maml:name> <!-- Parameter: ProviderName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specify the name of the provider to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByObject --> <command:syntaxItem> <maml:name>Remove-ArchivialProvider</maml:name> <!-- Parameter: Provider --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Provider</maml:name> <maml:description> <maml:para>Specify the object (from pipeline) to remove.</maml:para> </maml:description> <command:parameterValue required="true">Provider</command:parameterValue> <dev:type> <maml:name>ArchivialLibrary.Providers.Provider</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ProviderName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ProviderName</maml:name> <maml:description> <maml:para>Specify the name of the provider to remove.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Provider --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Provider</maml:name> <maml:description> <maml:para>Specify the object (from pipeline) to remove.</maml:para> </maml:description> <command:parameterValue required="true">Provider</command:parameterValue> <dev:type> <maml:name>ArchivialLibrary.Providers.Provider</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>ArchivialLibrary.Providers.Provider</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specify the object (from pipeline) to remove.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Remove-ArchivialProvider -ProviderName "Azure"</dev:code> <dev:remarks> <maml:para>Removes the configured Azure provider.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>C:\> Get-ArchivialProvider | Where Name -eq "Azure" | Remove-ArchivialProvider</dev:code> <dev:remarks> <maml:para>Removes the configured Azure provider, but using the pipeline scenario.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ArchivialProviders --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ArchivialProviders</command:name> <command:verb>Get</command:verb> <command:noun>ArchivialProviders</command:noun> <maml:description> <maml:para>Returns all of the configured Archivial Providers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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).</maml:para> <maml:para>Note: Only the name and ID of the provider will be returned. The encrypted secure setting values will not returned in the output.</maml:para> <maml:para>The output from this command can be piped to the Remove-ArchivialProvider cmdlet.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ArchivialProviders</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Get-ArchivialProviders</dev:code> <dev:remarks> <maml:para>Returns all of the configured Archivial Providers.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Set-ArchivialTwilioProviderOptions --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-ArchivialTwilioProviderOptions</command:name> <command:verb>Set</command:verb> <command:noun>ArchivialTwilioProviderOptions</command:noun> <maml:description> <maml:para>Configures the Twilio messaging provider as a status update recipient.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> <maml:para>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.</maml:para> <maml:para>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.</maml:para> <maml:para>If you would like to disable this provider, please run the Remove-ArchivialProvider cmdlet.</maml:para> <maml:para>All provided options here (ex: account name, token, phone numbers) are encrypted before saving to the database.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-ArchivialTwilioProviderOptions</maml:name> <!-- Parameter: TwilioAccountID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TwilioAccountID</maml:name> <maml:description> <maml:para>Specify the Twilio Account ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TwilioAuthToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TwilioAuthToken</maml:name> <maml:description> <maml:para>Specify the Twilio Authentication token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TwilioDestinationPhones --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TwilioDestinationPhones</maml:name> <maml:description> <maml:para>Specify the phone number(s) to send updates to.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TwilioSourcePhone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TwilioSourcePhone</maml:name> <maml:description> <maml:para>Specify the Twilio phone number (sender).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TwilioAccountID --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TwilioAccountID</maml:name> <maml:description> <maml:para>Specify the Twilio Account ID.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TwilioAuthToken --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TwilioAuthToken</maml:name> <maml:description> <maml:para>Specify the Twilio Authentication token.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TwilioSourcePhone --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TwilioSourcePhone</maml:name> <maml:description> <maml:para>Specify the Twilio phone number (sender).</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TwilioDestinationPhones --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TwilioDestinationPhones</maml:name> <maml:description> <maml:para>Specify the phone number(s) to send updates to.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>C:\> Set-ArchivialTwilioProviderOptions -TwilioAccountID "myaccount" -TwilioAuthToken "--token--" -TwilioSourcePhone "+12065551234" -TwilioDestinationPhones @("+12065554567","+12065556789")</dev:code> <dev:remarks> <maml:para>Configures Twilio as a status messaging recipient.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |