OLTDBAAPI

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

Method	HTTP request	Description
AddDBAProfile	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/dba/profiles/add	Create new DBA profile
DeleteDBAProfile	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/dba/profiles/delete	Delete an existing DBA profile
EditDBAProfile	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/dba/profiles/edit	Modify an existing DBA profile
GetDBAProfileList	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/dba/profiles/list	Get DBA profile list
GetDBAProfilePage	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/dba/profiles/page	Get DBA profile page

AddDBAProfile

OperationResponseDeviceResponseBodyDBAProfileDTO AddDBAProfile(ctx, omadacId, siteId, deviceMac).DBAProfileModifyDTO(dBAProfileModifyDTO).Execute()

Create new DBA 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
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    dBAProfileModifyDTO := *openapiclient.NewDBAProfileModifyDTO(int32(123)) // DBAProfileModifyDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTDBAAPI.AddDBAProfile(context.Background(), omadacId, siteId, deviceMac).DBAProfileModifyDTO(dBAProfileModifyDTO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTDBAAPI.AddDBAProfile``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AddDBAProfile`: OperationResponseDeviceResponseBodyDBAProfileDTO
    fmt.Fprintf(os.Stdout, "Response from `OLTDBAAPI.AddDBAProfile`: %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
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

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

Name	Type	Description	Notes

dBAProfileModifyDTO | DBAProfileModifyDTO | |

Return type

OperationResponseDeviceResponseBodyDBAProfileDTO

Authorization

AccessToken

HTTP request headers

Content-Type: application/json
Accept: /

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

DeleteDBAProfile

OperationResponseDeviceResponseBodyDBAProfileDeleteResultDTO DeleteDBAProfile(ctx, omadacId, siteId, deviceMac).IntIdListRequest(intIdListRequest).Execute()

Delete an existing DBA 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
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    intIdListRequest := *openapiclient.NewIntIdListRequest([]int32{int32(123)}) // IntIdListRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTDBAAPI.DeleteDBAProfile(context.Background(), omadacId, siteId, deviceMac).IntIdListRequest(intIdListRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTDBAAPI.DeleteDBAProfile``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteDBAProfile`: OperationResponseDeviceResponseBodyDBAProfileDeleteResultDTO
    fmt.Fprintf(os.Stdout, "Response from `OLTDBAAPI.DeleteDBAProfile`: %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
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

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

Name	Type	Description	Notes

intIdListRequest | IntIdListRequest | |

Return type

OperationResponseDeviceResponseBodyDBAProfileDeleteResultDTO

Authorization

AccessToken

HTTP request headers

Content-Type: application/json
Accept: /

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

EditDBAProfile

OperationResponseDeviceResponseBodyVoid EditDBAProfile(ctx, omadacId, siteId, deviceMac).DBAProfileModifyDTO(dBAProfileModifyDTO).Execute()

Modify an existing DBA 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
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    dBAProfileModifyDTO := *openapiclient.NewDBAProfileModifyDTO(int32(123)) // DBAProfileModifyDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTDBAAPI.EditDBAProfile(context.Background(), omadacId, siteId, deviceMac).DBAProfileModifyDTO(dBAProfileModifyDTO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTDBAAPI.EditDBAProfile``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EditDBAProfile`: OperationResponseDeviceResponseBodyVoid
    fmt.Fprintf(os.Stdout, "Response from `OLTDBAAPI.EditDBAProfile`: %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
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

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

Name	Type	Description	Notes

dBAProfileModifyDTO | DBAProfileModifyDTO | |

Return type

OperationResponseDeviceResponseBodyVoid

Authorization

AccessToken

HTTP request headers

Content-Type: application/json
Accept: /

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

GetDBAProfileList

OperationResponseListDBAProfileVO GetDBAProfileList(ctx, omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()

Get DBA profile 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
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    queryParam := *openapiclient.NewDBAProfileListQueryDTO() // DBAProfileListQueryDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTDBAAPI.GetDBAProfileList(context.Background(), omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTDBAAPI.GetDBAProfileList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDBAProfileList`: OperationResponseListDBAProfileVO
    fmt.Fprintf(os.Stdout, "Response from `OLTDBAAPI.GetDBAProfileList`: %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
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

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

Name	Type	Description	Notes

queryParam | DBAProfileListQueryDTO | |

Return type

OperationResponseListDBAProfileVO

Authorization

AccessToken

HTTP request headers

Content-Type: Not defined
Accept: /

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

GetDBAProfilePage

OperationResponsePageResponseDBAProfileVO GetDBAProfilePage(ctx, omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()

Get DBA profile page

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
    deviceMac := "deviceMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
    queryParam := *openapiclient.NewDBAProfilePageQueryDTO() // DBAProfilePageQueryDTO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.OLTDBAAPI.GetDBAProfilePage(context.Background(), omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTDBAAPI.GetDBAProfilePage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDBAProfilePage`: OperationResponsePageResponseDBAProfileVO
    fmt.Fprintf(os.Stdout, "Response from `OLTDBAAPI.GetDBAProfilePage`: %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
deviceMac	string	Device MAC address, like AA-BB-CC-DD-EE-FF

Other Parameters

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

Name	Type	Description	Notes

queryParam | DBAProfilePageQueryDTO | |

Return type

OperationResponsePageResponseDBAProfileVO

Authorization

AccessToken

HTTP request headers

Content-Type: Not defined
Accept: /

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