KB ID: 115119
Purpose
This guide provides step-by-step instructions to set up Azure Data Box Gateway. If you encounter any issues during the process, you can contact the support team at vembu-support@vembu.com.
Solution
Step 1: Prerequisites
Before you begin, ensure the following:
- Your Microsoft Azure account is enabled for both Data Box Gateway and Pay-as-you-go licenses.
- You have owner or contributor access to Data Box Edge / Data Box Gateway, IoT Hub, and Azure Storage resources at the register resource provider.
Step 2: Register Microsoft DataBoxEdge Provider
To create a Data Box Edge / Data Box Gateway resource, ensure that you have permissions as a contributor (or higher) at the resource group level. Also, make sure that the Microsoft DataBoxEdge provider is registered. To register the provider, follow the steps below:
1. Sign in to the Azure portal with your Microsoft Azure credentials.
2. In the left pane, select "Create a resource" and search for "Data Box Edge / Data Box Gateway".
3. Select "Data Box Edge / Data Box Gateway" and click on "Create".
Step 3: Choose Service and Create Data Box Gateway Resource
1. In the "Data Box Gateway" option, select "Create".
2. Enter or select the project details on the Basics tab:
- Subscription: This will be automatically repopulated based on your previous selection.
- Resource group: Choose an existing group or create a new one.
- Name: Provide a friendly name to identify the resource (2 to 50 characters with letters, numbers, and hyphens).
- Region: Choose a region and click "Review and Create".
3. Check the pricing details, terms of use, and information for your asset on the "Review + create" page, and then click "Create".
Step 4: Download the Virtual Device Image
After the Data Box Gateway resource is created, download the appropriate virtual device image to provision a virtual device on your host system.
1. Select "Overview" from the resource you created, and then select "Device setup".
2. On the "Download image" tile, select the virtual device image corresponding to the operating system on the host server used to provision the VM.
3. Download and unzip the file to a local drive.
Step 5: Get the Activation Key
Once the Data Box Gateway resource is up and running, get the activation key. This key is used to activate and connect the resource to your Data Box Gateway device. The Activation key is available in the Azure portal.
1. Choose the resource you have created, and then select "Overview".
2. Go to "Configure and activate" tile in the "System setup".
3. To create an activation key, select the "Generate key" option.
Note: Copy the key and save it for later use.
Step 6: Prerequisites for Provisioning the Azure Data Box Gateway in Hyper-V
To create a virtual device, ensure the following prerequisites are met:
1. Enable the Hyper-V role installed on Windows Server 2016, Windows Server 2012 R2, or Windows Server 2012.
2. Connect the Microsoft Hyper-V Manager on a Microsoft Windows client to the host.
3. Ensure that the underlying hardware (host system) meets the minimum requirements:
- A minimum of 4 virtual processors.
- At least 8 GB of RAM.
- One network interface connected to the network capable of routing traffic to the Internet.
- A 250 GB OS disk.
- A 2 TB virtual disk for system data.
Step 7: Provision a Virtual Device in the Hypervisor
Follow these steps to provision a device in your hypervisor:
1. On your Windows Server host, copy the virtual device image to a local drive (VHDX image).
2. Open Server Manager, click "Tools" in the top-right corner, and select "Hyper-V Manager".
3. In Hyper-V Manager, select the scope pane, right-click your system node to open the context menu, and then click "New" -> "Virtual Machine".
4. On the "Before you begin" page of the New Virtual Machine Wizard, click "Next".
5. Provide a name for your virtual device on the "Specify Name and Location" page, then click "Next".
6. Select "Generation 2" for the VHDX device on the "Specify Generation" page and click "Next".
7. Specify a startup memory of at least 8192 MB on the "Assign memory" tab, don't enable dynamic memory, and click "Next".
8. Specify the virtual switch connected to the Internet on the "Configure networking" page and click "Next".
9. On the "Connect virtual hard disk" page, choose to "Use an existing virtual hard disk", specify the location of the virtual device image, and click "Next".
10. Review the summary and then click "Finish" to create the virtual machine.
11. To meet the minimum requirements, you need 4 virtual processors. To add 4 virtual processors, select your host system in the Hyper-V Manager window. In the right pane under the list of Virtual Machines, locate the virtual machine you just created. Select and right-click the machine name and select "Settings".
12. On the "Settings" page, in the left pane, click "Processor". In the right pane, set the number of virtual processors to 4 (or more). Click "Apply".
13. To meet the minimum requirements, you also need to add a 2 TB virtual data disk. In the Settings page:
- In the left pane, select "SCSI Controller".
- In the right pane, select "Hard Drive", and click "Add".
- Select the "Virtual Disk" option on the "Hard Drive" page and click "New". The New Virtual Hard Disk Wizard starts.
- Follow the wizard to create the virtual disk with a size of 2 TB (or more).
14. On the "Summary" page, review the details of your virtual data disk and if satisfied, click "Finish" to create the disk. The wizard closes and a virtual hard disk is added to your machine.
15. Return to the "Settings" page, click "OK" to close the Settings page, and return to the Hyper-V Manager window.
Step 8: Start the Virtual Device and Configure the IP Address
Perform the following steps to start your virtual device and connect to it:
1. Start the virtual device.
2. Once your device is running, select the device, right-click, and select "Connect".
3. You may have to wait 10-15 minutes for the device to be ready. After the device is ready, go to "Action". Press "Ctrl + Alt + Delete" to sign in to the virtual device. The default user is "EdgeUser" and the default password is "Password1".
4. If you are booting up in a non-DHCP environment, perform steps 5-7. If you are in a DHCP environment, skip these steps.
5. To configure the network, use the "Get-HcsIpAddress" command to list the network interfaces enabled on your virtual device. If your device has a single network interface enabled, the default name assigned to this interface is "Ethernet".
6. Use the "Set-HcsIpAddress" cmd let to configure the network. For example: "Set-HcsIpAddress –Name Ethernet –IpAddress 192.168.XXX.XXX –Netmask 255.255.255.0 –Gateway 192.168.XXX.XXX".
7. After the initial setup is complete, and the device has booted up, note the IP address and the URL displayed in the banner text to manage the device. Use this IP address to connect to the web UI of your virtual device and complete the local setup and activation.
Step 9: Connect to the Local Web UI Setup
Open a browser window and access the local web UI of the device at: https://ip-address-of-network-interface
Note: You may encounter an error or a warning indicating a problem with the website’s security certificate. Proceed by selecting "Continue" on this webpage (steps might vary depending on the browser you're using).
Step 10: Sign in to the Web UI of Your Virtual Device
1. Sign in to the web UI of your virtual device. The default password is "Password1".
2. Change the device password when prompted. The new password must contain between 8 and 16 characters, including 3 of the following: uppercase, lowercase, numeric, and special characters.
3. You're now at the Dashboard of your device.
Step 11: Set Up and Activate the Virtual Device
Your dashboard displays the settings required to configure and register the virtual device with the Data Box Gateway service. The Cloud settings are the only required settings.
1. In the left pane, select "Device name", and then enter a friendly name for your device.
2. In the left pane, select "Network settings" and configure the settings. If DHCP is enabled in your environment, network interfaces are automatically configured. If not, you can assign static IPs if needed.
3. (Optional) Configure your web proxy server if you use one.
4. (Optional) In the left pane, select "Time settings" and configure the time zone and NTP servers for your device.
5. In the left pane, select "Cloud settings" and activate your device with the Data Box Gateway service in the Azure portal.
6. Enter the activation key obtained in "Step 5: Get the Activation Key" and select "Activate".
7. Wait for the device activation and any critical updates to be applied.
Step 12: Add a Share
To create a share, follow the steps below:
1. In the Azure portal, select your Data Box Gateway resource and then go to "Overview". Your device should be online.
2. Select "+ Add share" on the device command bar.
3. Provide a unique name for your share (3 to 63 characters with lowercase letters, numbers, and hyphens).
4. Select a type for the share (SMB or NFS).
5. Provide a storage account where the share will reside. If a container doesn't already exist, it will be created with the share name. If the container already exists, it will be used.
6. Choose the Storage service from block blob, page blob, or files based on where you want the data to reside in Azure.
7. Depending on the type of share (SMB or NFS), perform the following steps:
- For SMB share, under "All privilege local user", select "Create new" or "Use existing". If you create a new local user, enter a username and password, and then confirm the password. This action assigns permissions to the local user. You can also select the "Allow only read operations" checkbox for this share data to specify read-only users.
- For NFS share, enter the IP addresses of the allowed clients that can access the share.
8. Select "Create" to create the share.
Step 13: Connect to the Share
Depending on whether you have an SMB or NFS share, follow the appropriate steps to connect to the share:
Connect to an SMB Share
- On your Windows Server client connected to your Data Box Gateway, connect to an SMB share by entering the following commands:
- In a command window, type: `net use \<IP address of the device>\<share name> /u:<user name for the share>`.
- On your keyboard, press "Windows + R".
- In the Run window, specify the `\<device IP address>` and then press "OK". File Explorer opens. You should now be able to view the shares that you created as folders. In File Explorer, double-click a share (folder) to view the content.
Connect to an NFS Share
On your Linux client connected to your Data Box Gateway, do the following:
1. Make sure that the client has an NFSv4 client installed. To install the NFS client, use the following command:
`sudo apt-get install nfs-common`
2. After the NFS client is installed, use the following command to mount the NFS share you created on your Data Box Gateway device:
`sudo mount -t nfs -o sec=sys,resvport <device IP>:/<NFS shares on device> /home/username/<Folder on local Linux computer>`
Note: Prior to setting up the mounts, make sure the directories that will act as mount points on your local computer are already created and do not contain any files or sub-folders.
You have now successfully set up Azure Data Box Gateway and connected to your share. You can now start transferring data to the cloud using Data Box Gateway.