Set-DPMCloudSubscriptionSetting

Updates subscription settings in Azure Online Backup for a DPM server.

Syntax

Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting>
 [-Commit] [-SecurityPin <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting>
 [-EncryptionPassphrase] <SecureString> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting>
 [-WorkDay] <DayOfWeek[]> [-StartWorkHour] <TimeSpan> [-EndWorkHour] <TimeSpan> [-WorkHourBandwidth] <UInt32>
 [-NonWorkHourBandwidth] <UInt32> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting>
 [-NoProxy] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting>
 [-NoThrottle] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting>
 [-ProxyServer] <String> [-ProxyPort] <Int32> [[-ProxyUsername] <String>] [[-ProxyPassword] <SecureString>]
 [-Confirm] [-WhatIf] [<CommonParameters>]
Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String>] [-SubscriptionSetting] <CloudSubscriptionSetting>
 [-StagingAreaPath] <String> [-Confirm] [-WhatIf] [<CommonParameters>]

Description

The Set-DPMCloudSubscriptionSetting cmdlet updates subscription settings in Windows Azure Online Backup for a System Center 2016 - Data Protection Manager (DPM) server.

Examples

Example 1: Specify Azure Online Backup options for a DPM server

PS C:\>$Setting = Get-DPMCloudSubscriptionSetting -DPMServerName "TestingServer"
PS C:\> Set-DPMCloudSubscriptionSetting -DPMServerName "TestingServer" -SubscriptionSetting $Setting -StagingAreaPath "C:\StagingArea"
PS C:\> Set-DPMCloudSubscriptionSetting -DPMServerName "TestingServer" -SubscriptionSetting $Setting -NoProxy
PS C:\> $Passphrase = ConvertTo-SecureString -string "passphrase123456789" -AsPlainText -Force
PS C:\> Set-DPMCloudSubscriptionSetting -DPMServerName "TestingServer" -SubscriptionSetting $Setting -EncryptionPassphrase $Passphrase
PS C:\> Set-DPMCloudSubscriptionSetting -DPMServerName "TestingServer" -SubscriptionSetting $Setting -Commit

The first command gets the subscription settings for the server named TestingServer, and then stores the settings in the $Setting variable.

The second command specifies C:\StagingArea as the staging area for backup files from TestingServer.

The third command indicates that the backup does not use a proxy server.

The fourth command converts the string passphrase123456789 to a secure string, and then stores the secure string in the $Passphrase variable.

The fifth command sets the secure string in $Passphrase as the password for encrypting backups from TestingServer.

The final command saves the backup options that you set in previous commands.

Parameters

-Commit

Indicates that DPM saves the Azure Online Backup settings.

Type:SwitchParameter
Required:True
Position:3
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-DPMServerName

Specifies the name of the DPM server for which this cmdlet updates settings.

Type:String
Required:False
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EncryptionPassphrase

Specifies a secure string that contains a passphrase used to encrypt backups from the DPM server.

Type:SecureString
Required:True
Position:3
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-EndWorkHour

Specifies the end of the time range when DPM uses throttling as specified in the WorkHourBandwidth parameter. Use this parameter together with the StartWorkHour parameter.

Type:TimeSpan
Required:True
Position:5
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-NonWorkHourBandwidth

Specifies throttling settings for hours outside the range that the StartWorkHour and EndWorkHour parameters define.

Type:UInt32
Required:True
Position:7
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-NoProxy

Indicates that the cmdlet does not use a proxy server.

Type:SwitchParameter
Required:True
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NoThrottle

Indicates that the cmdlet does not use bandwidth throttling.

Type:SwitchParameter
Required:True
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProxyPassword

Specifies a secure string that contains the password for the proxy server.

Type:SecureString
Required:False
Position:6
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ProxyPort

Specifies a port number for the proxy server.

Type:Int32
Required:True
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ProxyServer

Specifies the name of the proxy server.

Type:String
Required:True
Position:3
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-ProxyUsername

Specifies the user name that you use to log on to the proxy server.

Type:String
Required:False
Position:5
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SecurityPin

Specifies the Security PIN value for the recovery services vault to which this DPM server is added. This is mandatory if Security Features are enabled for the related Recovery Services vault and encryption passphrase is being changed. To access Security PIN, go to Azure portal and navigate to your Recovery Services vault > Settings > Properties > Generate Security PIN.

Type:String
Required:False
Position:named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-StagingAreaPath

Specifies the path to which you download backups before you recover them to their final location. Ensure that the location you specify has sufficient space to hold the backups.

Type:String
Required:True
Position:3
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-StartWorkHour

Specifies the start of the time range when the throttling settings in the WorkHourBandwidth parameter are in effect. Use this parameter together with the EndWorkHour parameter.

Type:TimeSpan
Required:True
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SubscriptionSetting

Specifies a Subscription object that contains the subscription settings. To obtain a Subscription object, use the Get-DPMCloudSubscription cmdlet.

Type:CloudSubscriptionSetting
Required:True
Position:2
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-WorkDay

Specifies the days of the week when Azure Online Backup runs.

The acceptable values for this parameter are:

- Sunday

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday

Type:DayOfWeek[]
Required:True
Position:3
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-WorkHourBandwidth

Specifies the bandwidth that Azure Online Backup uses during working hours.

Type:UInt32
Required:True
Position:6
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False