This page applies to on-premise deployments.

Enterprise Console コマンドライン ユーティリティを使用して、オーケストレーションタスクを自動で実行できます。これは、以下の制限を想定して設計されています。

  • Web UI で提供されるすべての機能が、完全に一致するわけではありません。 
  • コマンドライン ユーティリティは、Enterprise Console がインストールされているホストのみで実行できます。 

コマンドラインディレクトリ

ホストマシンの <Enterprise Console home>/platform-admin/bin ディレクトリにおける platform-admin.sh|bat スクリプトでは、AppDynamics プラットフォームをインストールおよび管理するためのコマンドのセットが提供されます。 

Enterprise Console に対して利用できる操作を確認するには、コマンドラインからディレクトリに移動し、-h を指定して スクリプトを実行します。

bin/platform-admin.sh -h
BASH 
bin\platform-admin.exe cli -h
BASH

また、特定のコマンドに対して -h 引数を指定することで、コマンドラインにおいて各コマンドの形式を表示することができます。

bin/platform-admin.sh <command> -h
BASH 
bin\platform-admin.exe cli <command> -h
BASH
また、bin/platform-admin.sh list-jobs --service <controller or events-service> を使用して、提供されたサービスに対して利用できるジョブの一覧を表示することもできます。その後、次のコマンドを使用して、提供されたジョブに対して必要なパラメータを表示できます。bin/platform-admin.sh list-job-parameters --job <job_name> --service <controller or events-service>.
Linux で利用できるすべてのコマンドを、Windows でも利用できるわけではありません。-h パラメータを使用して表示される Enterprise Console コマンドのリストを参照してください。

Enterprise Console では、複数のユーザーがコマンドを同時に実行することが禁止されています。2人目のユーザーが別のコマンドの実行中にコマンドを実行しようとすると、2つ目のコマンドは完了せず、別のコマンドが実行中であることを示すエラーメッセージが表示されます。このようなコンフリクトを回避するため、通常、Enterprise Console は同時に複数のユーザーが使用しないようにする必要があります。   

Enterprise Console でのログインとログアウト

Enterprise Console でのログインおよびログアウトのコマンドは、以下のとおりです。

  • login --user-name <admin_username> --password <admin_password>
    最後のセッションから 1 日以上経った場合には、ログインしてからコマンド ライン ユーティリティを使用する必要があります。また、次のエラーメッセージが表示された場合も、再度ログインする必要があります。

    error: Command failed due to an error: Unauthorized
API code 401
Session expired. Please login and run the command again.
  • logout

Enterprise Consoleのパスワード管理

Enterprise Console パスワードをリセットまたは変更するためのコマンドは、次のとおりです。

  • reset-password
    管理パスワードを忘れたか、401 エラーが発生した場合、このコマンドを実行し、パスワードをデフォルト値である admin にリセットします。この変更を有効化するには、ログアウトしてから再びログインする必要があります。
  • change-password --user-name <username> --password <old_password> --new-password <new_password>

Enterprise Console の起動と停止

コントローラとイベントサービスを起動および停止する場合と同様に、Enterprise Console プロセスを起動および停止できます。Enterprise Console を起動および停止するためのコマンドは、次のとおりです。

  • start-platform-admin
  • stop-platform-admin 

イベントサービスノードをインストールまたは管理するには、Enterprise Console が実行中である必要があります。

プラットフォームバージョンの取得

Enterprise Console および Enterprise Console にインストールしたその他のコンポーネントのバージョンを取得できます。 

Enterprise Console のバージョンを取得するには、次のようにします。

bin/platform-admin.sh show-platform-admin-version
BASH 
bin\platform-admin.exe cli show-platform-admin-version
BASH

いずれかのプラットフォーム コンポーネントのバージョンを取得するには、次のようにします。

bin/platform-admin.sh get-available-versions --platform-name <platform-name> --service <controller or events-service>
BASH 
bin\platform-admin.exe cli get-available-versions --platform-name <platform-name> --service <controller or events-service>
BASH

現プラットフォームの設定

オプションのパラメータである --platform-name を各コマンドで渡し、現在使用しているプラットフォームの設定を行うことができます。ただし、現在使用しているパラメータを各コマンドで渡す必要がないよう、環境変数 APPD_CURRENT_PLATFORM を設定することができます。この変数は、setenv または export を使用して設定できます。この値は、存在する場合にはEnterprise Consoleで取得されます。

APPD_CURRENT_PLATFORM が設定されている状態で --platform-name パラメータを入力すると、フラグを介して渡された値が環境変数よりも優先されます。

全プラットフォームフラグ

--all フラグを使用して、すべてのプラットフォームをコマンドによって変更するよう指定できます。たとえば、次のコマンドを実行することにより、すべてのプラットフォームバイナリを一括でアップグレードすることができます。

bin/platform-admin.sh upgrade-orcha --all
BASH 
bin\platform-admin.exe cli upgrade-orcha --all
BASH

追加の Enterprise Console コマンド

以下は、頻繁に使用されるEnterprise Consoleコマンドの一覧です。

  • create-platform --name <platform_name> --description <description> --installation-dir <install_dir>

  • delete-platform --name <platform_name>
  • upgrade-orcha --platform-name <platform_name>
    このコマンドは、指定されたプラットフォーム内のすべてのリモート Orcha マシンで Orcha モジュールバイナリのアップグレードをトリガーします。このコマンドを実行するときは、プラットフォームのサービス上でジョブを実行していてはいけません。
  • list-supported-services
  • show-platform-admin-version