Soracom

Users

ドキュメント

IoT SIM が利用する VPG を切り替える

IoT SIM が利用する VPG を切り替えるには、下図のように、SIM グループで利用する VPG を設定して、IoT SIM をその SIM グループに所属させます。

IoT SIM やバーチャル SIM/Subscriber のセッションを再確立するまでは、利用する VPG が切り替わりません

IoT SIM やバーチャル SIM/Subscriber が利用する VPG を切り替えるには、セッション を再確立します。詳しくは、ステップ 3: IoT SIM が利用する VPG を切り替える を参照してください。

ステップ 1: SIM グループで利用する VPG を設定する

SIM グループで利用する VPG を設定します。

VPG 利用の有効 / 無効はグループに対して設定します

ここでは、グループの設定を変更する操作のみを説明します。グループの仕組みやグループを作成する操作について詳しくは、グループ設定 を参照してください。

  1. SIM グループ画面で [SORACOM Air for セルラー設定] をクリックします。

    SIM グループ画面を表示する操作について詳しくは、グループの設定を変更する を参照してください。

  2. [VPG (VIRTUAL PRIVATE GATEWAY)] をクリックして「ON」にして、[VPG] で利用する VPG を選択します。

    • [+ VPG作成] をクリックして、VPG を作成することもできます。
    • [VPG ID を直接入力する] にチェックを入れて、VPG ID を入力することもできます。
    • ソラコムが用意した Public Gate および Private Garden も利用できます。
    • 複数のグループで、同じ VPG を共用できます。
  3. [保存] をクリックします。

VPG 設定画面でグループを指定して、VPG を有効化することもできます。VPG 設定画面で [基本設定][+ グループを追加] の順にクリックし、グループを選択して [追加] をクリックしてください。

VPG 設定画面を表示する操作について詳しくは、VPG の設定を変更する を参照してください。

SORACOM CLI / SORACOM API の場合

SORACOM CLI または SORACOM API を利用しても、VPG を作成できます。

soracom groups put-config (Group:putConfigurationParameters API) を使用します。

$ soracom groups put-config --group-id {group_id} --namespace SoracomAir \
--body '[
  {
    "key": "useVpg",
    "value": true
  },
  {
    "key": "vpgId",
    "value": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
  }
]'

Group:putConfigurationParameters API を使用します。

$ curl -v -X PUT https://api.soracom.io/v1/groups/{group_id}/configuration/SoracomAir \
-H "X-Soracom-API-Key: $X_SORACOM_API_KEY" \
-H "X-Soracom-Token: $X_SORACOM_TOKEN" \
-H "Content-Type: application/json" \
-d '[
  {
    "key": "useVpg",
    "value": true
  },
  {
    "key": "vpgId",
    "value": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx"
  }
]'

ボディで指定するプロパティについて

以下の keyvalue のペアを配列で指定します。

keyvalue の型value
useVpgBoolean

VPG 利用の ON/OFF を設定します。

  • true: ON。VPG を利用します。
  • false: OFF
vpgIdString

VPG の識別子を指定します。指定できる識別子は以下のいずれかです。

  • VPG ID : VirtualPrivateGateway:listVirtualPrivateGateways API で取得できます。
  • PublicGate : Shared VPG for Public Gate - Frankfurt (PublicGate)
  • PublicGate-Tokyo : Shared VPG for Public Gate - Tokyo (PublicGate-Tokyo)
  • PublicGate-Oregon : Shared VPG for Public Gate - Oregon (PublicGate-Oregon)
  • PrivateGarden : Shared VPG for Private Garden (PrivateGarden)

想定していない値を指定した場合の動作は、定義されていません。SORACOM CLI / SORACOM API で設定を変更したあとで、SORACOM ユーザーコンソールで意図通りに設定されていることを確認してください。

ステップ 2: IoT SIM を SIM グループに所属させる

VPG を利用する IoT SIM を、ステップ 1: SIM グループで利用する VPG を設定する で設定を変更した SIM グループに所属させます。詳しくは、IoT SIM、LoRaWAN デバイス、Sigfox デバイスが所属するグループを切り替える を参照してください。

ステップ 3: IoT SIM が利用する VPG を切り替える

IoT SIM が利用する VPG は、SIM グループで設定します。したがって、IoT SIM が利用する VPG が切り替わる可能性があるのは、下図のように、SIM グループ A の設定を変更して利用する VPG を切り替えたとき (①、②) と、IoT SIM が所属する SIM グループを切り替えたとき (③、④) のいずれかです。

条件影響を受ける IoT SIM
① SIM グループ画面で [SORACOM Air for セルラー設定] をクリックし、[VPG (VIRTUAL PRIVATE GATEWAY)] のスイッチの ON / OFF を切り替えた場合設定を変更した SIM グループに所属するすべての IoT SIM
② SIM グループ画面で [SORACOM Air for セルラー設定] をクリックし、[VPG] で異なる VPG を選択した場合設定を変更した SIM グループに所属するすべての IoT SIM
③ IoT SIM が「VPG を利用する SIM グループ」に所属 / 解除した場合設定を変更した IoT SIM のみ
④ IoT SIM が「ほかの VPG を利用する SIM グループ」に所属した場合設定を変更した IoT SIM のみ

ただし、IoT SIM が利用する VPG が決まるのは、IoT SIM の セッション が確立するときです。つまり、すでに IoT SIM のセッションが確立されている状態 (オンラインの状態) のときは、上記の条件を満たしても、すぐには VPG が切り替わりません。IoT SIM が利用する VPG を切り替えるには、以下のいずれかの方法で IoT SIM のセッションを再確立してください。

IoT SIM が所属する VPG は SIM 詳細画面で確認できます

IoT SIM が所属する VPG は、SIM 詳細画面の [セッション詳細][VPG] で確認できます。詳しくは、セッション履歴を確認する を参照してください。

設定を変更した SIM グループに所属するすべての IoT SIM のセッションを再確立するには

上図の ①、② の場合に、設定を変更した SIM グループに所属するすべての IoT SIM のセッションを漏れなく再確立するには、以下のように操作します。

  1. 設定を変更したグループの SIM グループ画面で [所属している SIM] をクリックして、すべての IoT SIM を確認します。

    SIM グループ画面を表示する操作について詳しくは、グループの設定を変更する を参照してください。

  2. 手順 1 で確認したすべての IoT SIM のセッションを再確立します。

    詳しくは、以下のいずれかのページを参照してください。

設定を変更した IoT SIM のセッションを再確立するには

上図の ③、④ の場合は、設定を変更した IoT SIM のセッションを再確立します。詳しくは、IoT SIM のセッションを再確立する を参照してください。

(参考) IoT SIM が利用する VPG を確認するには

ある IoT SIM が利用する VPG を確認するには、SORACOM CLIsoracom subscribers list (SORACOM API の Subscriber:listSubscribers API) を利用します。レスポンスの [].sessionStatus.vpgId を確認してください。