VRRPAPI

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

Method	HTTP request	Description
CreateOswVrrp	Post /openapi/v1/{omadacId}/sites/{siteId}/osw-vrrp	Create Switch Vrrp
DeleteOswVrrp	Delete /openapi/v1/{omadacId}/sites/{siteId}/osw-vrrp/{oswVrrpId}	Delete Switch Vrrp
GetGridOswVrrp	Get /openapi/v1/{omadacId}/sites/{siteId}/osw-vrrp	Get Switch Vrrp list
ModifyOswVrrp	Put /openapi/v1/{omadacId}/sites/{siteId}/osw-vrrp/{oswVrrpId}	Modify Switch Vrrp

CreateOswVrrp

OperationResponseResIdOpenApiVO CreateOswVrrp(ctx, omadacId, siteId).CreateOswVrrpRequest(createOswVrrpRequest).Execute()

Create Switch Vrrp

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
    createOswVrrpRequest := *openapiclient.NewCreateOswVrrpRequest() // CreateOswVrrpRequest | 

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

Path Parameters

Name	Type	Description
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 apiCreateOswVrrpRequest struct via the builder pattern

Name	Type	Description	Notes

createOswVrrpRequest | CreateOswVrrpRequest | |

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]

DeleteOswVrrp

OperationResponseWithoutResult DeleteOswVrrp(ctx, omadacId, siteId, oswVrrpId).UserInfoBriefDTO(userInfoBriefDTO).Execute()

Delete Switch Vrrp

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
    oswVrrpId := "oswVrrpId_example" // string | Osw Vrrp ID
    userInfoBriefDTO := *openapiclient.NewUserInfoBriefDTO() // UserInfoBriefDTO |  (optional)

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

userInfoBriefDTO | UserInfoBriefDTO | |

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]

GetGridOswVrrp

OperationResponseGridVOOswVrrpOpenApiVO GetGridOswVrrp(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()

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

Path Parameters

Name	Type	Description
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 apiGetGridOswVrrpRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

OperationResponseGridVOOswVrrpOpenApiVO

Authorization

AccessToken

HTTP request headers

Content-Type: Not defined
Accept: /

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

ModifyOswVrrp

OperationResponseWithoutResult ModifyOswVrrp(ctx, omadacId, siteId, oswVrrpId).CreateOswVrrpRequest(createOswVrrpRequest).Execute()

Modify Switch Vrrp

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
    oswVrrpId := "oswVrrpId_example" // string | Osw Vrrp ID
    createOswVrrpRequest := *openapiclient.NewCreateOswVrrpRequest() // CreateOswVrrpRequest | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

createOswVrrpRequest | CreateOswVrrpRequest | |

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]