Skip to content

Commit 3aff95e

Browse files
fauhseInbalZim
andauthored
Adding Inbal's set of great corrections
Co-authored-by: InbalZim <[email protected]>
1 parent ebb3d5a commit 3aff95e

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

articles/storage-mover/bandwidth-management.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Before you can set a bandwidth schedule, you first need to [deploy a Storage Mov
2020

2121
## Understanding the basic concept of bandwidth management
2222

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.
2424

2525
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.
2626

@@ -119,7 +119,7 @@ Connect-AzAccount -SubscriptionId $subscriptionID # -DeviceLogin #Leverage Devic
119119
120120
#------------
121121
# GET the schedule configured on an agent:
122-
$schedule = @(Get-AzStorageMoverAgent -ResourceGroupName $resourceGroupName -StorageMoverName $storageMoverName -AgentName registeredAgentName).UploadLimitScheduleWeeklyRecurrence
122+
$schedule = @(Get-AzStorageMoverAgent -ResourceGroupName $resourceGroupName -StorageMoverName $storageMoverName -AgentName $registeredAgentName).UploadLimitScheduleWeeklyRecurrence
123123
# $schedule then contains a JSON structure with elements for each configured time windows and the upload limit in Mbps that applies during this window.
124124
125125
# Output the entire schedule
@@ -132,18 +132,18 @@ $schedule[0]
132132
#### Add a new bandwidth limitation
133133
```powershell
134134
$newLimit = New-AzStorageMoverUploadLimitWeeklyRecurrenceObject `
135-
-Day ["Monday", "Tuesday"] ` #Mandatory. An array, limited to the English names of all 7 days, Monday through Sunday in any order.
136-
-LimitInMbps 900 ` # Mandatory. limit in "Mega bits per second"
135+
-Day "Monday", "Tuesday" ` # Mandatory. An array, limited to the English names of all 7 days, Monday through Sunday in any order.
136+
-LimitInMbps 900 ` # Mandatory. Limit in "Mega bits per second"
137137
-StartTimeHour 5 ` # Mandatory. 24-hour clock: 5 = 5am
138138
-EndTimeHour 17 ` # Mandatory. 24-hour clock: 17 = 5pm
139139
-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.
140140
141141
# Updates the bandwidth limit schedule for the selected agent by adding the defined "time block" to the schedule.
142142
# Ensure that the new limit does not overlap with an already configured limit in the schedule, otherwise the operation will fail.
143143
Update-AzStorageMoverAgent `
144-
-ResourceGroupName resourceGroupName `
145-
-StorageMoverName storageMoverName `
146-
-AgentName registeredAgentName `
144+
-ResourceGroupName $resourceGroupName `
145+
-StorageMoverName $storageMoverName `
146+
-AgentName $registeredAgentName `
147147
-UploadLimitScheduleWeeklyRecurrence $newLimit
148148
# You can supply a comma-separated list of new limits. This action will add the new limit(s) to the schedule.
149149
# 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.
@@ -152,10 +152,10 @@ Update-AzStorageMoverAgent `
152152
#### Disable bandwidth limitation for an agent
153153
```powershell
154154
Update-AzStorageMoverAgent `
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.
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.
159159
```
160160

161161
#### Change an existing bandwidth limitation
@@ -164,14 +164,14 @@ You can combine the previously described management actions to selectively updat
164164
```powershell
165165
# Step 1: define the new limit object you want to use to replace an existing limit:
166166
$limit = New-AzStorageMoverUploadLimitWeeklyRecurrenceObject `
167-
-Day ["Monday", "Tuesday"] ` #Mandatory. An array, limited to the English names of all 7 days, Monday through Sunday in any order.
167+
-Day "Monday", "Tuesday" ` # Mandatory. An array, limited to the English names of all 7 days, Monday through Sunday in any order.
168168
-LimitInMbps 900 ` # Mandatory. limit in "Mega bits per second"
169169
-StartTimeHour 5 ` # Mandatory. 24-hour clock: 5 = 5am
170170
-EndTimeHour 17 ` # Mandatory. 24-hour clock: 17 = 5pm
171171
-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.
172172
173-
# Step 2: Find the bandwidth limitation window you wan to change:
174-
$schedule = @(Get-AzStorageMoverAgent -ResourceGroupName $resourceGroupName -StorageMoverName $storageMoverName -AgentName registeredAgentName).UploadLimitScheduleWeeklyRecurrence
173+
# Step 2: Find the bandwidth limitation window you want to change:
174+
$schedule = @(Get-AzStorageMoverAgent -ResourceGroupName $resourceGroupName -StorageMoverName $storageMoverName -AgentName $registeredAgentName).UploadLimitScheduleWeeklyRecurrence
175175
176176
$schedule[<n>] = $limit # Replace the limit (start count at zero) with your newly defined limit.
177177
@@ -188,7 +188,7 @@ Update-AzStorageMoverAgent `
188188
-ResourceGroupName $resourceGroupName `
189189
-StorageMoverName $storageMoverName `
190190
-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.
192192
```
193193
## Understanding the JSON schema of the bandwidth limit schedule
194194
The bandwidth limit schedule is stored as a JSON construct in the property `UploadLimitScheduleWeeklyRecurrence` of a registered agent.

0 commit comments

Comments
 (0)