Skip to content

SwitchQoSAPI

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

Method HTTP request Description
CreateQosRule Post /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule Create switch QoS rule.
DeleteQosRule Delete /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/{qosRuleId} Delete switch QoS rule.
GetAllSelectableDevices Get /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/selectable-devices/all Get switch QoS all selectable device's mac.
GetDscpMapping Get /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/dscp-mapping Get switch QoS dscp mapping.
GetDscpMappingTemplate Get /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-qos/qos-rule/dscp-mapping Get switch QoS dscp mapping in site template.
GetOswQosMode Get /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-mode Get switch QoS mode.
GetQosRules Get /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule Get switch QoS rules.
GetSchedulerMapping Get /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/scheduler-mapping Get switch QoS queue scheduling.
GetSelectableDevices Get /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/selectable-devices Get switch QoS selectable devices.
GetSelectedDeviceBriefInfo Post /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/device-info Get switch QoS selected device brief info.
GetUpgradableDevices Get /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/upgradable-devices Get switch QoS upgradable devices.
ModifyDscpMapping Put /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/dscp-mapping Modify switch QoS dscp mapping.
ModifyOswQosMode Put /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-mode Modify switch QoS mode.
ModifyQosRule Put /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/{qosRuleId} Modify switch QoS rule.
ModifyQosRuleStatus Put /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/status/{qosRuleId} Modify switch QoS rule's status.
ModifySchedulerMapping Put /openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/scheduler-mapping Modify switch QoS queue scheduling.

CreateQosRule

OperationResponse CreateQosRule(ctx, omadacId, siteId).OswQosRuleVO(oswQosRuleVO).Execute()

Create switch QoS rule.

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
    oswQosRuleVO := *openapiclient.NewOswQosRuleVO([]int32{int32(123)}, "Name_example", int32(123), false, int32(123)) // OswQosRuleVO | 

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

Name Type Description Notes

oswQosRuleVO | OswQosRuleVO | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

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

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

DeleteQosRule

OperationResponse DeleteQosRule(ctx, omadacId, siteId, qosRuleId).Execute()

Delete switch QoS rule.

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
    qosRuleId := "qosRuleId_example" // string | qosRuleId

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

Other Parameters

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

Name Type Description Notes

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetAllSelectableDevices

OperationResponse GetAllSelectableDevices(ctx, omadacId, siteId).RuleType(ruleType).NetworkId(networkId).Execute()

Get switch QoS all selectable device's mac.

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
    ruleType := int32(56) // int32 | 
    networkId := "networkId_example" // string |  (optional)

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

Name Type Description Notes

ruleType | int32 | | networkId | string | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetDscpMapping

OperationResponse GetDscpMapping(ctx, omadacId, siteId).Execute()

Get switch QoS dscp mapping.

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

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

Name Type Description Notes

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetDscpMappingTemplate

OperationResponse GetDscpMappingTemplate(ctx, omadacId, siteTemplateId).Execute()

Get switch QoS dscp mapping in site 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 Template ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SwitchQoSAPI.GetDscpMappingTemplate(context.Background(), omadacId, siteTemplateId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SwitchQoSAPI.GetDscpMappingTemplate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDscpMappingTemplate`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `SwitchQoSAPI.GetDscpMappingTemplate`: %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 Template ID

Other Parameters

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

Name Type Description Notes

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetOswQosMode

OperationResponse GetOswQosMode(ctx, omadacId, siteId).Execute()

Get switch QoS mode.

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

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

Name Type Description Notes

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetQosRules

OperationResponse GetQosRules(ctx, omadacId, siteId).Page(page).PageSize(pageSize).SearchKey(searchKey).Execute()

Get switch QoS rules.

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.
    searchKey := "searchKey_example" // string | Fuzzy query parameters, support field  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SwitchQoSAPI.GetQosRules(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).SearchKey(searchKey).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SwitchQoSAPI.GetQosRules``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetQosRules`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `SwitchQoSAPI.GetQosRules`: %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 apiGetQosRulesRequest 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. | searchKey | string | Fuzzy query parameters, support field |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetSchedulerMapping

OperationResponse GetSchedulerMapping(ctx, omadacId, siteId).Execute()

Get switch QoS queue scheduling.

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

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

Name Type Description Notes

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetSelectableDevices

OperationResponse GetSelectableDevices(ctx, omadacId, siteId).RuleType(ruleType).NetworkId(networkId).Execute()

Get switch QoS selectable devices.

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
    ruleType := int32(56) // int32 | 
    networkId := "networkId_example" // string |  (optional)

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

Name Type Description Notes

ruleType | int32 | | networkId | string | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetSelectedDeviceBriefInfo

OperationResponse GetSelectedDeviceBriefInfo(ctx, omadacId, siteId).OswMacListVO(oswMacListVO).Execute()

Get switch QoS selected device brief info.

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
    oswMacListVO := *openapiclient.NewOswMacListVO([]string{"SwitchMacList_example"}) // OswMacListVO | 

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

Name Type Description Notes

oswMacListVO | OswMacListVO | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

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

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

GetUpgradableDevices

OperationResponse GetUpgradableDevices(ctx, omadacId, siteId).Execute()

Get switch QoS upgradable devices.

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

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

Name Type Description Notes

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

ModifyDscpMapping

OperationResponse ModifyDscpMapping(ctx, omadacId, siteId).DscpMappingVO(dscpMappingVO).Execute()

Modify switch QoS dscp mapping.

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
    dscpMappingVO := *openapiclient.NewDscpMappingVO(map[string][]int32{"key": []int32{int32(123)}}) // DscpMappingVO | 

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

Name Type Description Notes

dscpMappingVO | DscpMappingVO | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

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

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

ModifyOswQosMode

OperationResponse ModifyOswQosMode(ctx, omadacId, siteId).OswQosModeVO(oswQosModeVO).Execute()

Modify switch QoS mode.

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
    oswQosModeVO := *openapiclient.NewOswQosModeVO() // OswQosModeVO | 

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

Name Type Description Notes

oswQosModeVO | OswQosModeVO | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

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

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

ModifyQosRule

OperationResponse ModifyQosRule(ctx, omadacId, siteId, qosRuleId).OswQosRuleVO(oswQosRuleVO).Execute()

Modify switch QoS rule.

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
    qosRuleId := "qosRuleId_example" // string | qosRuleId
    oswQosRuleVO := *openapiclient.NewOswQosRuleVO([]int32{int32(123)}, "Name_example", int32(123), false, int32(123)) // OswQosRuleVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SwitchQoSAPI.ModifyQosRule(context.Background(), omadacId, siteId, qosRuleId).OswQosRuleVO(oswQosRuleVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SwitchQoSAPI.ModifyQosRule``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyQosRule`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `SwitchQoSAPI.ModifyQosRule`: %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
qosRuleId string qosRuleId

Other Parameters

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

Name Type Description Notes

oswQosRuleVO | OswQosRuleVO | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

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

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

ModifyQosRuleStatus

OperationResponse ModifyQosRuleStatus(ctx, omadacId, siteId, qosRuleId).OswQosRuleStatusVO(oswQosRuleStatusVO).Execute()

Modify switch QoS rule's status.

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
    qosRuleId := "qosRuleId_example" // string | qosRuleId
    oswQosRuleStatusVO := *openapiclient.NewOswQosRuleStatusVO(false) // OswQosRuleStatusVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SwitchQoSAPI.ModifyQosRuleStatus(context.Background(), omadacId, siteId, qosRuleId).OswQosRuleStatusVO(oswQosRuleStatusVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SwitchQoSAPI.ModifyQosRuleStatus``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyQosRuleStatus`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `SwitchQoSAPI.ModifyQosRuleStatus`: %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
qosRuleId string qosRuleId

Other Parameters

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

Name Type Description Notes

oswQosRuleStatusVO | OswQosRuleStatusVO | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

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

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

ModifySchedulerMapping

OperationResponse ModifySchedulerMapping(ctx, omadacId, siteId).QueueSchedulerMappingVO(queueSchedulerMappingVO).Execute()

Modify switch QoS queue scheduling.

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
    queueSchedulerMappingVO := *openapiclient.NewQueueSchedulerMappingVO() // QueueSchedulerMappingVO | 

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

Name Type Description Notes

queueSchedulerMappingVO | QueueSchedulerMappingVO | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

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

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