external help file: QuestSoftware.RecoveryManager.AD.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:
Copies a backup from a local storage or a network share to the secure storage server.
Send-RMADFEBackupToSecureStorage -BackupPath <String> [-BackupTargetName <String>] -StorageServer <String>
[-AgentPort <UInt32>] [-AsJob] [<CommonParameters>]
Copies a backup from a local path or network share to the secure storage server. Backup is sent by a console to secure storage server agent. Note that there must be read access to provided backup location.
PS C:\> Send-RMADFEBackupToSecureStorage -StorageServer 'storage' -BackupPath '\\fr\backupsnew\DC1.rmad.local\2022-09-10 14-54-49.bkf'
{{ Add example description here }}
Secure storage agent port
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Runs the command as a background job.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Local or network path to the backup.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Alternative name that will be used to save backup on secure storage server.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Secure storage name or IP address. Assuming that the Forest Recovery agent is already installed on secure storage server.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Sets properties for a computer collection.
Set-RMADCollection [-Name] <String[]> [-BackupComponents <BackupComponents>] [-Properties <Hashtable>]
[-Schedule <Schedule[]>] [-ScheduleCredential <PSCredential>] [-AgentCredentialEnabled <Boolean>]
[-AgentCredential <PSCredential>] [-StorageCredentialEnabled <Boolean>] [-StorageCredential <PSCredential>]
[-SecondaryStorageCredential <PSCredential>] [-RetentionPolicyEnabled <Boolean>]
[-RetentionPolicyCount <Int32>] [-PassThru] [-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-RMADCollection [-InputObject] <ComputerCollection[]> [-BackupComponents <BackupComponents>]
[-Properties <Hashtable>] [-Schedule <Schedule[]>] [-ScheduleCredential <PSCredential>]
[-AgentCredentialEnabled <Boolean>] [-AgentCredential <PSCredential>] [-StorageCredentialEnabled <Boolean>]
[-StorageCredential <PSCredential>] [-SecondaryStorageCredential <PSCredential>]
[-RetentionPolicyEnabled <Boolean>] [-RetentionPolicyCount <Int32>] [-PassThru] [-IgnoreReadOnly] [-WhatIf]
[-Confirm] [<CommonParameters>]
Set-RMADCollection [-Id] <Int32[]> [-BackupComponents <BackupComponents>] [-Properties <Hashtable>]
[-Schedule <Schedule[]>] [-ScheduleCredential <PSCredential>] [-AgentCredentialEnabled <Boolean>]
[-AgentCredential <PSCredential>] [-StorageCredentialEnabled <Boolean>] [-StorageCredential <PSCredential>]
[-SecondaryStorageCredential <PSCredential>] [-RetentionPolicyEnabled <Boolean>]
[-RetentionPolicyCount <Int32>] [-PassThru] [-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]
Sets properties for the Recovery Manager computer collection you specify.
PS C:\> Set-RMADCollection -Name Collection1 -BackupComponents ActiveDirectory,Registry,GroupMembership,ForestRecoveryMetadata
This command sets properties for the computer collection named Collection1.
PS C:\> Set-RMADCollection * -RetentionPolicyEnabled $false
This command disables all backup retention policies for all existing computer collections.
PS C:\> $c = Get-RMADCollection | Where-Object { $_.AgentCredentialEnabled -eq $true }
C:\PS>$cred = Get-Credential
C:\PS>Set-RMADCollection -InputObject $c -AgentCredential $cred
The first command in this example gets objects representing the computer collections whose properties are set to access Backup Agent and backup files with a specific user account. Then the command saves the computer collection objects in the $c variable.
PS C:\> $a = Get-RMADCollection -Name "Collection1"
C:\PS>Set-RMADCollection -InputObject $a[1] -Properties @{BackupComponents="ActiveDirectory","BootFiles"; UsePreinstalledAgent=$true}
In the first line of this example, the Get-RMADCollection cmdlet gets the Computer Collection whose name is Collection1 and saves it to the $a variable. In the second line of this example, the Set-RMADCollection cmdlet sets the components to be backed up (that is, Active Directory and boot files) and specifies to use preinstalled Backup Agent for backup operations. For a complete list of items you can include in the braces, see the description of the Properties parameter.
PS C:\> $schedule=(New-RMADSchedule -Daily -StartDate "9/20/2022 10:00" -DaysInterval 1), (New-RMADSchedule -Daily -StartDate "9/20/2022 22:00" -DaysInterval 1)
C:\PS>Set-RMADCollection -InputObject $col -Properties @{EnableEmailLog=$true; EmailLogTo="administrator@mydomain.com"; EmailLogLevel="Everything"}
This example illustrates how to back up a Computer Collection by using two backup schedules. The first line of this example creates two backup creation schedules and stores them in the $schedule variable. One schedule invokes the backup operation once in every two days at 10 a.m. Another schedule invokes the backup operation once in every two days at 10 p.m. The two backup schedules become effective starting from the 20th September 2022. The second line of this example enables e-mail notifications for the Computer Collection. The recipient address for e-mail notifications is administrator@mydomain.com. The e-mail notifications provide information about all backup events.
PS C:\> $cred = Get-Credential
C:\PS>Set-RMADCollection -Name MyCollection -Properties @{AgentSideScriptBeforeBackupEnabled = $true; AgentSideScriptBeforeBackup = 'Set-Disk -Number 5 -IsOffline $false'; AgentSideScriptAfterBackupEnabled = $true; AgentSideScriptAfterBackup = 'Set-Disk -Number 5 -IsOffline $true'; AgentSideScriptCredential = $cred}
This example illustrates how to customize your environment by running PowerShell scripts on the domain controller before and after creating a backup.
Specifies the credentials for the account you want to use to access Backup Agent installed on the DCs in the computer collection and locations where backup files for the computer collection will be saved. TO enable using the account whose credentials you supply in this parameter, use the AgentCredentialEnabled parameter.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies to use a particular account to access Backup Agent installed on the DCs in the computer collection and locations where backup files for the computer collection will be saved. To specify the credentials for the account, use the AgentCredential parameter.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Use this parameter to specify the names of the System State components you want to back up.
Type: BackupComponents
Parameter Sets: (All)
Aliases:
Accepted values: None, ActiveDirectory, Adam, BootFiles, CertificateServer, ClusterQuorum, EnterpriseServices, ForestRecoveryMetadata, GroupMembership, IisMetabase, PerformanceCounters, Registry, CryptoKeys, All
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the identifier of the computer collection whose properties you want to set.
Type: Int32[]
Parameter Sets: Id
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
Allows you to perform the action in a console currently performing full replication.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Renames the computer collection represented by the specified collection objects. Specify the name of the variable that contains the objects or type a command or expression that gets the objects.
Type: ComputerCollection[]
Parameter Sets: InputObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies the name of the computer collection whose properties you want to set.
Type: String[]
Parameter Sets: Name
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
Passes the computer collection whose properties you have set along the pipeline. If this parameter is omitted, the computer collection is not passed along the pipeline.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Allows you to modify the Computer Collection properties.
To specify the properties you want to modify, use an associative array or hash table. For more information, see the Windows PowerShell help topic on associative arrays (hash tables). To open the topic, at the PoweShell command prompt enter the following: help about_associative_arrayBelow are the properties you can modify by using this parameter. The properties are grouped by the names of tabs in the "Computer Collection Properties" dialog box, because each property corresponds to an option on these tabs. To assign a new value to a property, use the following format: PropertyName=Value
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the number of latest backups you want to keep for each DC in the computer collection. To enable the deletion of obsolete backups, use the RetentionPolicyEnabled parameter.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies to delete obsolete backups for particular computer collection. To set the number of latest backups you want to keep for each DC in the computer collection, use the RetentionPolicyCount parameter.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Causes the computer collection you specify to use the backup creation schedule you set by using the New-RMADSchedule cmdlet.
Type: Schedule[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the user account under which the scheduled backup creation task will be run. This account must have sufficient permissions to back up the computer collection you specify.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the credentials for the account you want to use to Tier 1 remote storage to copy backups to the secondary storage like Secure Storage Server or Cloud Storage.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the credentials for the account you want to use to access locations where backup files for the computer collection will be saved. To enable using the account whose credentials you supply in this parameter, use the StorageCredentialEnabled parameter.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies to use a particular account to access locations where backup files for the computer collection will be saved. To specify the credentials for the account, use the StorageCredential parameter.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts for a confirmation before executing the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Describes what would happen if you ran the command without actually running the command.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:
Updates cloud storage in the Recovery Manager.
Set-RMADFECloudStorage [-Id] <Int32[]> [-DisplayName <String>] [-Container <String>]
-AzureConnectionString <String> [-PassThru] [-IgnoreReadOnly] [<CommonParameters>]
Set-RMADFECloudStorage [-Id] <Int32[]> [-DisplayName <String>] [-Container <String>] [-AwsRegion <String>]
-AwsAccessKey <String> -AwsSecretKey <String> [-PassThru] [-IgnoreReadOnly] [<CommonParameters>]
Set-RMADFECloudStorage [-InputObject] <CloudStorage[]> [-DisplayName <String>] [-Container <String>]
-AzureConnectionString <String> [-PassThru] [-IgnoreReadOnly] [<CommonParameters>]
Set-RMADFECloudStorage [-InputObject] <CloudStorage[]> [-DisplayName <String>] [-Container <String>]
[-AwsRegion <String>] -AwsAccessKey <String> -AwsSecretKey <String> [-PassThru] [-IgnoreReadOnly]
[<CommonParameters>]
Updates properties for the registered cloud storage in Recovery Manager for Active Directory.
PS C:\> Set-RMADFECloudStorage -Id 7 -DisplayName "MyStorage" -AzureConnectionString "..." -Container "MyContainer"
Updates cloud storage settings for the Azure cloud storage with the Id 7.
PS C:\> Set-RMADFECloudStorage -Id 7 -DisplayName "MyStorage" -AwsAccessKey "..." -AwsSecretKey "..." -Container "MyContainer"
Updates cloud storage settings for the AWS cloud storage with the Id 7.
AWS access key ID
Type: String
Parameter Sets: IdAwsProviderSet, InputObjectAwsProviderSet
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
AWS region
Type: String
Parameter Sets: IdAwsProviderSet, InputObjectAwsProviderSet
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
AWS secret key ID
Type: String
Parameter Sets: IdAwsProviderSet, InputObjectAwsProviderSet
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Microsoft Azure connection string or Shared Access Signature token
Type: String
Parameter Sets: IdAzureProviderSet, InputObjectAzureProviderSet
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Name of container in storage account. Backups will be copied to this location.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Cloud storage display name for the registered storage in Recovery Manager for Active Directory.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the cloud storage Id representing the storage you want to update.
Type: Int32[]
Parameter Sets: IdAzureProviderSet, IdAwsProviderSet
Aliases: StorageId
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
Allows you to perform the action in a console currently performing full replication (for internal use only).
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the CloudStorage object representing the storage you want to update.
Type: CloudStorage[]
Parameter Sets: InputObjectAzureProviderSet, InputObjectAwsProviderSet
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Passes the modified cloud storage along the pipeline. If this parameter is omitted, the modified cloud storage is not passed along the pipeline.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
external help file: QuestSoftware.RecoveryManager.AD.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:
Configure a computer collection to use a registered cloud storage.
Set-RMADFECloudStorageCollection [-Collection <ComputerCollection[]>] [-CollectionId <Int32[]>] [-Id] <Int32[]>
[-IgnoreReadOnly] [<CommonParameters>]
Set-RMADFECloudStorageCollection [-Collection <ComputerCollection[]>] [-CollectionId <Int32[]>]
[-InputObject] <CloudStorage[]> [-IgnoreReadOnly] [<CommonParameters>]
Configure a computer collection to use a registered cloud storage. Backups from the specified computer collections will be copied to the cloud storage. Multiple computer collections can use a cloud storage account.
PS C:\> Set-RMADFECloudStorageCollection -Id 2 -CollectionId @(1,2,3)
Specifies the computer collections with Id 1, 2 and 3 to copy backups to the cloud storage with Id 2.
Computer collection object.
Type: ComputerCollection[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Id of computer collection to copy backups from to cloud storage.
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Cloud storage Id that is registered in Recovery Manager for Active Directory.
Type: Int32[]
Parameter Sets: Id
Aliases: StorageId
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
Allows you to perform the action in a console currently performing full replication (for internal use only).
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the CloudStorage object representing the storage you want to update.
Type: CloudStorage[]
Parameter Sets: InputObject
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. 利用規約 プライバシー Cookie Preference Center