Chatee ahora con Soporte
Chat con el soporte

Recovery Manager for AD Forest Edition 10.3 - Management Shell Guide

Overview
About Management Shell Installing and opening Management Shell Getting Help Descriptions of PowerShell Commands
Add-RMADBackup Add-RMADCollectionItem Add-RMADFECloudStorage Add-RMADReplicationConsole Add-RMADStorageServer Backup-RMADCollection Backup-RMADFEConsoleConfiguration Close-RMADFEProject Compare-RMADObject Convert-RMADBackup ConvertTo-RMADRecycledObject Copy-RMADFEBackup Create-RMADStorageAgentSetup Expand-RMADBackup Export-RMADBackup Export-RMADFECloudStorageBackup Export-RMADFECloudStorageServers Export-RMADFERecoveryCertificate Export-RMADFEResult Export-RMADSecureStorageBackup Export-RMADStorageServers Get-RMADBackup Get-RMADBackupAgent Get-RMADBackupInfo Get-RMADBackupObject Get-RMADBackupSecurityStatus Get-RMADCollection Get-RMADCollectionItem Get-RMADDeletedObject Get-RMADFEAvailableSubnet Get-RMADFECloudStorage Get-RMADFECloudStorageCollection Get-RMADFECloudStorageUploadSession Get-RMADFEComputer Get-RMADFEConsole Get-RMADFEConsoleConfigurationBackupSchedule Get-RMADFEConsoleConfigurationProjectFiles Get-RMADFEDnsCache Get-RMADFEDomain Get-RMADFEEvent Get-RMADFEGlobalOptions Get-RMADFEOperation Get-RMADFEPersistenceConnection Get-RMADFEProject Get-RMADFERecoveryAgent Get-RMADFESchedule Get-RMADGlobalOptions Get-RMADHybridRecoveryDomainOptions Get-RMADHybridRecoveryOptions Get-RMADLicenseInfo Get-RMADObject Get-RMADReplicationConsole Get-RMADReplicationSchedule Get-RMADReplicationSession Get-RMADReplicationSessionItem Get-RMADReportObject Get-RMADReportObjectAttributes Get-RMADReportObjectChildren Get-RMADReportSession Get-RMADSession Get-RMADSessionItem Get-RMADSessionItemEvent Get-RMADStorageServer Import-RMADBackup Import-RMADFERecoveryCertificate Install-RMADBackupAgent Install-RMADFERecoveryAgent New-RMADCollection New-RMADFEProject New-RMADFERecoveryMedia New-RMADSchedule Open-RMADFEProject Protect-RMADSecureStorageServer Publish-RMADBackupSecurityStatus Refresh-RMADStorageServer Register-RMADSecureStorageBackups Remove-RMADBackup Remove-RMADBackupAgent Remove-RMADCollection Remove-RMADCollectionItem Remove-RMADFECloudStorage Remove-RMADFECloudStorageUploadSession Remove-RMADFERecoveryAgent Remove-RMADFESchedule Remove-RMADReplicationConsole Remove-RMADReplicationSchedule Remove-RMADReplicationSession Remove-RMADStorageServer Remove-RMADUnpackedComponent Rename-RMADCollection Restart-RMADFECloudStorageUploadSession Restore-RMADDeletedObject Restore-RMADDomainController Restore-RMADFEConsoleConfiguration Restore-RMADObject Resume-RMADFEOperation Resume-RMADFERecovery Save-RMADFEProject Set-RMADCollection Set-RMADFECloudStorage Set-RMADFECloudStorageCollection Set-RMADFEComputer Set-RMADFEConsoleConfigurationBackupSchedule Set-RMADFEConsoleConfigurationProjectFiles Set-RMADFEDnsCache Set-RMADFEDomain Set-RMADFEGlobalOptions Set-RMADFEPersistenceConnection Set-RMADFERecoveryMode Set-RMADFESchedule Set-RMADGlobalOptions Set-RMADHybridRecoveryDomainOptions Set-RMADHybridRecoveryOptions Set-RMADReplicationConsole Set-RMADReplicationSchedule Start-RMADFERecovery Start-RMADFERecoveryAgentOperation Start-RMADFEVerification Start-RMADHybridRecoveryDiscovery Start-RMADReplication Start-RMADReportViewer Stop-RMADFECloudStorageUploadSession Stop-RMADFEWorkflow Test-RMADBackup Test-RMADSecureStorageBackup Update-RMADBackupAgent Update-RMADFEProject Update-RMADLicense

Add-RMADBackup


external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:

schema: 2.0.0

SYNOPSIS

Registers a backup in the Recovery Manager database.

SYNTAX

BackupInfo

Add-RMADBackup [-InputObject] <BackupInfo[]> [-SkipAlreadyRegistered] [-CheckIntegrity]
 [-BackupPassword <SecureString>] [-IgnoreReadOnly] [<CommonParameters>]

Bkf

Add-RMADBackup [-CheckIntegrity] [-Path] <String[]> [-BackupPassword <SecureString>] [-IgnoreReadOnly]
 [<CommonParameters>]

OfflineDit

Add-RMADBackup [-Path] <String[]> [-SysvolPath <String[]>] [-ResolveIndexes <Boolean>] [-OfflineDit]
 [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Registers specified backup in the Recovery Manager database. Use the -InputObject parameter to specify the backup to register.

EXAMPLES

Example

PS C:\> $b = Get-ChildItem "C:\Backups" -Filter *.bkf -Recurse | Get-RMADBackupInfo

C:\PS>Add-RMADBackup $b

The first line of this example gets the backups held in the C:\Backups folder and its subfolders, and saves the backup objects in the $b variable. The second line of this example registers the backup objects in the Recovery Manager database.

PARAMETERS

-BackupPassword

Specifies the password to access a password-protected backup. This is the same password that is set in the computer collection properties in the Recovery Manager console.

Type: SecureString
Parameter Sets: BackupInfo, Bkf
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CheckIntegrity

Forces checking the integrity of backups after they are registered in the Recovery Manager database.

Type: SwitchParameter
Parameter Sets: BackupInfo, Bkf
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IgnoreReadOnly

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

-InputObject

Accepts a backup object as input to the cmdlet. Enter a variable that contains the objects or type a command or expression that gets the objects.

Type: BackupInfo[]
Parameter Sets: BackupInfo
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OfflineDit

Specifies that the application registers the DIT file as a backup.

Type: SwitchParameter
Parameter Sets: OfflineDit
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Path

Path to the backup file.

Type: String[]
Parameter Sets: Bkf, OfflineDit
Aliases: FullName

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ResolveIndexes

Resolve the DIT file index.

Type: Boolean
Parameter Sets: OfflineDit
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SkipAlreadyRegistered

Do not display the error message if the backup is registered.

Type: SwitchParameter
Parameter Sets: BackupInfo
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-SysvolPath

Path to the SYSVOL folder.

Type: String[]
Parameter Sets: OfflineDit
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

 

Add-RMADCollectionItem


external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:

schema: 2.0.0

SYNOPSIS

Adds a new item to a Computer Collection.

SYNTAX

InputObject

Add-RMADCollectionItem [-InputObject] <ComputerCollection> 
[-DomainController <String>] [-Domain <String>] [-OU <String>]
[-Container <String>] [-ADSite <String>] [-AdamSite <String>]
[-AdamServer <String>] [-AdamHost <String>] [-Exclusions <String[]>] 
[-Credentials <PSCredential>] [-IgnoreReadOnly]
[<CommonParameters>]

Name

Add-RMADCollectionItem -Name <String> [-DomainController <String>] 
[-Domain <String>] [-OU <String>] [-Container <String>] 
[-ADSite <String>] [-AdamSite <String>] [-AdamServer <String>] 
[-AdamHost <String>] [-Exclusions <String[]>] [-Credentials <PSCredential>]
[-IgnoreReadOnly] [<CommonParameters>]

Id

Add-RMADCollectionItem -Id <Int32> [-DomainController <String>] 
[-Domain <String>] [-OU <String>] [-Container <String>] 
[-ADSite <String>] [-AdamSite <String>] [-AdamServer <String>] 
[-AdamHost <String>] [-Exclusions <String[]>] [-Credentials <PSCredential>]
[-IgnoreReadOnly] [<CommonParameters>]

Domain

Add-RMADCollectionItem [-Domain <String>] [-Exclusions <String[]>] 
[-IgnoreReadOnly] [<CommonParameters>]

OU

Add-RMADCollectionItem [-OU <String>] [-Exclusions <String[]>] 
[-Credentials <PSCredential>] [-IgnoreReadOnly] [<CommonParameters>]

Container

Add-RMADCollectionItem [-Container <String>] [-Exclusions <String[]>]
[-Credentials <PSCredential>] [-IgnoreReadOnly] [<CommonParameters>]

ADSite

Add-RMADCollectionItem [-ADSite <String>] [-Exclusions <String[]>] 
[-Credentials <PSCredential>] [-IgnoreReadOnly] [<CommonParameters>]

AdamServer

Add-RMADCollectionItem [-AdamSite <String>] [-AdamServer <String>]
[-Credentials <PSCredential>] [-IgnoreReadOnly] [<CommonParameters>]

AdamSite

Add-RMADCollectionItem [-AdamSite <String>] [-Exclusions <String[]>]
[-Credentials <PSCredential>] [-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Adds a new item to the Computer Collection that has the specified name or is represented by the specified objects.

EXAMPLES

Example 1

PS C:\> Add-RMADCollectionItem -Name Collection1 -DomainController dc1.dom1.local

Adds the dc1.dom1.local domain controller to the computer collection named Collection1.

Example 2

PS C:\> $c = Get-RMADCollection Collection1

C:\PS>Add-RMADCollectionItem -InputObject $c -Domain dom1.local

In the first line of this example, the Get-RMADCollection cmdlet gets the computer collection object named Collection1 and saves it in the $c variable. In the second line, the Add-RMCollection cmdlet adds the dom1.local domain to the Computer Collection object saved in the $c variable.

Example 3

PS C:\> Add-RMADCollectionItem -Name Collection1 -OU "OU=Tokens,OU=Defender,DC=prod,DC=quest,DC=corp"

Adds an OU to the Computer Collection.

Example 4

PS C:\> Add-RMADCollectionItem -Name Collection1 -Container "CN=Computers,DC=prod,DC=quest,DC=corp"

Adds a container to the Computer Collection.

Example 5

PS C:\> $dn = "CN=Default-First-Site-Name,CN=Sites,CN=Configuration,DC=prod,DC=quest,DC=corp"
Add-RMADCollectionItem -Name Collection1 -ADSite $dn -Exclusions @("ws1.prod.quest.corp:0")

Create an ADSite exclude from the domain controller (ws1.prod.quest.corp:0") and add it to the Computer Collection.

Example 6

PS C:\> $dn = "CN=Default-First-Site-Name,CN=Sites,CN=Configuration,CN={7B1308BE-06B9-4925-BEF5-C323292279F5}"
Add-RMADCollectionItem -Name Collection1 -AdamServer ws1.prod.quest.corp:389 -AdamSite dn

Create an AdamSite and add it to the Computer Collection.

PARAMETERS

-AdamHost

Specifies the name of the server for the AD LDS instance installation.

Type: String
Parameter Sets: InputObject, Name, Id
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AdamServer

Name of the AD LDS instance.

Type: String
Parameter Sets: InputObject, Name, Id, AdamServer
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AdamSite

Specifies the distinguished name of the ADAM/AD LDS site to be added to the Computer Collection. Use it in conjunction with AdamServer.

Type: String
Parameter Sets: InputObject, Name, Id, AdamServer, AdamSite
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ADSite

Specifies the distinguished name of the Active Directory site to be added to the Computer Collection.

Type: String
Parameter Sets: InputObject, Name, Id, ADSite
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Container

Specifies the distinguished name of the container to be added to the Computer Collection.

Type: String
Parameter Sets: InputObject, Name, Id, Container
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credentials

Specifies the credentials for the account with which you want to connect. Use the Get-Credential cmdlet provided by Windows PowerShell to pass a PSCredential object to this parameter.

Type: PSCredential
Parameter Sets: InputObject, Name, Id, OU, Container, ADSite, AdamServer, AdamSite
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Domain

Specifies the DNS name of the domain to be added to the Computer Collection.

Type: String
Parameter Sets: InputObject, Name, Id, Domain
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DomainController

Specifies the DNS name of the domain controller to be added to the Computer Collection.

Type: String
Parameter Sets: InputObject, Name, Id
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Exclusions

Excludes a specified domain controller from the collection items to be added. The parameter must be used in conjunction with other parameters.

Type: String[]
Parameter Sets: InputObject, Name, Id, Domain, OU, Container, ADSite, AdamSite
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

Specifies the identifier of the Computer Collection to which you want to add items.

Type: Int32
Parameter Sets: Id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IgnoreReadOnly

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

-InputObject

Specifies the object representing the Computer Collections to which you want to add items. Enter a variable that contains the objects or type a command or expression that gets the objects.

Type: ComputerCollection
Parameter Sets: InputObject
Aliases: Collection

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specifies the name of the Computer Collection to which you want to add items.

Type: String
Parameter Sets: Name
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OU

Specifies the distinguished name of the organizational unit to be added to the Computer Collection.

Type: String
Parameter Sets: InputObject, Name, Id, OU
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

 

Add-RMADFECloudStorage


external help file: QuestSoftware.RecoveryManager.AD.PowerShellFE.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShellFE
online version:

schema: 2.0.0

SYNOPSIS

Registers a cloud storage in the Recovery Manager for Active Directory database, allowing backups to be copied to cloud storage.

SYNTAX

AzureProviderSet

Add-RMADFECloudStorage -Name <String> [-Container <String>] 
[-Confirm <Boolean>] -AzureConnectionString <String> 
[-IgnoreReadOnly] [<CommonParameters>]

AwsProviderSet

Add-RMADFECloudStorage -Name <String> [-Container <String>]
[-Confirm <Boolean>] -AwsAccessKey <String> -AwsSecretKey <String>
[-IgnoreReadOnly] [<CommonParameters>]

DESCRIPTION

Registers a cloud storage in the Recovery Manager for Active Directory database, allowing backups to be copied to cloud storage. Use the Connection String parameter to securely connect to the cloud storage and specify the type of storage using the Type parameter.

EXAMPLES

Example 1

PS C:\>  Add-RMADFECloudStorage -Name "MyStorage" -AzureConnectionString "..." -Container "MyContainer"

Registers the Azure Blob Storage container named MyContainer in Recovery Manager for Active Directory.

Example 2

PS C:\>  Add-RMADFECloudStorage -Name "MyStorage" -AwsAccessKey "..." 
-AwsSecretKey "..." -Container "MyContainer"

Registers the AWS S3 bucket named MyContainer in Recovery Manager for Active Directory.

PARAMETERS

-AwsAccessKey

AWS access key ID

Type: String
Parameter Sets: AwsProviderSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AwsSecretKey

AWS secret key ID

Type: String
Parameter Sets: AwsProviderSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AzureConnectionString

Microsoft Azure connection string

Type: String
Parameter Sets: AzureProviderSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Container

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

-IgnoreReadOnly

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

-Name

Cloud storage display name for the registered storage in Recovery Manager for Active Directory.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

 

Add-RMADReplicationConsole


external help file: QuestSoftware.RecoveryManager.AD.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:

schema: 2.0.0

SYNOPSIS

Adds a RMAD console as a replication source.

SYNTAX

Add-RMADReplicationConsole [-ComputerName] <String> 
[-Mode] <ReplicationMode> [-AccessCredential <PSCredential>] 
[-FallbackCredential <PSCredential>] [-FileSyncEnabled <Boolean>]
[-SourceFiles <String>] [-TargetFolder <String>] [<CommonParameters>]

DESCRIPTION

RMAD console can synchronize the backups, collections, global options, schedules, Secure Storage servers and backups stored on Secure Storage servers from the consoles in the replication console list manually or on schedule.

EXAMPLES

Example 1

PS C:\> C:\>$credential = Get-Credential
C:\>Add-RMADReplicationConsole Hostname1 -AccessCredential $credential 
-Mode Backups

This command adds the RMAD console on Hostname1 to the replication console list with the Backups mode enabled.

Example 2

PS C:\> C:\>Add-RMADReplicationConsole -ComputerName Hostname1 -Mode Full

This command adds the RMAD console on Hostname1 to the replication console list with the Full mode enabled.

Example 3

PS C:\> C:\>$fallbackAccount = Get-Credential
C:\>Add-RMADReplicationConsole -ComputerName Hostname1 -Mode Full 
-FallbackCredential $fallbackAccount

This command adds the RMAD console on Hostname1 to the replication console list with the Full mode enabled and with the specified fallback account.

Example 4

PS C:\> C:\>Add-RMADReplicationConsole -ComputerName Hostname1 -Mode Full -FileSyncEnabled $true -SourceFiles "C:\MyProjectFiles\*.frproj" -TargetFolder "C:\MyProjectFiles"

This command adds the RMAD console on Hostname1 to the replication console list with the Full mode enabled and with replication of the forest recovery project files.

PARAMETERS

-AccessCredential

Specifies the user credentials to read data from the target computer. The user must be a local Administrator on the target computer. To obtain the user credentials, create a PSCredential object using the Get-Credential cmdlet provided by Windows PowerShell.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

Specifies the hostname of the computer on which the RMAD console you want to add is installed.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FallbackCredential

Supplies a fallback account for replacing the account that is used by the backup schedule task. The account must have administrator privileges on the system(s) to be backed up. You can use this parameter only when Full mode is specified for the console.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FileSyncEnabled

Enables replication of forest recovery project files.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Mode

Specifies the console mode: Full (to replicate backups, collections, global options and schedule) or Backups (to replicate backups only).

Type: ReplicationMode
Parameter Sets: (All)
Aliases:
Accepted values: Full, Backups

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourceFiles

Specifies which forest recovery project files to replicate from the source console.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetFolder

Specifies the folder to store the forest recovery project files replicated from the source console.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

 

Documentos relacionados

The document was helpful.

Seleccionar calificación

I easily found the information I needed.

Seleccionar calificación