戻る | 前へ | 次へ

IoT SAFE Client コマンドリファレンス

概要

IoT SAFE Client は、Raspberry Pi OS / Ubuntu / Debian 向けの IoT SAFE アプリケーション管理ツールです。

サポート環境

本ツールは、以下の環境をサポートしています。

• アーキテクチャ

  • arm64

  • amd64 (x86_64)

• ディストリビューション

  • Raspberry Pi OS

  • Ubuntu

  • Debian

基本的な使用方法

iotsafe-client [グローバルオプション] <コマンド> [コマンドオプション]

グローバルオプション

すべてのコマンドで使用可能なオプションです。

オプション	説明	環境変数※
--api-id <API ID>	Applet Consoleで払い出されたAPI ID	API_ID
--api-secret <APIシークレット>	Applet Consoleで払い出されたAPI シークレット	API_SECRET
--config / -c <設定ファイルパス>	設定ファイルのパス	-
--verbose / -v	詳細出力	-
--quiet / -q	最小限の出力	-
--version	バージョン表示	-
--help	ヘルプ表示	-

注釈

※オプションを使用せず、環境変数で設定することも可能です。

コマンド

config - 設定管理

初期設定と管理を行います。

configの設定変数一覧

変数名	説明	デフォルト値	設定可能な値	備考
architecture	ターゲットアーキテクチャ	auto	auto x86_64 aarch64
fqdn	FQDN（完全修飾ドメイン名）	{APIのベースURLに使用するFQDN} ※インストール時に自動反映されます	有効なドメイン名形式の文字列	バリデーション: RFC 準拠のドメイン名形式である必要があります 機能: API のベース URL 構築に使用されます (https://{fqdn}/v1)
packages.keep_downloads	ダウンロードしたパッケージファイルの保持	False	True False
pkcs11.default_slot	デフォルトの PKCS11 スロット番号	0	0 以上の整数	バリデーション: 値は 0 以上である必要があります
pkcs11.module	PKCS11 モジュールライブラリ名称	libpkcs11_iotsafe.so	.so、.dll、.dylibのいずれかで終わるライブラリファイル名	バリデーション: 適切なライブラリファイル拡張子で終わる必要があります
vpn.auto_reconnect	VPN の自動再接続	True	True False

config init - 初期設定

初期設定を行います。

注釈

install.sh から実行した場合は初期化は不要です。

書式

iotsafe-client config init [オプション]

オプション

• --fqdn <FQDN文字列>: サーバーの FQDN

• --non-interactive / -n: 非対話モード

• --config-file <コンフィグファイルパス>: JSON/YAML ファイルから設定を読み込み

使用例

# 対話モード（デフォルト）
iotsafe-client config init

# 非対話モード
iotsafe-client config init -n --fqdn "iotsafe.example.com"

# 設定ファイルから読み込み
iotsafe-client config init --config-file "config.json" -n

config set - 変数の値の変更

変数の値を変更します。

書式

iotsafe-client config set <キー名> <値>

パラメーター

• キー名: キーの名前

• 値: キーに設定する値

使用例

iotsafe-client config set fqdn "iotsafe.example.com"
iotsafe-client config set vpn.auto_reconnect True

config get - 変数の値の取得

特定の変数の値を表示します。

書式

iotsafe-client config get <キー名>

パラメーター

• キー名: キーの名前

使用例

iotsafe-client config get fqdn

config list-schema - 変数リストの取得

設定可能なすべての変数を表示します。

書式

iotsafe-client config list-schema

config list - 全設定の表示

すべての変数の値と環境変数の API 認証情報を一覧表示します。

書式

iotsafe-client config list

config remove - 変数の削除

特定の変数を削除します。

書式

iotsafe-client config remove <キー名>

パラメーター

• キー名: キーの名前

使用例

iotsafe-client config remove packages.auto_update

package - パッケージ管理

IoT SAFE関連パッケージのインストールと管理を行います。

package install - パッケージのインストール

IoT SAFE関連パッケージをインストールします。

書式

iotsafe-client package install [オプション] [<パッケージ名>]

オプション

• --all: すべてのパッケージをインストール

パラメーター

• パッケージ名: インストールするパッケージ名

使用例

# 全パッケージをインストール
iotsafe-client package install --all

# 特定のパッケージをインストール
iotsafe-client package install iotsafe-client

package update - パッケージの更新

IoT SAFEパッケージを更新します。

書式

iotsafe-client package update [オプション] [<パッケージ名>]

オプション

• --all: すべてのパッケージをアップデート

パラメーター

• パッケージ名: アップデートするパッケージ名

使用例

# 全パッケージを更新
iotsafe-client package update --all

# 特定のパッケージを更新
iotsafe-client package update iotsafe-client

package list - インストール済みパッケージの表示

インストール済みのIoT SAFEパッケージを表示します。

書式

iotsafe-client package list

package remove - パッケージの削除

特定のIoT SAFE関連パッケージを削除します。

書式

iotsafe-client package remove <パッケージ名>

パラメーター

• パッケージ名: 削除するパッケージ名

使用例

# 特定のパッケージを削除
iotsafe-client package remove iotsafe-client

package info - パッケージ情報の表示

特定のIoT SAFE関連パッケージの情報を表示します。

書式

iotsafe-client package info <パッケージ名>

パラメーター

• パッケージ名: インストールするパッケージ名

使用例

# 特定のパッケージを削除
iotsafe-client package info iotsafe-client

cert - 証明書管理

CA 証明書のダウンロードと管理を行います。

cert download-ca - CA 証明書のダウンロード

Applet ConsoleのCA証明書をダウンロードします。

書式

iotsafe-client cert download-ca [オプション]

オプション

• --output / -o <出力ファイルパス>: 出力ファイルパス

使用例

# デフォルトの場所に保存
iotsafe-client cert download-ca

# 指定した場所に保存
iotsafe-client cert download-ca --output /path/to/ca.cert

cert show - 証明書情報の表示

CA 証明書や指定した証明書の情報を表示します。

書式

iotsafe-client cert show [<証明書ファイルパス>]

パラメーター

• 証明書ファイルパス: 内容を表示する証明書ファイルのパス（省略時: デフォルトCA証明書）

使用例

# デフォルトCA証明書を表示
iotsafe-client cert show

# 指定した証明書を表示
iotsafe-client cert show /path/to/cert.pem

cert verify - 証明書の検証

指定した証明書を検証します。

書式

iotsafe-client cert verify <証明書ファイルパス>

パラメーター

• 証明書ファイルパス: 内容を表示する証明書ファイルのパス

使用例

iotsafe-client cert verify /path/to/cert.pem

vpn - VPN 管理

VPN接続の設定と管理を行います。

vpn download-config - OpenVPN 設定のダウンロード

VPN 接続設定をダウンロードします。

書式

iotsafe-client vpn download-config [オプション]

オプション

• --iccid <ICCID>: SIM カードの ICCID を手動で入力

• --auto: ICCID を自動検出

使用例

# ICCIDを指定してダウンロード
iotsafe-client vpn download-config --iccid "89XXXXXXXXXXXXX"

# 自動検出モード
iotsafe-client vpn download-config --auto

vpn start - VPN 接続

VPN接続を確立します。

書式

iotsafe-client vpn start

vpn stop - VPN 切断

VPN接続を切断します。

書式

iotsafe-client vpn stop

vpn logs - VPN ログの表示

VPN接続のログを表示します。

書式

iotsafe-client vpn logs [オプション]

オプション

• -f: ログをリアルタイムで追跡

• -n <行数>: 表示する行数

• --since <文字列>: 指定時刻以降のログを表示（例: "1 hour ago", "2024-12-28 10:00:00"）

使用例

# VPNログの表示
iotsafe-client vpn logs

# VPNログの表示（リアルタイム更新）
iotsafe-client vpn logs -f

# VPNログの表示（表示行数指定）
iotsafe-client vpn logs -n 20

# VPNログの表示（指定した時間まで遡ってログを表示）
iotsafe-client vpn logs --since "1 hour ago"

vpn status - VPN 接続状態の確認

VPN接続状態を確認します。

書式

iotsafe-client vpn status

vpn enable - VPN 自動起動の有効化

VPN自動起動を有効にします。

書式

iotsafe-client vpn enable

vpn disable - VPN 自動起動の無効化

VPN自動起動を無効にします。

書式

iotsafe-client vpn disable

vpn get-iccid - ICCID の取得

SIMのICCIDを取得します。

書式

iotsafe-client vpn get-iccid

pkcs11 - PKCS#11 操作

PKCS#11 トークンの操作を行います。

pkcs11 list-slots - スロット一覧の表示

スロットの一覧を表示します。

書式

iotsafe-client pkcs11 list-slots [オプション]

オプション

• --module / -m <モジュールパス>: PKCS#11 モジュール（省略時: libpkcs11_iotsafe.so）

使用例

iotsafe-client pkcs11 list-slots
iotsafe-client pkcs11 list-slots --module /path/to/module.so

pkcs11 list-objects - オブジェクト一覧の表示

オブジェクトの一覧を表示します。

書式

iotsafe-client pkcs11 list-objects [オプション]

オプション

• --slot / -s <スロット番号>: スロット番号（省略時: 0）

• --module / -m <モジュールパス>: PKCS#11 モジュール（省略時: libpkcs11_iotsafe.so）

使用例

iotsafe-client pkcs11 list-objects
iotsafe-client pkcs11 list-objects --slot 1

pkcs11 read-object - オブジェクトの出力

指定したオブジェクトをファイル出力します。

書式

iotsafe-client pkcs11 read-object [オプション]

オプション

• --label / -l <オブジェクトラベル>: オブジェクトラベル（必須）

• --type / -t <オブジェクトタイプ>: オブジェクトタイプ（必須、 cert / data / pubkey の何れか）

• --output / -o <出力ファイルパス>: 出力ファイル（省略時: 標準出力に出力）

• --slot / -s <スロット番号>: スロット番号（省略時: 0）

• --module / -m <モジュールパス>: PKCS#11 モジュール

使用例

# 公開鍵の読み取り
iotsafe-client pkcs11 read-object --label "my_key_PublicKey" --type pubkey --output pubkey.der

# CSRの読み取り
iotsafe-client pkcs11 read-object --label "my_key_CertificateSigningRequest" --type data --output csr.der

# クライアント証明書の読み取り
iotsafe-client pkcs11 read-object --label "my_cert" --type cert --output cert.der

# データオブジェクトの読み取り
iotsafe-client pkcs11 read-object --label "my_data" --type data --output data.bin

pkcs11 dump - トークン情報のダンプ

トークン情報を表示します。

書式

iotsafe-client pkcs11 dump [オプション]

オプション

• --slot / -s <スロット番号>: スロット番号（省略時: 0）

• --module / -m <モジュールパス>: PKCS#11 モジュール（省略時: libpkcs11_iotsafe.so）

使用例

iotsafe-client pkcs11 dump
iotsafe-client pkcs11 dump --slot 1

pkcs11 info - モジュール情報の表示

PKCS#11関連カーネルモジュール情報を表示します。

書式

iotsafe-client pkcs11 info [オプション]

オプション

• --module / -m <モジュールパス>: PKCS#11 モジュール（デフォルト: libpkcs11_iotsafe.so）

使用例

iotsafe-client pkcs11 info
iotsafe-client pkcs11 info --module /path/to/module.so

system - システム管理

システムの診断と依存関係の管理を行います。

system check-deps - 依存関係の確認

必要なシステムパッケージがインストールされているか確認します。

書式

iotsafe-client system check-deps

system install-deps - 依存関係のインストール

不足している依存パッケージをインストールします。

書式

iotsafe-client system install-deps

system info - システム情報の表示

OS、ネットワーク、設定情報を表示します。

書式

iotsafe-client system info

system diagnose - システム診断

設定、ネットワーク、依存関係などの総合的な診断を実行します。

書式

iotsafe-client system diagnose

使用例

初期セットアップ

# 1. 設定を初期化
iotsafe-client config init

# 2. 依存関係をインストール
iotsafe-client system install-deps

# 3. パッケージをインストール
iotsafe-client package install --all

# 4. CA証明書をダウンロード
iotsafe-client cert download-ca

VPN 接続のセットアップ

# 1. ICCIDを確認
iotsafe-client vpn get-iccid

# 2. VPN設定をダウンロード
iotsafe-client vpn download-config --auto

# 3. VPN接続
iotsafe-client vpn start

# 4. 必要に応じて、VPNの自動起動を設定
iotsafe-client vpn enable

# 5. 接続状態、自動起動設定を確認
iotsafe-client vpn status

トラブルシューティング

API 認証エラー

# 設定を確認
iotsafe-client config list

# 以下、何れか方法でクレデンシャル情報を設定し、コマンドを実行

# オプションを指定して実行
iotsafe-client --api-id="your-api-id" --api-secret="your-api-secret" <コマンド>

# 環境変数を設定後、実行
export API_ID="your-api-id"
export API_SECRET="your-api-secret"
iotsafe-client <コマンド>

# configコマンドで設定して実行
iotsafe-client config set API_ID 'your-id'
iotsafe-client config set API_SECRET 'your-secret'
iotsafe-client <コマンド>

注釈

Applet Consoleに表示されるインストールコマンドを使用時、 API_ID 、 API_SECRET の保存確認でYesを選択した場合、情報は設定ディレクトリに保存されます。 その場合、 iotsafe-client のオプション指定は不要です。

接続エラー

# システム診断を実行
iotsafe-client system diagnose

# ネットワーク情報を確認
iotsafe-client system info

依存関係エラー

# 依存関係を確認
iotsafe-client system check-deps

# 不足している依存関係をインストール
iotsafe-client system install-deps

目次

• 1.1. 管理機能
• 1.2. パートナー概念
• 2.1. 提供機能について
  • 2.1.1. SIMについて
  • 2.1.2. プロファイル
  • 2.1.3. SIM種別
  • 2.1.4. ライフサイクル管理
  • 2.1.5. 通信プラン
  • 2.1.6. プラン/上限値変更
  • 2.1.7. 容量シェア
  • 2.1.8. キャリア冗長
  • 2.1.9. 容量追加
• 2.2. 料金について
• 2.3. ポータル/APIについて
• 2.4. 利用量上限に対する通知メール機能
• 2.5. IoT Connect Mobile Type S でご利用頂く端末について
  • 2.5.1. IoT Connect Mobile Type S ご利用のお客様向け販売端末
  • 2.5.2. 端末詳細
• 2.6. eSIMアプレットについて
• 3.1. 技術要件・端末設定等
  • 提供条件
  • 端末設定/インターフェイス条件(NTTCプロファイル(インターネット接続)ご利用時)
  • 端末設定/インターフェイス条件(NTTCプロファイル(閉域接続)ご利用時)
  • 端末設定/インターフェイス条件(NTTCプロファイル(IoT Connect Gateway)ご利用時)
  • 端末設定/インターフェイス条件(TSLプロファイル(インターネット接続)ご利用時)
  • 端末設定/インターフェイス条件(TSLプロファイル(閉域接続)ご利用時)
  • 端末設定/インターフェイス条件(マルチアクセスSIM(インターネット接続)ご利用時)
  • 端末設定/インターフェイス条件(マルチアクセスSIM(閉域接続)ご利用時)
• 3.2. 端末要件
  • 3.2.1. 端末要件について
  • 3.2.2. プロファイル追加/切替などに必要な端末要件
  • 動作確認済端末について
• 3.3. eSIMスペックシート
  • eSIMスペックシート
  • MFF2（チップSIM）の保管要件
• 3.4. マルチアクセスSIM機能利用時の端末要件
  • 3.4.1. 端末要件
  • 3.4.2. 動作確認端末一覧
• 4.1. 申し込みについて
  • 申し込みにあたっての注意事項
  • お申し込み
  • お問い合わせ
• 4.2. サポートについて
• 5.1. 海外利用(技術輸出)について
• 5.2. サービス品質について
• 5.3. 解約時におけるSIMカードの取り扱いについて
• 5.4. プロファイル毎の制約事項について
• 5.5. IoT Connect Gateway ご利用時の注意点について
• 5.6. 閉域接続ご利用時の注意点について
• 5.7. 上り特価プランご利用時の注意点について
• 5.8. テストモードご利用時の注意点について
• 5.9. 使用量表示画面・残量表示画面ご利用時の注意点について
• 5.10.グローバル固定IPアドレスご利用時の注意点について
• 5.11. 年間前払いについて
• 5.12. マルチアクセスSIMについて

---