Runtime Manager コマンドラインインターフェース
Anypoint Platform には、Runtime Manager のスクリプトおよびコマンドラインツールが用意されています。 コマンドラインインターフェース (CLI) は、対話型シェルと標準 CLI モードの両方をサポートしており、以下で動作します。
ローカルにデプロイされていて Runtime Manager で管理されるアプリケーション
| Anypoint Platform CLI で対象サーバーを認識できるように、手動で各サーバーをプラットフォームに登録する必要があります。 |
| コマンド | 説明 |
|---|---|
スタンドアロンアプリケーションアーティファクトバイナリをダウンロードする |
|
オンプレミスサーバー、サーバーグループ、クラスターにアプリケーションをデプロイまたは再デプロイする |
|
スタンドアロンアプリケーションアーティファクトを変更する |
|
スタンドアロンアプリケーションを開始する |
|
スタンドアロンアプリケーションを削除する |
|
スタンドアロンアプリケーションの詳細情報を表示する |
|
環境内のすべてのスタンドアロンアプリケーションをリストする |
|
スタンドアロンアプリケーションを再起動する |
|
スタンドアロンアプリケーションを停止する |
|
スタンドアロンアプリケーションをコピーする |
runtime-mgr:standalone-application:artifact
> runtime-mgr:standalone-application:artifact [flags] <identifier> <directory>
このコマンドは、identifier アプリケーションのアプリケーションアーティファクトを directory で渡されるディレクトリにダウンロードします。
identifier フラグは、アプリケーション ID または名前のいずれかになります。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
runtime-mgr:standalone-application:deploy
> runtime-mgr:standalone-application:deploy [flags] <targetIdentifier> <name> <zipfile>
このコマンドは、パス zipfile の ZIP ファイルとして渡されるアプリケーションを targetIdentifier で渡されるオンプレミスの対象にデプロイまたは再デプロイします。
targetIdentifier フラグは、対象 ID または名前のいずれかになります。
対象は、サーバー、サーバーグループ、クラスターのいずれかになります。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
アプリケーションを再デプロイしてログレベルを設定したり、インサイトイベント追跡を有効にしたりするには、「runtime-mgr:standalone-application:modify」を参照してください。
runtime-mgr:standalone-application:modify
> runtime-mgr:standalone-application:modify [flags] <identifier> <zipfile>
このコマンドでは、パスとして zipfile で渡される ZIP ファイルアプリケーションを使用して、identifier で渡されるスタンドアロン (オンプレミス) アプリケーションを変更します。
identifier オプションでは、アプリケーション識別子を指定します。
識別子を取得するには、「runtime-mgr:standalone-application:list」を参照してください。
このコマンドでは、デフォルトの --help フラグ以外に次のフラグも受け入れます。
| フラグ | 説明 |
|---|---|
|
各 Mule トランザクションのメッセージメタデータを保存する。 |
|
ログレベルとスコープのペアを設定する。
複数のログレベルを設定するには、 |
runtime-mgr:standalone-application:start
> runtime-mgr:standalone-application:start [flags] <identifier>
このコマンドでは、identifier で渡されるスタンドアロン (オンプレミス) アプリケーションを開始します。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
runtime-mgr:standalone-application:delete
> runtime-mgr:standalone-application:delete [flags] <identifier>
このコマンドでは、identifier で渡されるスタンドアロン (オンプレミス) アプリケーションを削除します。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
| このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。 |
runtime-mgr:standalone-application:describe
> runtime-mgr:standalone-application:describe [flags] <identifier>
このコマンドでは、identifier で渡されるスタンドアロン (オンプレミス) アプリケーションの状況、作成日、最終更新日などの詳細情報を表示します。
フラグ -o json を使用して、<name> で指定するアプリケーションの未加工の JSON 応答を取得します。
このコマンドには --output フラグを使用できます。--output フラグを使用して、応答形式を指定します。サポートされている値は、table (デフォルト) および json です。
このコマンドでは、デフォルトのフラグ --help も受け入れます。
runtime-mgr:standalone-application:list
> runtime-mgr:standalone-application:list [flags]
このコマンドでは、すべてのスタンドアロン (オンプレミス) アプリケーションをリストします。
このコマンドでは、デフォルトの --help フラグ以外に次のフラグも受け入れます。
| フラグ | 説明 |
|---|---|
|
取得する結果の数を指定する |
|
渡されるアプリケーションの数をオフセットする |
|
応答形式を指定する。 |
runtime-mgr:standalone-application:restart
> runtime-mgr:standalone-application:restart [flags] <identifier>
このコマンドでは、identifier で渡されるスタンドアロン (オンプレミス) アプリケーションを再起動します。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
runtime-mgr:standalone-application:stop
> runtime-mgr:standalone-application:stop [flags] <identifier>
このコマンドでは、identifier で渡されるスタンドアロン (オンプレミス) アプリケーションを停止します。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
runtime-mgr:standalone-application:copy
> runtime-mgr:standalone-application:copy [flags] <source> <target> <targetIdentifier>
このコマンドでは、source で渡されるスタンドアロン (オンプレミス) アプリケーションを target で渡される対象およびサーバー、サーバーグループ、クラスター ID (targetIdentifier で渡される名前) にコピーします。
source と destination の引数はどちらも、次のように <organizationName>:<environmentName>/<appName> の形式を使用して表されます。
> runtime-mgr:standalone-application:copy Services:QA/application-1 Development:QA/application-2 123456
application-1 という名前のアプリケーションをサービス組織の QA 環境からサーバー ID 123456 の Development 組織の QA 環境にコピーします。
Anypoint Platform CLI でサービス組織の QA 環境を使用する場合、コマンドの source としてアプリケーション名を使用できます。
> runtime-mgr:standalone-application:copy application-1 Development/QA/application-2 123456
このコマンドを実行するには、ユーザーに OS の /tmp ディレクトリ (CLI のインストール先) への参照/更新アクセス権が必要です。
|
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
ローカルにデプロイされていて Runtime Manager で管理されるアプリケーションのアラート
| コマンド | 説明 |
|---|---|
アラートの情報を表示する |
|
スタンドアロンランタイムの新しいアラートを作成する |
|
スタンドアロンランタイムのアラートを変更する |
|
環境内のスタンドアロンランタイムのすべてのアラートをリストする |
runtime-mgr:standalone-alert:describe
> runtime-mgr:standalone-alert:describe [flags] <alertId>
このコマンドは、alertId で渡されるアラートの情報を表示します。
このコマンドには --output フラグを使用できます。--output フラグを使用して、応答形式を指定します。サポートされている値は、table (デフォルト) および json です。
このコマンドでは、デフォルトのフラグ --help も受け入れます。
runtime-mgr:standalone-alert:create
> runtime-mgr:standalone-alert:create <name> [flags]
このコマンドは、name で渡される ID を使用して、スタンドアロンランタイムの新しいアラートを作成します。
アラート name は 256 文字に制限されます。
このコマンドでは、デフォルトの --help フラグ以外に次のフラグも受け入れます。
| フラグ | 説明 |
|---|---|
|
アラートの重要度 |
|
アラートのリソース種別 |
|
アラートのリソース ID。複数回使用できます。指定されていない場合、すべてのリソースでアラートがトリガーされます。 |
|
アラートのトリガー条件 |
|
条件の期間 (分) |
|
条件のしきい値 |
|
しきい値に関する値を記述する条件演算子。 |
|
アラート通知メールの件名 |
|
アラート通知メールの本文 |
|
アラート通知を送信するユーザー名。複数回使用して、最大 20 件のプラットフォームユーザー ID を指定できます。 |
|
アラート通知を送信するメールアドレス。複数回使用して、最大 20 件のメールアドレスを指定できます。 |
| このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に `-- ` (2 つのダッシュの後にスペース) を使用します。 |
runtime-mgr:standalone-alert:modify
> runtime-mgr:standalone-alert:modify <alertId> [flags]
このコマンドは、alertId で渡されるアラートを変更します。
このコマンドでは、デフォルトの --help フラグ以外に次のフラグも受け入れます。
| フラグ | 説明 |
|---|---|
|
アラート名 |
|
アラートの重要度 |
|
アラートのリソース種別 |
|
アラートのリソース ID。複数回使用できます。指定されていない場合、すべてのリソースでアラートがトリガーされます。 |
|
アラートのトリガー条件 |
|
条件の期間 (分) |
|
条件のしきい値 |
|
しきい値に関する値を記述する条件演算子。 |
|
アラート通知メールの件名 |
|
アラート通知メールの本文 |
|
アラート通知を送信するユーザー名。複数回使用して、最大 20 件のプラットフォームユーザー ID を指定できます。 |
|
アラート通知を送信するメールアドレス。複数回使用して、最大 20 件のメールアドレスを指定できます。 |
| このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に `-- ` (2 つのダッシュの後にスペース) を使用します。 |
ローカルサーバー
| コマンド | 説明 |
|---|---|
サーバーの情報を表示する |
|
サーバーを変更する |
|
サーバー登録トークンを取得する。新しいサーバーを登録するには、このトークンを使用する必要があります。 |
|
サーバーを削除する |
|
スタンドアロンアプリケーションアーティファクトを変更する |
runtime-mgr:server:describe
> runtime-mgr:server:describe [flags] <serverId>
このコマンドは、serverId で渡されるサーバーの情報を表示します。
このコマンドには --output フラグを使用できます。--output フラグを使用して、応答形式を指定します。サポートされている値は、table (デフォルト) および json です。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
runtime-mgr:server:modify
> runtime-mgr:server:modify [flags] <serverId>
このコマンドは、serverId で渡されるサーバーを変更します。
クラスターの ID を更新するには、--name フラグを渡す必要があります。
このコマンドでは、--name フラグ以外にデフォルトの --help フラグも使用できます。
runtime-mgr:server:token
> runtime-mgr:server:token [flags]
このコマンドは、サーバー登録トークンを取得します。新しいサーバーを登録するには、このトークンを使用する必要があります。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
ローカルサーバーグループ
| コマンド | 説明 |
|---|---|
サーバーのサーバーグループを作成する |
|
サーバーグループの情報を表示する |
|
サーバーグループを変更する |
|
サーバーをサーバーグループに追加する |
|
サーバーグループを削除する |
|
環境内のすべてのサーバーグループをリストする |
|
サーバーグループのサーバーを削除する |
runtime-mgr:serverGroup:create
> runtime-mgr:serverGroup:create [flags] <name> [serverIds...]
このコマンドは、後で引数として渡されるサーバー ID を使用して、name で渡される名前でサーバーグループを作成します。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
runtime-mgr:serverGroup:describe
> runtime-mgr:serverGroup:describe [flags] <serverGroupId>
このコマンドは、serverGroupId で渡されるサーバーグループの情報を表示します。
このコマンドには --output フラグを使用できます。--output フラグを使用して、応答形式を指定します。サポートされている値は、table (デフォルト) および json です。
このコマンドでは、デフォルトのフラグ --help も受け入れます。
runtime-mgr:serverGroup:modify
> runtime-mgr:serverGroup:modify [flags] <serverGroupId>
このコマンドは、serverGroupId で渡されるサーバーグループを変更します。
クラスターの ID を更新するには、--name フラグを渡す必要があります。
このコマンドでは、--name フラグ以外にデフォルトの --help フラグも使用できます。
runtime-mgr:serverGroup:add:server
> runtime-mgr:serverGroup:add:server [flags] <serverGroupId> <serverId>
このコマンドは、serverId で渡されるサーバーを serverGroupId で渡されるサーバーグループに追加します。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
runtime-mgr:serverGroup:delete
> runtime-mgr:serverGroup:delete [flags] <serverGroupId>
このコマンドは、serverGroupId で渡されるサーバーグループを削除します。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
| このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。 |
ローカルクラスターサーバー
| コマンド | 説明 |
|---|---|
サーバーをクラスターに追加する |
|
クラスターを削除する |
|
環境内のすべてのクラスターをリストする |
|
クラスターからサーバーを削除する |
|
新しいクラスターを作成する |
|
サーバークラスターの情報を表示する |
|
クラスターを変更する |
runtime-mgr:cluster:add:server
> runtime-mgr:cluster:add:server [flags] <clusterId> <serverId>
このコマンドは、clusterId のクラスターを serverId で渡されるサーバーに追加します。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
runtime-mgr:cluster:delete
> runtime-mgr:cluster:delete [flags] <clusterId>
このコマンドは、clusterId で渡されるクラスターを削除します。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
| このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。 |
runtime-mgr:cluster:list
> runtime-mgr:cluster:list [flags]
このコマンドは、環境内のすべてのクラスターをリストします。
このコマンドには --output フラグを使用できます。--output フラグを使用して、応答形式を指定します。サポートされている値は、table (デフォルト) および json です。
このコマンドでは、デフォルトのフラグ --help も受け入れます。
runtime-mgr:cluster:remove:server
> runtime-mgr:cluster:remove:server [flags] <clusterId> <serverId>
このコマンドは、clusterId で渡されるクラスターから serverId で渡されるサーバーを削除します。
このコマンドでは、デフォルトのフラグ --help のみを受け入れます。
runtime-mgr:cluster:create
> runtime-mgr:cluster:create <name> [flags]
このコマンドは、name で渡される ID を使用してクラスターを作成します。
このコマンドでは、デフォルトの --help フラグ以外に次のフラグも受け入れます。
| フラグ | 説明 |
|---|---|
|
クラスターをマルチキャストにする必要があるかどうか |
|
サーバー ID と IP アドレスのペア。マルチキャストクラスターの場合、後者は省略可能です。複数のサーバーを追加するには、複数の値を指定します。 |
| このコマンドには複数オプションのフラグがあります。コマンドで複数オプションのフラグを使用する場合は、フラグの前にパラメーターを置くか、パラメーターの前に `-- ` (2 つのダッシュの後にスペース) を使用します。 |