intdash-agentctl config
intdash-agentctl config [<config_command_options>] <command> <command_option> [<arguments>]
intdash Edge Agent 2の設定を変更します。
<command>
では、 connection
、 upstream
、 filter upstream
などの、設定対象を示すサブコマンドを指定します。
詳細については、設定対象ごとの説明を参照してください。
注釈
--modify <config_string>
-m <config_string>
--patch <config_string>
を使用する場合、<config_string>で指定されたフィールドのみが更新され、他のフィールドは変更されません。
削除できるフィールドの場合は、nullを指定することで削除できます。
intdash-agentctl config device-connector upstream --modify up-hello '
launch: null
'
configコマンドに共通の <config_command_options>
では、以下を使用することができます。
- --log <level>, -l <level>
ログレベルを設定します。levelには、以下を設定できます:
t[race]|d[ebug]|i[nformation]|w[arning]|e[rror]|q[uiet]
ログレベルは、環境変数AGENT_LOGでも設定できます。 環境変数AGENT_LOGよりもこのコマンドオプションが優先されます。環境変数AGENT_LOGが与えられておらず、このコマンドオプションも与えられていない場合、informationレベルとなります。
- --json, -j
設定の入出力をJSON形式で行います。
- --help, -h
ヘルプを表示します。
注釈
intdash-agentctl config
コマンドで設定の取得、変更、削除などを実行すると、intdash Edge Agent 2が持つREST APIに対してリクエストが行われ、設定の取得、変更、削除などが行われます。
connectionサブコマンド
intdash-agentctl config [<config_command_options>] connection <command_option> [<arguments>]
intdash Edge Agent 2とintdashサーバー間の接続について設定します。
設定操作
<command_option> [<arguments>]
で以下のように指定します。
- --get, -g
接続の設定を表示します。
- --modify <config_string>, -m <config_string>, --patch <config_string>
接続の設定を更新します。 <config_string>にはYAML形式の文字列(--json を指定した場合はJSON型式)を与えます。
例:
$ intdash-agentctl config connection --modify ' server_url: https://abc.example.com project_uuid: 01234567-89ab-cdef-0123-456789abcdef '
注釈
connection サブコマンドでは、 REST API の
/connection
エンドポイントが使用されます。 設定の詳細については、APIリファレンスの Update Connection Settings を参照してください。<config_string>
では、APIリファレンスに記載されているリクエストボディのJSONと同等の内容をYAML形式で指定してください(または--json
オプションを使用してJSON形式で指定してください)。
transportサブコマンド
intdash-agentctl config [<config_command_options>] transport <command_option> [<arguments>]
トランスポートについて設定します。
設定操作
<command_option> [<arguments>]
で以下のように指定します。
- --get, -g
トランスポートの設定を表示します。
- --modify <config_string>, -m <config_string>, --patch <config_string>
トランスポートの設定を更新します。 <config_string>にはYAML形式の文字列(--json を指定した場合はJSON型式)を与えます。 <config_string>で指定されたフィールドのみが更新され、他のフィールドは変更されません。
例:
$ intdash-agentctl config transport --modify 'protocol: websocket'
注釈
transportサブコマンドでは、 REST API の
/transport
エンドポイントが使用されます。 設定の詳細については、APIリファレンスの Update Transport Settings を参照してください。<config_string>
では、APIリファレンスに記載されているリクエストボディのJSONと同等の内容をYAML形式で指定してください(または--json
オプションを使用してJSON形式で指定してください)。
upstream、downstreamサブコマンド
intdash-agentctl config [<config_command_options>] upstream <command_option> [<arguments>]
intdash-agentctl config [<config_command_options>] downstream <command_option> [<arguments>]
アップストリームまたはダウンストリームについて設定します。
設定操作
<command_option> [<arguments>]
で以下のように指定します。
- --create <config_string>, -c <config_string>, --post <config_string>
アップストリームまたはダウンストリームの設定を新規作成します。 <config_string>にはYAML形式の文字列(--json を指定した場合はJSON型式)を与えます。 指定しなかった設定値はデフォルトが使用されます。
例:
$ intdash-agentctl config upstream --create ' id: recoverable enabled: true recover: true persist: true qos: unreliable flush_policy: interval flush_interval: 5 '
- --list, -l
アップストリーム/ダウンストリーム設定の一覧を表示します。
- --get <id>, -g <id>
指定されたIDのアップストリーム/ダウンストリームの設定を表示します。
例:
$ intdash-agentctl config upstream --get recoverable
- --modify <id> <config_string>, -m <id> <config_string>, --patch <id> <config_string>
指定されたIDのアップストリーム/ダウンストリームの設定を更新します。 <config_string>にはYAML形式の文字列(--json を指定した場合はJSON型式)を与えます。 <config_string>で指定されたフィールドのみが更新され、他のフィールドは変更されません。
例:
$ intdash-agentctl config upstream --modify recoverable 'enabled: false'
- --delete <id>, -d <id>
指定されたストリームを削除します。 引数としてアップストリーム/ダウンストリームのIDを指定します。
注釈
upstreamサブコマンドでは、 REST API の
/upstreams
エンドポイントが使用されます。 設定の詳細については、APIリファレンスの Create Upstream Settings を参照してください。downstreamサブコマンドでは、 REST API の
/downstreams
エンドポイントが使用されます。 設定の詳細については、APIリファレンスの Create Downstream Settings を参照してください。<config_string>
では、APIリファレンスに記載されているリクエストボディのJSONと同等の内容をYAML形式で指定してください(または--json
オプションを使用してJSON形式で指定してください)。
filterサブコマンド
intdash-agentctl config [<config_command_options>] filter upstream <command_option> [<arguments>]
intdash-agentctl config [<config_command_options>] filter downstream <command_option> [<arguments>]
フィルターについて設定します。
設定操作
<command_option> [<arguments>]
で以下のように指定します。
- --create <config_string>, -c <config_string>, --post <config_string>
フィルターの設定を新規作成します。 <config_string>にはYAML形式の文字列(--json を指定した場合はJSON型式)を与えます。 指定しなかった設定値はデフォルトが使用されます。
例
$ intdash-agentctl config filter upstream --create ' id: example enabled: true type: name target: dest_ids: - recoverable name: v1/.+ change_to: dest_id: deferred '
- --list, -l
フィルター設定の一覧を表示します。
- --get <id>, -g <id>
指定されたフィルターを表示します。 引数としてフィルターのIDを指定します。
- --modify <id> <config_string>, -m <id> <config_string>, --patch <id> <config_string>
指定されたIDのフィルター設定を更新します。 <config_string>にはYAML形式の文字列(--json を指定した場合はJSON型式)を与えます。 <config_string>で指定されたフィールドのみが更新され、他のフィールドは変更されません。
例:
$ intdash-agentctl config filter upstream --modify data_sampling 'enabled: false'
- --delete <id>, -d <id>
指定されたフィルター設定を削除します。
注釈
filter upstreamサブコマンドでは、 REST API の
/filters_upstream
エンドポイントが使用されます。 設定の詳細については、APIリファレンスの Create Filter for Upstream を参照してください。filter downstreamサブコマンドでは、 REST API の
/filters_downstream
エンドポイントが使用されます。 設定の詳細については、APIリファレンス Create Filter for Downstream を参照してください。<config_string>
では、APIリファレンスに記載されているリクエストボディのJSONと同等の内容をYAML形式で指定してください(または--json
オプションを使用してJSON形式で指定してください)。
device-connectorコマンド
intdash-agentctl config [<config_command_options>] device-connector upstream <command_option> [<arguments>]
intdash-agentctl config [<config_command_options>] device-connector downstream <command_option> [<arguments>]
デバイスコネクターIPCについて設定します。
設定操作
<command_option> [<arguments>]
で以下のように指定します。
- --create <config_string>, -c <config_string>, --post <config_string>
デバイスコネクターIPC設定を新規作成します。 <config_string>にはYAML形式の文字列(--json を指定した場合はJSON型式)を与えます。 指定しなかった設定値はデフォルトが使用されます。
例
$ intdash-agentctl config device-connector upstream --create ' id: dc1 data_name: group/subgroup dest_ids: - recoverable enabled: true data_name_prefix: v1/1/ format: iscp-v2-compat ipc: path: /var/run/intdash/device_connector.fifo type: fifo launch: args: - --config cmd: device-connector-intdash environment: - KEY=value '
- --list, -l
デバイスコネクターIPC設定の一覧を表示します。
- --get <id>
指定されたデバイスコネクターIPCを表示します。
- --modify <id> <config_string>, -m <id> <config_string>, --patch <id> <config_string>
指定されたIDのデバイスコネクターIPC設定を更新します。 <config_string>にはYAML形式の文字列(--json を指定した場合はJSON型式)を与えます。 <config_string>で指定されたフィールドのみが更新され、他のフィールドは変更されません。
例:
$ intdash-agentctl config device-connector upstream --modify dc1 'enabled: false'
- --delete <id>, -d <id>
指定されたIDのデバイスコネクターIPCを削除します。
注釈
device-connector upstreamサブコマンドでは、 REST API の
/device_connectors_upstream
エンドポイントが使用されます。 設定の詳細については、APIリファレンスの Create Device Connector IPC Settings for Upstream を参照してください。device-connector downstreamサブコマンドでは、 REST API の
/device_connectors_downstream
エンドポイントが使用されます。 設定の詳細については、 APIリファレンス Create Device Connector IPC Settings for Downstream を参照してください。<config_string>
では、APIリファレンスに記載されているリクエストボディのJSONと同等の内容をYAML形式で指定してください(または--json
オプションを使用してJSON形式で指定してください)。
deferred-uploadコマンド
intdash-agentctl config [<config_command_options>] deferred-upload <command_option> [<arguments>]
遅延アップロードについて設定します。
設定操作
<command_option> [<arguments>]
で以下のように指定します。
- --get, -g
遅延アップロードの設定を表示します。
- --modify <config_string>, -m <config_string>, --patch <config_string>
遅延アップロードの設定を更新します。 <config_string>にはYAML形式の文字列(--json を指定した場合はJSON型式)を与えます。 <config_string>で指定されたフィールドのみが更新され、他のフィールドは変更されません。
例:
$ intdash-agentctl config deferred-upload --modify 'priority: higher_than_realtime'
注釈
deferred-uploadサブコマンドでは、 REST API の
/deferred_upload
エンドポイントが使用されます。 設定の詳細については、APIリファレンスの Update Deferred Upload Settings を参照してください。<config_string>
では、APIリファレンスに記載されているリクエストボディのJSONと同等の内容をYAML形式で指定してください(または--json
オプションを使用してJSON形式で指定してください)。