Set-MBSAgentSetting
Change MBS backup agent options.
Set-MBSAgentSetting
[[-Edition] <String>]
[[-Bandwidth] <String>]
[[-Proxy] <String>]
[[-ProxyAddress] <String>]
[[-ProxyPort] <Int32>]
[[-ProxyAuthentication] <Nullable`1>]
[[-ProxyDomain] <String>]
[[-ProxyUser] <String>]
[[-ProxyPassword] <String>]
[[-ChunkSize] <Int32>]
[[-ThreadCount] <Int32>]
[[-Purge] <String>]
[[-DelayPurge] <String>]
[[-Keep] <String>]
[[-HistoryPurge] <String>]
[[-HistoryLimit] <String>]
[[-Logging] <String>]
[[-RepositoryLocation] <String>]
[[-IgnoreSSLValidation] <Nullable`1>]
[[-Output] <String>]
[[-MasterPassword] <SecureString>]
[<CommonParameters>]
Description
The Set-MBSAgentSetting cmdlet changes MBS agent options.
Examples
Example 1: Set thread count to 10.
This example changes the number of simultaneous thread to 10.
PS C:\>Set-MBSAgentSetting -ThreadCount 10
Example 2: Change default retention policy and logging level.
This example changes default retention policy to keep 5 versions and set logging level to high.
PS C:\>Set-MBSAgentSetting -Keep 5 -Logging high
Parameters
-Edition
Specify backup agent edition. Possible value: desktop, baremetal, mssql, msexchange, mssqlexchange, ultimate, vmedition.
Type | String |
Required: | False |
Position | 1 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Bandwidth
Bandwidth for a plan. Possible values: u(unlimited), value in kB
Type | String |
Required: | False |
Position | 2 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Proxy
Proxy type. Possible values: no, auto, manual
Type | String |
Required: | False |
Position | 3 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProxyAddress
Proxy address.
Type | String |
Required: | False |
Position | 4 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProxyPort
Proxy port (1 - 65535).
Type | Int32 |
Required: | False |
Position | 5 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProxyAuthentication
Proxy authentication. Possible values: $true, $false and unspecified.
Type | Nullable<bool> |
Required: | False |
Position | 6 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProxyDomain
Proxy domain.
Type | String |
Required: | False |
Position | 7 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProxyUser
Proxy user name.
Type | String |
Required: | False |
Position | 8 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProxyPassword
Proxy password.
Type | String |
Required: | False |
Position | 9 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ChunkSize
Specify chunk size in KBs. Possible values: 1024-5242880.
Type | Int32 |
Required: | False |
Position | 10 |
Default value: | 0 |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ThreadCount
Thread count. Possible values: 1-99.
Type | Int32 |
Required: | False |
Position | 11 |
Default value: | 0 |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Purge
Purge versions that are older than period (except lastest version). Possible values: no, 1d(day), 1w(week), 1m(month)
Type | String |
Required: | False |
Position | 12 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DelayPurge
Specify purge delay. Possible values: no, 1d(day), 1w(week), 1m(month)
Type | String |
Required: | False |
Position | 13 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Keep
Keep limited number of versions. Possible values: all, number
Type | String |
Required: | False |
Position | 14 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HistoryPurge
Purge history records that are older than value. Possible values: no, 1d(day), 1w(week), 1m(month)
Type | String |
Required: | False |
Position | 15 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HistoryLimit
Keep limited number of records in history. Possible values: all, number
Type | String |
Required: | False |
Position | 16 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Logging
Logging level. Possible values: no, low, high, debug
Type | String |
Required: | False |
Position | 17 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RepositoryLocation (Alias: DatabaseLocation)
Change database location. By default database is located in user profile. Database will be moved to specified directory for saving space on system drive or other reasons.
Type | String |
Required: | False |
Position | 18 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IgnoreSSLValidation
Ignore SSL validation. Possible values: $true, $false and unspecified.
Type | Nullable<bool> |
Required: | False |
Position | 19 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Output
Output format. Possible values: short, full
Type | String |
Required: | False |
Position | 20 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-MasterPassword
Master password. Should be specified if configuration is protected by master password. Use -MasterPassword (ConvertTo-SecureString -string ""Your_Password"" -AsPlainText -Force).
Type | SecureString |
Required: | False |
Position | 21 |
Default value: | |
Accept pipeline input: | False |
Accept wildcard characters: | False |
CommonParameters
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
System.String[]