管理クライアントについて

管理クライアントは、コマンド・ライン・ユーティリティです。マイクロサービスによって公開されているREST APIを使用して、Oracle GoldenGateデプロイメント内の制御や構成のタスクを実行します。

管理クライアントは、Oracle GoldenGateプロセスを作成、変更および削除するために使用できるコマンドライン・ユーティリティで、MA Webユーザー・インタフェースの代わりに使用できます。管理クライアント・プログラムは$OGG_HOME/binディレクトリにあり、$OGG_HOMEはOracle GoldenGateホーム・ディレクトリです。管理クライアント・プログラムの名前はadminclientです。

デプロイメントとの管理クライアント接続を自動化する必要がある場合、Oracleウォレットを使用してユーザー資格証明を格納できます。格納される資格証明は、次の特性を持っている必要があります:

単一のユーザー名(アカウント)とパスワード
管理クライアントが実行されている環境に対してローカルです
現在ログインしているユーザーのみが使用可能です
管理クライアントによって管理されます
資格証明名を使用して参照されます
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という別名がサーバーに作成されます。

次のコマンドを使用して、管理クライアントからサービスに接続します。Adminclientは、スクリプトを実行するユーザーの$HOMEディレクトリにあるウォレットから実際のユーザー名およびパスワードを取得し、それらの資格証明を使用してサービスに接続します。
```
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

ノート:管理クライアントからセキュアまたは非セキュア・デプロイメントに接続するパスワードの最後に感嘆符(!)が含まれる場合、単一行でCONNECTコマンドを使用する際はパスワードを二重引用符で囲まれて入力する必要があります。そうしないと、パスワードは受け入れられず、接続に失敗します。これは、強力なパスワード・ポリシーを持つすべてのデプロイメントで必須です。

構文:
```
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 ] ] ] [ ! ]
```
See the CONNECT command in the Command Line Interface Reference for Oracle GoldenGate to know more.

ノート:デプロイメント資格証明は、データベース資格証明の格納に使用されるOracleウォレットが管理サービスによって管理されるため、デプロイメント資格証明を資格証明ストアにUSERIDALIASとして格納することはできません。かわりに、管理クライアント用に個別のOracleウォレットが作成されます。Oracleウォレットは、ユーザー・ホーム・ディレクトリに格納されます。

次の例では、管理クライアントからデプロイメントに接続するために、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 *********
```
管理クライアントは、スクリプトを実行しているユーザーの$HOMEディレクトリにあるウォレットから実際のユーザー名とパスワードを取得し、それらの資格証明を使用してサービスに接続します。

出力:
```
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コマンドを使用すると、特定のコマンドの構文を表示できます。