All Products
Search
Document Center

Data Management:Create a database gateway

Last Updated:Mar 28, 2026

A database gateway connects databases in private networks — such as on-premises servers or internal VPCs without public IP addresses — to the Data Management (DMS) console for centralized management.

Prerequisites

Before you begin, make sure you have:

  • Access to the DMS console with sufficient permissions to create resources

  • A machine running Windows or another operating system that has network access to the target database

  • The internal endpoint and port of the database you want to connect

Create a gateway

  1. Log on to the DMS console V5.0.

  2. In the top navigation bar, click Solution. In the left-side navigation pane, click Database gateway.

    In DMS simple mode, move the pointer over the 2022-10-21_15-25-22.png icon in the upper-left corner and choose All functions > Solution > Database gateway.
  3. On the Gateway List page, click Create Gateway.

  4. Enter a name and description for the gateway, then click Next step.

    fdf

  5. Install the Database Gateway agent on the target machine.

    Select the installation method for your operating system:

    • Windows: Click Download gateway to download and run the installer.

    • Other operating systems: Copy the displayed command, paste it into a terminal on the target machine, and press Enter to run it.

    When the agent starts successfully, DMS automatically advances to the Adding a Database page. If it doesn't redirect automatically, click Next step.

  6. Add a database to the gateway. Configure the following parameters:

    To update connection details for a database after it's added, go to the Database Information page.
    ParameterDescription
    Database gatewaySelect the gateway you just created.
    Database typeSelect the database engine type.
    HostThe internal endpoint of the database, as accessible from the machine where the agent is installed.
    PortThe port used to connect to the database.
    DescriptionThe description of the database.

What's next

To add more databases to this gateway, go to the Database Information page.