Configurationの主な項目#

Terminal System 2 v1.0.0

MenderにConfigureアドオンが導入されている場合は、Configurationタブで設定の確認と変更が可能です。 Configurationタブで設定できる主な項目を挙げます(アルファベット順)。

注釈

Configutarionの編集方法については、 Configurationの編集 を参照してください。

agent.connection#

intdashサーバーとの接続に関する設定と、使用するプロジェクトについての設定です。

例:

{
  "server_url": "https://xxxxx.intdash.jp",
  "project_uuid": "00000000-0000-0000-0000-000000000000",
  "edge_uuid": "fa12ae1b-......",
  "client_secret": "cK6Yd....."
}

注釈

設定可能な項目は、REST API の /agent/connection エンドポイントと同じです。 設定の詳細については、APIリファレンスの Update Connection Settings を参照してください。

設定の手順については、 接続先intdashサーバーと認証の設定 または 使用するプロジェクトの設定 を参照してください。

agent.deferred_upload#

遅延アップロードに関する設定

例:

{
  "priority": "higher_than_realtime",
  "limit_data_storage": true,
  "data_storage_capacity": 102400
}

注釈

設定可能な項目は、REST API の /agent/deferred_upload エンドポイントと同じです。 設定の詳細については、APIリファレンスの Update Deferred Upload Settings を参照してください。

設定の手順については、 遅延アップロードの優先度とディスク容量 を参照してください。

agent.device_connectors_downstream#

ダウンストリームデバイスコネクターIPC設定の配列

例:

[
  {
    "id": "dc1",
    "enabled": true,
    "format": "iscp-v2-compat",
    "ipc": {
      "type": "fifo",
      "path": "/var/run/intdash/down-dc1.fifo"
    },
    "launch": {
      "cmd": "device-connector-intdash",
      "args": [
        "--config"
      ],
      "environment": [
        "KEY=value"
      ]
    }
  }
]

注釈

設定値は配列です。配列内のオブジェクトで設定可能な項目は、REST API の /agent/device_connectors_downstream エンドポイントと同じです。 設定の詳細については、 APIリファレンス Create Device Connector IPC Settings for Downstream を参照してください。

設定の手順については、 データ受信の設定(ダウンストリーム) を参照してください。

agent.device_connectors_upstream#

アップストリームデバイスコネクターIPC設定の配列

例:

[
  {
    "id": "dc1",
    "data_name_prefix": "group/subgroup/",
    "dest_ids": [
      "default-upstream"
    ],
    "enabled": true,
    "format": "iscp-v2-compat",
    "ipc": {
      "type": "fifo",
      "path": "/var/run/intdash/up-dc1.fifo"
    },
    "launch": {
      "cmd": "device-connector-intdash",
      "args": [
        "--config"
      ],
      "environment": [
        "KEY=value"
      ]
    }
  }
]

注釈

設定値は配列です。配列内のオブジェクトで設定可能な項目は、REST API の /agent/device_connectors_upstream エンドポイントと同じです。 設定の詳細については、APIリファレンスの Create Device Connector IPC Settings for Upstream を参照してください。

設定の手順については、 データ送信の設定(アップストリーム) を参照してください。

agent.downstreams#

ダウンストリームの設定を表すオブジェクトの配列

例:

[
  {
    "id": "down",
    "enabled": true,
    "dest_ids": [
      "dc1"
    ],
    "qos": "partial",
    "filters": [
      {
        "src_edge_uuid": "568ff243-d200-43c4-9942-473c08ccfac1",
        "data_filters": [
          {
            "type": "bytes",
            "name": "abc/efg"
          }
        ]
      }
    ]
  }
]

注釈

設定値は配列です。配列内のオブジェクトで設定可能な項目は、REST API の /agent/downstreams エンドポイントと同じです。 設定の詳細については、APIリファレンスの Create Downstream Settings を参照してください。

設定の手順については、 データ受信の設定(ダウンストリーム) を参照してください。

agent.filters_downstream#

ダウンストリーム用のフィルター設定の配列

例:

[
  {
    "id": "data_name",
    "enabled": true,
    "type": "name",
    "target": {
      "dest_ids": [
        "dc1"
      ],
      "name": "v1/.+"
    },
    "change_to": {
      "dest_id": "dc2"
    }
  }
]

注釈

設定値は配列です。配列内のオブジェクトで設定可能な項目は、REST API の /agent/filters_downstream エンドポイントと同じです。 設定の詳細については、APIリファレンス Create Filter for Downstream を参照してください。

agent.filters_upstream#

アップストリーム用のフィルター設定の配列

例:

[
  {
    "id": "data_sampling",
    "enabled": true,
    "type": "sampling",
    "target": {
      "dest_ids": [
        "default-upstream"
      ],
      "name": "v1/1/abc",
      "type": "",
      "src_id": "",
      "interval_ms": 300
    },
    "change_to": {
      "dest_id": "deferred"
    }
  }
]

注釈

設定可能な項目は、REST API の /agent/filters_upstream エンドポイントと同じです。 設定の詳細については、APIリファレンスの Create Filter for Upstream を参照してください。

agent.transport#

トランスポートの設定

例:

{
  "protocol": "websocket"
}

注釈

設定可能な項目は、REST API の /agent/transport エンドポイントと同じです。 設定の詳細については、APIリファレンスの Update Transport Settings を参照してください。

設定の手順については、 トランスポートの設定 を参照してください。

agent.upstreams#

アップストリームの設定を表すオブジェクトの配列

例:

[
  {
    "id": "default-upstream",
    "enabled": true,
    "recover": true,
    "persist": true,
    "qos": "partial",
    "flush_policy": "interval",
    "flush_interval": 5
  }
]

注釈

設定値は配列です。配列内のオブジェクトで設定可能な項目は、REST API の /agent/upstreams エンドポイントと同じです。 設定の詳細については、APIリファレンスの Create Upstream Settings を参照してください。

設定の手順については、 データ送信の設定(アップストリーム) を参照してください。

device_connectors#

デバイスコネクター設定の配列

[
  {
    "id": "can1",
    "service_id": "H.264 NAL Unit for EDGEPLANT USB Camera",
    "upstream_ipc_ids": [
      "usb0"
    ],
    "downstream_ipc_ids": [
      "can1"
    ],
    "service_substitutions": [
      "KEY=value"
    ]
  }
]

注釈

設定値は配列です。配列内のオブジェクトで設定可能な項目は、REST API の /device_connectors エンドポイントと同じです。 設定の詳細については、APIリファレンスの Create Device Connector を参照してください。

設定の手順については、 データ送信の設定(アップストリーム) または データ受信の設定(ダウンストリーム) を参照してください。

docker.composes#

Docker Composeに関する設定を更新します。

[
  {
    "id": "measurement",
    "boot_after": "",
    "protected": true,
    "docker_compose_yml": "/etc/core/docker-compose/measurement/docker-compose.yml",
    "working_directory": "/var/lib/core/docker-compose/measurement"
  }
]

注釈

設定値は配列です。配列内のオブジェクトで設定可能な項目は、REST API の /docker.composes エンドポイントと同じです。 設定の詳細については、APIリファレンスの Update Docker Compose を参照してください。

設定の手順については、 電源に連動したデータ送受信 を参照してください。

ip_allowlist#

IP許可リストを設定します。

{
  "allowlist": [
    "192.168.1.0/24",
    "192.168.10.0/24"
  ]
}

注釈

設定可能な項目は、REST API の /ip_allowlist エンドポイントと同じです。 設定の詳細については、APIリファレンスの Replace IP Allowlist を参照してください。

設定の手順については、 IP許可リストの設定 を参照してください。

monitors#

モニター設定(アラート通知の設定)の配列

例:

[
  {
    "id": "log_usb-disconnected",
    "subsystem": "log",
    "enabled": true,
    "variables": [
      "key=value"
    ]
  }
]

特定のモニター設定の有効/無効を変更する場合の例:

[
  {
    "id": "log_usb-disconnected",
    "enabled": true
  }
  // ...
]

注釈

設定値は配列です。配列内のオブジェクトで設定可能な項目は、REST API の /monitors エンドポイントと同じです。 設定の詳細については、APIリファレンスの Create Monitor を参照してください。

network_connections#

ネットワーク設定の項目は以下のとおりです。

[
  {
    "uuid": "77397428-dfa1-3427-a283-92face322b04",
    "device_name": "cdc-wdm0",
    "display_name": "Wireless connection 1",
    "enabled": true,
    "priority": 0,
    "metric": -1,
    "protected": false,
    "ipv4_settings": {
      "manual": false,
      "address": "",
      "subnet_mask": "",
      "default_gateway": "",
      "dns_servers": []
    },
    "connection_type": "gsm",
    "ethernet_settings": {
      "mtu": 0
    },
    "gsm_settings": {
      "mtu": 0,
      "apn": "xxxxx",
      "username": "",
      "password": "",
      "band_preset": ""
    },
    "wireless_settings": {
      "mtu": 0,
      "ssid": "xxxxx",
      "psk": "xxxxxxxx"
    }
  }
]

注釈

設定値は配列です。配列内のオブジェクトで設定可能な項目は、REST API の /network_connections エンドポイントと同じです。 設定の詳細については、APIリファレンスの Create Network Connection を参照してください。

設定の手順については、 ネットワーク設定を作成/変更する を参照してください。

terminal_system.identification#

例:

{
  "computer_name": "terminal-system",
  "serial_number": "TSBH000000000"
}

注釈

設定可能な項目は、REST API の /terminal_system/identification エンドポイントと同じです。 設定の詳細については、APIリファレンスの Update Terminal System Identification を参照してください。

設定の手順については、 コンピューター名の変更 を参照してください。