Skip to content

Commit 0cea803

Browse files
author
Jill Grant
authored
Merge pull request #283917 from khdownie/kendownie080724
remove login screenshot and cleanup
2 parents 1c58a24 + 8f6bd87 commit 0cea803

File tree

2 files changed

+45
-29
lines changed

2 files changed

+45
-29
lines changed

articles/storage/file-sync/file-sync-server-registration.md

Lines changed: 45 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,31 @@ title: Manage registered servers with Azure File Sync
33
description: Learn how to register and unregister a Windows Server with an Azure File Sync Storage Sync Service.
44
author: khdownie
55
ms.service: azure-file-storage
6-
ms.custom:
76
ms.topic: how-to
8-
ms.date: 10/04/2023
7+
ms.date: 08/07/2024
98
ms.author: kendownie
109
---
1110

1211
# Manage registered servers with Azure File Sync
12+
1313
Azure File Sync allows you to centralize your organization's file shares in Azure Files without giving up the flexibility, performance, and compatibility of an on-premises file server. It does this by transforming your Windows Servers into a quick cache of your Azure file share. You can use any protocol available on Windows Server to access your data locally (including SMB, NFS, and FTPS) and you can have as many caches as you need across the world.
1414

1515
The following article illustrates how to register and manage a server with a Storage Sync Service. See [How to deploy Azure File Sync](file-sync-deployment-guide.md) for information on how to deploy Azure File Sync end-to-end.
1616

1717
## Register/unregister a server with Storage Sync Service
18-
Registering a server with Azure File Sync establishes a trust relationship between Windows Server and Azure. This relationship can then be used to create *server endpoints* on the server, which represent specific folders that should be synced with an Azure file share (also known as a *cloud endpoint*).
18+
19+
Registering a server with Azure File Sync establishes a trust relationship between Windows Server and Azure. This relationship can then be used to create *server endpoints* on the server, which represent specific folders that should be synced with an Azure file share (also known as a *cloud endpoint*).
1920

2021
### Prerequisites
22+
2123
To register a server with a Storage Sync Service, you must first prepare your server with the necessary prerequisites:
2224

2325
* Your server must be running a supported version of Windows Server. For more information, see [Azure File Sync system requirements and interoperability](file-sync-planning.md#windows-file-server-considerations).
24-
* Ensure that a Storage Sync Service has been deployed. For more information on how to deploy a Storage Sync Service, see [How to deploy Azure File Sync](file-sync-deployment-guide.md).
26+
* Ensure that you've deployed a Storage Sync Service. For more information on how to deploy a Storage Sync Service, see [How to deploy Azure File Sync](file-sync-deployment-guide.md).
2527
* Ensure that the server is connected to the internet and that Azure is accessible.
2628
* Disable the IE Enhanced Security Configuration for administrators with the Server Manager UI.
2729

28-
![Server Manager UI with the IE Enhanced Security Configuration highlighted](media/storage-sync-files-server-registration/server-manager-ie-config.png)
30+
![Server Manager UI with the IE Enhanced Security Configuration highlighted.](media/storage-sync-files-server-registration/server-manager-ie-config.png)
2931

3032
* Ensure that the Azure PowerShell module is installed on your server. If your server is a member of a Failover Cluster, every node in the cluster will require the Az module. More details on how to install the Az module can be found on the [Install and configure Azure PowerShell](/powershell/azure/install-azure-powershell).
3133

@@ -41,7 +43,7 @@ To register a server with a Storage Sync Service, you must first prepare your se
4143
* Show the proxy: netsh winhttp show proxy
4244
* Set the proxy: netsh winhttp set proxy 127.0.0.1:8888
4345
* Reset the proxy: netsh winhttp reset proxy
44-
* if this is setup after the agent is installed, then restart our sync agent:
46+
* If this is set up after the agent is installed, then restart our sync agent:
4547
net stop filesyncsvc
4648

4749
```xml
@@ -54,55 +56,61 @@ To register a server with a Storage Sync Service, you must first prepare your se
5456
```
5557

5658
### Register a server with Storage Sync Service
59+
5760
Before a server can be used as a *server endpoint* in an Azure File Sync *sync group*, it must be registered with a *Storage Sync Service*. A server can only be registered with one Storage Sync Service at a time.
5861

5962
#### Install the Azure File Sync agent
63+
6064
1. [Download the Azure File Sync agent](https://go.microsoft.com/fwlink/?linkid=858257).
65+
6166
2. Start the Azure File Sync agent installer.
6267

63-
![The first pane of the Azure File Sync agent installer](media/storage-sync-files-server-registration/install-afs-agent-1.png)
68+
![The first pane of the Azure File Sync agent installer.](media/storage-sync-files-server-registration/install-afs-agent-1.png)
6469

65-
3. Be sure to enable updates to the Azure File Sync agent using Microsoft Update. It is important because critical security fixes and feature enhancements to the server package are shipped via Microsoft Update.
70+
3. Be sure to enable updates to the Azure File Sync agent using Microsoft Update. It's important because critical security fixes and feature enhancements to the server package are shipped via Microsoft Update.
6671

67-
![Ensure Microsoft Update is enabled in the Microsoft Update pane of the Azure File Sync agent installer](media/storage-sync-files-server-registration/install-afs-agent-2.png)
72+
![Ensure Microsoft Update is enabled in the Microsoft Update pane of the Azure File Sync agent installer.](media/storage-sync-files-server-registration/install-afs-agent-2.png)
6873

6974
4. If the server has not been previously registered, the server registration UI will pop up immediately after completing the installation.
7075

7176
> [!IMPORTANT]
72-
> If the server is a member of a Failover Cluster, the Azure File Sync agent needs to be installed on every node in the cluster.
77+
> If the server is a member of a Failover Cluster, the Azure File Sync agent must be installed on every node in the cluster.
7378
7479
#### Register the server using the server registration UI
75-
1. If the server registration UI did not start immediately after completing the installation of the Azure File Sync agent, it can be started manually by executing `C:\Program Files\Azure\StorageSyncAgent\ServerRegistration.exe`.
76-
2. Click *Sign-in* to access your Azure subscription.
7780

78-
![Opening dialog of the server registration UI](media/storage-sync-files-server-registration/server-registration-ui-1.png)
81+
1. If the server registration UI didn't start immediately after completing the installation of the Azure File Sync agent, start it manually by executing `C:\Program Files\Azure\StorageSyncAgent\ServerRegistration.exe`.
7982

80-
3. Pick the correct subscription, resource group, and Storage Sync Service from the dialog.
83+
2. Select *Sign-in* to access your Azure subscription.
8184

82-
![Storage Sync Service information](media/storage-sync-files-server-registration/server-registration-ui-2.png)
85+
![Opening dialog of the server registration UI.](media/storage-sync-files-server-registration/server-registration-ui-1.png)
8386

84-
4. In preview, one more sign-in is required to complete the process.
87+
3. Pick the correct subscription, resource group, and Storage Sync Service from the dialog.
8588

86-
![Sign in dialog](media/storage-sync-files-server-registration/server-registration-ui-3.png)
89+
![Storage Sync Service information.](media/storage-sync-files-server-registration/server-registration-ui-2.png)
90+
91+
4. You might be prompted to sign into Azure again to complete the process.
8792

8893
> [!IMPORTANT]
8994
> If the server is a member of a Failover Cluster, each server needs to run the Server Registration. When you view the registered servers in the Azure Portal, Azure File Sync automatically recognizes each node as a member of the same Failover Cluster, and groups them together appropriately.
9095
9196
#### Register the server with PowerShell
92-
You can also perform server registration via PowerShell.
97+
98+
You can also perform server registration via PowerShell.
9399

94100
```powershell
95101
Register-AzStorageSyncServer -ResourceGroupName "<your-resource-group-name>" -StorageSyncServiceName "<your-storage-sync-service-name>"
96102
```
97103

98104
### Unregister the server with Storage Sync Service
105+
99106
There are several steps that are required to unregister a server with a Storage Sync Service. Let's take a look at how to properly unregister a server.
100107

101108
> [!WARNING]
102-
> Do not attempt to troubleshoot issues with sync, cloud tiering, or any other aspect of Azure File Sync by unregistering and registering a server, or removing and recreating the server endpoints unless explicitly instructed to by a Microsoft engineer. Unregistering a server and removing server endpoints is a destructive operation, and tiered files on the volumes with server endpoints will not be "reconnected" to their locations on the Azure file share after the registered server and server endpoints are recreated, which will result in sync errors. Also note, tiered files that exist outside of a server endpoint namespace may be permanently lost. Tiered files may exist within server endpoints even if cloud tiering was never enabled.
109+
> Don't attempt to troubleshoot issues with sync, cloud tiering, or any other aspect of Azure File Sync by unregistering and registering a server, or removing and recreating the server endpoints unless explicitly instructed to by a Microsoft engineer. Unregistering a server and removing server endpoints is a destructive operation, and tiered files on the volumes with server endpoints will not be "reconnected" to their locations on the Azure file share after the registered server and server endpoints are recreated, which will result in sync errors. Tiered files that exist outside of a server endpoint namespace might be permanently lost. Tiered files might exist within server endpoints even if cloud tiering was never enabled.
103110
104111
#### (Optional) Recall all tiered data
105-
If you would like files that are currently tiered to be available after removing Azure File Sync (i.e. this is a production, not a test, environment), recall all files on each volume containing server endpoints. Disable cloud tiering for all server endpoints, and then run the following PowerShell cmdlet:
112+
113+
If you want files that are currently tiered to be available after removing Azure File Sync (i.e. this is a production, not a test, environment), recall all files on each volume containing server endpoints. Disable cloud tiering for all server endpoints, and then run the following PowerShell cmdlet:
106114

107115
```powershell
108116
Import-Module "C:\Program Files\Azure\StorageSyncAgent\StorageSync.Management.ServerCmdlets.dll"
@@ -113,14 +121,15 @@ Invoke-StorageSyncFileRecall -Path <a-volume-with-server-endpoints-on-it>
113121
> If the local volume hosting the server endpoint does not have enough free space to recall all the tiered data, the `Invoke-StorageSyncFileRecall` cmdlet will fail.
114122
115123
#### Remove the server from all sync groups
124+
116125
Before unregistering the server on the Storage Sync Service, you must remove all server endpoints on that server. You can do this via the Azure portal:
117126

118127
1. Navigate to the Storage Sync Service where your server is registered.
119-
2. Remove all server endpoints for this server in each sync group in the Storage Sync Service. This can be accomplished by right-clicking the relevant server endpoint in the sync group pane.
128+
2. Remove all server endpoints for this server in each sync group in the Storage Sync Service. Do this by right-clicking the relevant server endpoint in the sync group pane.
120129

121130
:::image type="content" source="media/storage-sync-files-server-registration/sync-group-server-endpoint-remove.png" alt-text="Screenshot showing how to remove a server endpoint from a sync group.":::
122131

123-
This can also be accomplished with a simple PowerShell script:
132+
You can also do this with a simple PowerShell script:
124133

125134
```powershell
126135
Connect-AzAccount
@@ -137,6 +146,7 @@ Get-AzStorageSyncGroup -ResourceGroupName $resourceGroup -StorageSyncServiceName
137146
```
138147

139148
#### Unregister the server
149+
140150
Now that all data has been recalled and the server has been removed from all sync groups, you can unregister the server.
141151

142152
1. In the Azure portal, navigate to the Storage Sync Service and select **Sync** > **Registered servers**.
@@ -145,6 +155,7 @@ Now that all data has been recalled and the server has been removed from all syn
145155
:::image type="content" source="media/storage-sync-files-server-registration/unregister-server.png" alt-text="Screenshot showing how to unregister a server.":::
146156

147157
#### Unregister the server with PowerShell
158+
148159
You can also unregister the server via PowerShell by using the `Unregister-AzStorageSyncServer` cmdlet.
149160

150161
> [!WARNING]
@@ -155,28 +166,31 @@ $RegisteredServer = Get-AzStorageSyncServer -ResourceGroupName "<your-resource-g
155166
Unregister-AzStorageSyncServer -Force -ResourceGroupName "<your-resource-group-name>" -StorageSyncServiceName "<your-storage-sync-service-name>" -ServerId $RegisteredServer.ServerId
156167
```
157168

158-
## Ensuring Azure File Sync is a good neighbor in your datacenter
159-
Because Azure File Sync will rarely be the only service running in your datacenter, you might want to limit the network and storage usage of Azure File Sync.
169+
## Ensuring Azure File Sync is a good neighbor in your data center
170+
171+
Because Azure File Sync will rarely be the only service running in your data center, you might want to limit the network and storage usage of Azure File Sync.
160172

161173
> [!IMPORTANT]
162174
> Setting limits too low will impact the performance of Azure File Sync synchronization and recall.
163175
164176
### Set Azure File Sync network limits
177+
165178
You can throttle the network utilization of Azure File Sync by using the `StorageSyncNetworkLimit` cmdlets.
166179

167180
> [!NOTE]
168-
> Network limits does not apply to the following scenarios:
181+
> Network limits don't apply to the following scenarios:
169182
> - When a tiered file is accessed.
170183
> - Sync metadata that is exchanged between the registered server and Storage Sync Service.
171184
>
172-
> Because this network traffic is not throttled, Azure File Sync may exceed the network limit configured. Our recommendation is to monitor the network traffic and adjust the limit to account for the network traffic that is not throttled.
185+
> Because this network traffic isn't throttled, Azure File Sync might exceed the network limit configured. We recommend monitoring the network traffic and adjusting the limit to account for the network traffic that isn't throttled.
173186
174-
For example, you can create a new throttle limit to ensure that Azure File Sync does not use more than 10 Mbps between 9 am and 5 pm (17:00h) during the work week:
187+
For example, you can create a new throttle limit to ensure that Azure File Sync doesn't use more than 10 Mbps between 9 am and 5 pm (17:00h) during the work week:
175188

176189
```powershell
177190
Import-Module "C:\Program Files\Azure\StorageSyncAgent\StorageSync.Management.ServerCmdlets.dll"
178191
New-StorageSyncNetworkLimit -Day Monday, Tuesday, Wednesday, Thursday, Friday -StartHour 9 -EndHour 17 -LimitKbps 10000
179192
```
193+
180194
> [!NOTE]
181195
> To apply the network limit for 24 hours, use 0 for the `-StartHour` and `-EndHour` parameters.
182196
@@ -192,10 +206,12 @@ To remove network limits, use `Remove-StorageSyncNetworkLimit`. For example, the
192206
Get-StorageSyncNetworkLimit | ForEach-Object { Remove-StorageSyncNetworkLimit -Id $_.Id } # assumes StorageSync.Management.ServerCmdlets.dll is imported
193207
```
194208

195-
### Use Windows Server storage QoS
196-
When Azure File Sync is hosted in a virtual machine running on a Windows Server virtualization host, you can use Storage QoS (storage quality of service) to regulate storage IO consumption. You can set the Storage QoS policy either as a maximum (or limit, such as how `StorageSyncNetworkLimit` is enforced in the previous example) or as a minimum (or reservation). Setting a minimum instead of a maximum allows Azure File Sync to burst to use available storage bandwidth if other workloads are not using it. For more information, see [Storage Quality of Service](/windows-server/storage/storage-qos/storage-qos-overview).
209+
### Use Windows Server storage QoS
210+
211+
When Azure File Sync is hosted in a virtual machine running on a Windows Server virtualization host, you can use Storage QoS (storage quality of service) to regulate storage IO consumption. You can set the Storage QoS policy either as a maximum (or limit, such as how `StorageSyncNetworkLimit` is enforced in the previous example) or as a minimum (or reservation). Setting a minimum instead of a maximum allows Azure File Sync to burst to use available storage bandwidth if other workloads aren't using it. For more information, see [Storage Quality of Service](/windows-server/storage/storage-qos/storage-qos-overview).
197212

198213
## See also
214+
199215
- [Planning for an Azure File Sync deployment](file-sync-planning.md)
200216
- [Deploy Azure File Sync](file-sync-deployment-guide.md)
201217
- [Monitor Azure File Sync](file-sync-monitoring.md)

0 commit comments

Comments
 (0)