設定 API - staticHost の追加、更新、削除

Prev Next

Cato APIを使用開始する前に、Cato APIのサポートポリシーをよくお読みください。

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

  • 静的ホストを追加

  • 静的ホストを更新

  • 静的ホストを削除

staticHost の概要

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

  • ホストの名前

  • ホストのIPアドレス

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

リセラーアカウントの場合、顧客アカウントごとに個別にAPIキーを作成して設定できます。

サイトの siteID の特定

Cato管理アプリケーションにはサイトIDが表示されず、以下の方法で特定できます:

  • “entityLookup” API クエリを使用し、サイト の値を持つtype を使用します(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はentityLookupリードオンリーAPIを使用して取得可能で、type として値 host を使用します

StaticHost名

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

StaticHost IP

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

StaticHost MAC アドレス(オプション)

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

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

静的ホストを削除

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
    }
}

関連リソース