All Products
Search
Document Center

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

Last Updated:Jan 04, 2026

This topic describes how to deploy an on-premises console for a file gateway from an image. The process includes downloading and installing the image, configuring the network, and activating the gateway.

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. You have created an AccessKey pair. Get your AccessKey pair from the Profile page.

Background information

Cloud Storage Gateway (CSG) can be deployed in on-premises data centers on supported hypervisors, including VMware vSphere, Hyper-V, and KVM. The corresponding gateway image for on-premises deployment is available for download in the CSG console.

Note
  • To deploy gateway images (version 1.0.30 or later) in the OVA format, you must use the vCenter Web Client in vCenter 6.0 or later.

  • Images downloaded from the CSG console cannot be imported into Elastic Compute Service (ECS).

Virtual machine configuration requirements

The virtual machine (VM) where you deploy the file gateway must meet the following minimum requirements:

  • 4 vCPUs (virtual CPUs).

  • At least 8 GB of memory.

  • At least 100 GB of disk space to install the virtual machine image and system data.

  • We recommend that you use Thick Provision for the cache disk to improve I/O performance. The size of a single cache disk must be at least 40 GB.

Installation methods

The installation method and file format depend on your hypervisor. You obtain these files from the CSG console during the gateway creation process.

Hypervisor

Supported installation method

Installation file format

VMware vSphere

Import an OVA file to install CSG.

ova

KVM

Use Virt-Manager to install CSG from a qcow2 file.

qcow2

Hyper-V

Import a VHD file to install CSG.

vhd

Step 1: Download the image

  1. Log on to the CSG console. In the left-side navigation pane, click Gateways. On the Gateways page, click Create.

  2. On the Gateway Information tab, set the following parameters and click Next.

    Parameter

    Description

    Name

    Enter a name for the gateway.

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

    Location

    Select On-premises.

    Region

    Select a region for the file gateway.

    Category

    Select Cloud Storage Gateway (CSG).

    Note

    This parameter is available only when you set Location to On-premises.

    Type

    Select File Gateway.

  3. On the Billing Information tab, set the following parameters and click Next.

    Parameter

    Description

    Billing Method

    Valid values: Pay-as-you-go and Subscription. For more information, see Billable items.

    If you select Subscription, you must complete the payment on the purchase page after the gateway is created. For more information, see Purchase a CSG instance.

    Expiration Policy

    Valid values: Switch to Pay-as-you-go and Release.

  4. On the Image Download tab, download the image for your hypervisor to your local machine.

Step 2: Install the image

After you download the image, deploy the CSG gateway in your on-premises data center. For more information, see Deploy a CSG gateway in an on-premises data center.

Step 3: Configure the network

After you install the gateway image, configure the gateway's IP address using the gateway command-line interface (CLI).

  1. Start the CSG gateway and open the Linux console terminal.

  2. Enter the username and password to access the gateway CLI.

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

  3. Select a language.

    Select English for configuration because some virtual machine versions have issues with Chinese language support.

Select Configure the Network.

Configure the Network1

  1. Select use static ip address.

  2. Note

    The netmask must be an integer from 1 to 32. For example, if the subnet mask is 255.255.255.0, enter 24.

    2Configure IP address

  3. Select config dns.

  4. Select network test to verify network connectivity.

  5. A successful test displays the following output:

  6. Verification result

Select Configure the Date/time to configure the NTP server.

Note

By default, the Alibaba Cloud NTP server (ntp.aliyun.com) provides automatic time synchronization. Alternatively, LocalTime can be selected for manual configuration. It is crucial that any manually configured time is accurate and synchronized with a reliable source.5

Step 4: Activate the gateway

  1. Log on to the CSG console.

  2. Activate the gateway.

    1. Find the target file gateway and click Certificate Download to download the certificate to your on-premises environment.

    2. Open a browser and enter https://<IP address of the file gateway> in the address bar to access the gateway's on-premises console.

    3. On the Cloud Storage Gateway Register page, set the following parameters and click Submit.

      • Upload Certificate: Click Upload Certificate and select the certificate that you downloaded.

        Note

        To register the gateway, you must provide the AccessKey pair of a RAM user. Get the AccessKey pair from the Profile page.

      • Access Key ID: Enter the Access Key ID of the RAM user.

      • Access Key Secret: Enter the Access Key Secret of the RAM user.

      • Username: Set the username for the gateway's on-premises console.

      • Password: Set the password for the gateway's on-premises console.

      • Confirm Password: Enter the password again.

    4. After the gateway is activated, log on to the on-premises console of the file gateway.

Related operations

The following additional operations are also available on the Gateways page:

Operation

Description

Delete a gateway

Find the target file gateway and click Delete.

Note

Only the pay-as-you-go gateways can be deleted.

Rename a gateway

Find the target file gateway, click More > Edit to rename it.

Switch to Subscription

Switch a pay-as-you-go gateway to the subscription billing method.

Click More > Switch to Subscription to open the subscription purchase page. Purchase a subscription plan as required. For more information, see Change the billing method of a gateway from pay-as-you-go to subscription.

Reset Password

For on-premises gateways, the on-premises console password can be reset. Find the target file gateway, click More > Reset Password.