You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/storage-mover/bandwidth-management.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Before you can set a bandwidth schedule, you first need to [deploy a Storage Mov
20
20
21
21
## Understanding the basic concept of bandwidth management
22
22
23
-
A schedule is an attribute of a registered server. In the portal, you can set and change this schedule on the registered agents page, found in your Storage Mover resource.
23
+
A schedule is an attribute of a registered **agent**. In the portal, you can set and change this schedule on the registered agents page, found in your Storage Mover resource.
24
24
25
25
A bandwidth management schedule describes time windows throughout a week, during which you can set a limit on how much upload bandwidth a Storage Mover agent is allowed to use.
# $schedule then contains a JSON structure with elements for each configured time windows and the upload limit in Mbps that applies during this window.
-EndTimeMinute 30 # Optional. Time blocks are precise to 30 Minutes. -EndTimeMinute 0 is equivalent to omitting the parameter. The only other acceptable value is the half hour mark: 30.
140
140
141
141
# Updates the bandwidth limit schedule for the selected agent by adding the defined "time block" to the schedule.
142
142
# Ensure that the new limit does not overlap with an already configured limit in the schedule, otherwise the operation will fail.
143
143
Update-AzStorageMoverAgent `
144
-
-ResourceGroupName resourceGroupName `
145
-
-StorageMoverName storageMoverName `
146
-
-AgentName registeredAgentName `
144
+
-ResourceGroupName $resourceGroupName `
145
+
-StorageMoverName $storageMoverName `
146
+
-AgentName $registeredAgentName `
147
147
-UploadLimitScheduleWeeklyRecurrence $newLimit
148
148
# You can supply a comma-separated list of new limits. This action will add the new limit(s) to the schedule.
149
149
# If there already are other limits defined, ensure the new limit's time span is not overlapping any of them. Otherwise, the operation will fail.
-UploadLimitScheduleWeeklyRecurrence [] # Supply an empty array to remove all previously configured limits. This operation cannot be undone. You have to build and supply a new schedule if you want to enable bandwidth limitations for this agent again.
155
+
-ResourceGroupName $resourceGroupName `
156
+
-StorageMoverName $storageMoverName `
157
+
-AgentName $registeredAgentName `
158
+
-UploadLimitScheduleWeeklyRecurrence @() # Supply an empty array to remove all previously configured limits. This operation cannot be undone. You have to build and supply a new schedule if you want to enable bandwidth limitations for this agent again.
159
159
```
160
160
161
161
#### Change an existing bandwidth limitation
@@ -164,14 +164,14 @@ You can combine the previously described management actions to selectively updat
164
164
```powershell
165
165
# Step 1: define the new limit object you want to use to replace an existing limit:
-EndTimeMinute 30 # Optional. Time blocks are precise to 30 Minutes. -EndTimeMinute 0 is equivalent to omitting the parameter. The only other acceptable value is the half hour mark: 30.
172
172
173
-
# Step 2: Find the bandwidth limitation window you wan to change:
$schedule[<n>] = $limit # Replace the limit (start count at zero) with your newly defined limit.
177
177
@@ -188,7 +188,7 @@ Update-AzStorageMoverAgent `
188
188
-ResourceGroupName $resourceGroupName `
189
189
-StorageMoverName $storageMoverName `
190
190
-AgentName $registeredAgentName `
191
-
-UploadLimitScheduleWeeklyRecurrence $schedule # Apply your entire, updated schedule. Performing this step on an agent with other limits already configured will try and append the new schedule. Ensure there are no overlapping time spans, otherwise the operation will fail.
191
+
-UploadLimitScheduleWeeklyRecurrence $schedule # Apply your entire, updated schedule. Performing this step on an agent with other limits already configured will override them with the new schedule. Ensure there are no overlapping time spans, otherwise the operation will fail.
192
192
```
193
193
## Understanding the JSON schema of the bandwidth limit schedule
194
194
The bandwidth limit schedule is stored as a JSON construct in the property `UploadLimitScheduleWeeklyRecurrence` of a registered agent.
0 commit comments