OUIBasedVLANTemplateAPI

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

Method	HTTP request	Description
CreateApOuiBasedVlanTemplate	Post /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ap-oui-rules	Create Ap oui based vlan template
CreateSwitchOuiBasedVlanTemplate	Post /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules	Create Switch oui based vlan template
DeleteApOuiBasedVlanTemplate	Delete /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ap-oui-rules/{ouiBasedVlanId}	Delete Ap oui based vlan template
DeleteSwitchOuiBasedVlanTemplate	Delete /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules/{ouiBasedVlanId}	Delete Switch oui based vlan template
GetGridApOuiBasedVlanTemplate	Get /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ap-oui-rules	Get Ap oui based vlan template list
GetGridSwitchOuiBasedVlanTemplate	Get /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules	Get Switch oui based vlan template list
ModifyApOuiBasedVlanTemplate	Put /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ap-oui-rules/{ouiBasedVlanId}	Modify Ap oui based vlan template
ModifySwitchOuiBasedVlanTemplate	Put /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules/{ouiBasedVlanId}	Modify Switch oui based vlan template

CreateApOuiBasedVlanTemplate

OperationResponseResIdOpenApiVO CreateApOuiBasedVlanTemplate(ctx, omadacId, siteTemplateId).OuiBasedVlanApOpenApiVO(ouiBasedVlanApOpenApiVO).Execute()

Create Ap oui based vlan template

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteTemplateId := "siteTemplateId_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.OUIBasedVLANTemplateAPI.CreateApOuiBasedVlanTemplate(context.Background(), omadacId, siteTemplateId).OuiBasedVlanApOpenApiVO(ouiBasedVlanApOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OUIBasedVLANTemplateAPI.CreateApOuiBasedVlanTemplate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateApOuiBasedVlanTemplate`: OperationResponseResIdOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `OUIBasedVLANTemplateAPI.CreateApOuiBasedVlanTemplate`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

CreateSwitchOuiBasedVlanTemplate

OperationResponseResIdOpenApiVO CreateSwitchOuiBasedVlanTemplate(ctx, omadacId, siteTemplateId).OuiBasedVlanTemplateOpenApiVO(ouiBasedVlanTemplateOpenApiVO).Execute()

Create Switch oui based vlan template

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteTemplateId := "siteTemplateId_example" // string | Site ID
    ouiBasedVlanTemplateOpenApiVO := *openapiclient.NewOuiBasedVlanTemplateOpenApiVO(false, int32(123), "Name_example", []openapiclient.VlanOuiModeOpenApiVO{*openapiclient.NewVlanOuiModeOpenApiVO("OuiProfileId_example", int32(123), int32(123))}) // OuiBasedVlanTemplateOpenApiVO | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

ouiBasedVlanTemplateOpenApiVO | OuiBasedVlanTemplateOpenApiVO | |

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]

DeleteApOuiBasedVlanTemplate

OperationResponseWithoutResult DeleteApOuiBasedVlanTemplate(ctx, omadacId, siteTemplateId, ouiBasedVlanId).Execute()

Delete Ap oui based vlan template

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteTemplateId := "siteTemplateId_example" // string | Site ID
    ouiBasedVlanId := "ouiBasedVlanId_example" // string | 

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

Path Parameters

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

Other Parameters

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

DeleteSwitchOuiBasedVlanTemplate

OperationResponseWithoutResult DeleteSwitchOuiBasedVlanTemplate(ctx, omadacId, siteTemplateId, ouiBasedVlanId).Execute()

Delete Switch oui based vlan template

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteTemplateId := "siteTemplateId_example" // string | Site ID
    ouiBasedVlanId := "ouiBasedVlanId_example" // string | 

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

Path Parameters

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

Other Parameters

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

GetGridApOuiBasedVlanTemplate

OperationResponseGridVOOuiBasedVlanApQueryOpenApiVO GetGridApOuiBasedVlanTemplate(ctx, omadacId, siteTemplateId).Page(page).PageSize(pageSize).Execute()

Get Ap oui based vlan template list

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteTemplateId := "siteTemplateId_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.OUIBasedVLANTemplateAPI.GetGridApOuiBasedVlanTemplate(context.Background(), omadacId, siteTemplateId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OUIBasedVLANTemplateAPI.GetGridApOuiBasedVlanTemplate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGridApOuiBasedVlanTemplate`: OperationResponseGridVOOuiBasedVlanApQueryOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `OUIBasedVLANTemplateAPI.GetGridApOuiBasedVlanTemplate`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

GetGridSwitchOuiBasedVlanTemplate

OperationResponseGridVOOuiBasedVlanTemplateSwitchQueryOpenApiVO GetGridSwitchOuiBasedVlanTemplate(ctx, omadacId, siteTemplateId).Page(page).PageSize(pageSize).Execute()

Get Switch oui based vlan template list

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteTemplateId := "siteTemplateId_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.OUIBasedVLANTemplateAPI.GetGridSwitchOuiBasedVlanTemplate(context.Background(), omadacId, siteTemplateId).Page(page).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OUIBasedVLANTemplateAPI.GetGridSwitchOuiBasedVlanTemplate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetGridSwitchOuiBasedVlanTemplate`: OperationResponseGridVOOuiBasedVlanTemplateSwitchQueryOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `OUIBasedVLANTemplateAPI.GetGridSwitchOuiBasedVlanTemplate`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

OperationResponseGridVOOuiBasedVlanTemplateSwitchQueryOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

ModifyApOuiBasedVlanTemplate

OperationResponseWithoutResult ModifyApOuiBasedVlanTemplate(ctx, omadacId, siteTemplateId, ouiBasedVlanId).OuiBasedVlanApOpenApiVO(ouiBasedVlanApOpenApiVO).Execute()

Modify Ap oui based vlan template

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteTemplateId := "siteTemplateId_example" // string | Site ID
    ouiBasedVlanId := "ouiBasedVlanId_example" // string | 
    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.OUIBasedVLANTemplateAPI.ModifyApOuiBasedVlanTemplate(context.Background(), omadacId, siteTemplateId, ouiBasedVlanId).OuiBasedVlanApOpenApiVO(ouiBasedVlanApOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OUIBasedVLANTemplateAPI.ModifyApOuiBasedVlanTemplate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyApOuiBasedVlanTemplate`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `OUIBasedVLANTemplateAPI.ModifyApOuiBasedVlanTemplate`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

ModifySwitchOuiBasedVlanTemplate

OperationResponseWithoutResult ModifySwitchOuiBasedVlanTemplate(ctx, omadacId, siteTemplateId, ouiBasedVlanId).OuiBasedVlanTemplateOpenApiVO(ouiBasedVlanTemplateOpenApiVO).Execute()

Modify Switch oui based vlan template

Example

package main

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

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteTemplateId := "siteTemplateId_example" // string | Site ID
    ouiBasedVlanId := "ouiBasedVlanId_example" // string | 
    ouiBasedVlanTemplateOpenApiVO := *openapiclient.NewOuiBasedVlanTemplateOpenApiVO(false, int32(123), "Name_example", []openapiclient.VlanOuiModeOpenApiVO{*openapiclient.NewVlanOuiModeOpenApiVO("OuiProfileId_example", int32(123), int32(123))}) // OuiBasedVlanTemplateOpenApiVO | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

ouiBasedVlanTemplateOpenApiVO | OuiBasedVlanTemplateOpenApiVO | |

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]