Skip to content

Commit 50a0787

Browse files
ktoliverktoliver
authored
Merge pull request #69107 from alkohli/eman
manage scenarios for Edge
2 parents f294c91 + 0509e49 commit 50a0787

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+440
-0
lines changed

‎articles/databox-online/TOC.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,14 @@
7979
items:
8080
- name: Develop C# module
8181
href: data-box-edge-create-iot-edge-module.md
82+
- name: Manage shares
83+
href: data-box-edge-manage-shares.md
84+
- name: Manage users
85+
href: data-box-edge-manage-users.md
86+
- name: Manage bandwidth schedules
87+
href: data-box-edge-manage-bandwidth-schedules.md
88+
- name: Manage power, access, connectivity
89+
href: data-box-edge-manage-access-power-connectivity-mode.md
8290
- name: Manage via PowerShell
8391
href: data-box-edge-connect-powershell-interface.md
8492
- name: Resources

‎articles/databox-online/data-box-edge-manage-access-power-connectivity-mode.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: Microsoft Azure Data Box Edge device access, power, and connectivity mode | Microsoft Docs
3+
description: Describes how to manage access, power, and connectivity mode for the Azure Data Box Edge device that helps transfer data to Azure
4+
services: databox
5+
author: alkohli
6+
7+
ms.service: databox
8+
ms.subservice: edge
9+
ms.topic: article
10+
ms.date: 03/11/2019
11+
ms.author: alkohli
12+
---
13+
14+
# Manage access, power, and connectivity mode for your Azure Data Box Edge (preview)
15+
16+
This article describes how to manage the access, power, and connectivity mode for your Azure Data Box Edge. These operations are performed via the local web UI or the Azure portal.
17+
18+
In this article, you learn how to:
19+
20+
> [!div class="checklist"]
21+
> * Manage device access
22+
> * Manage connectivity mode
23+
> * Manage power
24+
25+
> [!IMPORTANT]
26+
> Data Box Edge is in preview. Review the [Azure terms of service for preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) before you order and deploy this solution.
27+
28+
## Manage device access
29+
30+
The access to your Data Box Edge device is controlled by the use of a device administrator password. You can change the administrator password via the local web UI. You can also reset the device administrator password in the Azure portal.
31+
32+
### Change device administrator password
33+
34+
Follow these steps in the local UI to change the device administrator password.
35+
36+
1. In the local web UI, go to **Maintenance > Password change**.
37+
2. Enter the current password and then the new password. The supplied password must be between 8 and 16 characters. The password must have 3 of the following characters: uppercase, lowercase, numeric, and special characters. Confirm the new password.
38+
39+
![Change password](media/data-box-edge-manage-access-power-connectivity-mode/change-password-1.png)
40+
41+
3. Select **Change password**.
42+
43+
### Reset device administrator password
44+
45+
The reset workflow does not require the user to recall the old password and is useful when the password is lost. This workflow is performed in the Azure portal.
46+
47+
1. In the Azure portal, go to **Overview > Reset admin password**.
48+
49+
![Reset password](media/data-box-edge-manage-access-power-connectivity-mode/reset-password-1.png)
50+
51+
52+
2. Enter the new password and then confirm it. The supplied password must be between 8 and 16 characters. The password must have 3 of the following characters: uppercase, lowercase, numeric, and special characters. Select **Reset**.
53+
54+
![Reset password](media/data-box-edge-manage-access-power-connectivity-mode/reset-password-2.png)
55+
56+
## Manage connectivity mode
57+
58+
Apart from the default fully connected mode, your device can also run in partially connected, or fully disconnected mode. Each of these modes is described as below:
59+
60+
- **Fully connected** - This is the normal default mode in which the device operates. Both the cloud upload and download of data is enabled in this mode. You can use the Azure portal or the local web UI to manage the device.
61+
62+
- **Partially disconnected** – In this mode, the device cannot upload any data to the shares however can be managed via the Azure portal.
63+
64+
This mode is typically used when on a metered satellite network and the goal is to minimize network bandwidth consumption. Minimal network consumption may still occur for device monitoring operations.
65+
66+
- **Disconnected** – In this mode, the device is fully disconnected from the cloud and both the cloud uploads and downloads are disabled. The device can only be managed via the local web UI.
67+
68+
This mode is typically used when you want to take your device offline.
69+
70+
To change device mode, follow these steps:
71+
72+
1. In the local web UI of your device, go to **Configuration > Cloud settings**.
73+
2. From the dropdown list, select the mode that you want to operate the device in. You can select from **Fully connected**, **Partially connected**, and **Fully disconnected**. To run the device in partially disconnected mode, enable **Azure portal management**.
74+
75+
![Connectivity mode](media/data-box-edge-manage-access-power-connectivity-mode/connectivity-mode.png)
76+
77+
## Manage power
78+
79+
You can shut down or restart your physical device using the local web UI. We recommend that before you restart, take the shares offline on the data server and then the device. This action minimizes any possibility of data corruption.
80+
81+
1. In the local web UI, go to **Maintenance > Power settings**.
82+
2. Select **Shutdown** or **Restart** depending on what you intend to do.
83+
84+
![Power settings](media/data-box-edge-manage-access-power-connectivity-mode/shut-down-restart-1.png)
85+
86+
3. When prompted for confirmation, select **Yes** to proceed.
87+
88+
> [!NOTE]
89+
> If you shut down the physical device, you will need to push the power button on the device to turn it on.
90+
91+
## Next steps
92+
93+
- Learn how to [Manage shares](data-box-edge-manage-shares.md).

‎articles/databox-online/data-box-edge-manage-bandwidth-schedules.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: Azure Data Box Edge manage bandwidth schedules | Microsoft Docs
3+
description: Describes how to use the Azure portal to manage bandwidth schedules on your Azure Data Box Edge.
4+
services: databox
5+
author: alkohli
6+
7+
ms.service: databox
8+
ms.subservice: edge
9+
ms.topic: overview
10+
ms.date: 03/12/2019
11+
ms.author: alkohli
12+
---
13+
# Use the Azure portal to manage bandwidth schedules on your Azure Data Box Edge
14+
15+
This article describes how to manage users on your Azure Data Box Edge. Bandwidth schedules allow you to configure network bandwidth usage across multiple time-of-day schedules. These schedules can be applied to the upload and download operations from your device to the cloud.
16+
17+
You can add, modify, or delete the bandwidth schedules for your Data Box Edge via the Azure portal.
18+
19+
> [!IMPORTANT]
20+
> Data Box Edge is in preview. Review the [Azure terms of service for preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) before you order and deploy this solution.
21+
22+
In this article, you learn how to:
23+
24+
> [!div class="checklist"]
25+
> * Add a schedule
26+
> * Modify schedule
27+
> * Delete a schedule
28+
29+
30+
## Add a schedule
31+
32+
Do the following steps in the Azure portal to add a schedule.
33+
34+
1. In the Azure portal for your Data Box Edge resource, go to **Bandwidth**.
35+
2. In the right-pane, select **+ Add schedule**.
36+
37+
![Select Bandwidth](media/data-box-edge-manage-bandwidth-schedules/add-schedule-1.png)
38+
39+
3. In the **Add schedule**:
40+
41+
1. Provide the **Start day**, **End day**, **Start time**, and **End time** of the schedule.
42+
2. Check the **All day** option if this schedule should run all day.
43+
3. **Bandwidth rate** is the bandwidth in Megabits per second (Mbps) used by your device in operations involving the cloud (both uploads and downloads). Supply a number between 20 and 1,000,000,007 for this field.
44+
4. Check **Unlimited** bandwidth if you do not want to throttle the date upload and download.
45+
5. Select **Add**.
46+
47+
![Add schedule](media/data-box-edge-manage-bandwidth-schedules/add-schedule-2.png)
48+
49+
3. A schedule is created with the specified parameters. This schedule is then displayed in the list of bandwidth schedules in the portal.
50+
51+
![Updated list of bandwidth schedules](media/data-box-edge-manage-bandwidth-schedules/add-schedule-3.png)
52+
53+
## Edit schedule
54+
55+
Do the following steps to edit a bandwidth schedule.
56+
57+
1. In the Azure portal, go to your Data Box Edge resource and then go to **Bandwidth**.
58+
2. From the list of bandwidth schedules, select and select a schedule that you want to modify.
59+
![Select bandwidth schedule](media/data-box-edge-manage-bandwidth-schedules/modify-schedule-1.png)
60+
61+
3. Make the desired changes and save the changes.
62+
63+
![Modify user](media/data-box-edge-manage-bandwidth-schedules/modify-schedule-2.png)
64+
65+
4. After the schedule is modified, the list of schedules is updated to reflect the modified schedule.
66+
67+
![Modify user](media/data-box-edge-manage-bandwidth-schedules/modify-schedule-3.png)
68+
69+
70+
## Delete a schedule
71+
72+
Do the following steps to delete a bandwidth schedule associated with your Data Box Edge device.
73+
74+
1. In the Azure portal, go to your Data Box Edge resource and then go to **Bandwidth**.
75+
76+
2. From the list of bandwidth schedules, select a schedule that you want to delete. In the **Edit schedule**, select **Delete**. When prompted for confirmation, select **Yes**.
77+
78+
![Delete a user](media/data-box-edge-manage-bandwidth-schedules/delete-schedule-2.png)
79+
80+
3. After the schedule is deleted, the list of schedules is updated.
81+
82+
83+
## Next steps
84+
85+
- Learn how to [Manage shares](data-box-edge-manage-shares.md).

‎articles/databox-online/data-box-edge-manage-shares.md

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
---
2+
title: Azure Data Box Edge share management | Microsoft Docs
3+
description: Describes how to use the Azure portal to manage shares on your Azure Data Box Edge.
4+
services: databox
5+
author: alkohli
6+
7+
ms.service: databox
8+
ms.subservice: edge
9+
ms.topic: overview
10+
ms.date: 03/11/2019
11+
ms.author: alkohli
12+
---
13+
# Use the Azure portal to manage shares on your Azure Data Box Edge
14+
15+
This article describes how to manage shares on your Azure Data Box Edge. You can manage the Azure Data Box Edge via the Azure portal or via the local web UI. Use the Azure portal to add, delete, refresh shares, or sync storage key for storage account associated with the shares.
16+
17+
> [!IMPORTANT]
18+
> Data Box Edge is in preview. Review the [Azure terms of service for preview](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) before you order and deploy this solution.
19+
20+
21+
## About shares
22+
23+
To transfer data to Azure, you need to create shares on your Azure Data Box Edge. The shares that you add on the Data Box Edge device can be local shares or shares that push data to cloud.
24+
25+
- **Local shares**: Use these shares when you want the data to be processed locally on the device.
26+
- **Shares**: Use these shares when you want the device data to be automatically pushed to your storage account in the cloud. All the cloud functions such as **Refresh** and **Sync storage keys** apply to the shares.
27+
28+
In this article, you learn how to:
29+
30+
> [!div class="checklist"]
31+
> * Add a share
32+
> * Delete a share
33+
> * Refresh shares
34+
> * Sync storage key
35+
36+
37+
## Add a share
38+
39+
Do the following steps in the Azure portal to create a share.
40+
41+
1. In the Azure portal, go to your Data Box Edge resource and then go to **Gateway > Shares**. Select **+ Add share** on the command bar.
42+
43+
![Select add share](media/data-box-edge-manage-shares/add-share-1.png)
44+
45+
2. In **Add Share**, specify the share settings. Provide a unique name for your share.
46+
47+
Share names can only contain numbers, lowercase letters, and hyphens. The share name must be between 3 and 63 characters long and begin with a letter or a number. Each hyphen must be preceded and followed by a non-hyphen character.
48+
49+
3. Select a **Type** for the share. The type can be **SMB** or **NFS**, with SMB being the default. SMB is the standard for Windows clients, and NFS is used for Linux clients. Depending upon whether you choose SMB or NFS shares, options presented are slightly different.
50+
51+
4. Provide a **Storage account** where the share lives. A container is created in the storage account with the share name if the container already does not exist. If the container already exists, then the existing container is used.
52+
53+
5. From the dropdown list, choose the **Storage service** from block blob, page blob, or files. The type of the service chosen depends on which format you want the data to reside in Azure. For example, in this instance, we want the data to reside as block blobs in Azure, hence we select **Block Blob**. If choosing **Page Blob**, you must ensure that your data is 512 bytes aligned. Use **Page blob** for VHDs or VHDX that are always 512 bytes aligned.
54+
55+
6. This step depends on whether you are creating an SMB or an NFS share.
56+
- **If creating an SMB share** - In the **All privilege local user** field, choose from **Create new** or **Use existing**. If creating a new local user, provide the **username**, **password**, and then confirm password. This assigns the permissions to the local user. After you have assigned the permissions here, you can then use File Explorer to modify these permissions.
57+
58+
![Add SMB share](media/data-box-edge-manage-shares/add-smb-share.png)
59+
60+
If you check allow only read operations for this share data, you can specify read-only users.
61+
- **If creating an NFS share** - You need to supply the **IP addresses of the allowed clients** that can access the share.
62+
63+
![Add NFS share](media/data-box-edge-manage-shares/add-nfs-share.png)
64+
65+
7. Click **Create** to create the share. You are notified that the share creation is in progress. After the share is created with the specified settings, the **Shares** blade updates to reflect the new share.
66+
67+
## Add a local share
68+
69+
1. In the Azure portal, go to your Data Box Edge resource and then go to **Gateway > Shares**. Select **+ Add share** on the command bar.
70+
71+
![Select add share](media/data-box-edge-manage-shares/add-local-share-1.png)
72+
73+
2. In **Add Share**, specify the share settings. Provide a unique name for your share.
74+
75+
Share names can only contain numbers, lowercase letters, and hyphens. The share name must be between 3 and 63 characters long and begin with a letter or a number. Each hyphen must be preceded and followed by a non-hyphen character.
76+
77+
3. Select a **Type** for the share. The type can be **SMB** or **NFS**, with SMB being the default. SMB is the standard for Windows clients, and NFS is used for Linux clients. Depending upon whether you choose SMB or NFS shares, options presented are slightly different.
78+
79+
4. To easily access the shares from Edge compute modules, use the local mount point. Select **Use the share with Edge compute** so that the Edge module can use the compute with the local mount point.
80+
81+
5. Select **Configure as Edge local shares**. The data in local shares will stay locally on the device. You can process this data locally.
82+
83+
6. In the **All privilege local user** field, choose from **Create new** or **Use existing**.
84+
85+
7. Select **Create**.
86+
87+
![Create local share](media/data-box-edge-manage-shares/add-local-share-2.png)
88+
89+
You see a notification that the share creation is in progress. After the share is created with the specified settings, the **Shares** blade updates to reflect the new share.
90+
91+
![View updates Shares blade](media/data-box-edge-manage-shares/add-local-share-4.png)
92+
93+
Select the share to view the local mountpoint for the Edge compute modules for this share.
94+
95+
![View local share details](media/data-box-edge-manage-shares/add-local-share-4.png)
96+
97+
## Delete a share
98+
99+
Do the following steps in the Azure portal to delete a share.
100+
101+
1. From the list of shares, select and click the share that you want to delete.
102+
103+
![Select share](media/data-box-edge-manage-shares/delete-share-1.png)
104+
105+
2. Click **Delete**.
106+
107+
![Click delete](media/data-box-edge-manage-shares/delete-share-2.png)
108+
109+
3. When prompted for confirmation, click **Yes**.
110+
111+
![Confirm delete](media/data-box-edge-manage-shares/delete-share-3.png)
112+
113+
The list of shares updates to reflect the deletion.
114+
115+
116+
## Refresh shares
117+
118+
The refresh feature allows you to refresh the contents of a share. When you refresh a share, a search is initiated to find all the Azure objects including blobs and files that were added to the cloud since the last refresh. These additional files are then downloaded to refresh the contents of the share on the device.
119+
120+
> [!IMPORTANT]
121+
> You can't refresh local shares.
122+
123+
Do the following steps in the Azure portal to refresh a share.
124+
125+
1. In the Azure portal, go to **Shares**. Select and click the share that you want to refresh.
126+
127+
![Select share](media/data-box-edge-manage-shares/refresh-share-1.png)
128+
129+
2. Click **Refresh**.
130+
131+
![Click refresh](media/data-box-edge-manage-shares/refresh-share-2.png)
132+
133+
3. When prompted for confirmation, click **Yes**. A job starts to refresh the contents of the on-premises share.
134+
135+
![Confirm refresh](media/data-box-edge-manage-shares/refresh-share-3.png)
136+
137+
4. While the refresh is in progress, the refresh option is grayed out in the context menu. Click the job notification to view the refresh job status.
138+
139+
5. The time to refresh depends on the number of files in the Azure container as well as the files on the device. Once the refresh has successfully completed, the share timestamp is updated. Even if the refresh has partial failures, the operation is considered successful and the timestamp is updated. The refresh error logs are also updated.
140+
141+
![Updated timestamp](media/data-box-edge-manage-shares/refresh-share-4.png)
142+
143+
If there is a failure, an alert is raised. The alert details the cause and the recommendation to fix the issue. The alert also links to a file that has the complete summary of the failures including the files that failed to update or delete.
144+
145+
146+
## Sync storage keys
147+
148+
If your storage account keys have been rotated, then you need to sync the storage access keys. The sync helps the device get the latest keys for your storage account.
149+
150+
Do the following steps in the Azure portal to sync your storage access key.
151+
152+
1. Go to **Overview** in your resource. From the list of shares, choose and click a share associated with the storage account that you need to sync.
153+
154+
![Select share with relevant storage account](media/data-box-edge-manage-shares/sync-storage-key-1.png)
155+
156+
2. Click **Sync storage key**. Click **Yes** when prompted for confirmation.
157+
158+
![Select Sync storage key](media/data-box-edge-manage-shares/sync-storage-key-2.png)
159+
160+
3. Exit out of the dialog once the sync is complete.
161+
162+
>[!NOTE]
163+
> You only have to do this once for a given storage account. You don't need to repeat this action for all the shares associated with the same storage account.
164+
165+
166+
## Next steps
167+
168+
- Learn how to [Manage users via Azure portal](data-box-edge-manage-users.md).

0 commit comments

Comments
 (0)