OLTLineProfileAPI

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

Method	HTTP request	Description
AddLineProfile	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/profiles/add	Create new line profile
DeleteLineProfile	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/profiles/delete	Delete an existing line profile
EditLineProfile	Post /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/profiles/edit	Modify an existing line profile
GetLineProfileList	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/profiles/list	Get line profile list
GetLineProfilePage	Get /openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/profiles/page	Get line profile page

AddLineProfile

OperationResponseDeviceResponseBodyLineProfileDTO AddLineProfile(ctx, omadacId, siteId, deviceMac).LineProfileDTO(lineProfileDTO).Execute()

Create new line 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
    lineProfileDTO := *openapiclient.NewLineProfileDTO(int32(123), "MappingMode_example", "UpstreamFEC_example") // LineProfileDTO | 

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

Name	Type	Description	Notes

lineProfileDTO | LineProfileDTO | |

Return type

OperationResponseDeviceResponseBodyLineProfileDTO

Authorization

AccessToken

HTTP request headers

Content-Type: application/json
Accept: /

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

DeleteLineProfile

OperationResponseDeviceResponseBodyLineProfileDeleteResultDTO DeleteLineProfile(ctx, omadacId, siteId, deviceMac).IntIdListRequest(intIdListRequest).Execute()

Delete an existing line 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.OLTLineProfileAPI.DeleteLineProfile(context.Background(), omadacId, siteId, deviceMac).IntIdListRequest(intIdListRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `OLTLineProfileAPI.DeleteLineProfile``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteLineProfile`: OperationResponseDeviceResponseBodyLineProfileDeleteResultDTO
    fmt.Fprintf(os.Stdout, "Response from `OLTLineProfileAPI.DeleteLineProfile`: %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 apiDeleteLineProfileRequest struct via the builder pattern

Name	Type	Description	Notes

intIdListRequest | IntIdListRequest | |

Return type

OperationResponseDeviceResponseBodyLineProfileDeleteResultDTO

Authorization

AccessToken

HTTP request headers

Content-Type: application/json
Accept: /

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

EditLineProfile

OperationResponseDeviceResponseBodyVoid EditLineProfile(ctx, omadacId, siteId, deviceMac).LineProfileModifyDTO(lineProfileModifyDTO).Execute()

Modify an existing line 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
    lineProfileModifyDTO := *openapiclient.NewLineProfileModifyDTO(int32(123)) // LineProfileModifyDTO | 

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

Name	Type	Description	Notes

lineProfileModifyDTO | LineProfileModifyDTO | |

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]

GetLineProfileList

OperationResponseListLineProfileVO GetLineProfileList(ctx, omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()

Get line 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.NewLineProfileListQueryDTO() // LineProfileListQueryDTO | 

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

Name	Type	Description	Notes

queryParam | LineProfileListQueryDTO | |

Return type

OperationResponseListLineProfileVO

Authorization

AccessToken

HTTP request headers

Content-Type: Not defined
Accept: /

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

GetLineProfilePage

OperationResponsePageResponseLineProfileVO GetLineProfilePage(ctx, omadacId, siteId, deviceMac).QueryParam(queryParam).Execute()

Get line 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.NewLineProfilePageQueryDTO() // LineProfilePageQueryDTO | 

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

Name	Type	Description	Notes

queryParam | LineProfilePageQueryDTO | |

Return type

OperationResponsePageResponseLineProfileVO

Authorization

AccessToken

HTTP request headers

Content-Type: Not defined
Accept: /

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