구성 API - 네트워크 범위 추가, 업데이트 및 제거

이 문서는 다음 명령을 사용하여 사이트의 네트워크 범위를 관리하는 카토 API 사용 방법을 설명합니다:

  • addNetworkRange

  • updateNetworkRange

  • removeNetworkRange

네트워크 범위 개요

계정의 소켓 사이트에 대한 네트워크 범위를 추가, 업데이트 및 제거하기 위해 networkRange 변이 API를 사용하고 사이트에 대해 다음 설정을 정의합니다:

  • 네트워크 범위 ID (addNetworkRange에 대해 자동 생성)

  • LAN 소켓 인터페이스 ID

  • 서브넷, 로컬 IP 또는 게이트웨이 IP, VLAN을 포함하는 네트워크 범위 설정

  • Azure vSocket HA 구성의 경우, 부동 IP 주소

  • 네트워크 범위에 대한 DHCP 설정

재판매자 계정인 경우, 각 고객 계정 내에서 카토 API로 설정을 구성하여 별도의 API 키를 생성할 수 있습니다.

계정의 accountId 확인

계정 ID는 관리> 일반 정보 페이지에 표시됩니다.

사이트 생성 API의 accountId 인수에 이 ID를 입력하세요. 예를 들어:

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

addNetworkRange 및 updateNetworkRange 인수에 대한 세부 설명

카토 구성 API를 사용하여 소켓 사이트에 대한 네트워크 범위를 생성하거나 업데이트하는 데 동일한 인수가 사용됩니다. addNetworkRange의 경우, 선택 가능으로 표시되지 않은 한 인수는 필수입니다. updateNetworkRange의 경우, 업데이트하려는 소켓 인터페이스 설정의 인수를 포함하십시오.

  • networkRangeId - 네트워크 범위에 대한 ID (updateNetworkRange)

  • lanSocketInterfaceId - 네트워크 범위가 연결된 네트워크 인터페이스에 대한 ID (addNetworkRange)

  • name - 네트워크 범위의 이름

  • rangeType - 네트워크 범위의 유형 (라우팅, 직접 등)

  • subnet - CIDR 형식의 LAN 인터페이스에 대한 네이티브 범위

  • localIP - LAN 네트워크 범위에 대해 로컬 IP 주소

  • gateway - 라우트된 범위의 경우, 인접 라우터에 대한 다음 홉 IP 주소

  • vlan - 네트워크 범위의 VLAN ID

  • azureFloutingIP - Azure HA 구성의 경우, LAN 라우트 테이블에 대한 다음 홉 IP 주소

  • dhcpSettings - 이 네트워크 범위가 기본 계정 DHCP 설정을 사용하는지 또는 사용자 정의 설정을 사용하는지 정의합니다

networkRangeId (updateNetworkRange)

읽기 전용 API인 entityLookup을 사용하여 networkRangeId를 검색하세요. typesiteRange 값으로 사용하십시오.

검색 매개변수를 사용하여 사이트 이름을 값으로 설정하고 다른 사이트의 범위를 필터링합니다.

lanSocketInterfaceId (addNetworkRange)

entityLookup API 쿼리를 사용하여 lanSocketInterfaceId 인수의 값을 검색합니다. 사용 방법은 다음과 같습니다. 자세한 내용은 Cato API - EntityLookup를 참조하세요.

typenetworkInterface 값으로 사용하고, 이러한 parent 필드에서 값을 가져옵니다:

  • id - <사이트 id>

  • name - <인터페이스의 이름>

아래의 lanSocketInterfaceId에 대한 샘플 스크립트를 참조하십시오, Postman 샘플 스크립트.

networkRange 이름

name 인수는 네트워크 범위의 이름을 위한 것입니다.

networkRange rangeType

rangeType은 네트워크 범위의 유형을 정의하는 열거형 인수입니다.

다음은 옵션입니다:

  • Routed - 소켓을 통해 라우트로 연결되는 네트워크 범위

  • Direct - 라우터를 통하지 않고 소켓이나 방화벽에 직접 연결되는 네트워크 범위이지만, IP 범위는 사이트의 네이티브 범위와 다릅니다.

  • VLAN - Cato와 연결되는 VLAN은 트렁크 포트와 유사합니다

  • Native - 각 LAN 인터페이스에 대해 정의된 IP 범위

  • SecondaryNative - 소켓 HA 구성의 경우, 보조 소켓의 네이티브 범위

networkRange 서브넷

사이트의 네트워크 범위에 대한 IP 범위를 CIDR IPSubnet 형식의 subnet 인수에 정의합니다. /31 및 /32 CIDR 블록은 지원되지 않습니다.

networkRange localIP

(해당 범위: 네이티브, 소켓드 네이티브, 직접 연결, VLAN에 필수) LAN 네트워크 범위에 대한 로컬 IP 주소를 localIP 인수에 정의합니다.

networkRange 게이트웨이

(라우트된 범위에 필수) LAN 네트워크 범위에 대한 게이트웨이 IP 주소를 gateway 인수에 정의합니다.

networkRange vlan

(VLAN 범위에 필수) LAN 네트워크 범위에 대한 VLAN ID를 vlan 인수에 정의합니다.

networkRange azureFloatingIp

(Azure HA 소켓 구성에 필수) LAN 네트워크 범위에 대한 부동 IP를 azureFloatingIp 인수에 정의합니다.

networkRange dhcpSettings (선택 사항)

dhcpSettings은 네트워크 범위에 대한 DHCP 설정을 정의하는 열거형 인수입니다.

다음은 옵션입니다:

  • dhcpType - 네트워크 범위에 대해 다음 DHCP 유형 중 하나를 구성하세요:

    • DHCP_RELAY - 네트워크 범위는 계정에 대해 구성된 DHCP 릴레이를 사용합니다 (relayGroupId 인수에 정의됨)

    • DHCP_RANGE - 네트워크 범위는 ipRange 인수에 정의된 IP 범위에 따라 Cato DHCP 서버를 사용하여 DHCP를 사용합니다

    • ACCOUNT_DEFAULT - 네트워크 범위는 계정에 대해 정의된 기본 DHCP 릴레이를 사용합니다

    • DHCP_DISABLED - 이 네트워크 범위에 대해 DHCP가 비활성화되었습니다.

  • ipRange - 위의 DHCP_Range 옵션에서는 Cato DHCP 서버가 호스트에 할당할 수 있는 IP 범위를 정의합니다

  • relayGroupId - 이 네트워크 범위에서 사용하는 DHCP 릴레이 그룹의 ID를 입력하세요

    entityLookup의 경우, typedhcpRelayGroup으로 지정합니다

removeNetworkRange

사이트에서 네트워크 범위를 삭제하기 위해 removeNetworkRange API를 사용하세요. 이 API에서는 networkRangeId만 사용하면 됩니다.

Postman 샘플 스크립트

lanSocketInterfaceID에 대한 entityLookup 샘플

query entityLookup ($accountID: ID!, $type: EntityType!, $parent: EntityInput!) {
    entityLookup (accountID: $accountID, type: $type, parent: $parent) {
        items {
            entity {
                id
                name
                type
            }
            description
        }
    }
}

lanSocketInterfaceID에 대한 GraphQL 변수

{    
"accountID": "26",    
"type": "networkInterface",    
"parent": {
        "id": 26,
        "type": "site"
    }
}

새로운 VLAN 범위 만들기 위한 Postman 샘플 스크립트

mutation addNetworkRange ($accountId: ID!, $lanSocketInterfaceId: ID!, $input: AddNetworkRangeInput!) {
    site(accountId: $accountId) {
        addNetworkRange (lanSocketInterfaceId: $lanSocketInterfaceId, input: $input) {
            networkRangeId
        }
    }
}

새로운 VLAN 범위에 대한 GraphQL 변수

{
    "accountId": "26",
    "lanSocketInterfaceId": 26,
    "input": {
        "name": "Guest WIFI",
        "rangeType": "VLAN",
        "subnet": "10.1.0.0/24",
        "localIp": "10.1.0.0.1",
        "vlan": 100
    }
}

도움이 되었습니까?

1명 중 0명이 도움이 되었다고 했습니다.

댓글 0개