connectivity checker¶
connectivity_checker はICE Coreとバックエンドサーバとの接続性を検証するコマンドラインツールです。
このツールの出力メッセージとトラブルシューティングガイドを組み合わせることで、ICE Coreがバックエンドサーバとつながらない場合の確認箇所を絞り込むことができます。
このツールはICE Coreと以下のバックエンドサーバとの通信の検証をサポートします。
- CONNEXIVE Application Platform V2とのデータ通信(HTTP、MQTT)、ファイルアップロード、ファイルダウンロード
- CONNEXIVE Application Platform V2 (V1接続互換設定)とのデータ通信、ファイルアップロード、ファイルダウンロード
場所¶
connectivity_checker コマンドは${ICE_HOME}/bin配下にあります。
※ ${ICE_HOME} はICE Coreのインストールディレクトリを表します。
書式¶
connectivity_checker connect [--dest <destName>] [--verbose] [--traceTls]
connectivity_checker download --url <url> --downloadDir <dir> [--verbose] [--traceTls]
connectivity_checker upload --url <url> --uploadFile <file> [--uploadMethod <httpMethod>] [--verbose] [--traceTls]
connectivity_checker --help
サブコマンド¶
-
connect
ICE Coreとバックエンドサーバのデータ通信の接続性を検証します。
destオプションでcloud_config.jsonで定義したdestinationから選択して検証ができます。
destオプションでcloud_config.jsonで定義していないdestinationを指定するとエラーになります。 -
download
ICE Coreとバックエンドサーバのファイルダウンロード通信の接続性を検証します。
urlオプションでダウンロードするファイルのURLを、downloadDirオプションでダウンロードしたファイルの配置先ディレクトリを指定します。
urlオプションでファイルが存在しないURLを指定したり、downloadDirオプションで利用可能なディレクトリを指定しない場合はエラーになります。 -
upload
ICE Coreとバックエンドサーバのファイルアップロード通信の接続性を検証します。
urlオプションでアップロード先のURLを、uploadFileオプションでアップロードするファイルのファイルパスを指定します。
urlオプションでアップロード可能でないURLを指定したり、uploadFileオプションで利用可能なファイルを指定しない場合はエラーになります。
オプション¶
オプションは必ず'-'か'--'で始めます。また、一部を除いて複数指定が可能です。
-d,--dest
バックエンドサーバへのデータ通信の接続性検証で検証するdestinationを指定します。
connectサブコマンドでのみ有効なオプションです。
既定値は "default" です。-U,--url
ファイルダウンロード・アップロード通信の接続性の検証時に、ファイルダウンロード元/ファイルアップロード先のURLを指定します。
downloadまたはuploadサブコマンドでは必須です。-D,--downloadDir
ダウンロードしたファイルの格納先となるディレクトリパスを指定します。
downloadサブコマンドでは必須です。-F,--uploadFile
アップロード対象ファイルのファイルパスを指定します。
uploadサブコマンドでは必須です。-M,--uploadMethod
ファイルアップロード通信の接続性検証で使用するHTTPメソッドを指定します。
uploadサブコマンドでのみ有効なオプションです。
既定値は POST です。-v,--verbose
詳細情報を出力します。
既定値は 指定なし です。t,--traceTls
TLSコネクションの検証時に詳細情報を出力します。
既定値は 指定なし です。--help
オプションの説明を出力します。
既定値は 指定なし です。
戻り値¶
| エラーコード | 実行結果 |
|---|---|
| 0 | 正常終了 |
| 1 | 異常終了 |
| 2 | 設定値・引数が不正 |
| 3 | ファイルIOエラー |
使用例¶
- バックエンドサーバのデータ通信の接続性を検証する
# "default" destinationの接続性を検証
$ sudo connectivity_checker connect
- ファイルダウンロード通信の接続性を検証する
# ファイルサーバ上のファイルをダウンロードし、/tmpに配置
$ sudo connectivity_checker download --url http://192.168.1.1:80/download/data --downloadDir /tmp
- ファイルアップロード通信の接続性を検証する
# /tmp/dataにあるファイルをファイルサーバにアップロード
$ sudo connectivity_checker upload --url http://192.168.1.1:80/upload/ --uploadFile /tmp/data
ツールの実行のトラブルシュート¶
ツールの実行に失敗した場合、以下のエラーメッセージが出力されます。
出力されたメッセージに対応する対処列の記載に従って、コマンドを見直してください。
| メッセージ | 意味 | 対処 |
|---|---|---|
| Argument -D or --downloadDir is required | ツールの実行時に必須の引数が指定されていません | 必須の引数を指定してツールを実行してください |
| Argument -F or --uploadFile is required | ツールの実行時に必須の引数が指定されていません | 必須の引数を指定してツールを実行してください |
| Argument -U or --url is required | ツールの実行時に必須の引数が指定されていません | 必須の引数を指定してツールを実行してください |
| Invalid subcommand [%s] | %s は無効なサブコマンドです。 | ツール実行時のサブコマンドの指定を見直してください。 |
| Invalid protocol [%s] at url-option-value (-U or --url) | 引数でURLの値が指定されていないか、無効なプロトコルが指定されています。 | 引数でURLの値を指定しているか、指定している場合は値が正しいかを確認してください。 |