关于管理客户端

管理客户端是命令行实用程序。它使用微服务发布的 REST API 来完成 Oracle GoldenGate 部署中的控制和配置任务。

管理客户端是一款命令行实用程序，可用于创建一个、修改和删除 Oracle GoldenGate 进程，并且可用于替代 MA Web 用户界面。管理客户机程序位于 $OGG_HOME/bin 目录中，其中 $OGG_HOME 是 Oracle GoldenGate 主目录。管理客户机程序的名称为 adminclient。

如果您需要管理客户端与部署自动连接，可以使用 Oracle Wallet 存储用户身份证明。存储的身份证明必须具有以下特征：

单一用户名（账户）和密码
对于管理客户端的运行环境来说是本地的
仅可用于当前登录的用户
由管理客户端管理
使用身份证明名称进行引用
可用于 Oracle GoldenGate 部署和代理连接。

要使用管理客户端执行管理任务，需要可同时用于服务管理器和管理服务的用户身份证明。下面是使用管理客户端所需的配置：

确保 Oracle 软件的 bin 目录是 PATH 环境变量的一部分：
```
 export PATH=ogg_install_location/bin:$PATH
```
如果使用 SSL 证书文件（.pem 或 .der）配置安全部署，则必须添加 OGG_CLIENT_TLS_CAPATH 环境变量。要能够从管理客户端连接到部署，需要此变量。此变量用于指定证书文件在主机上的位置。对于只需要验证服务器证书的客户端，OGG_CLIENT_TLS_CAPATH 环境变量应引用包含可信 CA 证书的文件，此认证与预期客户端要连接到的服务器共享。
```
 export OGG_CLIENT_TLS_CAPATH = <em>deployment_rootCA_certificate_location</em>
```
注：对于 Microsoft Windows，默认证书文件格式为 .der，而所有其他平台使用 .pem 作为默认格式。
运行命令：
```
 [oracle]$ adminclient
```
输出显示 Oracle GoldenGate 管理客户端提示，您可以在此从管理客户端连接到部署。您可以为用户名和密码创建别名，并在脚本中使用该别名来连接到服务器。
```
 OGG (not connected) 1> ADD CREDENTIALS admin USER ggadmin PASSWORD *********
```
此处为服务器上的实际用户 ggadmin 和密码 ** 创建一个名为 admin 的别名。

现在使用以下命令从管理客户端连接到服务。管理客户端从执行脚本的用户的 $HOME 目录中的 Wallet 获取实际用户名和密码，并使用这些身份证明连接到服务。
```
CONNECT http(s)://my.gg.server.com AS admin
```
以安全用户身份从管理客户端连接到部署或代理服务器。这是您使用 OGGCA 为 Oracle GoldenGate 实例添加部署时创建的用户。

CONNECT http(s)://localhost:port DEPLOYMENT deployment name AS security role user PASSWORD password

Note: If the password to connect to a secure or non-secure deployment from the Admin Client has an exclamation mark (!) at the end, then you must enter the password in double quotes when using the CONNECT command in a single line. 否则，系统不接受该密码，连接将失败。这是采用强密码策略的所有部署都必须遵守的要求。

语法：
```
CONNECT server-url [ DEPLOYMENT deployment-name]
                     [ ( (   AS       deployment-credentials-name
                           | USER     deployment-user-name )
                           [ PASSWORD deployment-password  ] )
                     | TOKEN [ access-token ] ]
                     [ PROXY      proxy-uri
                     [ ( AS       proxy-credentials-name
                     |   USER     proxy-user-name      )
                       [ PASSWORD proxy-password ] ] ] [ ! ]
```
要了解详细信息，请参见《 Command Line Interface Reference for Oracle GoldenGate 》中的 CONNECT 命令。

注：因为用于存储数据库身份证明的 Oracle wallet 是由管理服务管理的，所以部署身份证明无法作为 USERIDALIAS 存储在身份证明存储中。应为管理客户端创建单独的 Oracle wallet。Oracle wallet 存储在用户主目录中。

以下示例显示如何添加 Oracle GoldenGate 部署用户以从管理客户端连接到部署：
```
ADD CREDENTIALS admin USER ggadmin PASSWORD *********
```
用户的密码存储在隐藏的 GoldenGate 目录 $HOME 中。

输出：
```
2019-02-14T00:35:38Z  INFO OGG-15114  Credential store altered.
```
以下示例显示如何为用户名和密码添加别名，并从管理客户端使用该别名来连接到部署：
```
 ADD CREDENTIALS admin USER ggadmin PASSWORD *********
```
Admin Client 从执行脚本的用户的 $HOME 目录中的 wallet 获取真实的用户名和密码，并使用这些凭据连接到服务。

输出：
```
2019-02-14T00:35:38Z  INFO OGG-15114  Credential store altered.
```
以下示例显示如何添加 Oracle GoldenGate 部署代理用户以从管理客户端连接到部署：
```
ADD CREDENTIALS proxy USER proxyadmin PASSWORD ********
```
以下示例使用 CONNECT 命令通过管理客户端访问部署：
```
OGG (Not Connected)4> CONNECT http://www.example.com:12000 deployment EAST PROXY http:111.1.1.1:3128 as proxyadmin password oggadmin-A2
Using default deployment 'Local'
OGG (http://www.example.com:12000 Local) 4>
```
您可以使用 HELP 命令查看管理客户端命令的完整列表。使用 HELP SHOWSYNTAX 命令可以查看特定命令的语法。