OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Admin Tool

V4.3.2
  • What's New
  • Product introduction
    • What is OAT?
    • Architecture
    • Terms
  • Quick start
    • Install OAT
    • Get started with OAT
  • oatcli
  • Upgrade guide
  • User guide
    • Log in to OAT
    • Page layout of the OAT console
    • Servers
      • Add a server
      • Edit a server
      • Maintain a server
      • Remove a server
      • Manage credentials
    • Product services
      • Product service versions that support IPv6
      • Install, upgrade, roll back, and uninstall OCP
      • Install, upgrade, roll back, and uninstall ODC
      • Install, upgrade, and uninstall OMS
      • Install, upgrade, roll back, modify, and uninstall OB Sharding
      • Install, upgrade, and uninstall MetaDB
      • Install and uninstall OBDNS
      • Install and uninstall InfluxDB
      • Install and uninstall NLB
      • Install and uninstall OpenSearch
      • Install and uninstall SQLAuditStore
      • Install and uninstall OBLB
      • Take over OCP
      • Take over ODC
      • Take over OB Sharding
      • Take over OMS
      • Take over MetaDB
      • Take over OBDNS
      • Take over InfluxDB
      • Take over NLB
      • Manage images
      • Change resources of services and components
      • Manage tools
      • Refresh data
      • Manage containers
    • Operation and maintenance
      • In-depth inspection
        • Overview
        • Configure inspection items
        • Initiate an in-depth inspection
          • Initiate an in-depth inspection for a single object
          • Initiate a global in-depth inspection
          • Initiate an in-depth inspection for multiple objects
        • View an inspection task
        • Manage an inspection report
          • View an inspection report
          • Download an inspection report
    • System and security
      • Use the task center
      • Manage packages
      • Manage users
      • Audit operations
      • System parameters
        • View and modify system parameters
        • OAT configuration parameters
  • FAQ
  • Release notes
    • OAT V4.3.2
    • OAT V4.3.1
    • OAT V4.3.0

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Admin Tool
  3. V4.3.2

Install and uninstall NLB

Last Updated:2026-09-03 09:50:23

Prerequisites
Install NLB
Uninstall NLB
What to do next

This topic describes how to install and uninstall Network Load Balancer (NLB) in the OceanBase Admin Toolkit (OAT) console.

Prerequisites

Before you install NLB, make sure that the following conditions are met:

  • You have installed OAT and logged in as a super administrator or an O&M engineer. For more information, see Install OAT.
  • You have added a server to install NLB. For more information, see Add a server.
  • You have added an NLB image file.
  • The server meets the requirements for installing NLB.

Install NLB

To install NLB, perform the following steps:

  1. In the left-side navigation pane, choose Product Service > Components.

  2. On the Components page, click Create Component in the upper-right corner and choose Create NLB.

  3. On the Create NLB page, configure the parameters.

    The following table describes the basic parameters of NLB.

    Parameter
    Description
    NLB Image The Docker image of NLB.
    Component Name The name of the component, which must be unique. Default value: NLB.
    Server The IP address of the server on which you want to install NLB.
    CPU The number of CPU cores available to NLB. Default value: 4.
    Memory The size of memory available to NLB, in GB. Default value: 8.
    VIP NIC The network interface controller (NIC) that provides the IP address for accessing NLB.
    VIP Address The IP address for accessing NLB.
    ETCD Peer Port The peer port of the internal etcd.
    ETCD Client Port The client port of the internal etcd.
  4. After you configure the parameters, click Submit.

    You can also click Reset to restore to the default configurations.

Uninstall NLB

To uninstall NLB, perform the following steps:

  1. In the left-side navigation pane, choose Product Service > Components.

  2. Find the NLB component that you want to uninstall and click Uninstall in the Actions column.

    Note

    You can also search for the required NLB component by name at the top of the page.

  3. In the message that appears, click OK.

    Then, OAT displays a message indicating that the component is being uninstalled and creates an uninstallation task. You can click the task ID in the message to view the task progress.

    Note

    If the NLB component is associated with another service, the uninstallation fails.

What to do next

After you install NLB, you can install other OceanBase services.

Previous topic

Install and uninstall InfluxDB
Last

Next topic

Install and uninstall OpenSearch
Next
on this page
Prerequisites
Install NLB
Uninstall NLB
What to do next