GatewayTemplateAPI

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

Method	HTTP request	Description
GetGatewayInfo	Get /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}	Get gateway template info
GetPortsTemplate	Get /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/ports/config	Get gateway template port info
GetSsidDetailTemplate1	Get /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/wlans/ssid	Get SSID detail info
ModifyConfigAdvancedTemplate	Put /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/advanced	Modify gateway template advanced config
ModifyConfigCommonAdvancedTemplate	Put /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/advanced/common	Modify gateway template common advanced config
ModifyConfigGeneralTemplate	Put /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/general	Modify gateway template general config
ModifyConfigRadiosTemplate	Put /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/radios	Modify gateway template radios config
ModifyConfigServicesTemplate	Put /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/services	Modify gateway template services config
ModifyConfigWirelessAdvancedTemplate	Put /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/advanced/wireless	Modify gateway template wireless advanced config
ModifyConfigWlansTemplate	Put /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/wlans	Modify gateway template wlans config
ModifyPortConfig	Patch /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/ports/{port}/config	Modify gateway template port config
ModifySsidBasicConfigTemplate	Patch /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/wlans/ssid/{ssidId}/basic-config	modify SSID basic config
ModifySsidMacFilterConfigTemplate	Patch /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/wlans/ssid/{ssidId}/mac-filter	Update SSID mac filter config

GetGatewayInfo

OperationResponseGatewayTemplateInfo GetGatewayInfo(ctx, siteTemplateId, deviceTemplateId, omadacId).Execute()

Get gateway template info

Example

package main

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

func main() {
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID
    deviceTemplateId := "deviceTemplateId_example" // string | Device Template ID
    omadacId := "omadacId_example" // string | omadacId

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseGatewayTemplateInfo

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetPortsTemplate

OperationResponseListOsgPortInfoOpenApiVO GetPortsTemplate(ctx, siteTemplateId, deviceTemplateId, omadacId).Execute()

Get gateway template port info

Example

package main

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

func main() {
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID
    deviceTemplateId := "deviceTemplateId_example" // string | Device Template ID
    omadacId := "omadacId_example" // string | omadacId

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseListOsgPortInfoOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

GetSsidDetailTemplate1

OperationResponseSsidDetailOpenApiVO GetSsidDetailTemplate1(ctx, omadacId, siteTemplateId, deviceTemplateId).Execute()

Get SSID detail info

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
    deviceTemplateId := "deviceTemplateId_example" // string | Device Template ID

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

Other Parameters

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

Name	Type	Description	Notes

Return type

OperationResponseSsidDetailOpenApiVO

Authorization

AccessToken

HTTP request headers

• Content-Type: Not defined
• Accept: /

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

ModifyConfigAdvancedTemplate

OperationResponseWithoutResult ModifyConfigAdvancedTemplate(ctx, siteTemplateId, deviceTemplateId, omadacId).OsgConfigAdvancedOpenApiVO(osgConfigAdvancedOpenApiVO).Execute()

Modify gateway template advanced config

Example

package main

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

func main() {
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID
    deviceTemplateId := "deviceTemplateId_example" // string | Device Template ID
    omadacId := "omadacId_example" // string | omadacId
    osgConfigAdvancedOpenApiVO := *openapiclient.NewOsgConfigAdvancedOpenApiVO() // OsgConfigAdvancedOpenApiVO | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

osgConfigAdvancedOpenApiVO | OsgConfigAdvancedOpenApiVO | |

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]

ModifyConfigCommonAdvancedTemplate

OperationResponseWithoutResult ModifyConfigCommonAdvancedTemplate(ctx, siteTemplateId, deviceTemplateId, omadacId).OsgConfigCommonAdvancedOpenApiVO(osgConfigCommonAdvancedOpenApiVO).Execute()

Modify gateway template common advanced config

Example

package main

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

func main() {
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID
    deviceTemplateId := "deviceTemplateId_example" // string | Device Template ID
    omadacId := "omadacId_example" // string | omadacId
    osgConfigCommonAdvancedOpenApiVO := *openapiclient.NewOsgConfigCommonAdvancedOpenApiVO() // OsgConfigCommonAdvancedOpenApiVO | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

osgConfigCommonAdvancedOpenApiVO | OsgConfigCommonAdvancedOpenApiVO | |

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]

ModifyConfigGeneralTemplate

OperationResponseWithoutResult ModifyConfigGeneralTemplate(ctx, siteTemplateId, deviceTemplateId, omadacId).OsgGeneralConfigOpenApiV2VO(osgGeneralConfigOpenApiV2VO).Execute()

Modify gateway template general config

Example

package main

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

func main() {
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID
    deviceTemplateId := "deviceTemplateId_example" // string | Device Template ID
    omadacId := "omadacId_example" // string | omadacId
    osgGeneralConfigOpenApiV2VO := *openapiclient.NewOsgGeneralConfigOpenApiV2VO(int32(123)) // OsgGeneralConfigOpenApiV2VO | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

osgGeneralConfigOpenApiV2VO | OsgGeneralConfigOpenApiV2VO | |

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]

ModifyConfigRadiosTemplate

OperationResponseWithoutResult ModifyConfigRadiosTemplate(ctx, siteTemplateId, deviceTemplateId, omadacId).OsgConfigRadiosopenApiVO(osgConfigRadiosopenApiVO).Execute()

Modify gateway template radios config

Example

package main

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

func main() {
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID
    deviceTemplateId := "deviceTemplateId_example" // string | Device Template ID
    omadacId := "omadacId_example" // string | omadacId
    osgConfigRadiosopenApiVO := *openapiclient.NewOsgConfigRadiosopenApiVO() // OsgConfigRadiosopenApiVO | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

osgConfigRadiosopenApiVO | OsgConfigRadiosopenApiVO | |

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]

ModifyConfigServicesTemplate

OperationResponseWithoutResult ModifyConfigServicesTemplate(ctx, siteTemplateId, deviceTemplateId, omadacId).OsgConfigServicesOpenApiVO(osgConfigServicesOpenApiVO).Execute()

Modify gateway template services config

Example

package main

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

func main() {
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID
    deviceTemplateId := "deviceTemplateId_example" // string | Device Template ID
    omadacId := "omadacId_example" // string | omadacId
    osgConfigServicesOpenApiVO := *openapiclient.NewOsgConfigServicesOpenApiVO() // OsgConfigServicesOpenApiVO | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

osgConfigServicesOpenApiVO | OsgConfigServicesOpenApiVO | |

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]

ModifyConfigWirelessAdvancedTemplate

OperationResponseWithoutResult ModifyConfigWirelessAdvancedTemplate(ctx, siteTemplateId, deviceTemplateId, omadacId).OsgConfigWirelessAdvancedOpenApiVO(osgConfigWirelessAdvancedOpenApiVO).Execute()

Modify gateway template wireless advanced config

Example

package main

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

func main() {
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID
    deviceTemplateId := "deviceTemplateId_example" // string | Device Template ID
    omadacId := "omadacId_example" // string | omadacId
    osgConfigWirelessAdvancedOpenApiVO := *openapiclient.NewOsgConfigWirelessAdvancedOpenApiVO() // OsgConfigWirelessAdvancedOpenApiVO | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

osgConfigWirelessAdvancedOpenApiVO | OsgConfigWirelessAdvancedOpenApiVO | |

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]

ModifyConfigWlansTemplate

OperationResponseWithoutResult ModifyConfigWlansTemplate(ctx, siteTemplateId, deviceTemplateId, omadacId).OsgConfigWlansOpenApiVO(osgConfigWlansOpenApiVO).Execute()

Modify gateway template wlans config

Example

package main

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

func main() {
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID
    deviceTemplateId := "deviceTemplateId_example" // string | Device Template ID
    omadacId := "omadacId_example" // string | omadacId
    osgConfigWlansOpenApiVO := *openapiclient.NewOsgConfigWlansOpenApiVO([]openapiclient.OsgSsidOverrideOpenApiVO{*openapiclient.NewOsgSsidOverrideOpenApiVO(false, "GlobalSsid_example", false, int32(123), int32(123), "Ssid_example", false, false)}) // OsgConfigWlansOpenApiVO | 

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

osgConfigWlansOpenApiVO | OsgConfigWlansOpenApiVO | |

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]

ModifyPortConfig

OperationResponseGatewayTemplatePortSettingConfig ModifyPortConfig(ctx, siteTemplateId, deviceTemplateId, port, omadacId).GatewayTemplatePortSettingConfig(gatewayTemplatePortSettingConfig).Execute()

Modify gateway template port config

Example

package main

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

func main() {
    siteTemplateId := "siteTemplateId_example" // string | Site Template ID
    deviceTemplateId := "deviceTemplateId_example" // string | Device Template ID
    port := "port_example" // string | Gateway port number
    omadacId := "omadacId_example" // string | omadacId
    gatewayTemplatePortSettingConfig := *openapiclient.NewGatewayTemplatePortSettingConfig() // GatewayTemplatePortSettingConfig | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
siteTemplateId	string	Site Template ID
deviceTemplateId	string	Device Template ID
port	string	Gateway port number
omadacId	string	omadacId

Other Parameters

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

Name	Type	Description	Notes

gatewayTemplatePortSettingConfig | GatewayTemplatePortSettingConfig | |

Return type

OperationResponseGatewayTemplatePortSettingConfig

Authorization

AccessToken

HTTP request headers

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

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

ModifySsidBasicConfigTemplate

OperationResponseWithoutResult ModifySsidBasicConfigTemplate(ctx, omadacId, siteTemplateId, deviceTemplateId, ssidId).UpdateSsidBasicConfigForIpptOpenApiVO(updateSsidBasicConfigForIpptOpenApiVO).Execute()

modify SSID basic config

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
    deviceTemplateId := "deviceTemplateId_example" // string | Gateway MAC address, like AA-BB-CC-DD-EE-FF
    ssidId := "ssidId_example" // string | Device Template ID
    updateSsidBasicConfigForIpptOpenApiVO := *openapiclient.NewUpdateSsidBasicConfigForIpptOpenApiVO(int32(123), false, "Name_example", int32(123)) // UpdateSsidBasicConfigForIpptOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.GatewayTemplateAPI.ModifySsidBasicConfigTemplate(context.Background(), omadacId, siteTemplateId, deviceTemplateId, ssidId).UpdateSsidBasicConfigForIpptOpenApiVO(updateSsidBasicConfigForIpptOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `GatewayTemplateAPI.ModifySsidBasicConfigTemplate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifySsidBasicConfigTemplate`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `GatewayTemplateAPI.ModifySsidBasicConfigTemplate`: %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
deviceTemplateId	string	Gateway MAC address, like AA-BB-CC-DD-EE-FF
ssidId	string	Device Template ID

Other Parameters

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

Name	Type	Description	Notes

updateSsidBasicConfigForIpptOpenApiVO | UpdateSsidBasicConfigForIpptOpenApiVO | |

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]

ModifySsidMacFilterConfigTemplate

OperationResponseWithoutResult ModifySsidMacFilterConfigTemplate(ctx, omadacId, siteTemplateId, deviceTemplateId, ssidId).UpdateSsidMacFilterOpenApiVO(updateSsidMacFilterOpenApiVO).Execute()

Update SSID mac filter config

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
    deviceTemplateId := "deviceTemplateId_example" // string | Gateway MAC address, like AA-BB-CC-DD-EE-FF
    ssidId := "ssidId_example" // string | Device Template ID
    updateSsidMacFilterOpenApiVO := *openapiclient.NewUpdateSsidMacFilterOpenApiVO(false) // UpdateSsidMacFilterOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.GatewayTemplateAPI.ModifySsidMacFilterConfigTemplate(context.Background(), omadacId, siteTemplateId, deviceTemplateId, ssidId).UpdateSsidMacFilterOpenApiVO(updateSsidMacFilterOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `GatewayTemplateAPI.ModifySsidMacFilterConfigTemplate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifySsidMacFilterConfigTemplate`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `GatewayTemplateAPI.ModifySsidMacFilterConfigTemplate`: %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
deviceTemplateId	string	Gateway MAC address, like AA-BB-CC-DD-EE-FF
ssidId	string	Device Template ID

Other Parameters

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

Name	Type	Description	Notes

updateSsidMacFilterOpenApiVO | UpdateSsidMacFilterOpenApiVO | |

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]