管理ゲートウェイの管理タスク
管理ゲートウェイのインストール後に、いくつかの管理タスクが必要な場合があります。
管理ゲートウェイ・プロパティの更新 🔗
管理ゲートウェイ・ポート
gateway.properties
ファイルのGatewayPort
プロパティを使用して指定された特定のポートでトラフィックを受け入れるように構成されます。
- Linuxプラットフォームでは、
gateway.properties
ファイルは/opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/config
にあります。 - Windowsプラットフォームでは、
gateway.properties
ファイルはC:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\config
にあります。
管理ゲートウェイのポート値を変更するには、gateway.properties
ファイルを編集して、GatewayPort
プロパティの現在の値を目的のポート番号で置き換えます。
gateway.properties
ファイルを変更した後、管理ゲートウェイ・サービスを再起動する必要があります。
-
Oracle Linux 6の場合は、
/sbin/initctl restart mgmt_gateway
を使用します。 -
Oracle Linux 7の場合は、
systemctl restart mgmt_gateway
を使用します。 -
Windowsでは、次を使用します。
net stop mgmt_gateway net start mgmt_gateway
GatewayPort
プロパティ値が変更された場合、そのManagement Gatewayを使用する管理エージェントは、新しいポート値を使用するように変更する必要があります。詳細は、管理ゲートウェイ構成の変更後の管理エージェントの更新を参照してください
Management Gateway資格証明
ゲートウェイは通常、資格証明を使用するように構成されます。接続するにはユーザー名とパスワードが必要です。
このような資格証明はOracleウォレットに格納されます。資格証明を追加、更新または削除する方法の詳細は、管理ゲートウェイ資格証明の構成を参照してください。
管理ゲートウェイ資格証明が変更された場合、新しい資格証明を使用するには、管理ゲートウェイを使用するすべての管理エージェントを変更する必要があります。詳細は、管理ゲートウェイ構成の変更後の管理エージェントの更新を参照してください。
管理ゲートウェイ資格証明の構成 🔗
この項では、管理ゲートウェイで必要になることがある資格証明を管理する方法について説明します。
管理ゲートウェイは、資格証明などの機密情報をOracleウォレットに格納します。
管理ゲートウェイのインストール後、資格証明の構成が必要になる場合があります。
CLIコマンドを使用して変更を行った場合は、ゲートウェイを再起動する必要があります。CLIコマンドの詳細は、Oracle Cloud Infrastructure CLIコマンド・リファレンスを参照してください。
資格証明の追加または更新 🔗
資格証明を追加するには、upsertCredentials
操作とともにgateway_credentials
スクリプトを使用します。
- Linux:
gateway_credentials.sh
スクリプトは/opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/bin
ディレクトリにあります。 - Windows:
gateway_credentials.bat
スクリプトはC:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\bin
ディレクトリにあります。
-
ゲートウェイのユーザー名とパスワードを含むテキスト・ファイルを作成します:
GatewayUsername=<USER_NAME> GatewayPassword=<USER_PASSWORD>
例:GatewayUsername=oracle2 GatewayPassword=welcomepwd
たとえば、このテキスト・ファイルをcred.propertiesとして保存できます。
-
テキスト・ファイルを使用して資格証明を追加します。
-
Linuxでは、次を使用します。
gateway_credentials.sh -o upsertCredentials
たとえば、
cred.properties
ファイルを使用して、Linuxで次を実行できます:cat cred.properties | sudo -u mgmt_agent sh /opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/bin/gateway_credentials.sh -o upsertCredentials
-
Windowsでは、次を使用します。
gateway_credentials.bat -o upsertCredentials
たとえば、cred.properties
ファイルを使用して、Windowsで次を実行できます:type cred.properties | C:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\bin\gateway_credentials.bat -o upsertCredentials
-
-
ステップ1で作成したテキスト・ファイルを削除します。
このテキスト・ファイルには機密情報が含まれています。ユーザーは、資格証明の追加または更新操作を完了した後で、資格証明のテキスト・ファイルを削除する必要があります。
資格証明の削除 🔗
資格証明を削除するには、deleteCredentials
操作とともにgateway_credentials
スクリプトを使用します。
- Linux:
gateway_credentials.sh
スクリプトは/opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/bin
ディレクトリにあります。構文:gateway_credentials.sh -o deleteCredentials
例:sudo -u mgmt_agent sh /opt/oracle/mgmt_agent/plugins/GatewayProxy/stateDir/bin/gateway_credentials.sh -o deleteCredentials
- Windows:
gateway_credentials.bat
スクリプトはC:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\bin
ディレクトリにあります。構文:gateway_credentials.bat -o deleteCredentials
例:C:\Oracle\mgmt_agent\plugins\GatewayProxy\stateDir\config\bin\gateway_credentials.bat -o deleteCredentials
資格証明を削除しても、その資格証明が含まれていたウォレットは削除されません。
管理ゲートウェイ構成の変更後の管理エージェントの更新 🔗
管理ゲートウェイの構成が変更されると、管理エージェントも変更する必要がある場合があります。
-
ゲートウェイ・ホスト: ゲートウェイが別のホストに移動された場合、またはゲートウェイ・ホストの名前が変更された場合は、そのゲートウェイを使用するエージェントが新しいホスト名を使用するように変更する必要があります。
この場合、新しいゲートウェイを使用するように管理エージェント・パラメータ
GatewayServerHost
を更新する必要があります。 -
ゲートウェイ・ポート: ゲートウェイ・ポートの値が変更された場合は、新しいポート値を使用するようにゲートウェイを使用するエージェントを変更する必要があります。
この場合、新しいゲートウェイ・ポートを使用するように管理エージェント・パラメータ
GatewayServerPort
を更新する必要があります。 -
ゲートウェイ資格証明: 管理ゲートウェイへの接続に必要な資格証明(ユーザー名やパスワードなど)が変更されると、そのゲートウェイを使用するすべてのエージェントが、新しい資格証明を使用するように変更する必要があります。詳細は、管理ゲートウェイおよびプロキシの資格証明タイプおよび資格証明の追加または更新を参照してください。
管理ゲートウェイのプロキシ資格証明の更新 🔗
管理ゲートウェイの既存の外部プロキシ資格証明を更新できます。
前提条件:
ProxyHost
ProxyPort
ProxyHost=myproxy.example.com
ProxyPort=80
ステップ1: プロキシ資格証明を更新するリクエスト本文の作成
次のプロパティを使用して、資格証明ファイルに新しいユーザー名とパスワードを指定します。
ProxyUser
: プロキシに対して認証するユーザー名。ProxyPassword
: プロキシを使用した認証のユーザー・パスワード。
前述の資格証明プロパティでは大文字/小文字が区別されます。
次のsample-proxycreds.json
サンプル資格証明ファイルを参照してください:
{"source":"agent.%%agentId%%",
"name":"ManagementAgent-Proxy",
"type":"ProxyCreds",
"description":"Proxy Credentials",
"properties":[
{"name":"ProxyUser","value":"<UserName>"},
{"name":"ProxyPassword","value":"<Password>"}]}
ステップ2: コマンドを実行してプロキシ資格証明を更新する
- Linuxの場合:
cat sample-proxycreds.json | sudo -u mgmt_agent /opt/oracle/mgmt_agent/agent_inst/bin/credential_mgmt.sh -o upsertCredentials -s Agent
- Windows:
type sample-proxycreds.json | C:\oracle\mgmt_agent\agent_inst\bin\credential_mgmt.bat -o upsertCredentials -s Agent
ステップ3: 管理ゲートウェイの再起動
- Linuxの場合:
sudo systemctl restart mgmt_gateway
- Windows:
net stop mgmt_gateway net start mgmt_gateway
資格証明は、管理ゲートウェイがOracle Cloud Infrastructureサービスと通信するために使用されます。形式を変更したり資格証明を削除したりすると、管理ゲートウェイのOracle Cloud Infrastructureサービスへの通信機能に悪影響を及ぼす可能性があります。
管理ゲートウェイのバッチ処理の有効化 🔗
管理ゲートウェイをインストールした後、バッチ処理を有効にして、ログ・アナリティクス・サービスへのロギング・アップロードをより適切かつ迅速に管理できます。
gateway.properties
ファイルに次のプロパティを追加します。BatchingEnabled=true
gateway.properties
ファイルを更新した後、管理ゲートウェイ・サービスを再起動する必要があります。再起動するには、次を実行します。
- Oracle Linux 6の場合は、
/sbin/initctl restart mgmt_gateway
を使用します - Oracle Linux 7の場合は、
systemctl restart mgmt_gateway
を使用します
管理ゲートウェイのアップグレード 🔗
Linuxでの管理ゲートウェイのアップグレード
- ソフトウェア・ダウンロード・ファイルを含む、最新バージョンの
RPM
ファイルをダウンロードします。詳細は、管理ゲートウェイ・ソフトウェアのダウンロードを参照してください。 - ゲートウェイをアップグレードするには、アップグレード・オプション
rpm -U
を指定してrpmコマンドを実行します。sudo rpm -U <rpm_file_name.rpm>
Zipファイルを使用したLinuxでの管理ゲートウェイのアップグレード
Zipファイルを使用してLinux上のゲートウェイをアップグレードするには、次を実行します:
- ゲートウェイ・ソフトウェア・ダウンロード・ファイルを含むZIPファイルの最新バージョンをダウンロードします。詳細は、管理ゲートウェイ・ソフトウェアのダウンロードを参照してください
- 管理ゲートウェイ・ソフトウェアのZIPファイルをダウンロードしたディレクトリに移動し、このファイルを任意の場所に解凍します。
- ゲートウェイをアップグレードするには、次のオプションを指定して
installer.sh
スクリプトを実行します:-u
installer.sh -u
- 次のように出力されます。
sudo ./installer.sh -u Checking pre-requisites Checking available disk space for gateway upgrade Checking agent version Executing install Unpacking software zip Copying files to destination dir (/opt/oracle/mgmt_agent) Updating communication wallet Creating 'mgmt_gateway' daemon Starting mgmt_gateway Gateway Install Logs: /opt/oracle/mgmt_agent/installer-logs/installer.log Gateway upgrade successful
Windowsでの管理ゲートウェイのアップグレード
- 管理者ユーザーとしてログインし、コマンド・プロンプト・ウィンドウを開きます。
- エージェント・ソフトウェア・ダウンロード・ファイルを含む、最新バージョンの
ZIP
ファイルをダウンロードします。詳細は、管理ゲートウェイ・ソフトウェアのダウンロードを参照してください。 - 管理エージェント・ソフトウェアの
ZIP
ファイルをダウンロードしたディレクトリに移動し、このファイルを任意の場所に解凍します。 - ゲートウェイをアップグレードするには、
-u
オプションを指定してinstaller.bat
スクリプトを実行します:installer.bat -u
たとえば:
出力は次のようになります。C:\Users\test_agent>installer.bat -u
JAVA_HOME found at: C:\Program Files\Java\jdk1.8.0_321 Executing upgrade Unpacking software zip Copying files to destination dir (C:\Oracle\mgmt_agent) Updating communication wallet Creating mgmt_gateway service Management Gateway upgrade successful The Oracle Management Gateway service is starting.... The Oracle Management Gateway service was started successfully.
管理ゲートウェイの削除 🔗
管理ゲートウェイをホストから削除すると、管理ゲートウェイは、ホストから削除される前にManagement Agents Cloud Serviceから登録解除されます。
管理ゲートウェイを次のオペレーティング・システムから削除またはアンインストールするには、次のステップに従います。
RPMコマンドを使用して、Linuxの管理ゲートウェイを削除します。
-e
オプションを指定して、次の rpm
コマンドを実行します。sudo rpm -e <rpm_name>
アンインストーラ・スクリプトを使用したLinuxでの管理ゲートウェイの削除
ZIP
ファイルを使用して管理ゲートウェイをインストールした場合は、uninstaller.sh
スクリプトを実行します。
出力は次のようになります。
$ sudo bash /opt/oracle/mgmt_agent/agent_inst/bin/uninstaller.sh
Executing pre-remove step from uninstall
Attempting to remove the Gateway from Management Agent Cloud service, please do not interrupt...
Attempting to remove the Gateway from Management Agent Cloud service,please do not interrupt...
Gateway was removed from Management Agent Cloud service successfully.
Detected Oracle Linux Server (Red Hat family):
Stopping mgmt_gateway...
Removing mgmt_gateway daemon from systemd...
Removed symlink /etc/systemd/system/multi-user.target.wants/mgmt_gateway.service.
Gateway was removed from the host successfully.
Executing post-remove step from uninstall
Gateway state directory was removed from the host successfully.
Linuxに外部ボリュームを使用して管理ゲートウェイをインストールした場合、管理ゲートウェイのアンインストーラ・スクリプトは、
/opt/oracle/mgmt_agent
ディレクトリの下のすべてのデータを削除し、一部のオペレーティング・システムでは、シンボリックリンクが指すターゲット・ディレクトリも削除します。
Windowsでの管理ゲートウェイの削除
「コマンド・プロンプト」ウィンドウを開き、管理ゲートウェイのインストール・ベース・ディレクトリに移動して、uninstaller.bat
スクリプトを実行します。
C:\Oracle>mgmt_agent\uninstaller.bat
Removing Management Gateway from the OCI service console.
Attempting to remove the agent from Management Agent Cloud service, do not interrupt...
Gateway was removed from the Management Agent Cloud service successfully.
Removing Management Gateway service from the host
Management Gateway service was removed from the host successfully
Removing Management Gateway directories
uninstaller.bat
スクリプトを実行する前に、他のすべてのコマンド・プロンプト・ウィンドウが閉じていること、またはそれらが管理ゲートウェイ・ホーム・ディレクトリを指していないことを確認します。
カスタム証明書を使用した管理ゲートウェイの構成 🔗
- Oracle Cloudコンソールで、ナビゲーション・メニューを開き、「アイデンティティとセキュリティ」を選択します。
- 「証明書」に移動し、「証明書」を選択します。
- 「証明書の作成」をクリックします。
- 証明書をインポートするコンパートメントを選択します。これは、管理ゲートウェイがインストールされているコンパートメントと同じコンパートメントである必要があります。
- 認証局(CA)を使用して管理する予定の証明書をインポートするには、「証明書タイプ」として「インポート済」をクリックします。
- 証明書の一意の表示名を入力します。機密情報を入力しないでください。
- オプションで、証明書の説明を入力できます。
- 秘密キーおよびチェーン証明書を入力する必要があります。
Oracle Cloudコンソールで証明書ステータスが「アクティブ」の場合、証明書を使用する準備ができています。
- 次に、証明書OCIDをコピーし、管理ゲートウェイのインストール中に、「管理ゲートウェイのレスポンス・ファイルの構成」の形式を使用して、管理ゲートウェイのレスポンス・ファイルにパラメータとしてOCIDを入力する必要があります。
GatewayCertOcid=ocid1.certificate.oc1.iad.<unique-id>
- 管理エージェントに同じ証明書をインポートして、エンドツーエンドの完全な相互作用が機能するように、次のステップを実行します。
デフォルト以外のOSユーザーを使用した管理ゲートウェイのインストール 🔗
Oracleでは、デフォルトのOSユーザーmgmt_agent
を使用して管理ゲートウェイのインストールを実行することをお薦めしますが、要件によっては、別のOSユーザーを使用してインストールを実行する必要がある場合があります。
この項では、デフォルトのOSユーザーであるmgmt_agent
とは異なるユーザーを使用して管理ゲートウェイをインストールする方法について説明します。
前提条件
mgmt_agent
以外のOSユーザーを選択してLinuxまたはUnixシステムで管理ゲートウェイのインストールを実行する場合は、次の考慮事項が必要です。
- 制限された権限を持つOSユーザーを選択します。
デフォルトのmgmt_agent OSユーザーは、ログイン・シェルを持たない最小権限のOSユーザーです。別のOSユーザーを選択する場合は、選択したユーザーに制限された権限があることを確認してください。
- 管理ゲートウェイはマルチスレッド・アプリケーションであり、各スレッド(LWP)はOSユーザー制限にカウントされます。次をチェックして、
max user processes
のユーザー制限(ulimit
)が適切に設定されていることを確認します。ulimit -u
不十分な制限を選択すると、管理ゲートウェイおよびOSユーザーが選択したアプリケーションが実行されなくなる可能性があります。
- 管理ゲートウェイのインストールを実行するための有効なOSユーザーを識別し、それを
RUN_AGENT_AS_USER
変数の値として使用します。Oracleでは、選択したOSユーザーには最低限の権限が必要で、ログインシェルは不要であることを推奨しています。id -un <username>
例1:
id -un myexistinguser
myexistinguser
OSユーザーが存在します。出力は、選択したユーザーの値を返し、次のようになります。
例2:myexistinguser
id -un mytestuser2
mytestuser2
OSユーザーは存在せず、有効なユーザーではありません。出力はユーザー値を返さず、次のようになります。id: mytestuser2: no such user
AGENT_USER_GROUP
変数の値として使用するユーザーのプライマリ・グループを識別します。AGENT_USER_GROUP
の値が、選択したOSユーザーのプライマリ・ユーザー・グループであることを確認します。ノート
セカンダリ・グループの使用はサポートされていないため、管理ゲートウェイが破損する可能性があります。id -gn <username>
例:id -gn myexistinguser
出力は次のようになります。staff
環境変数の設定および管理ゲートウェイのインストール
- 次の環境変数を設定します。
例:RUN_AGENT_AS_USER=<selected_OS_user_for_ManagementGateway_installation> AGENT_USER_GROUP=<OS_primary_group_of_selected_OS_user>
RUN_AGENT_AS_USER=myexistinguser AGENT_USER_GROUP=staff
root
OSユーザーが前述の環境変数にアクセスできることを確認します。デフォルトでは、環境変数は
root
ユーザーと共有されません。- 次のようにして、環境変数が正しく設定されていることを確認します。
たとえば、出力は次のようになります。sudo su echo $RUN_AGENT_AS_USER echo $AGENT_USER_GROUP
myexistinguser staff
root
が環境変数にアクセスできない場合は、/etc/sudoers
ファイルを編集して、次を追加します。Defaults env_keep+=RUN_AGENT_AS_USER Defaults env_keep+=AGENT_USER_GROUP
前述のとおり、
RUN_AGENT_AS_USER
およびAGENT_USER_GROUP
環境変数は保持され、root
ユーザーがアクセスできます。/etc/sudoers
ファイルを更新した後、環境変数を再度設定し、root
が環境変数にアクセスできることを確認します。 -
検証が完了したら、管理ゲートウェイのインストール(
root
としてログインし、環境変数を設定してから、管理ゲートウェイのインストールを開始)を開始できます。お好みの方法に応じて、Linux RPMファイルへの管理ゲートウェイのインストールまたはLinux ZIPファイルへの管理ゲートウェイのインストールの手順に従うことができます。
たとえば、Linux RPMファイルへの管理ゲートウェイのインストールの手順に従います。この場合は、すでに
root
であり、sudo
権限が不要なため、ステップ1をスキップします。ステップ2から開始します:rpm -ivh <rpm_file_name.rpm>