構成API - staticHostの追加、更新、削除

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

この記事では、Cato APIを使用してサイトで定義されたホストを以下のコマンドで管理する方法を説明します。

addStaticHost
updateStaticHost
removeStaticHost

staticHostの概要

staticHost変更APIを使用して、アカウント内のサイトのホストを追加、更新、削除し、ホストの以下の設定を定義します。

ホスト名
ホストのIPアドレス
MACアドレス（オプション - ホストのDHCP IP割り当てを予約するために使用）

再販業者アカウントでは、Cato APIを使用して設定を構成する各顧客アカウント内に別々のAPIキーを作成できます。

サイトのSiteIDを探す

サイトIDはCato管理アプリケーションに表示されないため、以下の手順でサイトIDを検索します。

エンティティ照会APIを使用して（Cato API - EntityLookupを参照）、タイプにサイトの値を使用します。

また、searchパラメータを使用して、サイト名を値として指定し、クエリはサイトIDを返します。
サイトを選択した場合、Cato管理アプリケーションのURLの数字（ネットワーク > サイト > {サイト名}）。例えば、次のURLでは、サイトIDは12345です： https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

addStaticHostとupdateStaticHostの引数の詳細

Cato構成APIを使用して、サイトの裏のホストを作成または更新するために、同じ引数が使用されます。 addStaticHostの場合、引数はオプションでマークされている場合を除き必須です。 updateStaticHostの場合、更新するホスト設定の引数を含めます。

hostId - updateStaticHostの場合、更新するホストのIDを入力します

addStaticHostの場合、新しいホストが作成されたときにこのIDが生成されます
name - サイトの裏にあるホスト名
ip - サイトの裏にあるホストのIPアドレス
macAddress - (オプション) サイトの裏にあるホストのMACアドレス

ホストのMACアドレスは、固定IPアドレスを持つホストのDHCP予約に使用されます。

StaticHost hostId

hostIdはホストエンティティの内部Cato IDです。

networkRangeIdは、読み取り専用のエンティティ照会を使用して取得でき、タイプにホストの値を使用します。

StaticHost name

name引数を使用してホストの名前を定義します。

StaticHost ip

ip引数を使用してホストのIPアドレスを定義します。

StaticHost macAddress (任意)

macAddress引数を使用して、DHCP予約のためのホストのMACアドレスを定義します。

CatoをDHCPサーバーとして使用するアカウントの場合、MACアドレスで定義されたホストのIPアドレスは予約され、別のホストに割り当てることができません。サイトで定義されたネットワークセグメントのDHCP範囲内にホストのIPアドレスが含まれていないことを確認してください。

removeStaticHost

removeStaticHost APIを使用して、サイトに定義されたホストを削除します。このAPIではhostIdのみを使用する必要があります。

サンプルPostmanスクリプト

mutation addStaticHost ($accountId: ID!, $siteId: ID!, $input:AddStaticHostInput!) {
    site(accountId: $accountId) {
      addStaticHost(
        siteId: $siteId, 
        input: $input
      ) {
      hostId
    }
  }
}

GraphQL変数

{
    "accountId": "26",
    "siteId": 126,
    "input": {
        "primaryManagementIp": "192.168.4.2",
        "secondaryManagementIp": "192.168.4.3",
        "vrid": 100
    }
}

関連リソース