OUIBasedVLANAPI

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

Method	HTTP request	Description
CreateApOuiBasedVlan	Post /openapi/v1/{omadacId}/sites/{siteId}/ap-oui-rules	Create Ap oui based vlan
CreateSwitchOuiBasedVlan	Post /openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules	Create Switch oui based vlan
DeleteApOuiBasedVlan	Delete /openapi/v1/{omadacId}/sites/{siteId}/ap-oui-rules/{ouiBasedVlanId}	Delete Ap oui based vlan
DeleteSwitchOuiBasedVlan	Delete /openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/{ouiBasedVlanId}	Delete Switch oui based vlan
GetGridApOuiBasedVlan	Get /openapi/v1/{omadacId}/sites/{siteId}/ap-oui-rules	Get Ap oui based vlan list
GetGridSwitchOuiBasedVlan	Get /openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules	Get Switch oui based vlan list
GetSwitchList	Get /openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/support-device	Get switch list of supporting oui based vlan
ModifyApOuiBasedVlan	Put /openapi/v1/{omadacId}/sites/{siteId}/ap-oui-rules/{ouiBasedVlanId}	Modify Ap oui based vlan
ModifySwitchOuiBasedVlan	Put /openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/{ouiBasedVlanId}	Modify Switch oui based vlan

CreateApOuiBasedVlan

OperationResponseResIdOpenApiVO CreateApOuiBasedVlan(ctx, omadacId, siteId).OuiBasedVlanApOpenApiVO(ouiBasedVlanApOpenApiVO).Execute()

Create Ap oui based 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
    ouiBasedVlanApOpenApiVO := *openapiclient.NewOuiBasedVlanApOpenApiVO(false, "Name_example", []openapiclient.VlanOuiModeOpenApiVO{*openapiclient.NewVlanOuiModeOpenApiVO("OuiProfileId_example", int32(123), int32(123))}, []string{"SsidIdList_example"}) // OuiBasedVlanApOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OUIBasedVLANAPI.CreateApOuiBasedVlan(context.Background(), omadacId, siteId).OuiBasedVlanApOpenApiVO(ouiBasedVlanApOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OUIBasedVLANAPI.CreateApOuiBasedVlan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateApOuiBasedVlan`: OperationResponseResIdOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `OUIBasedVLANAPI.CreateApOuiBasedVlan`: %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 apiCreateApOuiBasedVlanRequest struct via the builder pattern

Name	Type	Description	Notes

ouiBasedVlanApOpenApiVO | OuiBasedVlanApOpenApiVO | |

Return type

OperationResponseResIdOpenApiVO

Authorization

AccessToken

HTTP request headers

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

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

CreateSwitchOuiBasedVlan

OperationResponseResIdOpenApiVO CreateSwitchOuiBasedVlan(ctx, omadacId, siteId).OuiBasedVlanSwitchOpenApiVO(ouiBasedVlanSwitchOpenApiVO).Execute()

Create Switch oui based 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
    ouiBasedVlanSwitchOpenApiVO := *openapiclient.NewOuiBasedVlanSwitchOpenApiVO(false, int32(123), "Name_example", []openapiclient.VlanOuiModeOpenApiVO{*openapiclient.NewVlanOuiModeOpenApiVO("OuiProfileId_example", int32(123), int32(123))}) // OuiBasedVlanSwitchOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OUIBasedVLANAPI.CreateSwitchOuiBasedVlan(context.Background(), omadacId, siteId).OuiBasedVlanSwitchOpenApiVO(ouiBasedVlanSwitchOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OUIBasedVLANAPI.CreateSwitchOuiBasedVlan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateSwitchOuiBasedVlan`: OperationResponseResIdOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `OUIBasedVLANAPI.CreateSwitchOuiBasedVlan`: %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 apiCreateSwitchOuiBasedVlanRequest struct via the builder pattern

Name	Type	Description	Notes

ouiBasedVlanSwitchOpenApiVO | OuiBasedVlanSwitchOpenApiVO | |

Return type

OperationResponseResIdOpenApiVO

Authorization

AccessToken

HTTP request headers

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

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

DeleteApOuiBasedVlan

OperationResponseWithoutResult DeleteApOuiBasedVlan(ctx, omadacId, siteId, ouiBasedVlanId).Execute()

Delete Ap oui based 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
    ouiBasedVlanId := "ouiBasedVlanId_example" // string | Oui Based Vlan ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OUIBasedVLANAPI.DeleteApOuiBasedVlan(context.Background(), omadacId, siteId, ouiBasedVlanId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OUIBasedVLANAPI.DeleteApOuiBasedVlan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteApOuiBasedVlan`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `OUIBasedVLANAPI.DeleteApOuiBasedVlan`: %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
ouiBasedVlanId	string	Oui Based Vlan ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteApOuiBasedVlanRequest 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]

DeleteSwitchOuiBasedVlan

OperationResponseWithoutResult DeleteSwitchOuiBasedVlan(ctx, omadacId, siteId, ouiBasedVlanId).Execute()

Delete Switch oui based 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
    ouiBasedVlanId := "ouiBasedVlanId_example" // string | Oui Based Vlan ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OUIBasedVLANAPI.DeleteSwitchOuiBasedVlan(context.Background(), omadacId, siteId, ouiBasedVlanId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OUIBasedVLANAPI.DeleteSwitchOuiBasedVlan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteSwitchOuiBasedVlan`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `OUIBasedVLANAPI.DeleteSwitchOuiBasedVlan`: %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
ouiBasedVlanId	string	Oui Based Vlan ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteSwitchOuiBasedVlanRequest 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]

GetGridApOuiBasedVlan

OperationResponseGridVOOuiBasedVlanApQueryOpenApiVO GetGridApOuiBasedVlan(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()

Get Ap oui based vlan 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.OUIBasedVLANAPI.GetGridApOuiBasedVlan(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OUIBasedVLANAPI.GetGridApOuiBasedVlan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGridApOuiBasedVlan`: OperationResponseGridVOOuiBasedVlanApQueryOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `OUIBasedVLANAPI.GetGridApOuiBasedVlan`: %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 apiGetGridApOuiBasedVlanRequest 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

OperationResponseGridVOOuiBasedVlanApQueryOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetGridSwitchOuiBasedVlan

OperationResponseGridVOOuiBasedVlanSwitchQueryOpenApiVO GetGridSwitchOuiBasedVlan(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()

Get Switch oui based vlan 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.OUIBasedVLANAPI.GetGridSwitchOuiBasedVlan(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OUIBasedVLANAPI.GetGridSwitchOuiBasedVlan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGridSwitchOuiBasedVlan`: OperationResponseGridVOOuiBasedVlanSwitchQueryOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `OUIBasedVLANAPI.GetGridSwitchOuiBasedVlan`: %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 apiGetGridSwitchOuiBasedVlanRequest 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

OperationResponseGridVOOuiBasedVlanSwitchQueryOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetSwitchList

OperationResponseGridVOOuiBasedVlanSwitchInfoOpenApiVO GetSwitchList(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Name(name).Execute()

Get switch list of supporting 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
    name := "name_example" // string | Switch name. Support fuzzy search (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OUIBasedVLANAPI.GetSwitchList(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Name(name).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OUIBasedVLANAPI.GetSwitchList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSwitchList`: OperationResponseGridVOOuiBasedVlanSwitchInfoOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `OUIBasedVLANAPI.GetSwitchList`: %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 apiGetSwitchListRequest 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.

name | string | Switch name. Support fuzzy search |

Return type

OperationResponseGridVOOuiBasedVlanSwitchInfoOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

ModifyApOuiBasedVlan

OperationResponseWithoutResult ModifyApOuiBasedVlan(ctx, omadacId, siteId, ouiBasedVlanId).OuiBasedVlanApOpenApiVO(ouiBasedVlanApOpenApiVO).Execute()

Modify Ap oui based 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
    ouiBasedVlanId := "ouiBasedVlanId_example" // string | Oui Based Vlan ID
    ouiBasedVlanApOpenApiVO := *openapiclient.NewOuiBasedVlanApOpenApiVO(false, "Name_example", []openapiclient.VlanOuiModeOpenApiVO{*openapiclient.NewVlanOuiModeOpenApiVO("OuiProfileId_example", int32(123), int32(123))}, []string{"SsidIdList_example"}) // OuiBasedVlanApOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OUIBasedVLANAPI.ModifyApOuiBasedVlan(context.Background(), omadacId, siteId, ouiBasedVlanId).OuiBasedVlanApOpenApiVO(ouiBasedVlanApOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OUIBasedVLANAPI.ModifyApOuiBasedVlan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyApOuiBasedVlan`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `OUIBasedVLANAPI.ModifyApOuiBasedVlan`: %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
ouiBasedVlanId	string	Oui Based Vlan ID

Other Parameters

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

Name	Type	Description	Notes

ouiBasedVlanApOpenApiVO | OuiBasedVlanApOpenApiVO | |

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]

ModifySwitchOuiBasedVlan

OperationResponseWithoutResult ModifySwitchOuiBasedVlan(ctx, omadacId, siteId, ouiBasedVlanId).OuiBasedVlanSwitchOpenApiVO(ouiBasedVlanSwitchOpenApiVO).Execute()

Modify Switch oui based 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
    ouiBasedVlanId := "ouiBasedVlanId_example" // string | Oui Based Vlan ID
    ouiBasedVlanSwitchOpenApiVO := *openapiclient.NewOuiBasedVlanSwitchOpenApiVO(false, int32(123), "Name_example", []openapiclient.VlanOuiModeOpenApiVO{*openapiclient.NewVlanOuiModeOpenApiVO("OuiProfileId_example", int32(123), int32(123))}) // OuiBasedVlanSwitchOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OUIBasedVLANAPI.ModifySwitchOuiBasedVlan(context.Background(), omadacId, siteId, ouiBasedVlanId).OuiBasedVlanSwitchOpenApiVO(ouiBasedVlanSwitchOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OUIBasedVLANAPI.ModifySwitchOuiBasedVlan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifySwitchOuiBasedVlan`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `OUIBasedVLANAPI.ModifySwitchOuiBasedVlan`: %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
ouiBasedVlanId	string	Oui Based Vlan ID

Other Parameters

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

Name	Type	Description	Notes

ouiBasedVlanSwitchOpenApiVO | OuiBasedVlanSwitchOpenApiVO | |

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]