MENU

Soracom

Users

SORACOM CLI をインストールし SIM カードの一覧を取得する

ステップ 1: インストールする

SORACOM CLI Releases ページ からお使いの環境に合ったパッケージファイルをダウンロードして展開し、実行形式ファイルを PATH の通ったディレクトリに配置します。

  1. Releases ページ へアクセスし、soracom_[バージョン]_windows_amd64.zip をクリック、ダウンロードしてください。
  2. ダウンロードした zip ファイルを解凍してください。
  3. exe ファイルを PATH の通っているディレクトリ (%SystemRoot%\system32 など) に配置してください。
例として amd64 をインストールしていますが、i386 用のパッケージファイルも用意しています。環境に合ったファイルをダウンロードしてください。

以下のコマンドでインストールできます。例として 0.6.2 をインストールしていますが、最新のバージョンは Releases のページでご確認ください。

$ wget https://github.com/soracom/soracom-cli/releases/download/v0.6.2/soracom_0.6.2_linux_amd64.tar.gz
$ tar xvf ./soracom_0.6.2_linux_amd64.tar.gz
$ cp ./soracom_0.6.2_linux_amd64/soracom /usr/local/bin/
例として amd64 をインストールしていますが、i386, arm 用のパッケージファイルも用意しています。環境に合ったファイルをご利用ください。またインストール先は /usr/local/bin である必要はありません。環境や用途に合わせて PATH の通ったディレクトリに配置してください。

以下のコマンドでインストールできます。

$ brew tap soracom/soracom-cli
$ brew install soracom-cli

ステップ 2: 認証する

このステップで SORACOM CLI を実行するために必要な認証情報を保存します。soracom configure を実行します。

以下の実行例のように LANG 環境変数を日本語にしておけば soracom コマンドのメッセージが日本語化されます。一部のメッセージは英語のみの場合があります。
$ LANG=ja soracom configure
--- SORACOM CLI セットアップ ---
/home/mick/.soracom ディレクトリがなければ作成し、そこにファイル 'default.json' を作成します。

カバレッジタイプを選択してください。

1. Global
2. Japan

選択してください (1-2) >

plan01s などグローバルカバレッジをご利用であれば 1 を、plan-D など日本カバレッジをご利用であれば 2 を入力して Enter を押します。

認証方法を選択してください。

1. AuthKeyId と AuthKey を入力する (推奨)
2. オペレーターのメールアドレスとパスワードを入力する
3. SAM ユーザーの認証情報を入力する (オペレーターID、ユーザー名、パスワード)

選択してください (1-3) >

認証方式を選びます。推奨は AuthKeyIdAuthKey を用いる 1 です。希望する番号を入力して Enter を押します。SAM ユーザーを作成して AuthKeyIdAuthKey を発行する方法は アクセス管理 (SORACOM Access Management) をご参照ください。

多要素認証はサポートしていません。API 呼び出し専用の SAM ユーザー作成を推奨します。
authKeyId: (authKeyId を入力します)
authKey: (authKey を入力します)
プロファイル default はすでに存在しています。上書きしますか? (Y/n) Y

1 を選択して AuthKeyIdAuthKey を入力した後、過去にログインしたことがあれば設定を上書きしてよいか確認されます。上書きして良ければ Y を入力して Enter を押します。

以上で認証は完了です。以下のファイルに認証情報として保存されます(プロファイルと呼ばれます)。以後 SORACOM CLI を利用するときはこのプロファイルを用いて毎回自動的に認証が行われます。

  • macOS / Linux: ${HOME}/.soracom/default.json
  • Windows: %HOMEPATH%\.soracom\default.json
プロファイルに記載されている情報を使うと認証したユーザーが可能なすべての操作が実行できます。アクセス権限を慎重に管理してください。

ステップ 3: SIM カードの一覧を取得する

SORACOM CLI は soracom [command] [flag] という形式で使用します。

  • command: subscriber, vpg など呼び出したい SORACOM API を指定します。
  • flag: --imsi --limit など呼び出す際の条件を指定します。

soracom subscribers list と入力して SIM 一覧を表示しましょう。(下の表示例では一部情報をマスクしています)

$ soracom subscribers list
[
        {
                "apn": "soracom.io",
                "imsi": "44010xxxxxxxxxx",
                (中略)
                "speedClass": "s1.minimum"
        },
        {
                "apn": "soracom.io",
                "imsi": "44010yyyyyyyyyy",
                (中略)
                "speedClass": "s1.standard"
        },
        ... (以下略)
]