The agent is a component of the database audit system and must be installed on a user terminal, the target database server, or a connected application server. It collects database access traffic and forwards it to the audit system for analysis and logging. This topic explains how to install and uninstall the agent.
Support details
Database type
For the database types supported by a Database Auditing D100 instance, see Supported database types.
Operating system compatibility
The Agent cannot be installed on servers running a 32-bit operating system; therefore, database auditing is not supported on these servers.
|
Operating system |
Cloud assistant installation |
Manual installation |
|
|
Windows |
2022 Datacenter Edition 64-bit (Chinese) |
Supported |
Supported |
|
2022 Datacenter Edition 64-bit (Chinese, UEFI Edition) |
Supported |
Supported |
|
|
2022 Datacenter Edition 64-bit (English) |
Supported |
Supported |
|
|
2022 Datacenter Edition 64-bit (English, UEFI Edition) |
Supported |
Supported |
|
|
2022 with Container Datacenter Edition 64-bit (Chinese) |
Supported |
Supported |
|
|
2022 with Container Datacenter Edition 64-bit (English) |
Supported |
Supported |
|
|
2019 Datacenter Edition 64-bit (Chinese) |
Supported |
Supported |
|
|
2019 Datacenter Edition 64-bit (English) |
Supported |
Supported |
|
|
2019 with Container Datacenter Edition 64-bit (Chinese) |
Supported |
Supported |
|
|
2019 with Container Datacenter Edition 64-bit (English) |
Supported |
Supported |
|
|
2016 Datacenter Edition 64-bit (Chinese) |
Supported |
Supported |
|
|
2016 Datacenter Edition 64-bit (English) |
Supported |
Supported |
|
|
2016 Standard Edition 64-bit (Chinese) |
Supported |
Supported |
|
|
2012 R2 Datacenter Edition 64-bit (Chinese) |
Supported |
Supported |
|
|
2012 R2 Datacenter Edition 64-bit (English) |
Supported |
Supported |
|
|
2008 R2 Enterprise Edition 64-bit (Chinese) |
Supported |
Supported |
|
|
2008 R2 Enterprise Edition 64-bit (English) |
Supported |
Supported |
|
|
Alibaba Cloud Linux |
3.2104 LTS 64-bit |
Supported |
Supported |
|
2.1903 LTS 64-bit |
Supported |
Supported |
|
|
3.2104 LTS 64-bit Quick Start Edition |
Supported |
Supported |
|
|
3.2104 LTS 64-bit MLPS 2.0 Level 3 Edition |
Supported |
Supported |
|
|
2.1903 LTS 64-bit Quick Start Edition |
Supported |
Supported |
|
|
2.1903 LTS 64-bit MLPS 2.0 Level 3 Edition |
Supported |
Supported |
|
|
3.2104 LTS 64-bit UEFI Edition |
Supported |
Supported |
|
|
2.1903 LTS 64-bit UEFI Edition |
Supported |
Supported |
|
|
3.2104 LTS 64-bit SCC Edition |
Supported |
Supported |
|
|
2.1903 LTS 64-bit SCC Edition |
Supported |
Supported |
|
|
Anolis OS |
8.8 RHCK 64-bit |
Supported |
Supported |
|
8.8 ANCK 64-bit |
Supported |
Supported |
|
|
8.6 RHCK 64-bit |
Supported |
Supported |
|
|
8.6 ANCK 64-bit |
Supported |
Supported |
|
|
8.8 ANCK 64-bit MLPS 2.0 Level 3 Edition |
Supported |
Supported |
|
|
8.6 RHCK 64-bit UEFI Edition |
Supported |
Supported |
|
|
8.6 ANCK 64-bit UEFI Edition |
Supported |
Supported |
|
|
7.9 RHCK 64-bit |
Supported |
Supported |
|
|
7.9 ANCK 64-bit |
Supported |
Supported |
|
|
8.8 RHCK 64-bit UEFI Edition |
Supported |
Supported |
|
|
8.8 ANCK 64-bit UEFI Edition |
Supported |
Supported |
|
|
8.4 RHCK 64-bit |
Supported |
Supported |
|
|
8.4 ANCK 64-bit |
Supported |
Supported |
|
|
8.2 RHCK 64-bit |
Supported |
Supported |
|
|
8.2 ANCK 64-bit |
Supported |
Supported |
|
|
7.7 RHCK 64-bit |
Supported |
Supported |
|
|
7.7 ANCK 64-bit |
Supported |
Supported |
|
|
8.4 RHCK 64-bit UEFI Edition |
Supported |
Supported |
|
|
8.4 ANCK 64-bit UEFI Edition |
Supported |
Supported |
|
|
7.9 RHCK 64-bit UEFI Edition |
Supported |
Supported |
|
|
7.9 ANCK 64-bit UEFI Edition |
Supported |
Supported |
|
|
CentOS |
7.9 64-bit |
Supported |
Supported |
|
7.8 64-bit |
Supported |
Supported |
|
|
7.7 64-bit |
Supported |
Supported |
|
|
7.6 64-bit |
Supported |
Supported |
|
|
7.5 64-bit |
Supported |
Supported |
|
|
7.4 64-bit |
Supported |
Supported |
|
|
7.9 64-bit UEFI Edition |
Supported |
Supported |
|
|
7.9 64-bit SCC Edition |
Supported |
Supported |
|
|
7.3 64-bit |
Supported |
Supported |
|
|
7.2 64-bit |
Supported |
Supported |
|
|
7.0 64-bit |
Supported |
Supported |
|
|
8.5 64-bit |
Supported |
Supported |
|
|
8.4 64-bit |
Supported |
Supported |
|
|
8.3 64-bit |
Supported |
Supported |
|
|
8.2 64-bit |
Supported |
Supported |
|
|
8.1 64-bit |
Supported |
Supported |
|
|
8.0 64-bit |
Supported |
Supported |
|
|
8.5 64-bit UEFI Edition |
Supported |
Supported |
|
|
8.4 64-bit UEFI Edition |
Supported |
Supported |
|
|
8.3 64-bit UEFI Edition |
Supported |
Supported |
|
|
8.4 64-bit SCC Edition |
Supported |
Supported |
|
|
8.3 64-bit SCC Edition |
Supported |
Supported |
|
|
6.10 64-bit |
Supported |
Supported |
|
|
6.9 64-bit |
Supported |
Supported |
|
|
6.5 64-bit |
Supported |
Supported |
|
|
Fedora |
39 64-bit |
Supported |
Supported |
|
38 64-bit |
Supported |
Supported |
|
|
37 64-bit |
Supported |
Supported |
|
|
35 64-bit |
Supported |
Supported |
|
|
34 64-bit |
Supported |
Supported |
|
|
33 64-bit |
Supported |
Supported |
|
|
OpenSUSE |
15.5 64-bit |
Supported |
Supported |
|
15.4 64-bit |
Supported |
Supported |
|
|
15.3 64-bit |
Supported |
Supported |
|
|
15.2 64-bit |
Supported |
Supported |
|
|
42.3 64-bit |
Supported |
Supported |
|
|
15.1 64-bit |
Supported |
Supported |
|
|
Rocky Linux |
9.3 64-bit |
Supported |
Supported |
|
9.2 64-bit |
Supported |
Supported |
|
|
9.1 64-bit UEFI Edition |
Supported |
Supported |
|
|
9.1 64-bit |
Supported |
Supported |
|
|
9.0 64-bit |
Supported |
Supported |
|
|
8.9 64-bit |
Supported |
Supported |
|
|
8.8 64-bit UEFI Edition |
Supported |
Supported |
|
|
8.8 64-bit |
Supported |
Supported |
|
|
8.7 64-bit UEFI Edition |
Supported |
Supported |
|
|
8.7 64-bit |
Supported |
Supported |
|
|
8.6 64-bit |
Supported |
Supported |
|
|
8.5 64-bit |
Supported |
Supported |
|
|
CentOS Stream |
9 64-bit UEFI Edition |
Supported |
Supported |
|
9 64-bit |
Supported |
Supported |
|
|
8 64-bit UEFI Edition |
Supported |
Supported |
|
|
8 64-bit |
Supported |
Supported |
|
|
AlmaLinux |
9.3 64-bit |
Supported |
Supported |
|
9.2 64-bit UEFI Edition |
Supported |
Supported |
|
|
9.2 64-bit |
Supported |
Supported |
|
|
9.1 64-bit |
Supported |
Supported |
|
|
9.0 64-bit |
Supported |
Supported |
|
|
8.9 64-bit |
Supported |
Supported |
|
|
8.8 64-bit UEFI Edition |
Supported |
Supported |
|
|
8.8 64-bit |
Supported |
Supported |
|
|
8.7 64-bit UEFI Edition |
Supported |
Supported |
|
|
8.7 64-bit |
Supported |
Supported |
|
|
8.6 64-bit |
Supported |
Supported |
|
|
8.5 64-bit |
Supported |
Supported |
|
|
Fedora CoreOS |
Fedora CoreOS 33.20210217.3.0_3 |
Supported |
Supported |
|
Red Hat Enterprise Linux |
Enterprise Linux 9.3 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
Enterprise Linux 9.2 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 9.1 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 9.0 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 8.9 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 8.8 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 8.7 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 8.6 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 8.5 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 8.4 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 8.3 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 8.2 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 8.1 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 8 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 7.9 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 7.8 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 7.7 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 7.6 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 7.5 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 7.4 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 6.10 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Enterprise Linux 6.9 64-bit |
Not supported (Cloud Assistant is unavailable on this OS). |
Supported |
|
|
Ubuntu |
22.04 64-bit UEFI Edition |
Supported |
Supported |
|
22.04 64-bit |
Supported |
Supported |
|
|
20.04 64-bit |
Supported |
Supported |
|
|
18.04 64-bit |
Supported |
Supported |
|
|
16.04 64-bit |
Supported |
Supported |
|
|
14.04 64-bit |
Supported |
Supported |
|
|
20.04 64-bit UEFI Edition |
Supported |
Supported |
|
|
18.04 64-bit UEFI Edition |
Supported |
Supported |
|
|
Debian |
12.5 64-bit |
Supported |
Supported |
|
12.4 64-bit |
Supported |
Supported |
|
|
12.2 64-bit |
Supported |
Supported |
|
|
11.9 64-bit |
Supported |
Supported |
|
|
11.8 64-bit |
Supported |
Supported |
|
|
11.7 64-bit |
Supported |
Supported |
|
|
11.6 64-bit |
Supported |
Supported |
|
|
11.5 64-bit |
Supported |
Supported |
|
|
11.4 64-bit |
Supported |
Supported |
|
|
11.3 64-bit |
Supported |
Supported |
|
|
11.2 64-bit |
Supported |
Supported |
|
|
11.1 64-bit |
Supported |
Supported |
|
|
11.0 64-bit |
Supported |
Supported |
|
|
10.13 64-bit |
Supported |
Supported |
|
|
10.12 64-bit |
Supported |
Supported |
|
|
10.11 64-bit |
Supported |
Supported |
|
|
10.10 64-bit |
Supported |
Supported |
|
|
10.9 64-bit |
Supported |
Supported |
|
|
10.7 64-bit |
Supported |
Supported |
|
|
10.6 64-bit |
Supported |
Supported |
|
|
10.5 64-bit |
Supported |
Supported |
|
|
10.4 64-bit |
Supported |
Supported |
|
|
10.3 64-bit |
Supported |
Supported |
|
|
10.2 64-bit |
Supported |
Supported |
|
|
9.13 64-bit |
Supported |
Supported |
|
|
9.12 64-bit |
Supported |
Supported |
|
|
9.11 64-bit |
Supported |
Supported |
|
|
9.9 64-bit |
Supported |
Supported |
|
|
9.8 64-bit |
Supported |
Supported |
|
|
9.6 64-bit |
Supported |
Supported |
|
|
8.11 64-bit |
Supported |
Supported |
|
|
8.9 64-bit |
Supported |
Supported |
|
|
12.2 64-bit UEFI Edition |
Supported |
Supported |
|
|
11.6 64-bit UEFI Edition |
Supported |
Supported |
|
|
10.12 64-bit UEFI Edition |
Supported |
Supported |
|
|
10.10 64-bit UEFI Edition |
Supported |
Supported |
|
|
9.13 64-bit UEFI Edition |
Supported |
Supported |
|
|
SUSE Linux |
Enterprise Server 15 SP5 64-bit |
Supported |
Supported |
|
Enterprise Server 15 SP4 64-bit |
Supported |
Supported |
|
|
Enterprise Server 15 SP3 64-bit |
Supported |
Supported |
|
|
Enterprise Server 15 SP2 64-bit |
Supported |
Supported |
|
|
Enterprise Server 15 SP1 64-bit |
Supported |
Supported |
|
|
Enterprise Server 12 SP5 64-bit |
Supported |
Supported |
|
|
Enterprise Server 12 SP4 64-bit |
Supported |
Supported |
|
|
Enterprise Server 12 SP3 64-bit |
Supported |
Supported |
|
|
FreeBSD |
13.0 64-bit |
Not supported |
Not supported |
|
12.3 64-bit |
Not supported |
Not supported |
|
|
12.1 64-bit |
Not supported |
Not supported |
|
|
11.4 64-bit |
Not supported |
Not supported |
|
|
11.3 64-bit |
Not supported |
Not supported |
|
|
11.2 64-bit |
Not supported |
Not supported |
|
|
CentOS |
5.10 64-bit |
Not supported |
Not supported |
|
5.8 64-bit |
Not supported |
Not supported |
|
Installation location
Where you install the agent depends on the database type.
-
For an Alibaba Cloud cloud-native database, install the agent on the application server that connects to the database.
-
For a self-managed database, install the agent on either the database server or the application server that connects to the database.
Installation methods
|
Installation method |
Use cases |
Limitations |
|
Install the agent on multiple ECS instances at once with a single click from the Database Audit console. This automated process saves you from manually downloading the agent and logging on to each instance. |
ECS instances must meet the following requirements:
|
|
|
Install the agent on any server. With this method, you select the server's operating system, download the corresponding agent installation package, and then log on to the server to perform the manual installation. |
The server where you install the agent must be in the same VPC as the Database Audit instance. Alternatively, the server's network must be connected to the instance's VPC using a VPN, CEN, or a leased line. |
Prerequisites
-
You have purchased a Database Audit D100 instance. For more information, see Purchase a Database Audit instance (New Purchases Stopped).
-
You have completed the VPC configuration for the D100 instance. For more information, see Log on to the Database Audit system.
When you configure the VPC, you must specify the VPC and vSwitch where the ECS instance on which you want to install an agent is deployed.
Install using Cloud Assistant (Recommended)
Log on to the Database Audit. For more information, see Log on to the Database Audit.
-
In the left-side navigation pane, choose , and then click the Agent installation tab.
-
In the Install by using Cloud Assistant section, click Start installation.
-
In the Install agent by using Cloud Assistant dialog box, find the ECS instance where you want to install the agent and click Install in the Actions column.
To install the agent on multiple instances, select them and click Batch installation below the ECS instance list.
After the installation is complete, the agent status changes to Connected, running.
-
If your ECS instance runs a Linux operating system and both the application and database are deployed on that instance, follow these steps:
-
In the left-side navigation pane, choose .
-
On the Agent connection management tab, find the target server and click Configure in the Actions column.
-
In the Configure panel, set local loopback capture to Yes and click Save.
-
Manual agent installation
On a Linux server
Log on to Database Audit. For more information, see Log on to Database Audit.
-
In the navigation pane, go to and click the Agent Installation tab.
-
In the Download Agent for Manual Installation section, click Linux Version.
After the download is complete, the agent installation package is saved to your browser's default download directory.
-
Log on to your Linux server as the root user.
-
Upload the downloaded agent installation package to a directory on the Linux server. Run the following command to decompress the package.
tar -zxvf rmagent-530**.tar.gz #Replace rmagent-530**.tar.gz with the actual package filename. -
Modify the
server_hostparameter in the rmagent.ini configuration file:-
Log on to the Database Audit console. In the navigation pane, click D100 instance, and then select the instance's region from the top menu bar.
-
In the D100 instance section, click Configure.
-
In the Configuration (VPC) pane, copy the Domain Name.
-
Return to the server where the Agent is installed, run the vi rmagent.ini command, press i, and change the value of server_host to the domain name that you copied in Step 6.c.
-
If your application and database are deployed on the same server, change the value of loopback to 1.
-
Press Esc, and then enter :wq to save the file and exit.
-
Run the
./install.shcommand to install and enable the agent.
-
-
Authorize the agent.
-
Return to the Database Audit system. On the tab, in the Download Agent for Manual Installation area, click Authorization Token to download the authorization token file.
The authorization token file is used to verify the identity of an agent that attempts to connect to Database Audit. Only agents that pass this verification can connect.
ImportantThe authorization token is valid for one hour and is refreshed at the top of each hour. To prevent verification failure, use the token within its one-hour validity period and avoid downloading it near the top of the hour.
After the download is complete, the authorization token file is saved to your browser's default download directory.
-
Upload the authorization token file to the agent installation directory and run the
./start_rmagent.shcommand to start the agent.
-
-
In Database Audit, on the page, view the agent's connection status.
If the agent status is Normal, the installation is successful.
On a Windows server
Log on to Database Audit. For more information, see Log on to Database Audit.
-
In the navigation pane, go to and click the Agent Installation tab.
-
In the Download Agent for Manual Installation section, click Windows Version.
After the download is complete, the agent installation package is saved to your browser's default download directory.
-
Upload the agent installation package to the server and decompress it.
-
Modify the rmagent.ini file:
-
Log on to the Database Audit console. In the navigation pane, click D100 instance, and then select the instance's region from the top menu bar.
-
In the D100 instance section, click Configure.
-
In the Configuration (VPC) pane, copy the Domain Name.
-
Return to the server where you need to install the Agent, open the rmagent.ini file, change the value of the server_host parameter to the domain name copied in step 5.c, and save the file.
-
-
In the decompressed agent installation package, double-click the Rmagent_Setup.exe file and follow the installation wizard. Select components based on your scenario:
-
The application and database are on different servers
Keep the default selection: WinPcap Silence. Accept the defaults for the remaining options to complete the installation.
-
The application and database are on the same server
Select the npcap component. In the Installation Options dialog box, select Install Npcap in WinPcap API-compatible Mode. Accept the defaults for the remaining options to complete the installation.
-
-
Authorize the agent.
-
In Database Audit, go to the page. On the Agent Installation tab, in the Download Agent for Manual Installation section, click Authorization Token to download the authorization token file.
After the download is complete, the authorization token file is saved to your browser's default download directory.
-
Copy the downloaded authorization token file to the agent installation directory.
-
-
Press Win+R. In the Run dialog box, enter services.msc and click OK. Check that the Rmagent Service status is Running.
-
If the service status is Running, the Rmagent Service is installed and running correctly.
-
If the service status is not Running, start the service manually.
-
-
In Database Audit, on the page, view the agent's connection status.
If the agent status is Normal, the installation is successful.
Uninstall the agent
Uninstall an agent installed using Cloud Assistant
On the Agent Management page, on the Install Agent tab, in the Install by Using Cloud Assistant section, click Start Installation. In the Install Agent by Using Cloud Assistant dialog box, find the instance and click Uninstall in the Actions column.
Uninstall a manually installed agent
-
Linux server
-
Log on to the Linux server as the root user.
-
Navigate to the agent installation directory.
-
Run
./stop_rmagent.shto stop the agent service and delete all files in the agent installation directory.
-
-
Windows server
Press Win+R. In the Run dialog box, enter appwiz.cpl and click OK. In the Uninstall or change a program dialog box, find and uninstall the rmagent program and the WinPcap or Npcap program.