Soracom

Users

開発者向けツール

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

ステップ 0: 認証情報を準備する 

SORACOM CLI を実行するために、以下のいずれかの認証情報を準備します。準備した認証情報は、ステップ 2: 認証情報を保存する で入力します。

認証情報説明
認証キー (認証キー ID および認証キーシークレット)ルートユーザーまたは SAM ユーザーの認証キーを生成してください。
SAM ユーザーについて詳しくは、SAM ユーザーを作成する を参照してください。
ルートユーザーのメールアドレスとパスワードルートユーザーのメールアドレスとパスワードを確認してください。
SAM ユーザーの認証情報SAM ユーザーのオペレーターID、名前、コンソールログインパスワードを確認してください。
SAM ユーザーについて詳しくは、SAM ユーザーを作成する を参照してください。
安全のため SAM ユーザーの認証キーを使用することを推奨します

SORACOM CLI 呼び出し専用の SAM ユーザーを作成し、SAM ユーザーの認証キーを使用することを推奨しています。

認証情報が漏洩した場合、専用の SAM ユーザーを作成していれば、あらかじめ設定した権限の操作のみが実行される可能性があります。一方、ルートユーザーの認証情報を使用していると権限を限定できないため、すべての操作が実行される可能性があります。

SORACOM CLI は、多要素認証 には対応していません。

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

SORACOM CLI の Releases ページ から、SORACOM CLI を利用するアーキテクチャに合ったパッケージファイルをダウンロードして展開し、実行形式ファイルを PATH が通っているフォルダまたはディレクトリに配置します。

  1. Releases ページ へアクセスし、パッケージファイル (例: soracom_[バージョン]_windows_amd64.zip) をクリックして、ダウンロードします。
  2. ダウンロードしたファイルを解凍します。
  3. 実行形式ファイル (拡張子が exe のファイル) を、PATH が通っているフォルダ (%SystemRoot%\system32 など) にコピーします。
この手順では、例として amd64 用のパッケージファイルをダウンロードしていますが、i386 用のパッケージファイルも用意しています。

以下のコマンドでインストールできます。[バージョン] には、任意のバージョン番号 (例:0.10.0) を指定します。最新のバージョンは Releases ページ を参照してください。

$ wget https://github.com/soracom/soracom-cli/releases/download/v[バージョン]/soracom_[バージョン]_linux_amd64.tar.gz
$ tar xvf ./soracom_[バージョン]_linux_amd64.tar.gz
$ cp ./soracom_[バージョン]_linux_amd64/soracom /usr/local/bin/
この手順では、例として amd64 用のファイルをインストールしていますが、そのほかのアーキテクチャ用のファイルも用意しています。また、/usr/local/bin にインストールしていますが、任意の PATH が通ったディレクトリにインストールできます。

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

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

ステップ 2: 認証情報を保存する 

SORACOM CLI を実行するために必要な認証情報を保存します。

  1. soracom configure を実行します。

    $ LANG=ja soracom configure
    --- SORACOM CLI セットアップ ---
    /home/xxxxx/.soracom ディレクトリがなければ作成し、そこにファイル 'default.json' を作成します。
       
    カバレッジタイプを選択してください。
       
    1. Global
    2. Japan
       
    選択してください (1-2) >
    
    実行例のように LANG 環境変数に ja を指定すると、soracom コマンドのメッセージが日本語化されます。ただし、一部のメッセージは英語で表示される場合があります。
  2. 1 または 2 を入力して、Enter を押します。

    1 : SORACOM IoT SIM (グローバル) のサブスクリプション (plan01s など) を利用する IoT SIM を管理する

    2 : 特定地域向け IoT SIM (日本) のサブスクリプション (plan-D など) を利用する IoT SIM を管理する

    認証方法を選択してください。
       
    1. AuthKeyId と AuthKey を入力する (推奨)
    2. オペレーターのメールアドレスとパスワードを入力する
    3. SAM ユーザーの認証情報を入力する (オペレーターID、ユーザー名、パスワード)
       
    選択してください (1-3) >
    
  3. 希望する認証方式の番号 (例:1) を入力して、Enter を押します。

    ここでは、1 (AuthKeyId と AuthKey を入力する) の操作を説明します。

  4. 認証キー ID と認証キーシークレットを以下のように入力します。

    authKeyId: (認証キー ID を入力して、Enter を押します。入力した内容が表示されます。)
    authKey: (認証キーシークレットを入力して、Enter を押します。入力した内容は表示されません。)
    
  5. 過去に SORACOM CLI を実行して、SORACOM プラットフォームにアクセスしたことがあれば、設定を上書きしてよいか確認するメッセージが表示されます。上書きする場合は Y を入力して Enter を押します。

    認証情報が プロファイル に保存されます。SORACOM CLI を実行するときは、プロファイルに記載されている認証情報を利用して認証が行われます。

プロファイルに記載されている認証情報が漏洩しないように、プロファイルのアクセス権限を慎重に管理してください。

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

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

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

ステップ 4: そのほかのコマンドを確認する 

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

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

SORACOM CLI で利用できるコマンドの調べかたについては、ヘルプ を参照してください。