Press CTRL+K to open search

設定API - updateSocketInterface

  • 更新日 Jul 30, 2026
  • 公開日 Jun 24, 2026
  • 1 分で読めます
Prev Next

Cato APIを使用する前に、Cato APIのサポートポリシーを確認することを強くお勧めします。

updateSocketInterfaceの概要

Cato管理アプリケーション (ネットワーク > サイト > {site name} > サイト設定 > ソケット) のソケットセクションで、次のソケットインタフェースの設定を更新する際に、updateSocketInterfaceミューテーションAPIを使用してください。

  • インタフェースの宛先

  • 名前

  • LANインタフェースの設定

  • サイト帯域幅

  • WANインタフェースの設定

  • オフクラウド (Cato宛先用）

  • 代替WANインタフェース設定

  • LAG (リンク集約) メンバー

  • VRRPタイプ

サイトのためのsiteIDを見つける

Cato管理アプリケーションにはsite IDが表示されません。site IDの場所は次のとおりです：

  • エンティティの検索APIクエリを使用して (Cato API - EntityLookup) を参照)、siteという値のtypeを使用してください。

    また、サイトの名前を値としてsearchパラメータを使用することで、クエリがサイトIDを返します。

  • （ネットワーク > サイト > {site name}）でサイトを選択したときのCato管理アプリケーションのURLの番号。 例：次のURLのサイトIDは12345です： https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

ソケットのためのsocketInterfaceId値の理解

socketInterfaceIdは、Catoソケットに対する値を含む列挙型です。 インタフェース名は、(Network > Sites > {site name} > Site Configuration > Socket)として表示されます:

  • X1500 Socket - 自動設定, LAN1, LAN2, WAN1, WAN2, WAN3, USB1, USB2

  • X1600 ソケット - 1-8、USB1、USB2

  • X1700 ソケット - INT_1 - INT_12

updateSocketInterfaceInput引数の詳細

これらは、Cato構成APIを使用して、サイトのソケットインタフェース設定を更新するための引数です。 destType引数のみが必須であり、他の引数は、更新するソケットインタフェース設定に含める必要があります。

  • destType - インタフェースの宛先

  • name - サイトの名前

  • lan - LANインタフェースの設定

  • bandwidth - サイトの上りと下りの帯域幅

  • wan - WANインタフェース設定

  • offCloud - Cato宛先のインタフェース用のオフクラウドの設定

  • altWAN - 代替WANまたは代替WAN (レイヤー-2)の宛先を持つインタフェースの設定

  • lag - 宛先LAN LAGマスター用のリンク集約 (LAG) の最小リンク数 (マスターとメンバーを含む) としての設定

  • vrrp - ソケット高可用性 (HA) 構成のための、ソケット間のVRRP接続のタイプ

updateSocketInterfaceInput destType

destTypeは、インタフェースの宛先を定義する列挙型引数です。

これらがオプションです：

  • CATO - Catoクラウド用のWANトラフィック

  • LAN - ソケットの内部LAN

  • VRRP_AND_LAN - ソケットHAのためのインタフェースは、LANとVRRPトラフィックに使用されます

  • INTERFACE_DISABLED - インタフェースは無効で、トラフィックを通過させません

  • ALTERNATIVE - Catoクラウドを介さないWANトラフィック (例: MPLS)

  • LAYER_2_WAN - 代替WAN (レイヤー-2)オプションは、MPLSネットワークで、同じサブネット上のソケットサイトに対して設定されます

  • VRRP - ソケットHAのためのインタフェースは、VRRPトラフィック専用です

  • LAN_LAG_MASTER_AND_VRRP - ソケットHAとLAN LAGの構成のため、インタフェースはLAN LAGマスターであり、VRRPトラフィックに使用されます

  • LAN_LAG_MASTER - LAN LAG構成のため、インタフェースはLAN LAGマスターです

  • LAN_LAG_MEMBER - LAN LAG構成のため、インタフェースはLAN LAGメンバーです

  • LAN_AND_HA - AzureおよびAWSでのvSocket HAのため、インタフェースはLANとHAトラフィック用です

updateSocketInterfaceInput name

name引数は、ソケットインタフェースの名前を指定するためのものです。

updateSocketInterfaceInput lan

lan引数は、ソケット用のLANインタフェース設定に使用されます。

これらがオプションです：

  • subnet - CIDR形式でのLANインタフェースのネイティブ範囲

  • localIP - LANネットワーク範囲のローカルIPアドレス

updateSocketInterfaceInput bandwidth

WANトラフィックに使用されるインタフェースについては、帯域幅引数がインタフェースの上りと下りの帯域幅を定義します。

これらがオプションです：

  • upstreamBandwidth - このインタフェースの最大上り帯域幅

  • downstreamBandwidth - このインタフェースの最大下り帯域幅

updateSocketInterfaceInput wan

wan引数は、ソケット用のWANインタフェースの設定に使用されます。 WANロールは一般的に、ネットワークルールでトラフィックを定義するために使用されます。 優先度は、アクティブおよびパッシブインタフェースを持つソケットのフェイルオーバー優先度に使用されます。

これらがオプションです：

  • role - WANインタフェースの役割を定義：なし、自動、wan_1、wan_2、wan_3

  • precedence - インタフェースのフェイルオーバー優先度を定義：ACTIVE、PASSIVE、LAST_RESORT

    LAST_RESORTは最低の優先度のインタフェースです

updateSocketInterfaceInput offCloud

offCloud引数は、オフクラウド機能を使用してトラフィックをCatoクラウドの代わりに公共インターネット上でルーティングするソケットサイト用です。

これらがオプションです：

  • enabled - Boolean値、trueの場合、オフクラウドトラフィックはサイトに対して有効になります

  • publicIP (オプション) - インターネット接続を開始するための静的な公共IPアドレスを定義

  • publicStaticPort (オプション) - オフクラウドトラフィック用の静的ポート番号を定義

updateSocketInterfaceInput altWan

代替WAN引数は、MPLSのような代替WANネットワークに接続するソケットサイト用です。 通常、プライベートIPとインタフェースは、MPLSプロバイダーへの直接接続に使用されます。

これらがオプションです：

  • privateInterfaceIp - トラフィックのためのソケットインタフェースのプライベートIPアドレス

  • privateNetwork - LAN用のプライベートIP範囲 (CIDR付き)

  • privateGatewayIp - 代替WANゲートウェイ (例：MPLSファイアウォール又はルーター) のためのプライベートIPアドレス

  • privateVlanTag (オプション) - インタフェースのVLANタグ (プライベートIPアドレス付き)

  • publicInterfaceIP (オプション) - トラフィック用のソケットインタフェースのための公共IPアドレス

  • publicNetwork (オプション) - LAN用の公共IP範囲 (CIDR付き)

  • publicGatewayIp (オプション) - 代替WANゲートウェイ (例：MPLSファイアウォール又はルーター) のための公共IPアドレス

  • publicVlantag (オプション) - インタフェースのVLANタグ (公開IPアドレス付き)

updateSocketInterfaceInput lag

lag引数は、マスターLAN LAGインタフェースと、このソケットサイトのLAGに対する最小インタフェース数(マスターとメンバーを含む)を定義します。

これは選択肢です：

  • minLinks - LAG内の最小インタフェース(リンク)数

updateSocketInterfaceInput vrrp

vrrp列挙型引数はソケットHA構成用で、ソケット間のVRRP接続のタイプをキープアライブメッセージのために定義します。

これらがオプションです：

  • VIA_SWITCH - VRRP接続がスイッチ経由でソケット間をルーティングされます

  • DIRECT_LINK - VRRP接続がソケット間を直接ルーティングされます

サンプルPostmanスクリプト

サンプルスクリプト - ネイティブ範囲と名前の更新

これは、構成APIを使用して、LAN1インタフェースの名前をLAN-01に変更し、サブネットとネイティブ範囲のlocalIPを更新する例です。

mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
    site(accountId: $accountId) {
        updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
            siteId
            socketInterfaceId
        }
    }
}

GraphQL変数

{
    "accountId": "26",
    "siteId": 26,
    "socketInterfaceId": "LAN1",
    "input": {
        "name": "LAN-01",
        "destType": "LAN",
        "lan": {
            "subnet": "10.0.0.0/24",
            "localIp": "10.0.0.1"
        }
    }
}

サンプルスクリプト - 帯域幅と名前の変更

これは、構成APIを使用してWANインタフェースの帯域幅と名前を変更する例です。

mutation updateSocketInterface ($accountId: ID!, $siteId: ID!, $socketInterfaceId: SocketInterfaceIDEnum!, $input: UpdateSocketInterfaceInput!) {
    site(accountId: $accountId) {
        updateSocketInterface (siteId: $siteId, socketInterfaceId: $socketInterfaceId, input: $input) {
            siteId
            socketInterfaceId
        }
    }
}

GraphQL変数

{
    "accountId": "26",
    "siteId": 126,
    "socketInterfaceId": "WAN1",
    "input": {
        "name": "WAN Demo",
        "destType": "CATO",
        "bandwidth": {
            "upstreamBandwidth": 100,
            "downstreamBandwidth": 100
        }
    }
}

関連記事