OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Admin Tool

V4.2.1

  • What's New
  • Product introduction
    • What is OAT?
    • Architecture
    • Concepts
  • Quick start
    • Install OAT
    • Get started with OAT
  • oatcli
  • Upgrade guide
  • User guide
    • Log on to OAT
    • Page layout of the OAT console
    • Servers
      • Add a server
      • Edit a server
      • Perform O&M operations on a server
      • Remove a server
      • Manage credentials
    • Product services
      • Install, upgrade, and uninstall OCP
      • Install, upgrade, and uninstall ODC
      • Install, upgrade, and uninstall OMS
      • Install, Upgrade, Modify, and Uninstall OBSharding
      • Install 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 OBSharding
      • Take over OMS
      • Take over MetaDB
      • Take over OBDNS
      • Take over InfluxDB
      • Take over NLB
      • Manage images
      • Modify the resources of products and components
      • Manage tools
      • Refresh data
      • Container operations
    • System security
      • Task center
      • Package management
      • User management
      • Operation audit
      • System parameter
        • View and modify system parameters
        • OAT configuration parameters
  • FAQ

Download PDF

What's New What is OAT? Architecture Concepts Install OAT Get started with OAT oatcli Upgrade guide Log on to OAT Page layout of the OAT console Add a server Edit a server Perform O&M operations on a server Remove a server Manage credentials Install, upgrade, and uninstall OCP Install, upgrade, and uninstall ODC Install, upgrade, and uninstall OMS Install, Upgrade, Modify, and Uninstall OBSharding Install 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 OBSharding Take over OMS Take over MetaDB Take over OBDNS Take over InfluxDB Take over NLB Manage images Modify the resources of products and components Manage tools Refresh data Container operations Task center Package management User management Operation audit FAQ
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Admin Tool
  3. V4.2.1
iconOceanBase Admin Tool
V 4.2.1
  • V 4.5.0
  • V 4.4.1
  • V 4.4.0
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.1
  • V 4.1.2

Install and uninstall NLB

Last Updated:2026-04-13 08:52:08  Updated
share
What is on this page
Prerequisites
Install NLB
Uninstall NLB
What to do next

folded

share

This topic describes how to install and uninstall 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 on as either a super administrator or an O&M engineer. For more information, see Install OAT.
  • You have added a server where NLB is to be installed. 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 > Component Management.

  2. On the Component Management 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 where NLB is to be installed.
    CPU The number of CPU cores on the server available for NLB. Default value: 4C.
    Memory The memory on the server available for NLB. Default value: 8G.
    VIP NIC The NIC that provides the IP address for accessing NLB.
    VIP Address The IP address for accessing NLB.
    ETCD Peer Port The peer port used by the internal ETCD.
    ETCD Client Port The client port used by the internal ETCD.
  4. After you set 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 > Product Management.

  2. Find the target NLB service and click Uninstall in the Actions column.

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

  3. In the confirmation dialog box that appears, click OK.

    OAT displays a message indicating that the service is being uninstalled. OAT also creates an uninstallation task. In the confirmation dialog box that appears, you can click the task ID to view the task progress.

    Notice

    If NLB is associated with another product, the uninstall will fail.

What to do next

After you install NLB, you can install other products in the OceanBase ecosystem.

Previous topic

Install and uninstall InfluxDB
Last

Next topic

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