1. Homepage

  2. Anypoint CLI (3.x)

Anypoint CLI 3.x

Anypoint Platform には、Anypoint Platform と Anypoint Platform Private Cloud Edition (Anypoint Platform PCE) のスクリプトおよびコマンドラインツールが用意されています。 コマンドラインインターフェース (CLI) は、対話型シェルと標準 CLI モードの両方をサポートしており、以下で動作します。

前提条件

  • NodeJS と npm (ノードパッケージマネージャー) をシステムにダウンロードしてインストールします。

    必要な最小バージョン: Node.js バージョン 16.0.0 ～ 18.14.0 および npm 6.14.8

    NodeJS のダウンロードページ​を参照してください。

  • Git バージョン管理をシステムにダウンロードしてインストールします。

    Git のダウンロードサイト​を参照してください。

システムの設定によっては、システム管理者のログイン情報を使用して、次のコマンドを実行することが必要になる場合もあります。

インストール

$ npm install -g anypoint-cli@latest
システムの設定によっては、システム管理者のログイン情報を使用して、次のコマンドを実行することが必要になる場合もあります。

認証

ユーザー名とパスワード、クライアント ID とクライアントシークレット、またはベアラートークンを使用するように Anypoint CLI 認証を設定できます。 いずれか 1 つ以上の方法を設定する必要があります。

2022 年 10 月以降、すべてのユーザーに対する多要素認証 (MFA) の有効化の一環として、Anypoint CLI を使用する方法は​接続アプリケーション​経由のみになります。

ユーザー名とパスワード

シングルサインオン (SSO) を使用してログインしない場合は、ユーザー名とパスワードを使用して CLI に直接ログインできます。

パラメーター 説明

username

Anypoint Platform ユーザー名

環境変数 ​export ANYPOINT_USERNAME=<name>​ を使用して、この値を渡すこともできます。

password

Anypoint Platform パスワード

環境変数 ​export ANYPOINT_PASSWORD=<pwd>​ を使用して、この値を渡すこともできます。

SSO を使用したログインの詳細は、​「ID 管理について」​を参照してください。

クライアント ID とクライアントシークレット

client_credentials​ 許可種別を使用して、CLI で使用する接続アプリケーションを設定できます。

パラメーター 説明

client_id

接続アプリケーションの ID

環境変数 ​export ANYPOINT_CLIENT_ID=<client_id>​ を使用して、この値を渡すこともできます。

client_secret

接続アプリケーションのクライアントシークレット

環境変数 ​export ANYPOINT_CLIENT_SECRET=<client_secret>​ を使用して、この値を渡すこともできます。

接続アプリケーションについての詳細は、​「接続アプリケーション」​を参照してください。

ベアラートークン

すでにベアラートークンを生成してある場合は、直接 CLI に渡すことができます。 ベアラートークンを提供した場合、CLI は他に提供されているすべてのユーザーログイン情報やクライアントログイン情報を無視します。

パラメーター 説明

bearer

Anypoint Platform 用のベアラートークン

ベアラートークンの有効期限が切れると、CLI セッションの有効期限が切れます。

ベアラートークンの生成については、 「How to generate your Authorization Bearer token for Anypoint Platform (Anypoint Platform 用の認証ベアラートークンの生成方法)」​を参照してください。

省略可能な引数

Anypoint CLI は、以下の省略可能な引数を取ります。

パラメーター 説明

organization

Anypoint Platform 内の組織

環境変数 ​export ANYPOINT_ORG=<name>​ を使用して、この値を渡すこともできます。

environment

自分の Anypoint Platform 環境

環境変数 ​export ANYPOINT_ENV=<name>​ を使用して、この値を渡すこともできます。

host

Anypoint Platform インストールのホスト
デフォルトでは、この値は ​anypoint.mulesoft.com​ を参照します。

  • Anypoint Platform PCE を使用している場合、プラットフォームをホストしているアドレスを渡していることを確認します。

  • Anypoint Platform EU クラウドを使用している場合は、EU コントロールプレーンアドレスを渡します。

専用の環境変数 ​ANYPOINT_HOST=<name>​ を使用して、この値を渡すこともできます。

使用方法

Anypoint CLI を使用する場合は、次の点に留意してください。

  1. 環境変数はログイン情報ファイルパラメーターよりも優先され、コマンドラインパラメーターは環境変数よりも優先されます。
    コマンドラインパラメーターを渡さない場合、デフォルトプロファイルのプロパティが使用されます。

  2. 指定されていない場合、デフォルト環境は本番です。

  3. Anypoint セッションの有効期限は、組織の設定の ​[Default session timeout (デフォルトセッションタイムアウト)]​ に基づいています。

    組織の設定についての詳細は、​「ルート組織設定を管理する」​を参照してください。

  4. Anypoint CLI は、オートコンプリートと連動します。

    コマンドまたはパラメーターの名前の入力を開始してから Tab キーを押すと、オートコンプリートが実行されます。また、Tab+Tab キーを押すと、オプションのリストが表示されます。

ログイン情報ファイル

これらのオプションを Anypoint Platform CLI インストールに渡すには、​~/.anypoint​ ディレクトリ内にある ​credentials​ ファイルを使用することをお勧めします。このファイルは、インストール時に自動的に作成されません。ログイン情報ファイルを作成する手順は、次のとおりです。

  1. Linux および OSx では ​~/​ ディレクトリ、Windows では ​C:\Users\USERNAME \​ に ​.anypoint​ というディレクトリを作成します。

  2. .anypoint​ ディレクトリに移動し、次の構造の ​credentials​ という名前の空白のファイルを作成します。

    {
 "default": {
  "username": "yourAnypointUserName",
  "password": "yourAnypointPassword",
  "organization": "",
  "environment": "",
  "host": ""
 },
 "otherProfile": {
  "username": "",
  "password": "",
  "organization": "",
  "environment": "",
  "host": ""
 },
 "connAppProfile": {
  "client_id": "",
  "client_secret": "",
  "organization": "",
  "environment": "",
  "host": ""
 }
}

    ANYPOINT_PROFILE​ 環境変数が設定されていないと、​default​ プロファイルが使用されます。

    > export ANYPOINT_PROFILE="otherProfile"
> anypoint-cli

次に、オプションを指定せずに ​anypoint-cli​ コマンドを実行します。

> anypoint-cli

専用の環境変数

anypoint-cli​ の実行時にログイン情報を渡す場合、両方のパラメーターを環境変数 ​ANYPOINT_USERNAME​ および ​ANYPOINT_PASSWORD​ として渡します。

> export ANYPOINT_USERNAME="username"
> export ANYPOINT_PASSWORD="password"
> anypoint-cli

CLI オプション

ユーザー名のみを渡すと、Anypoint CLI からパスワードが求められます。

> anypoint-cli --username="user"
Password: ****

コマンドを渡す

CLI から Anypoint Platform にアクセスする適切な方法をセットアップしたら、コマンドを渡すことができます。
これらの使用方法の手順については、​「Anypoint Platform CLI 3.x のコマンドリスト」​を参照してください。

ネットワークプロキシ経由での Anypoint CLI の使用

Anypoint CLI をプロキシサーバー経由で使用するには、​HTTP_PROXY​ および ​HTTPS_PROXY​ (大文字) 環境変数を設定して、プロキシサーバーのホスト名と IP アドレスを指定します。

使用しているオペレーティングシステムに応じて、次のいずれかのコマンドを使用します。

  • Linux、macOS、または Unix

    $ export HTTP_PROXY=http://​proxy-server​:80

    または

    $ export HTTPS_PROXY=https://​proxy-server​:443

  • Windows

    > set HTTP_PROXY=http://​proxy-server​:80

    または

    > set HTTPS_PROXY=https//​proxy-server​:443

プロキシサーバーで認証が必要な場合は、次のコマンドを使用してください。

  • Linux、macOS、または Unix

    $ export HTTP_PROXY=http://​username​:password​@​proxy-server​:80

    または

    $ export HTTPS_PROXY=https://​username​:password​@​proxy-server​:443

  • Windows

    > set HTTP_PROXY=http://​username​:password​@​proxy-server​:80

    または

    > set HTTPS_PROXY=https://​username​:password​@​proxy-server​:443

注意事項

  • Anypoint CLI 環境を改善するために、匿名化された使用状況データが収集されます。​credentials​ ファイルで ​collectMetrics​ を false に設定することでオプトアウトできます。

関連情報