WiredNetworkAPI

All URIs are relative to https://use1-omada-northbound.tplinkcloud.com

Method	HTTP request	Description
BatchIsolateLanNetwork1	Post /openapi/v2/{omadacId}/sites/{siteId}/lan-networks/batch-isolate	Batch isolate network
CheckNetworkParamWhenCreate	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/param-check	Check basic parameters when creating network
CheckNetworkParamWhenModify	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/param-check	Check basic parameters when modifying the network
CheckParamAndGetPreConfig	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/check	Check all parameters and generate configuration when creating network
CheckParamAndGetPreConfigWhenModify	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/check	Check all parameters and generate configuration when modifying the network
CheckPortBindingParamWhenCreate	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/ports-check	Check selected ports when creating network
CheckPortBindingParamWhenModify	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/ports-check	Check port binding when modifying network
CheckVirtualWanUsed1	Get /openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans/delete-check	Check Virtual Wan Used
CheckWanLanStatus1	Get /openapi/v1/{omadacId}/sites/{siteId}/wan-lan-status	Check WAN-LAN status
ConfirmCreateVlanNetwork	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/confirm	Confirm create lan network
ConfirmModifyVlanNetwork	Put /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/confirm	Confirm modify lan network
CreateLanDns	Post /openapi/v1/{omadacId}/sites/{siteId}/setting/lan/dns	Create a LAN DNS rule
CreateLanNetwork	Post /openapi/v1/{omadacId}/sites/{siteId}/lan-networks	Create LAN network
CreateLanNetworkV2	Post /openapi/v2/{omadacId}/sites/{siteId}/lan-networks	Create LAN network
CreateLanProfile	Post /openapi/v1/{omadacId}/sites/{siteId}/lan-profiles	Create new LAN profile
CreateOswLanProfile	Post /openapi/v2/{omadacId}/sites/{siteId}/lan-profiles	Create new switch profile
CreateVirtualWan	Post /openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans	Create virtual WAN
CreateVlans1	Post /openapi/v1/{omadacId}/sites/{siteId}/lan-vlans	Batch create vlans
DeleteLanDns	Delete /openapi/v1/{omadacId}/sites/{siteId}/setting/lan/dns/{dnsId}	Delete an existing LAN DNS rule
DeleteLanNetwork	Delete /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/{networkId}	Delete LAN network
DeleteLanProfile	Delete /openapi/v1/{omadacId}/sites/{siteId}/lan-profiles/{profileId}	Delete an existing LAN profile
DeleteOswLanProfile	Delete /openapi/v2/{omadacId}/sites/{siteId}/lan-profiles/{profileId}	Delete an existing switch profile
DeleteVirtualWan1	Delete /openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans/{virtualWanId}	Delete virtual WAN
GetAllInterfacesForBatchIsolate1	Get /openapi/v2/{omadacId}/sites/{siteId}/lan-networks/isolate/interfaces	Get interface List
GetAllLanNetworks	Get /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/all	Get all networks for the omada id and site id
GetAllValidVlansInSiteForSwitchOuiBasedVlan1	Get /openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/valid-vlans	Get valid vlanList for switch oui based vlan
GetAutoEffectDevicesWhenCreate	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/auto-effect-devices	Get auto effect devices when creating network
GetAutoEffectDevicesWhenModify	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/auto-effect-devices	Get auto effect devices when modifying network
GetAutoSelectDevicesWhenModify	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/auto-select-devices	Get auto select devices when modifying network
GetAvailableVirtualWan	Get /openapi/v1/{omadacId}/sites/{siteId}/setting/available-virtual-wans	Query available virtual WAN list
GetAvailableWanPorts1	Get /openapi/v1/{omadacId}/sites/{siteId}/setting/wan-ports	Get available wan ports
GetBandScanResult	Get /openapi/v1/{omadacId}/sites/{siteId}/internet/band-scan/{portUuid}	Get band scan result.
GetDeliveringProcess	Get /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/process	Get network delivering process and config
GetDeliveringProcessWithoutConfig	Get /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/brief-process	Get network delivering process
GetDevicePortSupportVlansInfo	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/device-support-ports	Get device port info on whether support any of current vlans
GetDhcpServerDevCapForNetwork	Get /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/dhcp-server/capabilities	Get the capabilities of the DHCP server under the network
GetDhcpServerInfoForNetwork	Get /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/dhcp-server-info	Get the address pool of the DHCP server under the network and the number of available IPs
GetGridAllClients1	Get /openapi/v1/{omadacId}/sites/{siteId}/networks/client	Get client list
GetGridLanDns	Get /openapi/v1/{omadacId}/sites/{siteId}/setting/lan/dns	Get LAN DNS list
GetGridSupportVlanNetworkDevicesBySite	Get /openapi/v1/{omadacId}/sites/{siteId}/networks/devices	Get devices list that can be dhcp server
GetGridVirtualWan	Get /openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans	Query virtual WAN list
GetGridVlanNetworkAffectedDevicePorts	Get /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/vlan/{vlan}/ports	Get the ports of devices that use the network
GetGridVlans	Get /openapi/v1/{omadacId}/sites/{siteId}/networks/vlans	Get the networks whose purpose is vlan
GetInterfaceLanNetwork	Get /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/interface	Get all \"single\"/\"multi\" interface lan network
GetInterfaceLanNetworkV2	Get /openapi/v2/{omadacId}/sites/{siteId}/lan-networks/interface	Get all \"single\"/\"multi\" interface lan network V2
GetInternet	Get /openapi/v1/{omadacId}/sites/{siteId}/internet	Get internet info
GetInternetBasicPortInfo1	Get /openapi/v1/{omadacId}/sites/{siteId}/internet/basic-info	Get internet basic info
GetInternetLoadBalance1	Get /openapi/v1/{omadacId}/sites/{siteId}/internet/load-balance	Get internet load balance config
GetIpptInternet	Get /openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/internet	Get internet info by mac
GetIspScanResult	Get /openapi/v1/{omadacId}/sites/{siteId}/internet/isp-scan/{portUuid}	Get Isp scan result
GetLanNetwork	Get /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/{networkId}	Get LAN network
GetLanNetworkList	Get /openapi/v1/{omadacId}/sites/{siteId}/lan-networks	Get LAN network list
GetLanNetworkListV2	Get /openapi/v2/{omadacId}/sites/{siteId}/lan-networks	Get LAN network list
GetLanNetworkListV3	Get /openapi/v3/{omadacId}/sites/{siteId}/lan-networks	Get LAN network list V3
GetLanProfileList	Get /openapi/v1/{omadacId}/sites/{siteId}/lan-profiles	Get LAN profile list
GetLoadBalanceWeightStatus	Get /openapi/v1/{omadacId}/sites/{siteId}/internet/load-balance/status	Check Wan Loadbalance status
GetLocationAndIspInfo	Get /openapi/v1/{omadacId}/sites/{siteId}/internet/location-isp	Get location and ISP info
GetLteWanPortsConfig	Get /openapi/v1/{omadacId}/sites/{siteId}/internet/lte/ports-config	Get internet lte wan ports config
GetNetworksWithServersForReservation	Get /openapi/v1/{omadacId}/sites/{siteId}/networks/server-for-reservation	Get all networks that can reserve IP addresses and their corresponding servers
GetOswForGivenLanNetworkIds	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/switches	Get LAN network list
GetOswLanProfileList	Get /openapi/v2/{omadacId}/sites/{siteId}/lan-profiles	Get switch profile list
GetOswPortLanNetInfo	Get /openapi/v1/{omadacId}/sites/{siteId}/lan-switch-setting	Get switch port profile info
GetSelectDevicePortsInfo	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/devices/ports	Get the port information of the selected devices when creating network
GetSelectDevicePortsInfoWhenModify	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/devices/ports	Get the port information of the selected devices when modifying the network
GetSelectStackPortsInfo	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/stack/ports	Get the port information of the selected stacks when creating network
GetSelectStackPortsInfoWhenModify	Post /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/stack/ports	Get the port information of the selected stacks when modifying the network
GetSimCardBandScanResult	Get /openapi/v1/{omadacId}/sites/{siteId}/wan/networks/band-scan/{portUuid}/{simCard}	Obtain the bandScan result of the corresponding SIM card
GetSimCardIspScanResult	Get /openapi/v1/{omadacId}/sites/{siteId}/wan/networks/isp-scan/{portUuid}/{simCard}	Obtain the ispScan result of the corresponding SIM card
GetSpeedTestV2Setting	Get /openapi/v1/{omadacId}/sites/{siteId}/setting/speedTest	Get SpeedTest Setting
GetSupportInfo	Get /openapi/v1/{omadacId}/sites/{siteId}/internet/models	Get supported gateway model list for pre-configuration
GetUseLanProfileES	Get /openapi/v1/{omadacId}/sites/{siteId}/lan-profiles/{profileId}/es	Query Agile Series switches that used the profile
GetUseNativeNetworkOsw	Post /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/es	Query switches that used the Native Network's profile
GetUseNativeNetworkOswV2	Post /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/es-native	Query switches that used the Native Network's profile V2
GetVlanNetworkAffectedDevice1	Get /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/vlan/{vlan}/devices	Get devices list that use the network
GetVlanNetworkAffectedSsid1	Get /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/vlan/{vlan}/ssids	Get grid ssid list that use the vlan
GetVlanNetworkDevicePortSupportVlanInfo	Get /openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/vlan/{vlan}/device-support-ports	Get device port info on whether support current vlan
GetWanPortsConfig	Get /openapi/v1/{omadacId}/sites/{siteId}/internet/ports-config	Get internet ports config
GetWanPortsMaxSpeed1	Get /openapi/v1/{omadacId}/sites/{siteId}/wan-max-speed	Get wan ports max speed
ModifyGatewayModel	Post /openapi/v1/{omadacId}/sites/{siteId}/internet/change-model	Modify gateway mode for pre-configuration
ModifyInternetBasicPortInfo1	Put /openapi/v1/{omadacId}/sites/{siteId}/internet/basic-info	Modify the internet basic configuration
ModifyInternetLoadBalance1	Put /openapi/v1/{omadacId}/sites/{siteId}/internet/load-balance	Modify internet load balance config
ModifyIpptLteWanPortConfig	Put /openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/internet/lte/ports-config	Modify internet lte port config for ippt
ModifyIpptWanMode	Patch /openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/internet/wan-mode	Modify internet wan mode
ModifyLanDns	Patch /openapi/v1/{omadacId}/sites/{siteId}/setting/lan/dns/{dnsId}	Modify an existing LAN DNS rule
ModifyLanNetwork	Patch /openapi/v1/{omadacId}/sites/{siteId}/lan-networks/{networkId}	Modify LAN network
ModifyLanNetworkV2	Patch /openapi/v2/{omadacId}/sites/{siteId}/lan-networks/{networkId}	Modify LAN network
ModifyLanProfile	Patch /openapi/v1/{omadacId}/sites/{siteId}/lan-profiles/{profileId}	Modify a LAN profile
ModifyLteWanPortConfig	Put /openapi/v1/{omadacId}/sites/{siteId}/internet/lte/ports-config	Modify internet lte port config
ModifyOswLanProfile	Patch /openapi/v2/{omadacId}/sites/{siteId}/lan-profiles/{profileId}	Modify a switch profile
ModifySpeedTestV2Setting	Post /openapi/v1/{omadacId}/sites/{siteId}/setting/speedTest	Modify SpeedTest Setting
ModifyVirtualWan	Patch /openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans/{virtualWanId}	Modify virtual WAN
ModifyVirtualWanStatus	Patch /openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans/{virtualWanId}/status	Modify virtual WAN status
ModifyWanPortSettings	Patch /openapi/v1/{omadacId}/sites/{siteId}/wan/networks/port-setting	Modify Wan Port Settings
ModifyWanPorts	Patch /openapi/v1/{omadacId}/sites/{siteId}/setting/wan-ports	Modify Wan Ports
ModifyWanPortsConfig	Put /openapi/v1/{omadacId}/sites/{siteId}/internet/ports-config	Modify internet ports config
NetworkMapping	Patch /openapi/v1/{omadacId}/sites/{siteId}/network-mapping	Network mapping
ObtainWanUnsupportedFunction	Get /openapi/v1/{omadacId}/sites/{siteId}/wan/networks/unsupportedFunction	Get linkage functions that are not supported by WAN
SpeedTest	Post /openapi/v1/{omadacId}/sites/{siteId}/cmd/speedTest	SpeedTest
StartBandScan	Post /openapi/v1/{omadacId}/sites/{siteId}/wan/networks/band-scan	Start Band scan
StartIspScan	Post /openapi/v1/{omadacId}/sites/{siteId}/wan/networks/isp-scan	Start Isp scan

BatchIsolateLanNetwork1

OperationResponseWithoutResult BatchIsolateLanNetwork1(ctx, omadacId, siteId).BatchIsolateInterfaceOpenApiVO(batchIsolateInterfaceOpenApiVO).Execute()

Batch isolate network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    batchIsolateInterfaceOpenApiVO := *openapiclient.NewBatchIsolateInterfaceOpenApiVO() // BatchIsolateInterfaceOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.BatchIsolateLanNetwork1(context.Background(), omadacId, siteId).BatchIsolateInterfaceOpenApiVO(batchIsolateInterfaceOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.BatchIsolateLanNetwork1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `BatchIsolateLanNetwork1`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.BatchIsolateLanNetwork1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiBatchIsolateLanNetwork1Request struct via the builder pattern

Name	Type	Description	Notes

batchIsolateInterfaceOpenApiVO | BatchIsolateInterfaceOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CheckNetworkParamWhenCreate

OperationResponseLanNetworkQueryOpenApiV3VO CheckNetworkParamWhenCreate(ctx, omadacId, siteId).LanNetworkOpenApiV3VO(lanNetworkOpenApiV3VO).Execute()

Check basic parameters when creating network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    lanNetworkOpenApiV3VO := *openapiclient.NewLanNetworkOpenApiV3VO(int32(123), false, "Name_example") // LanNetworkOpenApiV3VO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CheckNetworkParamWhenCreate(context.Background(), omadacId, siteId).LanNetworkOpenApiV3VO(lanNetworkOpenApiV3VO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CheckNetworkParamWhenCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CheckNetworkParamWhenCreate`: OperationResponseLanNetworkQueryOpenApiV3VO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CheckNetworkParamWhenCreate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiCheckNetworkParamWhenCreateRequest struct via the builder pattern

Name	Type	Description	Notes

lanNetworkOpenApiV3VO | LanNetworkOpenApiV3VO | |

Return type

OperationResponseLanNetworkQueryOpenApiV3VO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CheckNetworkParamWhenModify

OperationResponseLanNetworkQueryOpenApiV3VO CheckNetworkParamWhenModify(ctx, omadacId, siteId, networkId).LanNetworkOpenApiV3VO(lanNetworkOpenApiV3VO).Execute()

Check basic parameters when modifying the network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    lanNetworkOpenApiV3VO := *openapiclient.NewLanNetworkOpenApiV3VO(int32(123), false, "Name_example") // LanNetworkOpenApiV3VO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CheckNetworkParamWhenModify(context.Background(), omadacId, siteId, networkId).LanNetworkOpenApiV3VO(lanNetworkOpenApiV3VO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CheckNetworkParamWhenModify``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CheckNetworkParamWhenModify`: OperationResponseLanNetworkQueryOpenApiV3VO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CheckNetworkParamWhenModify`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiCheckNetworkParamWhenModifyRequest struct via the builder pattern

Name	Type	Description	Notes

lanNetworkOpenApiV3VO | LanNetworkOpenApiV3VO | |

Return type

OperationResponseLanNetworkQueryOpenApiV3VO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CheckParamAndGetPreConfig

OperationResponseVlanPreConfigOpenApiVO CheckParamAndGetPreConfig(ctx, omadacId, siteId).CreateVlanParamOpenApiVO(createVlanParamOpenApiVO).Execute()

Check all parameters and generate configuration when creating network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    createVlanParamOpenApiVO := *openapiclient.NewCreateVlanParamOpenApiVO(*openapiclient.NewSelectPortBindingBriefVO(), *openapiclient.NewLanNetworkOpenApiV3VO(int32(123), false, "Name_example")) // CreateVlanParamOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CheckParamAndGetPreConfig(context.Background(), omadacId, siteId).CreateVlanParamOpenApiVO(createVlanParamOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CheckParamAndGetPreConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CheckParamAndGetPreConfig`: OperationResponseVlanPreConfigOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CheckParamAndGetPreConfig`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiCheckParamAndGetPreConfigRequest struct via the builder pattern

Name	Type	Description	Notes

createVlanParamOpenApiVO | CreateVlanParamOpenApiVO | |

Return type

OperationResponseVlanPreConfigOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CheckParamAndGetPreConfigWhenModify

OperationResponseVlanPreConfigOpenApiVO CheckParamAndGetPreConfigWhenModify(ctx, omadacId, siteId, networkId).ModifyVlanParamOpenApiVO(modifyVlanParamOpenApiVO).Execute()

Check all parameters and generate configuration when modifying the network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    modifyVlanParamOpenApiVO := *openapiclient.NewModifyVlanParamOpenApiVO(*openapiclient.NewSelectPortBindingBriefVO(), *openapiclient.NewLanNetworkOpenApiV3VO(int32(123), false, "Name_example")) // ModifyVlanParamOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CheckParamAndGetPreConfigWhenModify(context.Background(), omadacId, siteId, networkId).ModifyVlanParamOpenApiVO(modifyVlanParamOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CheckParamAndGetPreConfigWhenModify``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CheckParamAndGetPreConfigWhenModify`: OperationResponseVlanPreConfigOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CheckParamAndGetPreConfigWhenModify`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiCheckParamAndGetPreConfigWhenModifyRequest struct via the builder pattern

Name	Type	Description	Notes

modifyVlanParamOpenApiVO | ModifyVlanParamOpenApiVO | |

Return type

OperationResponseVlanPreConfigOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CheckPortBindingParamWhenCreate

OperationResponseListCheckFailedDeviceInfoForVlanVO CheckPortBindingParamWhenCreate(ctx, omadacId, siteId).SelectPortBindingVO(selectPortBindingVO).Execute()

Check selected ports when creating network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    selectPortBindingVO := *openapiclient.NewSelectPortBindingVO(int32(123), int32(123)) // SelectPortBindingVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CheckPortBindingParamWhenCreate(context.Background(), omadacId, siteId).SelectPortBindingVO(selectPortBindingVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CheckPortBindingParamWhenCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CheckPortBindingParamWhenCreate`: OperationResponseListCheckFailedDeviceInfoForVlanVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CheckPortBindingParamWhenCreate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiCheckPortBindingParamWhenCreateRequest struct via the builder pattern

Name	Type	Description	Notes

selectPortBindingVO | SelectPortBindingVO | |

Return type

OperationResponseListCheckFailedDeviceInfoForVlanVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CheckPortBindingParamWhenModify

OperationResponseListCheckFailedDeviceInfoForVlanVO CheckPortBindingParamWhenModify(ctx, omadacId, siteId, networkId).SelectPortBindingVO(selectPortBindingVO).Execute()

Check port binding when modifying network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    selectPortBindingVO := *openapiclient.NewSelectPortBindingVO(int32(123), int32(123)) // SelectPortBindingVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CheckPortBindingParamWhenModify(context.Background(), omadacId, siteId, networkId).SelectPortBindingVO(selectPortBindingVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CheckPortBindingParamWhenModify``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CheckPortBindingParamWhenModify`: OperationResponseListCheckFailedDeviceInfoForVlanVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CheckPortBindingParamWhenModify`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiCheckPortBindingParamWhenModifyRequest struct via the builder pattern

Name	Type	Description	Notes

selectPortBindingVO | SelectPortBindingVO | |

Return type

OperationResponseListCheckFailedDeviceInfoForVlanVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CheckVirtualWanUsed1

OperationResponseVirtualWanIdUsedOpenApiVO CheckVirtualWanUsed1(ctx, omadacId, siteId).VirtualWanId(virtualWanId).Execute()

Check Virtual Wan Used

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    virtualWanId := "virtualWanId_example" // string | Virtual WAN ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CheckVirtualWanUsed1(context.Background(), omadacId, siteId).VirtualWanId(virtualWanId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CheckVirtualWanUsed1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CheckVirtualWanUsed1`: OperationResponseVirtualWanIdUsedOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CheckVirtualWanUsed1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiCheckVirtualWanUsed1Request struct via the builder pattern

Name	Type	Description	Notes

virtualWanId | string | Virtual WAN ID |

Return type

OperationResponseVirtualWanIdUsedOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CheckWanLanStatus1

OperationResponseCheckWanLanStatusOpenApiVO CheckWanLanStatus1(ctx, omadacId, siteId).Execute()

Check WAN-LAN status

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CheckWanLanStatus1(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CheckWanLanStatus1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CheckWanLanStatus1`: OperationResponseCheckWanLanStatusOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CheckWanLanStatus1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiCheckWanLanStatus1Request struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseCheckWanLanStatusOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ConfirmCreateVlanNetwork

OperationResponseVlanNetworkIdListVO ConfirmCreateVlanNetwork(ctx, omadacId, siteId).CreateVlanParamOpenApiVO(createVlanParamOpenApiVO).Execute()

Confirm create lan network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    createVlanParamOpenApiVO := *openapiclient.NewCreateVlanParamOpenApiVO(*openapiclient.NewSelectPortBindingBriefVO(), *openapiclient.NewLanNetworkOpenApiV3VO(int32(123), false, "Name_example")) // CreateVlanParamOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ConfirmCreateVlanNetwork(context.Background(), omadacId, siteId).CreateVlanParamOpenApiVO(createVlanParamOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ConfirmCreateVlanNetwork``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ConfirmCreateVlanNetwork`: OperationResponseVlanNetworkIdListVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ConfirmCreateVlanNetwork`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiConfirmCreateVlanNetworkRequest struct via the builder pattern

Name	Type	Description	Notes

createVlanParamOpenApiVO | CreateVlanParamOpenApiVO | |

Return type

OperationResponseVlanNetworkIdListVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ConfirmModifyVlanNetwork

OperationResponseVlanNetworkIdListVO ConfirmModifyVlanNetwork(ctx, omadacId, siteId, networkId).ModifyVlanParamOpenApiVO(modifyVlanParamOpenApiVO).Execute()

Confirm modify lan network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    modifyVlanParamOpenApiVO := *openapiclient.NewModifyVlanParamOpenApiVO(*openapiclient.NewSelectPortBindingBriefVO(), *openapiclient.NewLanNetworkOpenApiV3VO(int32(123), false, "Name_example")) // ModifyVlanParamOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ConfirmModifyVlanNetwork(context.Background(), omadacId, siteId, networkId).ModifyVlanParamOpenApiVO(modifyVlanParamOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ConfirmModifyVlanNetwork``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ConfirmModifyVlanNetwork`: OperationResponseVlanNetworkIdListVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ConfirmModifyVlanNetwork`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiConfirmModifyVlanNetworkRequest struct via the builder pattern

Name	Type	Description	Notes

modifyVlanParamOpenApiVO | ModifyVlanParamOpenApiVO | |

Return type

OperationResponseVlanNetworkIdListVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateLanDns

OperationResponseWithoutResult CreateLanDns(ctx, omadacId, siteId).LanDnsOpenApiVO(lanDnsOpenApiVO).Execute()

Create a LAN DNS rule

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    lanDnsOpenApiVO := *openapiclient.NewLanDnsOpenApiVO("Domain_example", false, "Name_example", int32(123)) // LanDnsOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CreateLanDns(context.Background(), omadacId, siteId).LanDnsOpenApiVO(lanDnsOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CreateLanDns``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateLanDns`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CreateLanDns`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateLanDnsRequest struct via the builder pattern

Name	Type	Description	Notes

lanDnsOpenApiVO | LanDnsOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateLanNetwork

ResponseIdVO CreateLanNetwork(ctx, omadacId, siteId).LanNetworkOpenApiVO(lanNetworkOpenApiVO).Execute()

Create LAN network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    lanNetworkOpenApiVO := *openapiclient.NewLanNetworkOpenApiVO(false, "Name_example", int32(123)) // LanNetworkOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CreateLanNetwork(context.Background(), omadacId, siteId).LanNetworkOpenApiVO(lanNetworkOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CreateLanNetwork``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateLanNetwork`: ResponseIdVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CreateLanNetwork`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateLanNetworkRequest struct via the builder pattern

Name	Type	Description	Notes

lanNetworkOpenApiVO | LanNetworkOpenApiVO | |

Return type

ResponseIdVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateLanNetworkV2

OperationResponseResponseIdVO CreateLanNetworkV2(ctx, omadacId, siteId).LanNetworkOpenApiV2VO(lanNetworkOpenApiV2VO).Execute()

Create LAN network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    lanNetworkOpenApiV2VO := *openapiclient.NewLanNetworkOpenApiV2VO(false, "Name_example", int32(123)) // LanNetworkOpenApiV2VO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CreateLanNetworkV2(context.Background(), omadacId, siteId).LanNetworkOpenApiV2VO(lanNetworkOpenApiV2VO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CreateLanNetworkV2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateLanNetworkV2`: OperationResponseResponseIdVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CreateLanNetworkV2`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateLanNetworkV2Request struct via the builder pattern

Name	Type	Description	Notes

lanNetworkOpenApiV2VO | LanNetworkOpenApiV2VO | |

Return type

OperationResponseResponseIdVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateLanProfile

ResponseIdVO CreateLanProfile(ctx, omadacId, siteId).LanProfileConfigOpenApiVO(lanProfileConfigOpenApiVO).Execute()

Create new LAN profile

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    lanProfileConfigOpenApiVO := *openapiclient.NewLanProfileConfigOpenApiVO(int32(123), int32(123), false, false, "Name_example", "NativeNetworkId_example", int32(123), false, false) // LanProfileConfigOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CreateLanProfile(context.Background(), omadacId, siteId).LanProfileConfigOpenApiVO(lanProfileConfigOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CreateLanProfile``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateLanProfile`: ResponseIdVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CreateLanProfile`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateLanProfileRequest struct via the builder pattern

Name	Type	Description	Notes

lanProfileConfigOpenApiVO | LanProfileConfigOpenApiVO | |

Return type

ResponseIdVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateOswLanProfile

ResponseIdVO CreateOswLanProfile(ctx, omadacId, siteId).LanProfileSettingOpenApiVO(lanProfileSettingOpenApiVO).Execute()

Create new switch profile

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    lanProfileSettingOpenApiVO := *openapiclient.NewLanProfileSettingOpenApiVO(int32(123), int32(123), false, false, "Name_example", int32(123), false, false) // LanProfileSettingOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CreateOswLanProfile(context.Background(), omadacId, siteId).LanProfileSettingOpenApiVO(lanProfileSettingOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CreateOswLanProfile``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateOswLanProfile`: ResponseIdVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CreateOswLanProfile`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateOswLanProfileRequest struct via the builder pattern

Name	Type	Description	Notes

lanProfileSettingOpenApiVO | LanProfileSettingOpenApiVO | |

Return type

ResponseIdVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateVirtualWan

OperationResponseWithoutResult CreateVirtualWan(ctx, omadacId, siteId).VirtualWanConfigOpenApiVO(virtualWanConfigOpenApiVO).Execute()

Create virtual WAN

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    virtualWanConfigOpenApiVO := *openapiclient.NewVirtualWanConfigOpenApiVO("Name_example", "PhysicalWanId_example", *openapiclient.NewVirtualWanIpv4SettingConfigOpenApiVO("Proto_example", int32(123))) // VirtualWanConfigOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CreateVirtualWan(context.Background(), omadacId, siteId).VirtualWanConfigOpenApiVO(virtualWanConfigOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CreateVirtualWan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateVirtualWan`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CreateVirtualWan`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateVirtualWanRequest struct via the builder pattern

Name	Type	Description	Notes

virtualWanConfigOpenApiVO | VirtualWanConfigOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateVlans1

OperationResponseWithoutResult CreateVlans1(ctx, omadacId, siteId).CreateVLANs(createVLANs).Execute()

Batch create vlans

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    createVLANs := *openapiclient.NewCreateVLANs(false, "Name_example", "Vlans_example") // CreateVLANs | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.CreateVlans1(context.Background(), omadacId, siteId).CreateVLANs(createVLANs).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.CreateVlans1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateVlans1`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.CreateVlans1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateVlans1Request struct via the builder pattern

Name	Type	Description	Notes

createVLANs | CreateVLANs | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteLanDns

OperationResponseWithoutResult DeleteLanDns(ctx, omadacId, siteId, dnsId).Execute()

Delete an existing LAN DNS rule

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    dnsId := "dnsId_example" // string | LAN DNS ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.DeleteLanDns(context.Background(), omadacId, siteId, dnsId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.DeleteLanDns``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteLanDns`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.DeleteLanDns`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
dnsId	string	LAN DNS ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteLanDnsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteLanNetwork

OperationResponseWithoutResult DeleteLanNetwork(ctx, omadacId, siteId, networkId).Execute()

Delete LAN network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.DeleteLanNetwork(context.Background(), omadacId, siteId, networkId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.DeleteLanNetwork``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteLanNetwork`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.DeleteLanNetwork`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteLanNetworkRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteLanProfile

OperationResponseWithoutResult DeleteLanProfile(ctx, omadacId, siteId, profileId).Execute()

Delete an existing LAN profile

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    profileId := "profileId_example" // string | LAN profile ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.DeleteLanProfile(context.Background(), omadacId, siteId, profileId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.DeleteLanProfile``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteLanProfile`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.DeleteLanProfile`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
profileId	string	LAN profile ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteLanProfileRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteOswLanProfile

OperationResponseWithoutResult DeleteOswLanProfile(ctx, omadacId, siteId, profileId).Execute()

Delete an existing switch profile

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    profileId := "profileId_example" // string | Switch profile ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.DeleteOswLanProfile(context.Background(), omadacId, siteId, profileId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.DeleteOswLanProfile``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteOswLanProfile`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.DeleteOswLanProfile`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
profileId	string	Switch profile ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteOswLanProfileRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteVirtualWan1

OperationResponseWithoutResult DeleteVirtualWan1(ctx, omadacId, siteId, virtualWanId).Execute()

Delete virtual WAN

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    virtualWanId := "virtualWanId_example" // string | Virtual WAN ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.DeleteVirtualWan1(context.Background(), omadacId, siteId, virtualWanId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.DeleteVirtualWan1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteVirtualWan1`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.DeleteVirtualWan1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
virtualWanId	string	Virtual WAN ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteVirtualWan1Request struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllInterfacesForBatchIsolate1

OperationResponseListInterfaceForBatchIsolateOpenApiVO GetAllInterfacesForBatchIsolate1(ctx, omadacId, siteId).SearchKey(searchKey).IsolationFilter(isolationFilter).Execute()

Get interface List

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    searchKey := "searchKey_example" // string | Fuzzy query parameters, support field  (optional)
    isolationFilter := int32(56) // int32 | non-isolation set 0; isolation set 1; don't filter isolation vlan set 2. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetAllInterfacesForBatchIsolate1(context.Background(), omadacId, siteId).SearchKey(searchKey).IsolationFilter(isolationFilter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetAllInterfacesForBatchIsolate1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAllInterfacesForBatchIsolate1`: OperationResponseListInterfaceForBatchIsolateOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetAllInterfacesForBatchIsolate1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetAllInterfacesForBatchIsolate1Request struct via the builder pattern

Name	Type	Description	Notes

searchKey | string | Fuzzy query parameters, support field | isolationFilter | int32 | non-isolation set 0; isolation set 1; don't filter isolation vlan set 2. |

Return type

OperationResponseListInterfaceForBatchIsolateOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllLanNetworks

OperationResponseListLanNetworkVO GetAllLanNetworks(ctx, omadacId, siteId).Execute()

Get all networks for the omada id and site id

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetAllLanNetworks(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetAllLanNetworks``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAllLanNetworks`: OperationResponseListLanNetworkVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetAllLanNetworks`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetAllLanNetworksRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseListLanNetworkVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllValidVlansInSiteForSwitchOuiBasedVlan1

GridVOLanNetworkVlansOpenApiVO GetAllValidVlansInSiteForSwitchOuiBasedVlan1(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()

Get valid vlanList for switch oui based vlan

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetAllValidVlansInSiteForSwitchOuiBasedVlan1(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetAllValidVlansInSiteForSwitchOuiBasedVlan1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAllValidVlansInSiteForSwitchOuiBasedVlan1`: GridVOLanNetworkVlansOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetAllValidVlansInSiteForSwitchOuiBasedVlan1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetAllValidVlansInSiteForSwitchOuiBasedVlan1Request struct via the builder pattern

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

Return type

GridVOLanNetworkVlansOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAutoEffectDevicesWhenCreate

OperationResponseAutoEffectDevicesForVlanVO GetAutoEffectDevicesWhenCreate(ctx, omadacId, siteId).LanNetworkOpenApiV3VO(lanNetworkOpenApiV3VO).Execute()

Get auto effect devices when creating network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    lanNetworkOpenApiV3VO := *openapiclient.NewLanNetworkOpenApiV3VO(int32(123), false, "Name_example") // LanNetworkOpenApiV3VO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetAutoEffectDevicesWhenCreate(context.Background(), omadacId, siteId).LanNetworkOpenApiV3VO(lanNetworkOpenApiV3VO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetAutoEffectDevicesWhenCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAutoEffectDevicesWhenCreate`: OperationResponseAutoEffectDevicesForVlanVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetAutoEffectDevicesWhenCreate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetAutoEffectDevicesWhenCreateRequest struct via the builder pattern

Name	Type	Description	Notes

lanNetworkOpenApiV3VO | LanNetworkOpenApiV3VO | |

Return type

OperationResponseAutoEffectDevicesForVlanVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAutoEffectDevicesWhenModify

OperationResponseAutoEffectDevicesForVlanVO GetAutoEffectDevicesWhenModify(ctx, omadacId, siteId, networkId).LanNetworkOpenApiV3VO(lanNetworkOpenApiV3VO).Execute()

Get auto effect devices when modifying network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    lanNetworkOpenApiV3VO := *openapiclient.NewLanNetworkOpenApiV3VO(int32(123), false, "Name_example") // LanNetworkOpenApiV3VO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetAutoEffectDevicesWhenModify(context.Background(), omadacId, siteId, networkId).LanNetworkOpenApiV3VO(lanNetworkOpenApiV3VO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetAutoEffectDevicesWhenModify``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAutoEffectDevicesWhenModify`: OperationResponseAutoEffectDevicesForVlanVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetAutoEffectDevicesWhenModify`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiGetAutoEffectDevicesWhenModifyRequest struct via the builder pattern

Name	Type	Description	Notes

lanNetworkOpenApiV3VO | LanNetworkOpenApiV3VO | |

Return type

OperationResponseAutoEffectDevicesForVlanVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAutoSelectDevicesWhenModify

OperationResponseAutoSelectDevicesForVlanVO GetAutoSelectDevicesWhenModify(ctx, omadacId, siteId, networkId).LanNetworkOpenApiV3VO(lanNetworkOpenApiV3VO).Execute()

Get auto select devices when modifying network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    lanNetworkOpenApiV3VO := *openapiclient.NewLanNetworkOpenApiV3VO(int32(123), false, "Name_example") // LanNetworkOpenApiV3VO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetAutoSelectDevicesWhenModify(context.Background(), omadacId, siteId, networkId).LanNetworkOpenApiV3VO(lanNetworkOpenApiV3VO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetAutoSelectDevicesWhenModify``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAutoSelectDevicesWhenModify`: OperationResponseAutoSelectDevicesForVlanVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetAutoSelectDevicesWhenModify`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiGetAutoSelectDevicesWhenModifyRequest struct via the builder pattern

Name	Type	Description	Notes

lanNetworkOpenApiV3VO | LanNetworkOpenApiV3VO | |

Return type

OperationResponseAutoSelectDevicesForVlanVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAvailableVirtualWan

OperationResponseVirtualWanAvailablesOpenApiVO GetAvailableVirtualWan(ctx, omadacId, siteId).Execute()

Query available virtual WAN list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetAvailableVirtualWan(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetAvailableVirtualWan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAvailableVirtualWan`: OperationResponseVirtualWanAvailablesOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetAvailableVirtualWan`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetAvailableVirtualWanRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseVirtualWanAvailablesOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAvailableWanPorts1

OperationResponseAvailableWanResultOpenApiVO GetAvailableWanPorts1(ctx, omadacId, siteId).Function(function).Execute()

Get available wan ports

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    function := int32(56) // int32 | function used for wan ports query. 0: ACL, 1: QOS, 2: IP_MAC_BLINDING, 3: IGMP_PROXY, 4: VIRTUAL_WAN, 5: PORT_FROWARDING, 6: OTONAT, 7: BANDWIDTH_CONTROL, 8: STATIC_ROUTING, 9: POLICY_ROUTING, 10: VPN, 11: SSL_VPN, 12: DDNS, 13: UPNP, 14: MLD, 15: LAN

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetAvailableWanPorts1(context.Background(), omadacId, siteId).Function(function).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetAvailableWanPorts1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAvailableWanPorts1`: OperationResponseAvailableWanResultOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetAvailableWanPorts1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetAvailableWanPorts1Request struct via the builder pattern

Name	Type	Description	Notes

function | int32 | function used for wan ports query. 0: ACL, 1: QOS, 2: IP_MAC_BLINDING, 3: IGMP_PROXY, 4: VIRTUAL_WAN, 5: PORT_FROWARDING, 6: OTONAT, 7: BANDWIDTH_CONTROL, 8: STATIC_ROUTING, 9: POLICY_ROUTING, 10: VPN, 11: SSL_VPN, 12: DDNS, 13: UPNP, 14: MLD, 15: LAN |

Return type

OperationResponseAvailableWanResultOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBandScanResult

OperationResponseBandScanResultOpenApiVO GetBandScanResult(ctx, omadacId, siteId, portUuid).Execute()

Get band scan result.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    portUuid := "portUuid_example" // string | Port uuid to get band scan result

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetBandScanResult(context.Background(), omadacId, siteId, portUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetBandScanResult``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetBandScanResult`: OperationResponseBandScanResultOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetBandScanResult`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
portUuid	string	Port uuid to get band scan result

Other Parameters

Other parameters are passed through a pointer to a apiGetBandScanResultRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseBandScanResultOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDeliveringProcess

OperationResponseVlanNetworkDeliverDataVO GetDeliveringProcess(ctx, omadacId, siteId, networkId).Execute()

Get network delivering process and config

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetDeliveringProcess(context.Background(), omadacId, siteId, networkId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetDeliveringProcess``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDeliveringProcess`: OperationResponseVlanNetworkDeliverDataVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetDeliveringProcess`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiGetDeliveringProcessRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseVlanNetworkDeliverDataVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDeliveringProcessWithoutConfig

OperationResponseVlanNetworkDeliverBriefDataVO GetDeliveringProcessWithoutConfig(ctx, omadacId, siteId, networkId).Execute()

Get network delivering process

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetDeliveringProcessWithoutConfig(context.Background(), omadacId, siteId, networkId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetDeliveringProcessWithoutConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDeliveringProcessWithoutConfig`: OperationResponseVlanNetworkDeliverBriefDataVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetDeliveringProcessWithoutConfig`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiGetDeliveringProcessWithoutConfigRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseVlanNetworkDeliverBriefDataVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDevicePortSupportVlansInfo

OperationResponseVlanNetworkDeviceSupportInfoVO GetDevicePortSupportVlansInfo(ctx, omadacId, siteId).VlanNetworkVlansVO(vlanNetworkVlansVO).Execute()

Get device port info on whether support any of current vlans

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    vlanNetworkVlansVO := *openapiclient.NewVlanNetworkVlansVO() // VlanNetworkVlansVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetDevicePortSupportVlansInfo(context.Background(), omadacId, siteId).VlanNetworkVlansVO(vlanNetworkVlansVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetDevicePortSupportVlansInfo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDevicePortSupportVlansInfo`: OperationResponseVlanNetworkDeviceSupportInfoVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetDevicePortSupportVlansInfo`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetDevicePortSupportVlansInfoRequest struct via the builder pattern

Name	Type	Description	Notes

vlanNetworkVlansVO | VlanNetworkVlansVO | |

Return type

OperationResponseVlanNetworkDeviceSupportInfoVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDhcpServerDevCapForNetwork

OperationResponseDhcpServerDevCapForVlanVO GetDhcpServerDevCapForNetwork(ctx, omadacId, siteId, networkId).Execute()

Get the capabilities of the DHCP server under the network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetDhcpServerDevCapForNetwork(context.Background(), omadacId, siteId, networkId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetDhcpServerDevCapForNetwork``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDhcpServerDevCapForNetwork`: OperationResponseDhcpServerDevCapForVlanVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetDhcpServerDevCapForNetwork`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiGetDhcpServerDevCapForNetworkRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseDhcpServerDevCapForVlanVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDhcpServerInfoForNetwork

OperationResponseDhcpServerForVlanVO GetDhcpServerInfoForNetwork(ctx, omadacId, siteId, networkId).Execute()

Get the address pool of the DHCP server under the network and the number of available IPs

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetDhcpServerInfoForNetwork(context.Background(), omadacId, siteId, networkId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetDhcpServerInfoForNetwork``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDhcpServerInfoForNetwork`: OperationResponseDhcpServerForVlanVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetDhcpServerInfoForNetwork`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiGetDhcpServerInfoForNetworkRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseDhcpServerForVlanVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGridAllClients1

OperationResponseGridVONetworkClientAllOpenApiVO GetGridAllClients1(ctx, omadacId, siteId).Page(page).PageSize(pageSize).SearchKey(searchKey).Execute()

Get client list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    searchKey := "searchKey_example" // string | Fuzzy query parameters, support field  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetGridAllClients1(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).SearchKey(searchKey).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetGridAllClients1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGridAllClients1`: OperationResponseGridVONetworkClientAllOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetGridAllClients1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetGridAllClients1Request struct via the builder pattern

Name	Type	Description	Notes

page | int32 | Start page number. Start from 1. | pageSize | int32 | Number of entries per page. It should be within the range of 1–1000. | searchKey | string | Fuzzy query parameters, support field |

Return type

OperationResponseGridVONetworkClientAllOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGridLanDns

OperationResponseLanDnsGridVOLanDnsQueryOpenApiVO GetGridLanDns(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()

Get LAN DNS list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetGridLanDns(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetGridLanDns``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGridLanDns`: OperationResponseLanDnsGridVOLanDnsQueryOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetGridLanDns`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetGridLanDnsRequest struct via the builder pattern

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

Return type

OperationResponseLanDnsGridVOLanDnsQueryOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGridSupportVlanNetworkDevicesBySite

OperationResponseGridVODeviceVO GetGridSupportVlanNetworkDevicesBySite(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()

Get devices list that can be dhcp server

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetGridSupportVlanNetworkDevicesBySite(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetGridSupportVlanNetworkDevicesBySite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGridSupportVlanNetworkDevicesBySite`: OperationResponseGridVODeviceVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetGridSupportVlanNetworkDevicesBySite`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetGridSupportVlanNetworkDevicesBySiteRequest struct via the builder pattern

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

Return type

OperationResponseGridVODeviceVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGridVirtualWan

OperationResponseVirtualWanGridOpenApiVOVirtualWanInfoOpenApiVO GetGridVirtualWan(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()

Query virtual WAN list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetGridVirtualWan(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetGridVirtualWan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGridVirtualWan`: OperationResponseVirtualWanGridOpenApiVOVirtualWanInfoOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetGridVirtualWan`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetGridVirtualWanRequest struct via the builder pattern

Name	Type	Description	Notes

page | int32 | Start page number. Start from 1. | pageSize | int32 | Number of entries per page. It should be within the range of 1–1000. |

Return type

OperationResponseVirtualWanGridOpenApiVOVirtualWanInfoOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGridVlanNetworkAffectedDevicePorts

OperationResponseVlanForPortDisplayGridVOVlanNetworkAffectingDeviceDetailVO GetGridVlanNetworkAffectedDevicePorts(ctx, omadacId, siteId, networkId, vlan).Page(page).PageSize(pageSize).Execute()

Get the ports of devices that use the network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    vlan := "vlan_example" // string | Vlan ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetGridVlanNetworkAffectedDevicePorts(context.Background(), omadacId, siteId, networkId, vlan).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetGridVlanNetworkAffectedDevicePorts``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGridVlanNetworkAffectedDevicePorts`: OperationResponseVlanForPortDisplayGridVOVlanNetworkAffectingDeviceDetailVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetGridVlanNetworkAffectedDevicePorts`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID
vlan	string	Vlan ID

Other Parameters

Other parameters are passed through a pointer to a apiGetGridVlanNetworkAffectedDevicePortsRequest struct via the builder pattern

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

Return type

OperationResponseVlanForPortDisplayGridVOVlanNetworkAffectingDeviceDetailVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGridVlans

OperationResponseGridVOVlanLanNetworkForBtachDeleteVO GetGridVlans(ctx, omadacId, siteId).Page(page).PageSize(pageSize).SearchKey(searchKey).Execute()

Get the networks whose purpose is vlan

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    searchKey := "searchKey_example" // string | Fuzzy query parameters, support field name (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetGridVlans(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).SearchKey(searchKey).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetGridVlans``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGridVlans`: OperationResponseGridVOVlanLanNetworkForBtachDeleteVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetGridVlans`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetGridVlansRequest struct via the builder pattern

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

searchKey | string | Fuzzy query parameters, support field name |

Return type

OperationResponseGridVOVlanLanNetworkForBtachDeleteVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetInterfaceLanNetwork

OperationResponseResponseDataVOLanNetworkQueryOpenApiVO GetInterfaceLanNetwork(ctx, omadacId, siteId).Type_(type_).Execute()

Get all \"single\"/\"multi\" interface lan network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    type_ := int32(56) // int32 | Interface vlan type. When \"type\" is 0, return \"single\" interface lan network, else return \"single\"/\"multi\" interface lan network (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetInterfaceLanNetwork(context.Background(), omadacId, siteId).Type_(type_).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetInterfaceLanNetwork``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetInterfaceLanNetwork`: OperationResponseResponseDataVOLanNetworkQueryOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetInterfaceLanNetwork`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetInterfaceLanNetworkRequest struct via the builder pattern

Name	Type	Description	Notes

type_ | int32 | Interface vlan type. When \"type\" is 0, return \"single\" interface lan network, else return \"single\"/\"multi\" interface lan network |

Return type

OperationResponseResponseDataVOLanNetworkQueryOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetInterfaceLanNetworkV2

OperationResponseResponseDataVOLanNetworkQueryOpenApiV2VO GetInterfaceLanNetworkV2(ctx, omadacId, siteId).Type_(type_).Execute()

Get all \"single\"/\"multi\" interface lan network V2

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    type_ := int32(56) // int32 | Interface vlan type. When \"type\" is 0, return \"single\" interface lan network, else return \"single\"/\"multi\" interface lan network (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetInterfaceLanNetworkV2(context.Background(), omadacId, siteId).Type_(type_).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetInterfaceLanNetworkV2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetInterfaceLanNetworkV2`: OperationResponseResponseDataVOLanNetworkQueryOpenApiV2VO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetInterfaceLanNetworkV2`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetInterfaceLanNetworkV2Request struct via the builder pattern

Name	Type	Description	Notes

type_ | int32 | Interface vlan type. When \"type\" is 0, return \"single\" interface lan network, else return \"single\"/\"multi\" interface lan network |

Return type

OperationResponseResponseDataVOLanNetworkQueryOpenApiV2VO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetInternet

OperationResponseInternetOpenApiVO GetInternet(ctx, omadacId, siteId).Execute()

Get internet info

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetInternet(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetInternet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetInternet`: OperationResponseInternetOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetInternet`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetInternetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseInternetOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetInternetBasicPortInfo1

OperationResponseInternetBaseInfoOpenApiVO GetInternetBasicPortInfo1(ctx, omadacId, siteId).Execute()

Get internet basic info

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetInternetBasicPortInfo1(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetInternetBasicPortInfo1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetInternetBasicPortInfo1`: OperationResponseInternetBaseInfoOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetInternetBasicPortInfo1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetInternetBasicPortInfo1Request struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseInternetBaseInfoOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetInternetLoadBalance1

OperationResponseWanLoadBalanceOpenApiVO GetInternetLoadBalance1(ctx, omadacId, siteId).Execute()

Get internet load balance config

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetInternetLoadBalance1(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetInternetLoadBalance1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetInternetLoadBalance1`: OperationResponseWanLoadBalanceOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetInternetLoadBalance1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetInternetLoadBalance1Request struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseWanLoadBalanceOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIpptInternet

OperationResponseInternetOpenApiVO GetIpptInternet(ctx, omadacId, siteId, gatewayMac).Execute()

Get internet info by mac

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    gatewayMac := "gatewayMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetIpptInternet(context.Background(), omadacId, siteId, gatewayMac).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetIpptInternet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetIpptInternet`: OperationResponseInternetOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetIpptInternet`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
gatewayMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiGetIpptInternetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseInternetOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIspScanResult

OperationResponseIspScanResultOpenApiVO GetIspScanResult(ctx, omadacId, siteId, portUuid).Execute()

Get Isp scan result

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    portUuid := "portUuid_example" // string | Port Uuid to be scanned

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetIspScanResult(context.Background(), omadacId, siteId, portUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetIspScanResult``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetIspScanResult`: OperationResponseIspScanResultOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetIspScanResult`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
portUuid	string	Port Uuid to be scanned

Other Parameters

Other parameters are passed through a pointer to a apiGetIspScanResultRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseIspScanResultOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLanNetwork

OperationResponseLanNetworkQueryOpenApiV3VO GetLanNetwork(ctx, omadacId, siteId, networkId).Execute()

Get LAN network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetLanNetwork(context.Background(), omadacId, siteId, networkId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetLanNetwork``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLanNetwork`: OperationResponseLanNetworkQueryOpenApiV3VO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetLanNetwork`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiGetLanNetworkRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseLanNetworkQueryOpenApiV3VO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLanNetworkList

OperationResponseLanNetworkOpenApiGridVOLanNetworkQueryOpenApiVO GetLanNetworkList(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()

Get LAN network list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetLanNetworkList(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetLanNetworkList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLanNetworkList`: OperationResponseLanNetworkOpenApiGridVOLanNetworkQueryOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetLanNetworkList`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetLanNetworkListRequest struct via the builder pattern

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

Return type

OperationResponseLanNetworkOpenApiGridVOLanNetworkQueryOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLanNetworkListV2

OperationResponseLanNetworkOpenApiV2GridVOLanNetworkQueryOpenApiV2VO GetLanNetworkListV2(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()

Get LAN network list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetLanNetworkListV2(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetLanNetworkListV2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLanNetworkListV2`: OperationResponseLanNetworkOpenApiV2GridVOLanNetworkQueryOpenApiV2VO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetLanNetworkListV2`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetLanNetworkListV2Request struct via the builder pattern

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

Return type

OperationResponseLanNetworkOpenApiV2GridVOLanNetworkQueryOpenApiV2VO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLanNetworkListV3

OperationResponseLanNetworkOpenApiV3GridVOLanNetworkQueryOpenApiV3VO GetLanNetworkListV3(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()

Get LAN network list V3

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetLanNetworkListV3(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetLanNetworkListV3``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLanNetworkListV3`: OperationResponseLanNetworkOpenApiV3GridVOLanNetworkQueryOpenApiV3VO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetLanNetworkListV3`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetLanNetworkListV3Request struct via the builder pattern

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

Return type

OperationResponseLanNetworkOpenApiV3GridVOLanNetworkQueryOpenApiV3VO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLanProfileList

OperationResponseGridVOLanProfileOpenApiVO GetLanProfileList(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()

Get LAN profile list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetLanProfileList(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetLanProfileList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLanProfileList`: OperationResponseGridVOLanProfileOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetLanProfileList`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetLanProfileListRequest struct via the builder pattern

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

Return type

OperationResponseGridVOLanProfileOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLoadBalanceWeightStatus

OperationResponse GetLoadBalanceWeightStatus(ctx, omadacId, siteId).Execute()

Check Wan Loadbalance status

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetLoadBalanceWeightStatus(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetLoadBalanceWeightStatus``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLoadBalanceWeightStatus`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetLoadBalanceWeightStatus`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetLoadBalanceWeightStatusRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLocationAndIspInfo

OperationResponseLocationAndIspInfoOpenApiVO GetLocationAndIspInfo(ctx, omadacId, siteId).Execute()

Get location and ISP info

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetLocationAndIspInfo(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetLocationAndIspInfo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLocationAndIspInfo`: OperationResponseLocationAndIspInfoOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetLocationAndIspInfo`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetLocationAndIspInfoRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseLocationAndIspInfoOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLteWanPortsConfig

OperationResponseLteWanSettingOpenApiVO GetLteWanPortsConfig(ctx, omadacId, siteId).Execute()

Get internet lte wan ports config

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetLteWanPortsConfig(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetLteWanPortsConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLteWanPortsConfig`: OperationResponseLteWanSettingOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetLteWanPortsConfig`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetLteWanPortsConfigRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseLteWanSettingOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNetworksWithServersForReservation

OperationResponseDhcpServerInfoUnderNetworkVO GetNetworksWithServersForReservation(ctx, omadacId, siteId).Execute()

Get all networks that can reserve IP addresses and their corresponding servers

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetNetworksWithServersForReservation(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetNetworksWithServersForReservation``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetNetworksWithServersForReservation`: OperationResponseDhcpServerInfoUnderNetworkVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetNetworksWithServersForReservation`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetNetworksWithServersForReservationRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseDhcpServerInfoUnderNetworkVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOswForGivenLanNetworkIds

OperationResponseGridVOOswDataVO GetOswForGivenLanNetworkIds(ctx, omadacId, siteId).QueryOswDateByNetworkVO(queryOswDateByNetworkVO).Execute()

Get LAN network list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    queryOswDateByNetworkVO := *openapiclient.NewQueryOswDateByNetworkVO() // QueryOswDateByNetworkVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetOswForGivenLanNetworkIds(context.Background(), omadacId, siteId).QueryOswDateByNetworkVO(queryOswDateByNetworkVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetOswForGivenLanNetworkIds``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetOswForGivenLanNetworkIds`: OperationResponseGridVOOswDataVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetOswForGivenLanNetworkIds`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetOswForGivenLanNetworkIdsRequest struct via the builder pattern

Name	Type	Description	Notes

queryOswDateByNetworkVO | QueryOswDateByNetworkVO | |

Return type

OperationResponseGridVOOswDataVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOswLanProfileList

OperationResponseGridVOLanProfileInfoOpenApiVO GetOswLanProfileList(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()

Get switch profile list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetOswLanProfileList(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetOswLanProfileList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetOswLanProfileList`: OperationResponseGridVOLanProfileInfoOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetOswLanProfileList`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetOswLanProfileListRequest struct via the builder pattern

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

Return type

OperationResponseGridVOLanProfileInfoOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOswPortLanNetInfo

GridVOOswProfileOpenApiVO GetOswPortLanNetInfo(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()

Get switch port profile info

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetOswPortLanNetInfo(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetOswPortLanNetInfo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetOswPortLanNetInfo`: GridVOOswProfileOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetOswPortLanNetInfo`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetOswPortLanNetInfoRequest struct via the builder pattern

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

Return type

GridVOOswProfileOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSelectDevicePortsInfo

OperationResponseListSelectDeviceForVlanVO GetSelectDevicePortsInfo(ctx, omadacId, siteId).SelectMacsWithVlanVO(selectMacsWithVlanVO).Execute()

Get the port information of the selected devices when creating network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    selectMacsWithVlanVO := *openapiclient.NewSelectMacsWithVlanVO([]string{"Macs_example"}, int32(123)) // SelectMacsWithVlanVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetSelectDevicePortsInfo(context.Background(), omadacId, siteId).SelectMacsWithVlanVO(selectMacsWithVlanVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetSelectDevicePortsInfo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSelectDevicePortsInfo`: OperationResponseListSelectDeviceForVlanVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetSelectDevicePortsInfo`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetSelectDevicePortsInfoRequest struct via the builder pattern

Name	Type	Description	Notes

selectMacsWithVlanVO | SelectMacsWithVlanVO | |

Return type

OperationResponseListSelectDeviceForVlanVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSelectDevicePortsInfoWhenModify

OperationResponseListSelectDeviceForVlanVO GetSelectDevicePortsInfoWhenModify(ctx, omadacId, siteId, networkId).SelectMacsWithVlanVO(selectMacsWithVlanVO).Execute()

Get the port information of the selected devices when modifying the network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    selectMacsWithVlanVO := *openapiclient.NewSelectMacsWithVlanVO([]string{"Macs_example"}, int32(123)) // SelectMacsWithVlanVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetSelectDevicePortsInfoWhenModify(context.Background(), omadacId, siteId, networkId).SelectMacsWithVlanVO(selectMacsWithVlanVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetSelectDevicePortsInfoWhenModify``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSelectDevicePortsInfoWhenModify`: OperationResponseListSelectDeviceForVlanVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetSelectDevicePortsInfoWhenModify`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiGetSelectDevicePortsInfoWhenModifyRequest struct via the builder pattern

Name	Type	Description	Notes

selectMacsWithVlanVO | SelectMacsWithVlanVO | |

Return type

OperationResponseListSelectDeviceForVlanVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSelectStackPortsInfo

OperationResponseListSelectStackForVlanVO GetSelectStackPortsInfo(ctx, omadacId, siteId).SelectStacksWithVlanVO(selectStacksWithVlanVO).Execute()

Get the port information of the selected stacks when creating network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    selectStacksWithVlanVO := *openapiclient.NewSelectStacksWithVlanVO([]string{"StackIds_example"}, int32(123)) // SelectStacksWithVlanVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetSelectStackPortsInfo(context.Background(), omadacId, siteId).SelectStacksWithVlanVO(selectStacksWithVlanVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetSelectStackPortsInfo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSelectStackPortsInfo`: OperationResponseListSelectStackForVlanVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetSelectStackPortsInfo`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetSelectStackPortsInfoRequest struct via the builder pattern

Name	Type	Description	Notes

selectStacksWithVlanVO | SelectStacksWithVlanVO | |

Return type

OperationResponseListSelectStackForVlanVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSelectStackPortsInfoWhenModify

OperationResponseListSelectStackForVlanVO GetSelectStackPortsInfoWhenModify(ctx, omadacId, siteId, networkId).SelectStacksWithVlanVO(selectStacksWithVlanVO).Execute()

Get the port information of the selected stacks when modifying the network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    selectStacksWithVlanVO := *openapiclient.NewSelectStacksWithVlanVO([]string{"StackIds_example"}, int32(123)) // SelectStacksWithVlanVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetSelectStackPortsInfoWhenModify(context.Background(), omadacId, siteId, networkId).SelectStacksWithVlanVO(selectStacksWithVlanVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetSelectStackPortsInfoWhenModify``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSelectStackPortsInfoWhenModify`: OperationResponseListSelectStackForVlanVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetSelectStackPortsInfoWhenModify`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiGetSelectStackPortsInfoWhenModifyRequest struct via the builder pattern

Name	Type	Description	Notes

selectStacksWithVlanVO | SelectStacksWithVlanVO | |

Return type

OperationResponseListSelectStackForVlanVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSimCardBandScanResult

OperationResponseBandScanResultOpenApiVO GetSimCardBandScanResult(ctx, omadacId, siteId, portUuid, simCard).Execute()

Obtain the bandScan result of the corresponding SIM card

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    portUuid := "portUuid_example" // string | The ID of the port.
    simCard := "simCard_example" // string | SIM card. 1: SIM1; 2: SIM2.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetSimCardBandScanResult(context.Background(), omadacId, siteId, portUuid, simCard).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetSimCardBandScanResult``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSimCardBandScanResult`: OperationResponseBandScanResultOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetSimCardBandScanResult`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
portUuid	string	The ID of the port.
simCard	string	SIM card. 1: SIM1; 2: SIM2.

Other Parameters

Other parameters are passed through a pointer to a apiGetSimCardBandScanResultRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseBandScanResultOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSimCardIspScanResult

OperationResponseIspScanResultOpenApiVO GetSimCardIspScanResult(ctx, omadacId, siteId, portUuid, simCard).Execute()

Obtain the ispScan result of the corresponding SIM card

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    portUuid := "portUuid_example" // string | The ID of the port.
    simCard := "simCard_example" // string | SIM card. 1: SIM1; 2: SIM2.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetSimCardIspScanResult(context.Background(), omadacId, siteId, portUuid, simCard).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetSimCardIspScanResult``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSimCardIspScanResult`: OperationResponseIspScanResultOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetSimCardIspScanResult`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
portUuid	string	The ID of the port.
simCard	string	SIM card. 1: SIM1; 2: SIM2.

Other Parameters

Other parameters are passed through a pointer to a apiGetSimCardIspScanResultRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseIspScanResultOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSpeedTestV2Setting

OperationResponseSpeedTestV2SettingVO GetSpeedTestV2Setting(ctx, omadacId, siteId).Execute()

Get SpeedTest Setting

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetSpeedTestV2Setting(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetSpeedTestV2Setting``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSpeedTestV2Setting`: OperationResponseSpeedTestV2SettingVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetSpeedTestV2Setting`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetSpeedTestV2SettingRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseSpeedTestV2SettingVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSupportInfo

OperationResponseSupportOsgModelOpenApiAppVO GetSupportInfo(ctx, omadacId, siteId).Execute()

Get supported gateway model list for pre-configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetSupportInfo(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetSupportInfo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSupportInfo`: OperationResponseSupportOsgModelOpenApiAppVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetSupportInfo`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetSupportInfoRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseSupportOsgModelOpenApiAppVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUseLanProfileES

OperationResponseGridVOUseProfileOswOpenApiVO GetUseLanProfileES(ctx, omadacId, siteId, profileId).Page(page).PageSize(pageSize).Execute()

Query Agile Series switches that used the profile

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    profileId := "profileId_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetUseLanProfileES(context.Background(), omadacId, siteId, profileId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetUseLanProfileES``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetUseLanProfileES`: OperationResponseGridVOUseProfileOswOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetUseLanProfileES`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
profileId	string

Other Parameters

Other parameters are passed through a pointer to a apiGetUseLanProfileESRequest struct via the builder pattern

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

Return type

OperationResponseGridVOUseProfileOswOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUseNativeNetworkOsw

OperationResponseGridVOUseProfileOswOpenApiVO GetUseNativeNetworkOsw(ctx, omadacId, siteId).QueryUseNativeNetworkOswOpenApiVO(queryUseNativeNetworkOswOpenApiVO).Execute()

Query switches that used the Native Network's profile

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    queryUseNativeNetworkOswOpenApiVO := *openapiclient.NewQueryUseNativeNetworkOswOpenApiVO(int32(123), int32(123)) // QueryUseNativeNetworkOswOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetUseNativeNetworkOsw(context.Background(), omadacId, siteId).QueryUseNativeNetworkOswOpenApiVO(queryUseNativeNetworkOswOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetUseNativeNetworkOsw``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetUseNativeNetworkOsw`: OperationResponseGridVOUseProfileOswOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetUseNativeNetworkOsw`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetUseNativeNetworkOswRequest struct via the builder pattern

Name	Type	Description	Notes

queryUseNativeNetworkOswOpenApiVO | QueryUseNativeNetworkOswOpenApiVO | |

Return type

OperationResponseGridVOUseProfileOswOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUseNativeNetworkOswV2

OperationResponseGridVOUseProfileOswOpenApiVO GetUseNativeNetworkOswV2(ctx, omadacId, siteId).QueryUseNativeNetworkOswV2OpenApiVO(queryUseNativeNetworkOswV2OpenApiVO).Execute()

Query switches that used the Native Network's profile V2

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    queryUseNativeNetworkOswV2OpenApiVO := *openapiclient.NewQueryUseNativeNetworkOswV2OpenApiVO(int32(123), int32(123)) // QueryUseNativeNetworkOswV2OpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetUseNativeNetworkOswV2(context.Background(), omadacId, siteId).QueryUseNativeNetworkOswV2OpenApiVO(queryUseNativeNetworkOswV2OpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetUseNativeNetworkOswV2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetUseNativeNetworkOswV2`: OperationResponseGridVOUseProfileOswOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetUseNativeNetworkOswV2`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetUseNativeNetworkOswV2Request struct via the builder pattern

Name	Type	Description	Notes

queryUseNativeNetworkOswV2OpenApiVO | QueryUseNativeNetworkOswV2OpenApiVO | |

Return type

OperationResponseGridVOUseProfileOswOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetVlanNetworkAffectedDevice1

OperationResponseListVlanNetworkAffectingDeviceVO GetVlanNetworkAffectedDevice1(ctx, omadacId, siteId, networkId, vlan).Execute()

Get devices list that use the network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    vlan := "vlan_example" // string | Vlan ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetVlanNetworkAffectedDevice1(context.Background(), omadacId, siteId, networkId, vlan).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetVlanNetworkAffectedDevice1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetVlanNetworkAffectedDevice1`: OperationResponseListVlanNetworkAffectingDeviceVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetVlanNetworkAffectedDevice1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID
vlan	string	Vlan ID

Other Parameters

Other parameters are passed through a pointer to a apiGetVlanNetworkAffectedDevice1Request struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseListVlanNetworkAffectingDeviceVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetVlanNetworkAffectedSsid1

OperationResponseGridVOVlanNetworkAffectingSsidVO GetVlanNetworkAffectedSsid1(ctx, omadacId, siteId, networkId, vlan).Page(page).PageSize(pageSize).Execute()

Get grid ssid list that use the vlan

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    vlan := "vlan_example" // string | Vlan ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetVlanNetworkAffectedSsid1(context.Background(), omadacId, siteId, networkId, vlan).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetVlanNetworkAffectedSsid1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetVlanNetworkAffectedSsid1`: OperationResponseGridVOVlanNetworkAffectingSsidVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetVlanNetworkAffectedSsid1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID
vlan	string	Vlan ID

Other Parameters

Other parameters are passed through a pointer to a apiGetVlanNetworkAffectedSsid1Request struct via the builder pattern

Name	Type	Description	Notes
page	int32	Start page number. Start from 1.
pageSize	int32	Number of entries per page. It should be within the range of 1–1000.

Return type

OperationResponseGridVOVlanNetworkAffectingSsidVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetVlanNetworkDevicePortSupportVlanInfo

OperationResponseVlanNetworkDeviceSupportInfoVO GetVlanNetworkDevicePortSupportVlanInfo(ctx, omadacId, siteId, networkId, vlan).Execute()

Get device port info on whether support current vlan

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    vlan := "vlan_example" // string | Vlan ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetVlanNetworkDevicePortSupportVlanInfo(context.Background(), omadacId, siteId, networkId, vlan).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetVlanNetworkDevicePortSupportVlanInfo``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetVlanNetworkDevicePortSupportVlanInfo`: OperationResponseVlanNetworkDeviceSupportInfoVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetVlanNetworkDevicePortSupportVlanInfo`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID
vlan	string	Vlan ID

Other Parameters

Other parameters are passed through a pointer to a apiGetVlanNetworkDevicePortSupportVlanInfoRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseVlanNetworkDeviceSupportInfoVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetWanPortsConfig

OperationResponseWanSettingOpenApiVO GetWanPortsConfig(ctx, omadacId, siteId).Execute()

Get internet ports config

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetWanPortsConfig(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetWanPortsConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetWanPortsConfig`: OperationResponseWanSettingOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetWanPortsConfig`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetWanPortsConfigRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseWanSettingOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetWanPortsMaxSpeed1

OperationResponseWanMaxSpeedOpenApiVO GetWanPortsMaxSpeed1(ctx, omadacId, siteId).WanId(wanId).Execute()

Get wan ports max speed

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    wanId := "wanId_example" // string | WanId, can pass multiple wan ports using comma separator like '{portId1},{portId2}'.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.GetWanPortsMaxSpeed1(context.Background(), omadacId, siteId).WanId(wanId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.GetWanPortsMaxSpeed1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetWanPortsMaxSpeed1`: OperationResponseWanMaxSpeedOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.GetWanPortsMaxSpeed1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetWanPortsMaxSpeed1Request struct via the builder pattern

Name	Type	Description	Notes

wanId | string | WanId, can pass multiple wan ports using comma separator like '{portId1},{portId2}'. |

Return type

OperationResponseWanMaxSpeedOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyGatewayModel

OperationResponseWithoutResult ModifyGatewayModel(ctx, omadacId, siteId).OsgModelOpenApiVO(osgModelOpenApiVO).Execute()

Modify gateway mode for pre-configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    osgModelOpenApiVO := *openapiclient.NewOsgModelOpenApiVO(int32(123)) // OsgModelOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyGatewayModel(context.Background(), omadacId, siteId).OsgModelOpenApiVO(osgModelOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyGatewayModel``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyGatewayModel`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyGatewayModel`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyGatewayModelRequest struct via the builder pattern

Name	Type	Description	Notes

osgModelOpenApiVO | OsgModelOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyInternetBasicPortInfo1

OperationResponseWithoutResult ModifyInternetBasicPortInfo1(ctx, omadacId, siteId).InternetBaseConfigOpenApiVO(internetBaseConfigOpenApiVO).Execute()

Modify the internet basic configuration

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    internetBaseConfigOpenApiVO := *openapiclient.NewInternetBaseConfigOpenApiVO(false, []string{"WanPortList_example"}) // InternetBaseConfigOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyInternetBasicPortInfo1(context.Background(), omadacId, siteId).InternetBaseConfigOpenApiVO(internetBaseConfigOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyInternetBasicPortInfo1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyInternetBasicPortInfo1`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyInternetBasicPortInfo1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyInternetBasicPortInfo1Request struct via the builder pattern

Name	Type	Description	Notes

internetBaseConfigOpenApiVO | InternetBaseConfigOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyInternetLoadBalance1

OperationResponseWithoutResult ModifyInternetLoadBalance1(ctx, omadacId, siteId).WanLoadBalanceOpenApiVO(wanLoadBalanceOpenApiVO).Execute()

Modify internet load balance config

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    wanLoadBalanceOpenApiVO := *openapiclient.NewWanLoadBalanceOpenApiVO(false, false, []int32{int32(123)}) // WanLoadBalanceOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyInternetLoadBalance1(context.Background(), omadacId, siteId).WanLoadBalanceOpenApiVO(wanLoadBalanceOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyInternetLoadBalance1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyInternetLoadBalance1`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyInternetLoadBalance1`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyInternetLoadBalance1Request struct via the builder pattern

Name	Type	Description	Notes

wanLoadBalanceOpenApiVO | WanLoadBalanceOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyIpptLteWanPortConfig

OperationResponseWithoutResult ModifyIpptLteWanPortConfig(ctx, omadacId, siteId, gatewayMac).LteWanPortSettingConfigOpenApiV2VO(lteWanPortSettingConfigOpenApiV2VO).Execute()

Modify internet lte port config for ippt

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    gatewayMac := "gatewayMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    lteWanPortSettingConfigOpenApiV2VO := *openapiclient.NewLteWanPortSettingConfigOpenApiV2VO(*openapiclient.NewDialupSettingOpenApiV2VO(int32(123), false, int32(123), int32(123)), false, "PortUuid_example") // LteWanPortSettingConfigOpenApiV2VO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyIpptLteWanPortConfig(context.Background(), omadacId, siteId, gatewayMac).LteWanPortSettingConfigOpenApiV2VO(lteWanPortSettingConfigOpenApiV2VO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyIpptLteWanPortConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyIpptLteWanPortConfig`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyIpptLteWanPortConfig`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
gatewayMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiModifyIpptLteWanPortConfigRequest struct via the builder pattern

Name	Type	Description	Notes

lteWanPortSettingConfigOpenApiV2VO | LteWanPortSettingConfigOpenApiV2VO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyIpptWanMode

OperationResponse ModifyIpptWanMode(ctx, omadacId, siteId, gatewayMac).IpptWanModeOpenApiVO(ipptWanModeOpenApiVO).Execute()

Modify internet wan mode

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    gatewayMac := "gatewayMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    ipptWanModeOpenApiVO := *openapiclient.NewIpptWanModeOpenApiVO(false) // IpptWanModeOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyIpptWanMode(context.Background(), omadacId, siteId, gatewayMac).IpptWanModeOpenApiVO(ipptWanModeOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyIpptWanMode``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyIpptWanMode`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyIpptWanMode`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
gatewayMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

Other parameters are passed through a pointer to a apiModifyIpptWanModeRequest struct via the builder pattern

Name	Type	Description	Notes

ipptWanModeOpenApiVO | IpptWanModeOpenApiVO | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyLanDns

OperationResponseWithoutResult ModifyLanDns(ctx, omadacId, siteId, dnsId).LanDnsOpenApiVO(lanDnsOpenApiVO).Execute()

Modify an existing LAN DNS rule

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    dnsId := "dnsId_example" // string | LAN DNS ID
    lanDnsOpenApiVO := *openapiclient.NewLanDnsOpenApiVO("Domain_example", false, "Name_example", int32(123)) // LanDnsOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyLanDns(context.Background(), omadacId, siteId, dnsId).LanDnsOpenApiVO(lanDnsOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyLanDns``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyLanDns`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyLanDns`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
dnsId	string	LAN DNS ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyLanDnsRequest struct via the builder pattern

Name	Type	Description	Notes

lanDnsOpenApiVO | LanDnsOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyLanNetwork

OperationResponseWithoutResult ModifyLanNetwork(ctx, omadacId, siteId, networkId).LanNetworkOpenApiVO(lanNetworkOpenApiVO).Execute()

Modify LAN network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    lanNetworkOpenApiVO := *openapiclient.NewLanNetworkOpenApiVO(false, "Name_example", int32(123)) // LanNetworkOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyLanNetwork(context.Background(), omadacId, siteId, networkId).LanNetworkOpenApiVO(lanNetworkOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyLanNetwork``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyLanNetwork`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyLanNetwork`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyLanNetworkRequest struct via the builder pattern

Name	Type	Description	Notes

lanNetworkOpenApiVO | LanNetworkOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyLanNetworkV2

OperationResponseWithoutResult ModifyLanNetworkV2(ctx, omadacId, siteId, networkId).LanNetworkOpenApiV2VO(lanNetworkOpenApiV2VO).Execute()

Modify LAN network

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkId := "networkId_example" // string | Network ID
    lanNetworkOpenApiV2VO := *openapiclient.NewLanNetworkOpenApiV2VO(false, "Name_example", int32(123)) // LanNetworkOpenApiV2VO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyLanNetworkV2(context.Background(), omadacId, siteId, networkId).LanNetworkOpenApiV2VO(lanNetworkOpenApiV2VO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyLanNetworkV2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyLanNetworkV2`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyLanNetworkV2`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
networkId	string	Network ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyLanNetworkV2Request struct via the builder pattern

Name	Type	Description	Notes

lanNetworkOpenApiV2VO | LanNetworkOpenApiV2VO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyLanProfile

OperationResponseWithoutResult ModifyLanProfile(ctx, omadacId, siteId, profileId).LanProfileConfigOpenApiVO(lanProfileConfigOpenApiVO).Execute()

Modify a LAN profile

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    profileId := "profileId_example" // string | lanProfileId
    lanProfileConfigOpenApiVO := *openapiclient.NewLanProfileConfigOpenApiVO(int32(123), int32(123), false, false, "Name_example", "NativeNetworkId_example", int32(123), false, false) // LanProfileConfigOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyLanProfile(context.Background(), omadacId, siteId, profileId).LanProfileConfigOpenApiVO(lanProfileConfigOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyLanProfile``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyLanProfile`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyLanProfile`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
profileId	string	lanProfileId

Other Parameters

Other parameters are passed through a pointer to a apiModifyLanProfileRequest struct via the builder pattern

Name	Type	Description	Notes

lanProfileConfigOpenApiVO | LanProfileConfigOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyLteWanPortConfig

OperationResponseWithoutResult ModifyLteWanPortConfig(ctx, omadacId, siteId).LteWanPortSettingConfigOpenApiVO(lteWanPortSettingConfigOpenApiVO).Execute()

Modify internet lte port config

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    lteWanPortSettingConfigOpenApiVO := *openapiclient.NewLteWanPortSettingConfigOpenApiVO(false, *openapiclient.NewDialupSettingOpenApiVO(int32(123), int32(123)), false, int32(123), "PortId_example") // LteWanPortSettingConfigOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyLteWanPortConfig(context.Background(), omadacId, siteId).LteWanPortSettingConfigOpenApiVO(lteWanPortSettingConfigOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyLteWanPortConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyLteWanPortConfig`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyLteWanPortConfig`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyLteWanPortConfigRequest struct via the builder pattern

Name	Type	Description	Notes

lteWanPortSettingConfigOpenApiVO | LteWanPortSettingConfigOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyOswLanProfile

OperationResponseWithoutResult ModifyOswLanProfile(ctx, omadacId, siteId, profileId).LanProfileSettingOpenApiVO(lanProfileSettingOpenApiVO).Execute()

Modify a switch profile

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    profileId := "profileId_example" // string | Switch profile ID
    lanProfileSettingOpenApiVO := *openapiclient.NewLanProfileSettingOpenApiVO(int32(123), int32(123), false, false, "Name_example", int32(123), false, false) // LanProfileSettingOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyOswLanProfile(context.Background(), omadacId, siteId, profileId).LanProfileSettingOpenApiVO(lanProfileSettingOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyOswLanProfile``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyOswLanProfile`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyOswLanProfile`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
profileId	string	Switch profile ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyOswLanProfileRequest struct via the builder pattern

Name	Type	Description	Notes

lanProfileSettingOpenApiVO | LanProfileSettingOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifySpeedTestV2Setting

OperationResponseWithoutResult ModifySpeedTestV2Setting(ctx, omadacId, siteId).ModifySpeedTestV2SettingOpenApiVO(modifySpeedTestV2SettingOpenApiVO).Execute()

Modify SpeedTest Setting

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    modifySpeedTestV2SettingOpenApiVO := *openapiclient.NewModifySpeedTestV2SettingOpenApiVO(false) // ModifySpeedTestV2SettingOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifySpeedTestV2Setting(context.Background(), omadacId, siteId).ModifySpeedTestV2SettingOpenApiVO(modifySpeedTestV2SettingOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifySpeedTestV2Setting``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifySpeedTestV2Setting`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifySpeedTestV2Setting`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiModifySpeedTestV2SettingRequest struct via the builder pattern

Name	Type	Description	Notes

modifySpeedTestV2SettingOpenApiVO | ModifySpeedTestV2SettingOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyVirtualWan

OperationResponseWithoutResult ModifyVirtualWan(ctx, omadacId, siteId, virtualWanId).VirtualWanConfigOpenApiVO(virtualWanConfigOpenApiVO).Execute()

Modify virtual WAN

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    virtualWanId := "virtualWanId_example" // string | Virtual WAN ID
    virtualWanConfigOpenApiVO := *openapiclient.NewVirtualWanConfigOpenApiVO("Name_example", "PhysicalWanId_example", *openapiclient.NewVirtualWanIpv4SettingConfigOpenApiVO("Proto_example", int32(123))) // VirtualWanConfigOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyVirtualWan(context.Background(), omadacId, siteId, virtualWanId).VirtualWanConfigOpenApiVO(virtualWanConfigOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyVirtualWan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyVirtualWan`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyVirtualWan`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
virtualWanId	string	Virtual WAN ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyVirtualWanRequest struct via the builder pattern

Name	Type	Description	Notes

virtualWanConfigOpenApiVO | VirtualWanConfigOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyVirtualWanStatus

OperationResponseWithoutResult ModifyVirtualWanStatus(ctx, omadacId, siteId, virtualWanId).VirtualWanStatusOpenApiVO(virtualWanStatusOpenApiVO).Execute()

Modify virtual WAN status

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    virtualWanId := "virtualWanId_example" // string | Virtual WAN ID
    virtualWanStatusOpenApiVO := *openapiclient.NewVirtualWanStatusOpenApiVO(false) // VirtualWanStatusOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyVirtualWanStatus(context.Background(), omadacId, siteId, virtualWanId).VirtualWanStatusOpenApiVO(virtualWanStatusOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyVirtualWanStatus``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyVirtualWanStatus`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyVirtualWanStatus`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID
virtualWanId	string	Virtual WAN ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyVirtualWanStatusRequest struct via the builder pattern

Name	Type	Description	Notes

virtualWanStatusOpenApiVO | VirtualWanStatusOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyWanPortSettings

OperationResponseWithoutResult ModifyWanPortSettings(ctx, omadacId, siteId).InternetPortOpenApiVO(internetPortOpenApiVO).Execute()

Modify Wan Port Settings

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    internetPortOpenApiVO := *openapiclient.NewInternetPortOpenApiVO(int32(123)) // InternetPortOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyWanPortSettings(context.Background(), omadacId, siteId).InternetPortOpenApiVO(internetPortOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyWanPortSettings``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyWanPortSettings`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyWanPortSettings`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyWanPortSettingsRequest struct via the builder pattern

Name	Type	Description	Notes

internetPortOpenApiVO | InternetPortOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyWanPorts

OperationResponse ModifyWanPorts(ctx, omadacId, siteId).WanPortsOpenApiVO(wanPortsOpenApiVO).Execute()

Modify Wan Ports

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    wanPortsOpenApiVO := *openapiclient.NewWanPortsOpenApiVO(false) // WanPortsOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyWanPorts(context.Background(), omadacId, siteId).WanPortsOpenApiVO(wanPortsOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyWanPorts``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyWanPorts`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyWanPorts`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyWanPortsRequest struct via the builder pattern

Name	Type	Description	Notes

wanPortsOpenApiVO | WanPortsOpenApiVO | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyWanPortsConfig

OperationResponseWithoutResult ModifyWanPortsConfig(ctx, omadacId, siteId).WanSettingConfigOpenApiVO(wanSettingConfigOpenApiVO).Execute()

Modify internet ports config

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    wanSettingConfigOpenApiVO := *openapiclient.NewWanSettingConfigOpenApiVO() // WanSettingConfigOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ModifyWanPortsConfig(context.Background(), omadacId, siteId).WanSettingConfigOpenApiVO(wanSettingConfigOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ModifyWanPortsConfig``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyWanPortsConfig`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ModifyWanPortsConfig`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyWanPortsConfigRequest struct via the builder pattern

Name	Type	Description	Notes

wanSettingConfigOpenApiVO | WanSettingConfigOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NetworkMapping

OperationResponseInternetOpenApiVO NetworkMapping(ctx, omadacId, siteId).NetworkMappingVO(networkMappingVO).Execute()

Network mapping

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    networkMappingVO := *openapiclient.NewNetworkMappingVO() // NetworkMappingVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.NetworkMapping(context.Background(), omadacId, siteId).NetworkMappingVO(networkMappingVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.NetworkMapping``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `NetworkMapping`: OperationResponseInternetOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.NetworkMapping`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiNetworkMappingRequest struct via the builder pattern

Name	Type	Description	Notes

networkMappingVO | NetworkMappingVO | |

Return type

OperationResponseInternetOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ObtainWanUnsupportedFunction

OperationResponseWanUnsupportedFunctionOpenApiVO ObtainWanUnsupportedFunction(ctx, omadacId, siteId).Filter(filter).Execute()

Get linkage functions that are not supported by WAN

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    filter := int32(56) // int32 | 1: Obtain the functions that are not supported when you configure DS-Lite and MAP-E dial-up for IPv4 on the WAN port. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.ObtainWanUnsupportedFunction(context.Background(), omadacId, siteId).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.ObtainWanUnsupportedFunction``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ObtainWanUnsupportedFunction`: OperationResponseWanUnsupportedFunctionOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.ObtainWanUnsupportedFunction`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiObtainWanUnsupportedFunctionRequest struct via the builder pattern

Name	Type	Description	Notes

filter | int32 | 1: Obtain the functions that are not supported when you configure DS-Lite and MAP-E dial-up for IPv4 on the WAN port. |

Return type

OperationResponseWanUnsupportedFunctionOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SpeedTest

OperationResponseWithoutResult SpeedTest(ctx, omadacId, siteId).InternetOpenApiVO(internetOpenApiVO).Execute()

SpeedTest

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    internetOpenApiVO := *openapiclient.NewInternetOpenApiVO("SiteId_example") // InternetOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.SpeedTest(context.Background(), omadacId, siteId).InternetOpenApiVO(internetOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.SpeedTest``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SpeedTest`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.SpeedTest`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiSpeedTestRequest struct via the builder pattern

Name	Type	Description	Notes

internetOpenApiVO | InternetOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StartBandScan

OperationResponseWithoutResult StartBandScan(ctx, omadacId, siteId).BandScanStart(bandScanStart).Execute()

Start Band scan

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    bandScanStart := *openapiclient.NewBandScanStart("PortUuid_example") // BandScanStart | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.StartBandScan(context.Background(), omadacId, siteId).BandScanStart(bandScanStart).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.StartBandScan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `StartBandScan`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.StartBandScan`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiStartBandScanRequest struct via the builder pattern

Name	Type	Description	Notes

bandScanStart | BandScanStart | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StartIspScan

OperationResponseWithoutResult StartIspScan(ctx, omadacId, siteId).IspScanStartOpenApiVO(ispScanStartOpenApiVO).Execute()

Start Isp scan

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    ispScanStartOpenApiVO := *openapiclient.NewIspScanStartOpenApiVO("PortUuid_example") // IspScanStartOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.WiredNetworkAPI.StartIspScan(context.Background(), omadacId, siteId).IspScanStartOpenApiVO(ispScanStartOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `WiredNetworkAPI.StartIspScan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `StartIspScan`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `WiredNetworkAPI.StartIspScan`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId	string	Omada ID
siteId	string	Site ID

Other Parameters

Other parameters are passed through a pointer to a apiStartIspScanRequest struct via the builder pattern

Name	Type	Description	Notes

ispScanStartOpenApiVO | IspScanStartOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

• Content-Type: application/json
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]