Recovery Manager for AD 10.3.1 - Management Shell Guide

Get-RMADBackupObject

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

schema: 2.0.0

SYNOPSIS

Get objects from backups

SYNTAX

InputObject+Name (Default)

Get-RMADBackupObject -InputObject <BackupInfo[]> [-Name <String[]>] [-BackupPassword <SecureString>]
 [-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
 [-AdLdsInstance <String[]>] [<CommonParameters>]

InputObject+Id

Get-RMADBackupObject -InputObject <BackupInfo[]> [-Id <String[]>] [-BackupPassword <SecureString>]
 [-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
 [-AdLdsInstance <String[]>] [<CommonParameters>]

InputObject+Filter

Get-RMADBackupObject -InputObject <BackupInfo[]> [-Filter <String>] [-BackupPassword <SecureString>]
 [-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
 [-AdLdsInstance <String[]>] [<CommonParameters>]

BackupGuid+Id

Get-RMADBackupObject -BackupGuid <Guid[]> [-Id <String[]>] [-BackupPassword <SecureString>]
 [-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
 [-AdLdsInstance <String[]>] [<CommonParameters>]

BackupGuid+Name

Get-RMADBackupObject -BackupGuid <Guid[]> [-Name <String[]>] [-BackupPassword <SecureString>]
 [-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
 [-AdLdsInstance <String[]>] [<CommonParameters>]

BackupGuid+Filter

Get-RMADBackupObject -BackupGuid <Guid[]> [-Filter <String>] [-BackupPassword <SecureString>]
 [-Attribute <String[]>] [-SearchBase <String>] [-Count <Int32>] [-KeepBackupUnpacked]
 [-AdLdsInstance <String[]>] [<CommonParameters>]

DESCRIPTION

Retrieves specific objects from certain backups registered with Recovery Manager for Active Directory.

EXAMPLES

Example 1

PS C:\> Get-RMADBackup | Get-RMADBackupObject -Name "Adm" -Attribute *

Retrieves a list of all backups that are registered in Recovery Manager for Active Directory and then search for the object using ambiguous name resolution. In this example, you will get a list of all objects that have 'Adm' in the beginning of any naming attribute from the 'ANR attribute Set'.

Example 2

PS C:\> Get-RMADBackup | Get-RMADBackupObject -SearchBase 'CN=Partitions,CN=Configuration,DC=CONTOSO,DC=COM' -Filter "objectClass='crossRef'"

Retrieves a list of objects from the container that is specified in the 'SearchBase' parameter. The objects are filtered by the 'objectClass' attribute.

Example 3

PS C:\> Get-RMADBackup | Get-RMADBackupObject -Filter "givenName=Name 1|Name 2,cn=Smith"

Retrieves a list of all registered backups and all objects that have 'Name 1' or 'Name 2' value for the 'givenName' attribute and 'Smith' for the 'CN' attribute.

Example 4

PS C:\> Get-RMADObject -Filter  "distinguishedName='CN=name1,DC=mydomain,DC=com'"

Retrieves a list of all registered backups and all objects that have the following distinguished name: CN=name1,DC=mydomain,DC=com.

Example 5

PS C:\> Get-RMADBackup | Get-RMADBackupObject -AdLdsInstance 'ContosoApplication' -Filter "distinguishedName='CN=Users,CN=Roles,CN=App1,DC=contoso,DC=com'"

Retrieves the object with the specified distinguished name from the backup of the 'ContosoApplication' AD LDS instance.

PARAMETERS

-AdLdsInstance

If you search in the AD LDS instance backup, you should specify a list of AD LDS instances in which you want to search.

Type: String[]
Parameter Sets: (All)
Aliases: AdamInstance

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

-Attribute

Specifies the object attributes to retrieve in addition to the attributes the cmdlet retrieves by default. If this parameter is omitted or empty, the cmdlet retrieves the following default set of object attributes:

• distinguishedName
• name
• objectClass
• objectguid
  
  

Type: String[]
Parameter Sets: (All)
Aliases:

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

-BackupGuid

GUID of the registered backup.

Type: Guid[]
Parameter Sets: BackupGuid+Id, BackupGuid+Name, BackupGuid+Filter
Aliases: Guid

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

-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: (All)
Aliases:

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

-Count

Limits the maximum number of objects to retrieve.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Filter

Allows you to filter objects by attribute names and attribute values. For details, see the examples provided for this cmdlet.

Type: String
Parameter Sets: InputObject+Filter, BackupGuid+Filter
Aliases:

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

-Id

Specifies the identifier of the object to retrieve. This parameter accepts one of the following:

• GUID
• Distinguished name (DN)
• samAccountName
• userLogonName
  
  

Type: String[]
Parameter Sets: InputObject+Id, BackupGuid+Id
Aliases:

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

-InputObject

Specifies backups that contain the retrieved object. To get the backup, use the Get-RMADBackup cmdlet.

Type: BackupInfo[]
Parameter Sets: InputObject+Name, InputObject+Id, InputObject+Filter
Aliases: Backup, Backups

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

-KeepBackupUnpacked

Determines whether to save the unpacked backup after the search operation. If this parameter is not set, the unpacked backup will be deleted after the search operation is completed.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Name

Retrieves objects whose Name attribute value is equal to the value specified in this parameter.

Type: String[]
Parameter Sets: InputObject+Name, BackupGuid+Name
Aliases:

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

-SearchBase

Specifies an Active Directory container in which to search for objects. The search is performed in the specified container and all its subcontainers. Specify the distinguished name (DN) of the container in which you want to search.

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

Get-RMADBackupSecurityStatus

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

schema: 2.0.0

SYNOPSIS

Gets security check information for a specified backup.

SYNTAX

Get-RMADBackupSecurityStatus [-BackupGuid <Guid[]>] [-From <DateTime>] [<CommonParameters>]

DESCRIPTION

Retrieves security check information for a specified backup registered with Recovery Manager for Active Directory.

EXAMPLES

Example 1

PS C:\> $bkf = (Get-RMADBackup -ComputerName dc.DomainName.local)[-1]
$status = New-Object -TypeName QuestSoftware.RecoveryManager.AD.PowerShell.BackupSecurityStatus
$status.Summary = "Passed"
$status.Details = "all successful"
$status.CheckDate = Get-Date 
Publish-RMADBackupSecurityStatus -BackupGuid $bkf.backupGuid -SecurityStatus $status
Get-RMADBackup -ComputerName dc.DomainName.local | %{  
    Get-RMADBackupSecurityStatus -BackupGuid $_.BackupGuid
    }

For troubleshooting only. This command retrieves information related to antimalware scan results for all backups registered with Recovery Manager for Active Directory.

PARAMETERS

-BackupGuid

This is the GUID of the backup for which a user wants to get the antimalware scan results.

Type: Guid[]
Parameter Sets: (All)
Aliases:

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

-From

Specifies the time point to get statuses.

Type: DateTime
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

Get-RMADCollection

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

schema: 2.0.0

SYNOPSIS

Retrieves Recovery Manager computer collection objects or default computer collection settings.

SYNTAX

Name (Default)

Get-RMADCollection [[-Name] <String[]>] [<CommonParameters>]

Id

Get-RMADCollection [-Id] <Int32[]> [<CommonParameters>]

Default

Get-RMADCollection [-Default] [<CommonParameters>]

DESCRIPTION

Allows you to retrieve an existing Recovery Manager computer collection by its name or ID. This cmdlet retrieves all existing computer collections if no collection name or ID is specified. You can also use this cmdlet to retrieve the default computer collection settings that apply to each new computer collection.

EXAMPLES

Example 1

PS C:\> Get-RMADCollection

This command retrieves all Recovery Manager computer collections.

Example 2

PS C:\> (Get-RMADCollection Coll1).Schedule

This command retrieves the line containing the schedule for the collection named Coll1.

PARAMETERS

-Default

Allows you to retrieve the default computer collection settings that apply to each new computer collection. Do not use the Name or ID parameter along with this parameter.

Type: SwitchParameter
Parameter Sets: Default
Aliases:

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

-Id

Specifies the identifier of the Computer Collection to retrieve.

Type: Int32[]
Parameter Sets: Id
Aliases:

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

-Name

Specifies the name of the computer collection you want to retrieve. In the computer collection name that you type in this parameter, you can use an asterisk as a wildcard symbol for any number of any characters. Do not use the Default parameter along with this parameter.

Type: String[]
Parameter Sets: Name
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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

Get-RMADCollectionItem

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

schema: 2.0.0

SYNOPSIS

Retrieves information about items contained in specified Recovery Manager for Active Directory computer collections.

SYNTAX

InputObject

Get-RMADCollectionItem [-InputObject] <ComputerCollection[]> [-UseCache] [-ComputerInfo] [<CommonParameters>]

Name

Get-RMADCollectionItem [-UseCache] [-Name] <String[]> [-ComputerInfo] [<CommonParameters>]

Id

Get-RMADCollectionItem [-UseCache] [-Id] <Int32[]> [-ComputerInfo] [<CommonParameters>]

DESCRIPTION

Retrieves information about items contained in specified Recovery Manager for Active Directory computer collections. You can use this cmdlet to retrieve information about one of the following:

• Items that were explicitly added to computer collections (such as domain controllers, Active Directory domains, Active Directory sites, organizational units, AD LDS (ADAM) hosts, AD LDS (ADAM) instances, and AD LDS (ADAM) sites).
• Domain controllers and AD LDS (ADAM) hosts that are explicitly or implicitly added to computer collections.

EXAMPLES

Example 1

PS C:\> Get-RMADCollectionitem "Computer Collection 02"


Name         : hal-test-dc.hal-test.dev.hal.ca.qsft
DisplayName  : hal-test-dc.hal-test.dev.hal.ca.qsft
Type         : 4
Domain       : hal-test.dev.hal.ca.qsft
TargetGuid   : 00000000000000000000000000000000
Id           : 2
Components   : 0
ComputerName : hal-test-dc.hal-test.dev.hal.ca.qsft
Exclusions   : {}
Port         : 0

This example retrieves information about items that are explicitly contained in the computer collection named Computer Collection 02. These items can include domain controllers, Active Directory domains, Active Directory sites, organizational units, AD LDS (ADAM) hosts, AD LDS (ADAM) instances, and AD LDS (ADAM) sites.

Example 2

PS C:\> Get-RMADCollectionitem -Id 2

Name         : hal-test-dc.hal-test.dev.hal.ca.qsft
DisplayName  : hal-test-dc.hal-test.dev.hal.ca.qsft
Type         : 4
Domain       : hal-test.dev.hal.ca.qsft
TargetGuid   : 00000000000000000000000000000000
Id           : 2
Components   : 0
ComputerName : hal-test-dc.hal-test.dev.hal.ca.qsft
Exclusions   : {}
Port         : 0

Each computer added to the computer collection has an associated identification or Id. This example retrieves information about items that are explicitly contained in the Computer Collection identified by the Id.

Example 3

PS C:\> Get-RMADCollectionitem "Computer Collection 02" -Computerinfo

Id Name                                 Domain                   Components
-- ----                                 ------                   ----------
2 hal-test-dc.hal-test.dev.hal.ca.qsft hal-test.dev.hal.ca.qsft   63966463


PS C:\> Get-RMADCollectionitem "Computer Collection 01" -Computerinfo

Id Name                                Domain                    Components
-- ----                                ------                    ----------
2 hal-test-dc.hal-test.dev.hal.ca.qsft  hal-test.dev.hal.ca.qsft   59770111
4 hal-test-srv.hal-test.dev.hal.ca.qsft hal-test.dev.hal.ca.qsft     524288

These examples retrieve information about the computer items that is explicitly contained in the computer collection named Computer Collection 02.

Example 4

PS C:\> Get-RMADCollectionitem -Name "Computer Collection 02"

Name         : hal-test-dc.hal-test.dev.hal.ca.qsft
DisplayName  : hal-test-dc.hal-test.dev.hal.ca.qsft
Type         : 4
Domain       : hal-test.dev.hal.ca.qsft
TargetGuid   : 00000000000000000000000000000000
Id           : 2
Components   : 0
ComputerName : hal-test-dc.hal-test.dev.hal.ca.qsft
Exclusions   : {}
Port         : 0

This example retrieves information about items that are explicitly contained in the computer collection when
the -Name option is used indicating Computer Collection 02.

Example 5

PS C:\> $B = "Computer Collection 02"
PS C:\> Get-RMADCollectionitem $B -ComputerInfo

Id Name                                 Domain                   Components
-- ----                                 ------                   ----------
 2 hal-test-dc.hal-test.dev.hal.ca.qsft hal-test.dev.hal.ca.qsft   63966463

This example retrieves information about items that are explicitly contained in the computer collection when
the -InputObject option is used indicating Computer Collection 02.

Example 6

PS C:\> Get-RMADCollectionitem -Name "Computer Collection 01" -UseCache

Name         : hal-test-dc.hal-test.dev.hal.ca.qsft
DisplayName  : hal-test-dc.hal-test.dev.hal.ca.qsft
Type         : 4
Domain       : hal-test.dev.hal.ca.qsft
TargetGuid   : 00000000000000000000000000000000
Id           : 1
Components   : 0
ComputerName : hal-test-dc.hal-test.dev.hal.ca.qsft
Exclusions   : {}
Port         : 0

Name         : hal-test-srv.hal-test.dev.hal.ca.qsft
DisplayName  : hal-test-srv.hal-test.dev.hal.ca.qsft
Type         : 5120
Domain       :
TargetGuid   : 00000000000000000000000000000000
Id           : 3
Components   : 0
ComputerName : hal-test-srv.hal-test.dev.hal.ca.qsft
Exclusions   : {}
Port         : 0

This example retrieves information about items that are explicitly contained in the Computer Collection named Computer Collection 02. These items returned are a domain controllers, AD LDS (ADAM) host and AD LDS (ADAM) instance. The -UseCache options returns any additional data from cache.

PARAMETERS

-ComputerInfo

When present, specifies to retrieve information about the domain controllers and AD LDS (ADAM) hosts that are explicitly or implicitly added to the computer collections you specified in the Collection parameter.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Id

Specifies the identifier of the computer collection that includes the items you want to retrieve.

Type: Int32[]
Parameter Sets: Id
Aliases:

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

-InputObject

Specifies the object representing the computer collections that include the items you want to retrieve.

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 that includes the items you want to retrieve.

Type: String[]
Parameter Sets: Name
Aliases:

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

-UseCache

Specifies to return the data from cache

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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