The Set-DPMCloudSubscriptionSetting cmdlet updates subscription settings in Windows Azure Online Backup for a System Center - Data Protection Manager (DPM) server.
Examples
Example 1: Specify Azure Online Backup options for a DPM server
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.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Commit
Position:
3
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
cf
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-DPMServerName
Specifies the name of the DPM server for which this cmdlet updates settings.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
1
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-EncryptionPassphrase
Specifies a secure string that contains a passphrase used to encrypt backups from the DPM server.
Parameter properties
Type:
SecureString
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Encryption
Position:
3
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
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.
Parameter properties
Type:
TimeSpan
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Throttle
Position:
5
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-NonWorkHourBandwidth
Specifies throttling settings for hours outside the range that the StartWorkHour and EndWorkHour parameters define.
Parameter properties
Type:
UInt32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Throttle
Position:
7
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-NoProxy
Indicates that the cmdlet does not use a proxy server.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
NoProxy
Position:
3
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-NoThrottle
Indicates that the cmdlet does not use bandwidth throttling.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
NoThrottle
Position:
3
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ProxyPassword
Specifies a secure string that contains the password for the proxy server.
Parameter properties
Type:
SecureString
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
ProxyServer
Position:
6
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ProxyPort
Specifies a port number for the proxy server.
Parameter properties
Type:
Int32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
ProxyServer
Position:
4
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-ProxyServer
Specifies the name of the proxy server.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
ProxyServer
Position:
3
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-ProxyUsername
Specifies the user name that you use to log on to the proxy server.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
ProxyServer
Position:
5
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
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.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Commit
Position:
3
Mandatory:
False
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
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.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
StagingArea
Position:
3
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
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.
Parameter properties
Type:
TimeSpan
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Throttle
Position:
4
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
-SubscriptionSetting
Specifies a Subscription object that contains the subscription settings.
To obtain a Subscription object, use the Get-DPMCloudSubscription cmdlet.
Parameter properties
Type:
CloudSubscriptionSetting
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
2
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
wi
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
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
Parameter properties
Type:
DayOfWeek[]
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Throttle
Position:
3
Mandatory:
True
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-WorkHourBandwidth
Specifies the bandwidth that Azure Online Backup uses during working hours.
Parameter properties
Type:
UInt32
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
Throttle
Position:
6
Mandatory:
True
Value from pipeline:
False
Value from pipeline by property name:
True
Value from remaining arguments:
False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.