configedit¶

configedit はICE Coreの設定を変更するコマンドラインツールです。 ICE Core実行中に使用できますが、設定は動的には反映されません。

場所¶

configedit コマンドは${ICE_HOME}/bin配下にあります。 ※ ${ICE_HOME} はICE Coreのインストールディレクトリを表します。

書式¶

configedit set [-a] [-s|-n|-b] [-i] [-f <ファイル>] <プロパティ名> <値> [<値>...]

configedit set [-c] [-f <ファイル>] <プロパティ名> <値> [<値>...]

configedit delete [-r] [-f <ファイル>] <プロパティ名>

サブコマンド¶

set 指定したプロパティに値を設定します。既存のプロパティに対してデータ型の異なる値をsetするとエラーになります。型を無視してsetする場合は--ignore_typeを指定します。
delete 指定したプロパティを削除します。 array, objectのプロパティを削除する場合は--recursiveを指定します。

オプション¶

オプションは必ず'-'か'--'で始めます。また、一部を除いて複数指定が可能です。

-a, --array
値をarrayで設定します。合わせて--string, --number, --booleanのいずれかを指定することで、配列の要素の型を指定します。 --string, --number, --booleanを省略した場合は--stringが選択されます。このオプションを指定した場合のみ、＜値＞を複数定義できるようになります。 setコマンドでのみ有効なオプションです。
-s, --string
値をstringで設定します。--number, --booleanと同時に指定することはできません。このオプションは既定で有効になります。 setコマンドでのみ有効なオプションです。
-n, --number
値をnumberで設定します。--string, --booleanと同時に指定することはできません。 setコマンドでのみ有効なオプションです。
-b, --boolean
値をbooleanで設定します。--string, --numberと同時に指定することはできません。 setコマンドでのみ有効なオプションです。このオプションを指定した場合、＜値＞にはtrueかfalseのいずれかのみを指定します。
-i, --ignore_type
setコマンドで既存のプロパティに対してデータ型の異なるデータを設定する場合に指定します。 setコマンドでのみ有効なオプションです。
-f, --file
編集する設定ファイルを指定します。既定ではconf/core_config.jsonを編集します。
-r, --recursive
deleteコマンドで指定すると、指定したプロパティがarray, objectの場合でも削除できるようになります。
-c, --credential
パスワードなどの文字列を暗号化します。編集対象の設定ファイルにはマスクされた文字列が設定されます。

プロパティ名¶

プロパティはICE Coreの設定項目名を表す一意な文字列です。設定が階層構造を持ち、プロパティでピリオド区切りの文字列で階層構造を表現します。

戻り値¶

エラーコード	実行結果
0	正常終了
1	異常終了
2	型チェックエラー
3	ファイルIOエラー

使用例¶

mqttプロトコルでバックエンドに接続する場合

# 設定ファイルをバックアップ
$ sudo cp ${ICE_HOME}/conf/core_config.json{,.bak}
# 設定の変更
$ sudo configedit set -s edge_id site_A_01
$ sudo configedit set -s default.type mqtt -f ${ICE_HOME}/conf/cloud_config.json
$ sudo configedit set -s default.compatible_mode. ice-v1 -f ${ICE_HOME}/conf/cloud_config.json
$ sudo configedit set -s default.config.url "mqtt://example.com:1883" -f ${ICE_HOME}/conf/cloud_config.json
$ sudo configedit set -s default.config.options.user iotuser -f ${ICE_HOME}/conf/cloud_config.json
$ sudo configedit set -c default.config.options.password password -f ${ICE_HOME}/conf/cloud_config.json

誤って作成したconfig.options配下の設定を削除する（deleteコマンド）

# 誤った設定を実行
$ sudo configedit set -s default.config.options.username username -f ${ICE_HOME}/conf/cloud_config.json
# 誤った設定を削除
$ sudo configedit delete -r default.config.options -f ${ICE_HOME}/conf/cloud_config.json