設定 API - addSocketSite

Prev Next

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

addSocketSiteの概要

addSocketSiteのmutation APIを使用して、アカウント内に新しいソケットサイトを作成し、サイトの設定を次のように定義します:

  • 名前

  • 説明

  • タイプ

  • 接続タイプ

  • タイムゾーン

  • 国

  • 州

  • 住所

  • ネイティブ範囲

サイトはデフォルトの帯域幅設定で作成され、下り25 Mbps、上り25 Mbpsで、ライセンスは割り当てられていません。

リセラーアカウントでは、Cato APIを使用して設定する顧客アカウントごとに、別々のAPIキーを作成できます。

アカウントのアカウントIDを探す

このアカウントIDはCato管理画面には表示されません。代わりに、Cato管理画面のURL 番号です。 例えば、以下のURLではアカウントIDは26です: https://cc.catonetworks.com/#!/26/topology。

サイト作成APIのaccountId引数にこのIDを入力します。例:

site(accountId: 26) {
    addSocketSite(input: $addSocketSite) { 
        siteId 
    } 
}

addSocketSite引数の詳細

これらは、Cato設定APIを使用して新しいソケットサイトを作成するための引数です。 引数はオプショナルと記載されている場合を除き、必須です:

  • 名前 - サイトの名前

  • 接続タイプ - このサイトの物理ソケットまたはvソケット

  • サイトタイプ - 組織内のサイトタイプ、例としてクラウドデータセンタ

  • 説明 - (オプション) サイトの説明

  • ネイティブネットワーク範囲 - CIDR形式でサイトの背後にあるネイティブLANのIP範囲

  • サイトロケーション - サイトの物理的な位置のデータ

AddSocketSite 名

作成するソケットサイト名を定義します。

AddSocketSite 接続タイプ

接続タイプは、サイトの物理または仮想ソケットのタイプを定義する列挙型引数です。

オプションは以下の通りです:

  • SOCKET_X1500 - 物理サイト用のX1500またはX1500Bソケット

  • SOCKET_X1600 - 物理サイト用のX1600ソケット

  • SOCKET_X1700 - 物理サイト用のX1700またはX1700Bソケット

  • SOCKET_ESX - 仮想VMwareサイトのvソケット

  • SOCKET_AWS - 仮想AWSサイトのvソケット

  • SOCKET_AZURE - 仮想Azureサイトのvソケット

AddSocketSite サイトタイプ

サイトタイプは、Cato管理画面のモニタリング> トポロジ画面で使用されるアイコンを決定するサイトタイプを定義する列挙型引数です。

オプションは以下の通りです:

  • BRANCH - 物理または仮想サイト

  • HEADQUARTERS - 企業本社の物理サイト

  • CLOUD_DC - クラウドベースのデータセンター用の仮想サイト

  • DATACENTER - データセンター用の物理サイト

AddSocketSite 説明 (オプション)

説明はサイトを記述するためのオプションのフリーテキストフィールドです。

AddSocketSite ネイティブネットワーク範囲

サイトのネイティブネットワーク範囲引数でLANネイティブ範囲のIP範囲をIPSubnet形式で定義します。 ネイティブ範囲はサブネットにCIDRを使用し、/32 CIDR ブロックはサポートされていません。

AddSocketSite サイトロケーション

サイトロケーション引数は、サイトの物理的詳細を次のように定義します。 国コードは、アカウント内の特定の地域に利用可能なサイトライセンスの数に関連します。

これらの引数の値を取得するには、エンティティルックアップAPIクエリーを使用します。詳細はCato API - EntityLookupをご覧ください。

これらはサイトロケーション引数です:

  • 国コード - サイトがある国の2文字コード (ISO 3166-1 alpha-2)

    エンティティルックアップの場合、値にtypeを使用します country

  • 州コード - (オプション) 該当国のサイトがある州

    エンティティルックアップの場合、値にtypeを使用します countryState

  • タイムゾーン - ソケットとvソケットのアップグレードのメンテナンスウィンドウの時間枠を設定するためにサイトに使用されるタイムゾーン

    エンティティルックアップの場合、値にtypeを使用します timezone

  • 住所 - (オプション) 物理サイトの所在地

サンプルPostmanスクリプト

mutation addSocketSite ($accountId: ID!, $input: AddSocketSiteInput!) {
    site(accountId: $accountId) {
        addSocketSite (input: $input) {
            siteId
        }
    }
}

GraphQL変数

{
    "accountId": "26",
    "input": {
        "name": "SampleUsSite2",
        "description": "My first API site",
        "siteType": "BRANCH",
        "connectionType": "SOCKET_X1500",
        "nativeNetworkRange": "10.0.0.0/24",
        "siteLocation": {
            "countryCode": "US",
            "timezone": "US/Central",
            "stateCode": "US-AL"
        }
    }
}

関連リソース