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.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Sets global application settings
Set-RMADGlobalOptions [-ExchangeOAuth2 <Boolean>] [-EmailServer <String>] [-EmailSender <String>]
[-ExtendedLogging <Boolean>] [-Properties <Hashtable>] [-IgnoreReadOnly] [-WhatIf] [-Confirm]
[<CommonParameters>]
Sets Recovery Manager global application settings
PS C:\> Set-RMADGlobalOptions -ExchangeOAuth2 $False
Set-RMADGlobalOptions -EmailServer "WS.DomainName.local"
Set-RMADGlobalOptions -EmailSender "from@WS.DomainName.local"
Set-RMADGlobalOptions -ExtendedLogging $True
This command sets global email settings to use SMTP Authentication in Recovery Manager for Active Directory.
PS C:\> $mailOptions = @{
"Email.ExchangeOAuth2" =$True;
"Email.ApplicationId" ='111-111-111';
"Email.TenantId" ='123-456-789';
"Email.Thumbprint" ='abcdefg';
"Email.Sender" ='from@WS.DomainName.local'
}
Set-RMADGlobalOptions -Properties $mailOptions
This command sets global email settings to use Exchange OAuth2 in Recovery Manager for Active Directory using the 'Properties' option.
PS C:\> $mailOptions = @{
"Email.ExchangeOAuth2" =$False;
"Email.Server" ='WS.DomainName.local';
"Email.UseSSL" =$True;
"Email.Sender" ='from@WS.DomainName.local';
"Email.AuthRequired" =$True;
"Email.UserName" ='SmtpAccount';
"Email.Password" ='Password'
}
Set-RMADGlobalOptions -Properties $mailOptions
This command sets global email settings to use SMTP Authentication in Recovery Manager for Active Directory using the 'Properties' option.
PS C:\> Set-RMADGlobalOptions -Properties @{"UseRestoreAgentPort" = $True; "DefaultRestoreMethod" = 0; "AgentPort" = 3845 }
This command sets Recovery Manager global settings for agent.
PS C:\> $mailOptions = @{
"Email.ExchangeOAuth2" =$True;
"Email.ApplicationId" ='111-111-111';
"Email.TenantId" ='123-456-789';
"Email.Thumbprint" ='abcdefg';
"Email.Sender" ='from@WS.DomainName.local';
"Email.GccHighAccount" =$True
}
Set-RMADGlobalOptions -Properties $mailOptions
This command sets global email settings to use Exchange OAuth2 for U.S. Gcc High Account in Recovery Manager for Active Directory using the 'Properties' option.
Specifies the sender field of email notifications
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the SMTP server for email notifications
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies Exchange OAuth2 mode for email notifications
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies diagnostic logs
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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
Allows you to modify the application settings.
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_array Below 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 E-MAIL TAB
Type: Hashtable
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.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Sets the domain systems associated with the Hybrid Connector.
Set-RMADHybridRecoveryDomainOptions -Domain <String> -DomainController <String> -Credentials <PSCredential>
[-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]
Sets the domain and associated systems used for the Hybrid Connector.
PS C:\>$password = ConvertTo-SecureString 'mypassword' -AsPlainText -Force
PS C:\>$credentials = New-Object System.Management.Automation.PSCredential ('rmad-admin', $password)
PS C:\>Set-RMADHybridRecoveryDomainOptions -Domain rmad.local -DomainController DC1.rmad.local -Credentials $credentials
Returns: Nothing on success; otherwise an error
Credentials used for connecting to the system that is running the Azure Active Directory Connector.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Domain which the Hybrid Connector will be using.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The domain Controller that the Azure Active Directory Connector is installed on.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
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: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
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.PowerShell.dll-Help.xml
Module Name: Quest.RecoveryManager.AD.PowerShell
online version:
Sets the domain systems associated with the Hybrid Connector.
Set-RMADHybridRecoveryOptions [-Enabled <Boolean>] [-RelayUrl <String>] [-RelayKeyName <String>]
[-RelayKey <SecureString>] [-UsePackedBackups <Boolean>] [-SkipReplication <Boolean>] [-IgnoreReadOnly]
[-WhatIf] [-Confirm] [<CommonParameters>]
Set-RMADHybridRecoveryOptions [-Enabled <Boolean>] -AADConnectHost <String>
-AADConnectCredentials <PSCredential> [-UsePackedBackups <Boolean>] [-SkipReplication <Boolean>]
[-IgnoreReadOnly] [-WhatIf] [-Confirm] [<CommonParameters>]
Sets the domain and associated systems used in the Hybrid Connector.
PS C:\>$key = ConvertTo-SecureString 'YDrMzfQWP8EliwRj41BtvNIZ4pH7i4pRW24klu8ZRcU=' -AsPlainText -Force
PS C:\>Set-RMADHybridRecoveryOptions -Enabled $true -RelayUrl 'https://relayurl' -RelayKeyName 'listenKey' -RelayKey $key -UsePackedBackups $true -SkipReplication $true
Returns: Nothing on success; otherwise an error
Credentials to connect to the Azure Active Directory Connector.
Type: PSCredential
Parameter Sets: AADConnect
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The host where the Azure Active Directory Connector is installed.
Type: String
Parameter Sets: AADConnect
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Setting to confirm if the Hybrid Connector is enabled. Values can be $true or $false.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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: None
Accept pipeline input: False
Accept wildcard characters: False
Relay key contained in the file received from ODR. This file is down loaded from ODR when the Hybrid Connection is configured in ODR.
Type: SecureString
Parameter Sets: Relay
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Relay name contained in the file received from ODR. This file is down loaded from ODR when the Hybrid Connection is configured in ODR.
Type: String
Parameter Sets: Relay
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The URL contained in the file received from ODR. This file is down loaded from ODR when the Hybrid Connection is configured in ODR.
Type: String
Parameter Sets: Relay
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Configures the Hybrid Connector to perform a replication via the Azure Active Directory Connector. The values can be either $true or $false.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Configures the Hybrid Connector use any unpacked backups that are available. The values can be either $true or $false.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
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.
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. 使用条款 隐私 Cookie Preference Center