All Products
Search
Document Center

Cloud Storage Gateway:Deploy an on-premises console for a file gateway

Last Updated:Mar 28, 2025

This topic describes how to deploy an on-premises console for a file gateway by using an image, including tasks such as image download, image installation, network configuration, and gateway activation.

Prerequisites

  1. An Alibaba Cloud account is created and real-name verification for the account is complete. For more information, see Create an Alibaba Cloud account.

    Note

    We recommend that you log on to the CSG console as a RAM user. For more information, see Use RAM to implement account-based access control.

  2. CSG is activated. If CSG is not activated, follow the on-screen instructions in the CSG console to activate CSG.

  3. An Alibaba Cloud AccessKey pair is created. You can go to the Profile page to obtain your AccessKey pair.

Background information

Cloud Storage Gateway (CSG) allows you to deploy gateways in data centers. You can deploy an on-premises console for a file gateway on the following platforms: VMware vSphere, Hyper-V, and Kernel-based Virtual Machine (KVM). Before the deployment, download the corresponding gateway image in the CSG console.

Note
  • OVA images of gateways V1.0.30 and later can be deployed only on web clients of vCenter v6.0 and later.

  • Images downloaded from the CSG console cannot be imported to ECS instances.

Hardware requirements for virtual machines

The virtual machine where the on-premises file gateway is deployed must meet the following requirements:

  • The virtual machine has four vCPUs.

  • The virtual machine has at least 8 GB of memory.

  • The virtual machine has at least 100 GB of disk space. The disk space is used to install a CSG image and store system data.

  • The size of each cache disk must be 40 GB or larger. We recommend that you use thick-provisioned cache disks on the virtual machine to optimize I/O performance.

Installation methods

Installation methods and installation files vary depending on the hypervisor. You can obtain an installation file when you create an on-premises file gateway.

Hypervisor

Installation method

Installation file format

VMware vSphere

Import an OVA image.

ova

KVM

Open the virt-manager and use the QCOW2 file.

qcow2

Hyper-V

Import a VHD file.

vhd

Step 1: Download an image

  1. On the Gateways page of the CSG console, click Create.

  2. In the Gateway Information step, configure the parameters described in the following table and click Next.

    Parameter

    Description

    Name

    Specify a name for the gateway.

    The name must be 1 to 60 characters in length, and can contain letters, digits, underscores (_), hyphens (-), and periods (.). It must start with a letter.

    Location

    Select On-premises.

    Region

    Select the region of the file gateway.

    Type

    The type of the gateway. Select File Gateway.

  3. In the Billing Information step, configure the parameters described in the following table and click Next.

    Parameter

    Description

    Billing Method

    Select Pay-as-you-go or Subscription. For more information, see Billable items and billing methods.

    If you select Subscription, you are redirected to the subscription purchase page after you create the file gateway. Complete the payment. For more information, see Purchase a gateway.

    Expiration Policy

    Select an expiration policy for the gateway. You can select Switch to Pay-as-you-go or Release.

  4. In the Image Download step, download the required image to your on-premises machine.

Step 2: Install the image

After the image is downloaded, use the image to deploy a file gateway. For more information, see How do I deploy a gateway in a data center?

Step 3: Configure network settings

After you install the gateway image, you can configure the gateway IP address in the CLI of the gateway.

  1. Start the on-premises console of the file gateway, and open the Linux terminal of the virtual machine.

  2. Enter your user name and password to log on to the gateway CLI.

    The default user name is root and the default password is Alibaba#sgw#1030.

  3. Select a language.

    Select English.

  4. Select Configure the Network to configure network settings.

    Configure the Network1

    1. Select use static ip address to specify the IP address.

      Note

      The value of the Netmask field ranges from 1 to 32. For example, if the subnet mask is 255.255.255.0, enter 24.

      2配置IP地址

    2. Select config dns and enter the Domain Name System (DNS) server IP address.

    3. Select network test and check the network configuration result.

      The following message indicates that the network settings have been configured.

      验证结果

  5. Select Configure the Date/time and configure the Network Time Protocol (NTP) server.

    Note

    By default, the Alibaba Cloud NTP server at ntp.aliyun.com is used. You can also select LocalTime to specify the local time. The local time must be synchronized with that on Alibaba Cloud.5

Step 4: Activate the gateway

  1. Log on to the CSG console.

  2. Activate the file gateway.

    1. Find the file gateway that you want to activate and click Certificate Download in the Actions column to download the certificate to your computer.

    2. Open your browser. In the address bar of the browser, enter https://<IP address of the file gateway> to visit the on-premises console of the file gateway.

    3. On the Cloud Storage Gateway Register page, configure the following settings, and click Submit.

      • Upload Certificate: Click Upload Certificate to select the certificate that you want to upload.

        Note

        The first time you log on to the CSG console, you must provide the AccessKey pair of your Alibaba Cloud account. You can go to the Profile page to obtain your AccessKey pair.

      • Access Key ID: Enter the AccessKey ID of your Alibaba Cloud account.

      • Access Key Secret: Enter the AccessKey secret of your Alibaba Cloud account.

      • Username: Specify the user name used to log on to the on-premises console of the file gateway.

      • Password: Specify the password used to log on to the on-premises console of the file gateway.

      • Confirm Password: Confirm the password that you have specified.

    4. After you activate the file gateway, log on to the on-premises console of the file gateway.

Related operations

On the Gateways page, you can also perform the following operations.

Operation

Procedure

Delete a gateway

Find the file gateway and click Delete in the Actions column.

Note

You can delete only pay-as-you-go file gateways.

Rename a gateway

Find the gateway and choose More > Edit in the Actions column.

Switch to subscription

After you create a pay-as-you-go gateway, you can switch the billing method from pay-as-you-go to subscription.

Click More > Switch to Subscription to go to the subscription page. For more information, see Switch the billing method from pay-as-you-go to subscription.

Reset the password

Find the file gateway and click More > Reset Password.