구성 API - staticHost 추가, 업데이트 및 제거

Cato API를 사용하기 전에 Cato API 지원 정책을 검토할 것을 권장합니다.

이 문서에서는 사이트에 정의된 호스트를 관리하기 위해 Cato API를 사용하는 방법을 설명합니다.

addStaticHost
updateStaticHost
removeStaticHost

staticHost 개요

계정의 사이트에 대해 staticHost 변이 API를 사용하여 호스트를 추가, 업데이트 및 제거하고 다음 설정을 정의합니다.

호스트 이름
호스트의 IP 주소
MAC 주소 (선택 사항 - 호스트에 대한 DHCP IP 할당을 예약하는 데 사용됨)

리셀러 계정의 경우, Cato API로 설정을 구성하는 고객 계정 내에 별도의 API 키를 생성할 수 있습니다.

사이트의 siteID 찾기

Cato 관리 응용 프로그램에 사이트 ID가 표시되지 않을 경우 사이트 ID를 찾을 수 있습니다.

entityLookup API 쿼리( Cato API - EntityLookup 참조)를 사용하여, 유형의 값이 사이트인 것을 사용합니다.

site의 이름값으로 검색 매개변수를 사용하여 쿼리가 사이트 ID를 반환합니다.
Cato 관리 응용 프로그램의 URL이 사이트 선택 시 (네트워크 > 사이트 > {site name}) 예를 들어, 다음 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를 사용하여 검색할 수 있으며, 유형의 값이 호스트인 것을 사용합니다.

StaticHost 이름

name 인수를 사용하여 호스트의 이름을 정의합니다.

StaticHost ip

ip 인수를 사용하여 호스트의 IP 주소를 정의합니다.

StaticHost macAddress (선택 사항)

macAddress 인수를 사용하여 DHCP 예약을 위한 호스트의 MAC 주소를 정의합니다.

Cato를 DHCP 서버로 사용하는 계정의 경우, MAC 주소로 정의된 호스트의 IP 주소는 예약되며 다른 호스트에 할당될 수 없습니다. 호스트의 IP 주소가 사이트에 정의된 네트워크 세그먼트의 DHCP 범위에 포함되지 않도록 합니다.

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

관련 리소스