Set-DPMCloudSubscriptionSetting

Set-DPMCloudSubscriptionSetting

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

Syntax

Parameter Set: Commit
Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String> ] [-SubscriptionSetting] <CloudSubscriptionSetting> [-Commit] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Encryption
Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String> ] [-SubscriptionSetting] <CloudSubscriptionSetting> [-EncryptionPassphrase] <SecureString> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: NoProxy
Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String> ] [-SubscriptionSetting] <CloudSubscriptionSetting> [-NoProxy] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: NoThrottle
Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String> ] [-SubscriptionSetting] <CloudSubscriptionSetting> [-NoThrottle] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ProxyServer
Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String> ] [-SubscriptionSetting] <CloudSubscriptionSetting> [-ProxyServer] <String> [-ProxyPort] <Int32> [[-ProxyUsername] <String> ] [[-ProxyPassword] <SecureString> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: StagingArea
Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String> ] [-SubscriptionSetting] <CloudSubscriptionSetting> [-StagingAreaPath] <String> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Throttle
Set-DPMCloudSubscriptionSetting [[-DPMServerName] <String> ] [-SubscriptionSetting] <CloudSubscriptionSetting> [-WorkDay] {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}[] [-StartWorkHour] <TimeSpan> [-EndWorkHour] <TimeSpan> [-WorkHourBandwidth] <UInt32> [-NonWorkHourBandwidth] <UInt32> [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

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

Parameters

-Commit

Indicates that DPM saves the Windows Azure Online Backup settings.

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-DPMServerName<String>

Specifies the name of the DPM server.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EncryptionPassphrase<SecureString>

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

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-EndWorkHour<TimeSpan>

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

Aliases

none

Required?

true

Position?

5

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-NonWorkHourBandwidth<UInt32>

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

Aliases

none

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.

Aliases

none

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.

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ProxyPassword<SecureString>

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

Aliases

none

Required?

false

Position?

6

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ProxyPort<Int32>

Specifies a port number for the proxy server.

Aliases

none

Required?

true

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ProxyServer<String>

Specifies the name of the proxy server.

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-ProxyUsername<String>

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

Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-StagingAreaPath<String>

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.

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-StartWorkHour<TimeSpan>

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

Aliases

none

Required?

true

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SubscriptionSetting<CloudSubscriptionSetting>

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

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-WorkDay<DayOfWeek[]>

Specifies the days of the week when Windows Azure Online Backup runs. Valid values for this parameter are:

-- Sunday
-- Monday
-- Tuesday
-- Wednesday
-- Thursday
-- Friday
-- Saturday

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-WorkHourBandwidth<UInt32>

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

Aliases

none

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.

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.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

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

This example sets subscription options for Windows Azure Online Backup for the DPM server named TestingServer.

The first command gets the subscription settings for the server named TestingServer and 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 assigns the secure string to the variable named $Passphrase.

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

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

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

Get-DPMCloudSubscription

Get-DPMCloudSubscriptionSetting