KB ID : 115119
Products :
Published : Nov. 28, 2019
Created : Nov. 28, 2019
Last Modified : Nov. 29, 2019


The complete guide to setup Azure Data Box Gateway is described in this article. If you have any trouble following the steps provided, contact our support at vembu-support@vembu.com


For the Data Box Gateway resource

Before you begin, make sure:

  • Your Microsoft Azure account must be enabled for both Data Box Gateway and Pay-as-you-go licenses.
  • You have an owner or contributor access to the Data Box Edge / Data Box Gateway, IoT Hub, and Azure Storage resources at the Register resource provider.

    • To create any Data Box Edge/ Data Box Gateway resource, you must have permissions as a contributor (or higher) at the resource group level. You also need to ensure that the Microsoft DataBoxEdge provider is registered. For details on how to register, go to Register resource provider.

    • To create a Storage account resource, you need a contributor or a higher level of access at the resource group level. By default, Azure Storage is a registered resource provider.

To create a Data Box Gateway resource, proceed with the following steps in the Azure portal.

  • Use your Microsoft Azure credentials to sign in to the Azure portal.

  • In the left pane, select Create a resource and search for Data Box Edge / Data Box Gateway then Select Data Box Edge / Data Box Gateway and Select Create.

  • Choose the service you want to use for the Data Box Gateway device. Choose the area where you want to deploy the Gateway Data Box resource, East US, South East Asia, and West Europe are available for this release. Choose a location closest to the geographical region where you want to deploy your device. In the Data Box Gateway option, select Create.

Select Device Type

Enter or select the following project details on the Basics tab.

  • Subscription: This is automatically repopulated based on the previous selection. Your subscription is linked to your billing account.

  • Resource group: Choose an existing group or create a new group.

Enter or select the following Instance details.

  • Name: A friendly name to identify the resource.

Note: The name should range from 2 to 50 characters with letters, numbers, and hyphens. The name should begin and end with a letter or number

  • Region: Choose a region and click Review and Create.  Check the pricing details, terms of use, and information for your asset on the Review + create page, and select Create.

Creating a resource takes a few minutes. Once you have successfully created and deployed the resource, you will be notified. Select Go to the resource.

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.

Note: The virtual device images are specific to an operating system.

  1. Select Overview from the resource you created and select the Device setup.

    Note: If you have an existing Azure Data Box Gateway resource, select the resource and go to Overview. Select the 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.

Get the activation key

You'll need to get the activation key after the Data Box Gateway resource is up and running. 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. Go to Configure and activate tile in the System setup.

  2. To create an activation key, select the Generate key option.

Note: Select the copy icon to copy the key and save it for later use.

Prerequisites for provisioning the Azure Data Box Gateway in Hyper-V

To create a virtual device,

  • Enable the Hyper-V role installed on Windows Server 2016, Windows Server 2012 R2, or Windows Server 2012.

  • Connect the Microsoft Hyper-V Manager on a Microsoft Windows client to the host.

  • Make sure that the underlying hardware (host system) on which you are creating the virtual device is able to dedicate the following resources to your virtual device:

    • 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

Provision a virtual device in the hypervisor

Perform the following steps to provision a device in your hypervisor.

1) On your Windows Server host, copy the virtual device image to a local drive. You can download this VHDX image through the Azure portal.

Note: Make a note of the location where you copied the image as you are using this image later in the procedure.

2) Open Server Manager. In the top-right corner, click Tools 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. Click Next.

6) Select Generation 2 for vhdx device on the Specify Generation page and then press Next.

7) Specify a startup memory of at least 8192 MB on the Assign memory tab, don't enable dynamic memory, and then click Next.

8) Specify the virtual switch connected to the Internet on the Configure networking page and then 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 then 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:

i. In the left pane, select **SCSI Controller**.

ii. In the right pane, select **Hard Drive**, and click Add.

14) Select the Virtual Disk option on the Hard Drive page and click New. The New Virtual Hard Disk Wizard starts.

15) On the Before you begin page of the New Virtual Hard Disk Wizard, click Next.

16) On the Choose Disk Format page, accept the default option of VHDX format. Click Next.

17) On the Choose Disk Type page, set virtual hard disk type as Dynamically expanding (recommended). The fixed-size disk would work but you may need to wait a long time. We recommend that you do not use the Differencing option. Click Next.

18) Provide a name and location for the data disk on the Specify Name and Location page. Click Next.

19) Select the Create a new blank virtual hard disk option on the Configure Disk page and specify the size as 2 TB (or more). Click Next.

Note : While 2 TB is the minimum requirement, you can always provision a larger disk. As you cannot shrink the disk once provisioned. Attempting to shrink the disk results in a loss of all the local data on the device. You can, however, expand the disk by adding a data disk.

20) 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.

21) Return to the Settings page. Click OK to close the Settings page and return to the Hyper-V Manager window.

Start the virtual device and configure the IP address

Perform the following steps to start your virtual device and connect to it.

To start the virtual device

  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. A status message is displayed on the console to indicate the progress. 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. Steps 5-7 only apply when booting up in a non-DHCP environment. If you are in a DHCP environment, then skip these steps. If you booted up your device in the non-DHCP environment, you will see a message to the effect.

  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 cmdlet to configure the network. See the following example: Set-HcsIpAddress –Name Ethernet –IpAddress 192.168.XXX.XXX –Netmask –Gateway 192.168.XXX.XXX.

  7. After the initial setup is complete and the device has booted up, you will see the device banner text. Make a note of 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.

Note: If your device does not meet the minimum configuration requirements, you see an error in the banner text. Modify the device configuration so that the machine has adequate resources to meet the minimum requirements. You can then restart and connect to the device. Refer to the minimum configuration requirements

Connect to the local web UI setup

  1. Open a browser window and access the local web UI of the device at: https://ip-address-of-network-interface

Use the connection URL noted in the previous tutorial. You see an error or a warning indicating that there is a problem with the website’s security certificate.

  1. Select Continue on this webpage. These steps might vary depending on the browser you're using.

  2. Sign in to the web UI of your virtual device. The default password is Password1.

  3. At the prompt, change the device password. The new password must contain between 8 and 16 characters. It must contain 3 of the following: uppercase, lowercase, numeric, and special characters.

You're now at the Dashboard of your device.

Set up and activate the virtual device

Your dashboard displays the various settings that are required to configure and register the virtual device with the Data Box Gateway service. The Device name, Network settings, Web proxy settings, and Time settings are optional. The only required settings are Cloud settings.

1) In the left pane, select Device name, and then enter a friendly name for your device. The name must contain from 1 to 15 characters long and have letters, numbers, and hyphens.

2) In the left pane, select Network settings and then configure the settings. On your virtual device, you'll see at least one network interface and more depending on how many you configured in the underlying virtual machine.

As you configure network settings, keep in mind:

A. If DHCP is enabled in your environment, network interfaces are automatically configured. An IP address, subnet, gateway, and DNS are automatically assigned.

B. If DHCP isn't enabled, you can assign static IPs if needed.

C. You can configure your network interface as IPv4.

3) (Optional) configure your web proxy server. Although web proxy configuration is optional, if you use a web proxy, you can configure it only on this page.

On the Web proxy page, do the following:

A. In the Web proxy URL box, enter the URL in this format: http://host-IP address or FQDN: Port number. HTTPS URLs are not supported.

B. Under Authentication, select None or NTLM.

C. If you're using authentication, enter a Username and Password.

D. To validate and apply the configured web proxy settings, select Apply.

4) (Optional) In the left pane, select Time settings, and then configure the time zone and the primary and secondary NTP servers for your device. NTP servers are required because your device must synchronize time so that it can authenticate with your cloud service providers.

In the Time settings page, do the following:

A. In the Time zone drop-down list, select the time zone that corresponds to the geographic location in which the device is deployed. The default time zone for your device is PST. Your device will use this time zone for all scheduled operations.

B. Specify a Primary NTP server for your device or accept the default value of time.windows.com.

C. Ensure that your network allows NTP traffic to pass from your datacenter to the Internet.

D. Optionally, in the Secondary NTP server box, enter a secondary server for your device.

E. To validate and apply the configured time settings, select Apply.

5) In the left pane, select Cloud settings, and then activate your device with the Data Box Gateway service in the Azure portal.

A. In the Activation key box, enter the Activation Key that you got in “Get the activation key” for Data Box Gateway.

B. Select Activate.

C. The device is activated and critical updates, if available, are automatically applied. You see a notification to that effect. Monitor the update progress via the Azure portal.

Note: The dialog also has a recovery key that you should copy and save in a safe location. This key is used to recover your data in the event the device can't boot up.

D. You may need to wait several minutes for the update to successfully complete. After the update is complete, sign in to the device. The Cloud settings page updates to indicate that the device is successfully activated.

The device setup is complete. You can now add shares on your device.

Add a share

To create a share do the following procedure:

1) In the Azure portal, select your Data Box Gateway resource and then go to Overview. Your device should be online. Select + Add share on the device command bar.

2) In Add Share, do the following procedure:

A. Provide a unique name for your share. The share names can only have lowercase letters, numbers, and hyphens. The share name must have 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.

B. 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 cliProvide a unique name for your share.ents. Depending upon whether you choose SMB or NFS shares, options presented are slightly different.

C. Provide a storage account where the share will reside. If a container doesn't already exist, it's created in the storage account with the newly created share name. If the container already exists, that container is used.

D. Choose the Storage service from block blob, page blob, or files. The type of 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 blob blocks in Azure, hence we select Block Blob. If choosing Page Blob, you must ensure that your data is 512 bytes aligned. For example, a VHDX is always 512 bytes aligned.

E. This step depends on whether you are creating an SMB or an NFS share.

  - **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 your password. This action assigns the permissions to the local user. After you've assigned the permissions here, you can use File Explorer to modify these permissions. If you select Allow only read operations checkbox for this share data, you can specify read-only users.

  - **NFS share** - Enter the IP addresses of the allowed clients that can access the share.

3) Select Create to create the share. You're notified that the share creation is in progress. After the share is created with the specified settings, the Shares tile updates to reflect the new share.

Connect to the share

You can now connect to one or more of the shares that you created in the last step. Depending upon whether you have an SMB or an NFS share, the steps can vary.

Connect to an SMB share

On your Windows Server client connected to your Data Box Gateway, connect to an SMB share by entering the commands:

  1. In a command window, type: net use \<IP address of the device>\<share name> /u:<user name for the share>

  2. On your keyboard, select Windows + R.

  3. In the Run window, specify the \<device IP address> and then select 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.

The data is written to these shares as it is generated and the device pushes the data to the cloud.

Connect to an NFS share

On your Linux client connected to your Data Box Edge device, do the following procedure:

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-commo

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>

Prior to setting up the mounts, make sure the directories that will act as mount points on your local computer are already created and also do not contain any files or sub-folders.

edit retag flag offensive close merge delete