ProfilesAPI
All URIs are relative to https://use1-omada-northbound.tplinkcloud.com
| Method | HTTP request | Description |
|---|---|---|
| AddPSKsToPPSKProfile | Post /openapi/v1/{omadacId}/sites/{siteId}/ppsk-profile/{profileId}/add-psk | Add PSKs to PPSK profile |
| AutoCreatePPSK | Post /openapi/v1/{omadacId}/sites/{siteId}/ppsk-profile/generate-psk | Auto Create PSKs |
| CreateApnProfile | Post /openapi/v1/{omadacId}/sites/{siteId}/profiles/apn | Create a new APN profile |
| CreateApnProfileByMac | Post /openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/profiles/apns | Create a new APN profile by mac |
| CreateGoogleLdapProfile | Post /openapi/v1/{omadacId}/sites/{siteId}/profiles/ldap/google | Create a new google LDAP profile |
| CreateGroupProfile | Post /openapi/v1/{omadacId}/sites/{siteId}/profiles/groups | Create a new group profile |
| CreateLdapProfile | Post /openapi/v1/{omadacId}/sites/{siteId}/profiles/ldap | Create a new LDAP profile |
| CreateMdnsProfile | Post /openapi/v1/{omadacId}/sites/{siteId}/profiles/bonjour-service | Create new Bonjour Service |
| CreateOuiProfile | Post /openapi/v1/{omadacId}/sites/{siteId}/oui-profiles | Create OUI profile |
| CreatePPSKProfile | Post /openapi/v1/{omadacId}/sites/{siteId}/ppsk-profile | Create PPSK profile |
| CreatePPSKProfileV2 | Post /openapi/v2/{omadacId}/sites/{siteId}/ppsk-profile | Create PPSK profile V2 |
| CreateRadiusProfile | Post /openapi/v1/{omadacId}/sites/{siteId}/profiles/radius | Create a new Radius profile |
| CreateRadiusUser | Post /openapi/v1/{omadacId}/sites/{siteId}/profiles/radius-server/users | Create a new Build-in Radius profile user |
| CreateRateLimitProfile | Post /openapi/v1/{omadacId}/sites/{siteId}/rate-limit-profiles | Create rate limit profile |
| CreateServiceType | Post /openapi/v1/{omadacId}/sites/{siteId}/profiles/service-type | Create new Gateway QoS Service |
| CreateTimeRangeProfile | Post /openapi/v1/{omadacId}/sites/{siteId}/time-range-profiles | Create time range profile |
| DeleteAllPPSKProfiles | Delete /openapi/v1/{omadacId}/sites/{siteId}/ppsk-profiles | Delete All PPSK profiles |
| DeleteApnProfile | Delete /openapi/v1/{omadacId}/sites/{siteId}/profiles/apn/{profileId} | Delete an exist APN profile |
| DeleteGoogleLdapProfile | Delete /openapi/v1/{omadacId}/sites/{siteId}/profiles/ldap/google/{profileId} | Delete an exist google LDAP profile |
| DeleteGroupProfile | Delete /openapi/v1/{omadacId}/sites/{siteId}/profiles/groups/{groupType}/{groupId} | Delete an exist group profile |
| DeleteLdapProfile | Delete /openapi/v1/{omadacId}/sites/{siteId}/profiles/ldap/{ldapProfileId} | Delete an exist LDAP profile |
| DeleteMdnsProfile | Delete /openapi/v1/{omadacId}/sites/{siteId}/profiles/bonjour-service/{id} | Delete an existing Bonjour Service |
| DeleteOuiProfile | Delete /openapi/v1/{omadacId}/sites/{siteId}/oui-profiles/{ouiId} | Delete OUI Profile |
| DeletePPSKProfile | Delete /openapi/v1/{omadacId}/sites/{siteId}/ppsk-profile/{profileId} | Delete PPSK profile |
| DeletePSKsToPPSKProfile | Post /openapi/v1/{omadacId}/sites/{siteId}/ppsk-profile/{profileId}/delete-psk | Delete PSKs to PPSK profile |
| DeleteRadiusProfile | Delete /openapi/v1/{omadacId}/sites/{siteId}/profiles/radius/{radiusProfileId} | Delete an exist Radius profile |
| DeleteRadiusUser | Delete /openapi/v1/{omadacId}/sites/{siteId}/profiles/radius-server/users/{userId} | Delete an exist Build-in Radius profile user |
| DeleteRateLimitProfile | Delete /openapi/v1/{omadacId}/sites/{siteId}/rate-limit-profile/{profileId} | Delete rate limit profile |
| DeleteServiceType | Delete /openapi/v1/{omadacId}/sites/{siteId}/profiles/service-type/{id} | Delete an existing Gateway QoS Service |
| DeleteTimeRangeProfile | Delete /openapi/v1/{omadacId}/sites/{siteId}/time-range-profile/{profileId} | Delete time range profile |
| GetApnProfileList | Get /openapi/v1/{omadacId}/sites/{siteId}/profiles/apn | Get APN profile list |
| GetApnProfilesForIppt | Get /openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/profiles/apns | Get APN profile list by mac for ippt |
| GetGoogleLdapProfileList | Get /openapi/v1/{omadacId}/sites/{siteId}/profiles/ldap/google | Get google LDAP profile list |
| GetGroupProfiles | Get /openapi/v1/{omadacId}/sites/{siteId}/profiles/groups | Get group profile list |
| GetGroupProfilesByType | Get /openapi/v1/{omadacId}/sites/{siteId}/profiles/groups/{groupType} | Get group profile list by type |
| GetLdapProfileList | Get /openapi/v1/{omadacId}/sites/{siteId}/profiles/ldap | Get LDAP profile list |
| GetOuiProfileFullList | Get /openapi/v1/{omadacId}/sites/{siteId}/oui-profiles/all | Get OUI profile summary list |
| GetOuiProfileList | Get /openapi/v1/{omadacId}/sites/{siteId}/oui-profiles | Get OUI profile list |
| GetPPSKProfileDetail | Get /openapi/v1/{omadacId}/sites/{siteId}/ppsk-profile/{profileId} | Get PPSK profile detail |
| GetPPSKProfiles | Get /openapi/v1/{omadacId}/sites/{siteId}/ppsk-profiles | Get PPSK profiles list |
| GetRadiusProfileList | Get /openapi/v1/{omadacId}/sites/{siteId}/profiles/radius | Get Radius profile list |
| GetRadiusUserList | Get /openapi/v1/{omadacId}/sites/{siteId}/profiles/radius-server/users | Get Build-in Radius profile user list |
| GetRateLimitProfileList | Get /openapi/v1/{omadacId}/sites/{siteId}/rate-limit-profiles | Get rate limit profile list |
| GetServiceTypeSummary | Get /openapi/v1/{omadacId}/sites/{siteId}/profiles/service-type-summary | Get all Gateway QoS Service's ID and name info |
| GetTimeRangeList | Get /openapi/v1/{omadacId}/sites/{siteId}/time-range-profiles | Get time range profile list |
| ListMdnsProfile | Get /openapi/v1/{omadacId}/sites/{siteId}/profiles/bonjour-service | Get Bonjour Service list |
| ListRateLimitForHotspot | Get /openapi/v1/{omadacId}/hotspot/sites/{siteId}/setting/profiles/rateLimits | get the rate limit list |
| ListServiceType | Get /openapi/v1/{omadacId}/sites/{siteId}/profiles/service-type | Get Gateway QoS Service list |
| ModifyApnProfile | Put /openapi/v1/{omadacId}/sites/{siteId}/profiles/apn/{profileId} | Modify an exist APN profile |
| ModifyGoogleLdapProfile | Put /openapi/v1/{omadacId}/sites/{siteId}/profiles/ldap/google/{profileId} | Modify an exist google LDAP profile |
| ModifyGroupProfile | Patch /openapi/v1/{omadacId}/sites/{siteId}/profiles/groups/{groupType}/{groupId} | Modify an exist group profile |
| ModifyLdapProfile | Patch /openapi/v1/{omadacId}/sites/{siteId}/profiles/ldap/{ldapProfileId} | Modify an exist LDAP profile |
| ModifyMdnsProfile | Put /openapi/v1/{omadacId}/sites/{siteId}/profiles/bonjour-service/{id} | Modify an existing Bonjour Service |
| ModifyOuiProfile | Put /openapi/v1/{omadacId}/sites/{siteId}/oui-profiles/{ouiId} | Modify OUI Profile |
| ModifyPPSKProfile | Post /openapi/v1/{omadacId}/sites/{siteId}/ppsk-profile/{profileId} | Modify PPSK profile |
| ModifyRadiusProfile | Patch /openapi/v1/{omadacId}/sites/{siteId}/profiles/radius/{radiusProfileId} | Modify an exist Radius profile |
| ModifyRadiusUser | Patch /openapi/v1/{omadacId}/sites/{siteId}/profiles/radius-server/users/{userId} | Modify an exist Build-in Radius profile user |
| ModifyRateLimitProfile | Put /openapi/v1/{omadacId}/sites/{siteId}/rate-limit-profile/{profileId} | Modify rate limit profile |
| ModifyServiceType | Put /openapi/v1/{omadacId}/sites/{siteId}/profiles/service-type/{id} | Modify an existing Gateway QoS Service |
| ModifyTimeRangeProfile | Put /openapi/v1/{omadacId}/sites/{siteId}/time-range-profile/{profileId} | Modify time range profile |
AddPSKsToPPSKProfile
OperationResponseWithoutResult AddPSKsToPPSKProfile(ctx, omadacId, siteId, profileId).AddPSKsOpenApiVO(addPSKsOpenApiVO).Execute()
Add PSKs to PPSK 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
profileId := "profileId_example" // string | PPSK profile Id
addPSKsOpenApiVO := *openapiclient.NewAddPSKsOpenApiVO([]openapiclient.PpskSetting{*openapiclient.NewPpskSetting("Name_example", "Psk_example")}) // AddPSKsOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.AddPSKsToPPSKProfile(context.Background(), omadacId, siteId, profileId).AddPSKsOpenApiVO(addPSKsOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.AddPSKsToPPSKProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AddPSKsToPPSKProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.AddPSKsToPPSKProfile`: %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 | |
| profileId | string | PPSK profile Id |
Other Parameters
Other parameters are passed through a pointer to a apiAddPSKsToPPSKProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
addPSKsOpenApiVO | AddPSKsOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AutoCreatePPSK
[]PSK AutoCreatePPSK(ctx, omadacId, siteId).PpskAutoCreateSetting(ppskAutoCreateSetting).Execute()
Auto Create PSKs
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
ppskAutoCreateSetting := *openapiclient.NewPpskAutoCreateSetting(int32(123), int32(123), "Prefix_example") // PpskAutoCreateSetting |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.AutoCreatePPSK(context.Background(), omadacId, siteId).PpskAutoCreateSetting(ppskAutoCreateSetting).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.AutoCreatePPSK``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AutoCreatePPSK`: []PSK
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.AutoCreatePPSK`: %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 apiAutoCreatePPSKRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
ppskAutoCreateSetting | PpskAutoCreateSetting | |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateApnProfile
OperationResponseResIdOpenApiVO CreateApnProfile(ctx, omadacId, siteId).ApnProfileConfig(apnProfileConfig).Execute()
Create a new APN 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
apnProfileConfig := *openapiclient.NewApnProfileConfig(int32(123), int32(123), "Name_example", int32(123)) // ApnProfileConfig |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreateApnProfile(context.Background(), omadacId, siteId).ApnProfileConfig(apnProfileConfig).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreateApnProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateApnProfile`: OperationResponseResIdOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreateApnProfile`: %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 apiCreateApnProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
apnProfileConfig | ApnProfileConfig | |
Return type
OperationResponseResIdOpenApiVO
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateApnProfileByMac
OperationResponseResIdOpenApiVO CreateApnProfileByMac(ctx, omadacId, siteId, gatewayMac).ApnProfileConfig(apnProfileConfig).Execute()
Create a new APN profile by 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
gatewayMac := "gatewayMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
apnProfileConfig := *openapiclient.NewApnProfileConfig(int32(123), int32(123), "Name_example", int32(123)) // ApnProfileConfig |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreateApnProfileByMac(context.Background(), omadacId, siteId, gatewayMac).ApnProfileConfig(apnProfileConfig).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreateApnProfileByMac``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateApnProfileByMac`: OperationResponseResIdOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreateApnProfileByMac`: %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 | |
| gatewayMac | string | Device MAC address, like AA-BB-CC-DD-EE-FF |
Other Parameters
Other parameters are passed through a pointer to a apiCreateApnProfileByMacRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
apnProfileConfig | ApnProfileConfig | |
Return type
OperationResponseResIdOpenApiVO
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateGoogleLdapProfile
OperationResponseResIdOpenApiVO CreateGoogleLdapProfile(ctx, omadacId, siteId).Config(config).File(file).Execute()
Create a new google LDAP 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
config := *openapiclient.NewCreateGoogleLdapProfileOpenApiVO("BaseDn_example", int32(123), "Cn_example", "Name_example", int32(123), "Server_example", false) // CreateGoogleLdapProfileOpenApiVO |
file := os.NewFile(1234, "some_file") // *os.File | Google LDAP certificate file.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreateGoogleLdapProfile(context.Background(), omadacId, siteId).Config(config).File(file).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreateGoogleLdapProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateGoogleLdapProfile`: OperationResponseResIdOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreateGoogleLdapProfile`: %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 apiCreateGoogleLdapProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
config | CreateGoogleLdapProfileOpenApiVO | | file | *os.File | Google LDAP certificate file. |
Return type
OperationResponseResIdOpenApiVO
Authorization
HTTP request headers
- Content-Type: multipart/form-data
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateGroupProfile
OperationResponseResIdOpenApiVO CreateGroupProfile(ctx, omadacId, siteId).CreateGroupOpenApiVO(createGroupOpenApiVO).Execute()
Create a new group 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
createGroupOpenApiVO := *openapiclient.NewCreateGroupOpenApiVO("Name_example", int32(123)) // CreateGroupOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreateGroupProfile(context.Background(), omadacId, siteId).CreateGroupOpenApiVO(createGroupOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreateGroupProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateGroupProfile`: OperationResponseResIdOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreateGroupProfile`: %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 apiCreateGroupProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
createGroupOpenApiVO | CreateGroupOpenApiVO | |
Return type
OperationResponseResIdOpenApiVO
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateLdapProfile
OperationResponseResIdOpenApiVO CreateLdapProfile(ctx, omadacId, siteId).CreateLdapProfileOpenApiVO(createLdapProfileOpenApiVO).Execute()
Create a new LDAP 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
createLdapProfileOpenApiVO := *openapiclient.NewCreateLdapProfileOpenApiVO("BaseDn_example", int32(123), "Cn_example", int32(123), "Name_example", "Server_example", false, false) // CreateLdapProfileOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreateLdapProfile(context.Background(), omadacId, siteId).CreateLdapProfileOpenApiVO(createLdapProfileOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreateLdapProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateLdapProfile`: OperationResponseResIdOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreateLdapProfile`: %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 apiCreateLdapProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
createLdapProfileOpenApiVO | CreateLdapProfileOpenApiVO | |
Return type
OperationResponseResIdOpenApiVO
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateMdnsProfile
OperationResponseResponseIdVO CreateMdnsProfile(ctx, omadacId, siteId).BonjourServiceOpenApiVO(bonjourServiceOpenApiVO).Execute()
Create new Bonjour Service
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
bonjourServiceOpenApiVO := *openapiclient.NewBonjourServiceOpenApiVO("Name_example", []string{"ServiceIds_example"}) // BonjourServiceOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreateMdnsProfile(context.Background(), omadacId, siteId).BonjourServiceOpenApiVO(bonjourServiceOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreateMdnsProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateMdnsProfile`: OperationResponseResponseIdVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreateMdnsProfile`: %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 apiCreateMdnsProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
bonjourServiceOpenApiVO | BonjourServiceOpenApiVO | |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateOuiProfile
OperationResponseWithoutResult CreateOuiProfile(ctx, omadacId, siteId).OuiProfileOpenApiVO(ouiProfileOpenApiVO).Execute()
Create OUI 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
ouiProfileOpenApiVO := *openapiclient.NewOuiProfileOpenApiVO("Name_example") // OuiProfileOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreateOuiProfile(context.Background(), omadacId, siteId).OuiProfileOpenApiVO(ouiProfileOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreateOuiProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateOuiProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreateOuiProfile`: %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 apiCreateOuiProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
ouiProfileOpenApiVO | OuiProfileOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreatePPSKProfile
OperationResponseWithoutResult CreatePPSKProfile(ctx, omadacId, siteId).PpskProfile(ppskProfile).Execute()
Create PPSK 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
ppskProfile := *openapiclient.NewPpskProfile([]openapiclient.PpskSetting{*openapiclient.NewPpskSetting("Name_example", "Psk_example")}, "ProfileName_example") // PpskProfile |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreatePPSKProfile(context.Background(), omadacId, siteId).PpskProfile(ppskProfile).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreatePPSKProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreatePPSKProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreatePPSKProfile`: %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 apiCreatePPSKProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
ppskProfile | PpskProfile | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreatePPSKProfileV2
OperationResponseWithoutResult CreatePPSKProfileV2(ctx, omadacId, siteId).PpskProfileV2(ppskProfileV2).Execute()
Create PPSK profile V2
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
ppskProfileV2 := *openapiclient.NewPpskProfileV2(false, "ProfileName_example") // PpskProfileV2 |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreatePPSKProfileV2(context.Background(), omadacId, siteId).PpskProfileV2(ppskProfileV2).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreatePPSKProfileV2``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreatePPSKProfileV2`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreatePPSKProfileV2`: %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 apiCreatePPSKProfileV2Request struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
ppskProfileV2 | PpskProfileV2 | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateRadiusProfile
OperationResponseString CreateRadiusProfile(ctx, omadacId, siteId).CreateRadiusProfileOpenApiVO(createRadiusProfileOpenApiVO).Execute()
Create a new Radius 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
createRadiusProfileOpenApiVO := *openapiclient.NewCreateRadiusProfileOpenApiVO([]openapiclient.RadiusAuthServerOpenApiVO{*openapiclient.NewRadiusAuthServerOpenApiVO(int32(123), "RadiusPwd_example", "RadiusServerIp_example")}, "Name_example", false, false) // CreateRadiusProfileOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreateRadiusProfile(context.Background(), omadacId, siteId).CreateRadiusProfileOpenApiVO(createRadiusProfileOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreateRadiusProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateRadiusProfile`: OperationResponseString
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreateRadiusProfile`: %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 apiCreateRadiusProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
createRadiusProfileOpenApiVO | CreateRadiusProfileOpenApiVO | |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateRadiusUser
OperationResponseResIdOpenApiVO CreateRadiusUser(ctx, omadacId, siteId).CreateRadiusUserOpenApiVO(createRadiusUserOpenApiVO).Execute()
Create a new Build-in Radius profile user
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
createRadiusUserOpenApiVO := *openapiclient.NewCreateRadiusUserOpenApiVO(int32(123)) // CreateRadiusUserOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreateRadiusUser(context.Background(), omadacId, siteId).CreateRadiusUserOpenApiVO(createRadiusUserOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreateRadiusUser``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateRadiusUser`: OperationResponseResIdOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreateRadiusUser`: %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 apiCreateRadiusUserRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
createRadiusUserOpenApiVO | CreateRadiusUserOpenApiVO | |
Return type
OperationResponseResIdOpenApiVO
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateRateLimitProfile
OperationResponseWithoutResult CreateRateLimitProfile(ctx, omadacId, siteId).CreateRateLimitProfileOpenApiVO(createRateLimitProfileOpenApiVO).Execute()
Create rate limit 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
createRateLimitProfileOpenApiVO := *openapiclient.NewCreateRateLimitProfileOpenApiVO(false, "Name_example", false) // CreateRateLimitProfileOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreateRateLimitProfile(context.Background(), omadacId, siteId).CreateRateLimitProfileOpenApiVO(createRateLimitProfileOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreateRateLimitProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateRateLimitProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreateRateLimitProfile`: %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 apiCreateRateLimitProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
createRateLimitProfileOpenApiVO | CreateRateLimitProfileOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateServiceType
OperationResponseResponseIdVO CreateServiceType(ctx, omadacId, siteId).GatewayQosServiceOpenApiVO(gatewayQosServiceOpenApiVO).Execute()
Create new Gateway QoS Service
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
gatewayQosServiceOpenApiVO := *openapiclient.NewGatewayQosServiceOpenApiVO("Name_example", int32(123)) // GatewayQosServiceOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreateServiceType(context.Background(), omadacId, siteId).GatewayQosServiceOpenApiVO(gatewayQosServiceOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreateServiceType``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateServiceType`: OperationResponseResponseIdVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreateServiceType`: %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 apiCreateServiceTypeRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
gatewayQosServiceOpenApiVO | GatewayQosServiceOpenApiVO | |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateTimeRangeProfile
OperationResponseWithoutResult CreateTimeRangeProfile(ctx, omadacId, siteId).CreateTimeRangeProfileOpenApiVO(createTimeRangeProfileOpenApiVO).Execute()
Create time range 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
createTimeRangeProfileOpenApiVO := *openapiclient.NewCreateTimeRangeProfileOpenApiVO(int32(123), "Name_example", []openapiclient.ScheduleTimeOpenApiVO{*openapiclient.NewScheduleTimeOpenApiVO(int32(123), int32(123), int32(123), int32(123), int32(123))}) // CreateTimeRangeProfileOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.CreateTimeRangeProfile(context.Background(), omadacId, siteId).CreateTimeRangeProfileOpenApiVO(createTimeRangeProfileOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.CreateTimeRangeProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateTimeRangeProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.CreateTimeRangeProfile`: %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 apiCreateTimeRangeProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
createTimeRangeProfileOpenApiVO | CreateTimeRangeProfileOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteAllPPSKProfiles
OperationResponseWithoutResult DeleteAllPPSKProfiles(ctx, omadacId, siteId).Execute()
Delete All PPSK profiles
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.ProfilesAPI.DeleteAllPPSKProfiles(context.Background(), omadacId, siteId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeleteAllPPSKProfiles``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteAllPPSKProfiles`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeleteAllPPSKProfiles`: %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 apiDeleteAllPPSKProfilesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteApnProfile
OperationResponseWithoutResult DeleteApnProfile(ctx, omadacId, siteId, profileId).Execute()
Delete an exist APN 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
profileId := "profileId_example" // string | APN profile ID.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.DeleteApnProfile(context.Background(), omadacId, siteId, profileId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeleteApnProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteApnProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeleteApnProfile`: %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 | |
| profileId | string | APN profile ID. |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteApnProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteGoogleLdapProfile
OperationResponseWithoutResult DeleteGoogleLdapProfile(ctx, omadacId, siteId, profileId).Execute()
Delete an exist google LDAP 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
profileId := "profileId_example" // string | google LDAP profile ID.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.DeleteGoogleLdapProfile(context.Background(), omadacId, siteId, profileId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeleteGoogleLdapProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteGoogleLdapProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeleteGoogleLdapProfile`: %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 | |
| profileId | string | google LDAP profile ID. |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteGoogleLdapProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteGroupProfile
OperationResponseWithoutResult DeleteGroupProfile(ctx, omadacId, siteId, groupId, groupType).Execute()
Delete an exist group 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
groupId := "groupId_example" // string | Group profile id.
groupType := "groupType_example" // string | groupType
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.DeleteGroupProfile(context.Background(), omadacId, siteId, groupId, groupType).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeleteGroupProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteGroupProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeleteGroupProfile`: %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 | |
| groupId | string | Group profile id. | |
| groupType | string | groupType |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteGroupProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteLdapProfile
OperationResponseWithoutResult DeleteLdapProfile(ctx, omadacId, siteId, ldapProfileId).Execute()
Delete an exist LDAP 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
ldapProfileId := "ldapProfileId_example" // string | LDAP profile ID.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.DeleteLdapProfile(context.Background(), omadacId, siteId, ldapProfileId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeleteLdapProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteLdapProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeleteLdapProfile`: %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 | |
| ldapProfileId | string | LDAP profile ID. |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteLdapProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteMdnsProfile
OperationResponseWithoutResult DeleteMdnsProfile(ctx, omadacId, siteId, id).Execute()
Delete an existing Bonjour Service
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
id := "id_example" // string | Bonjour Service ID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.DeleteMdnsProfile(context.Background(), omadacId, siteId, id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeleteMdnsProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteMdnsProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeleteMdnsProfile`: %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 | |
| id | string | Bonjour Service ID |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteMdnsProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteOuiProfile
OperationResponseWithoutResult DeleteOuiProfile(ctx, omadacId, siteId, ouiId).Execute()
Delete OUI 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
ouiId := "ouiId_example" // string | OUI ID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.DeleteOuiProfile(context.Background(), omadacId, siteId, ouiId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeleteOuiProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteOuiProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeleteOuiProfile`: %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 | |
| ouiId | string | OUI ID |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteOuiProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeletePPSKProfile
OperationResponseWithoutResult DeletePPSKProfile(ctx, omadacId, siteId, profileId).Execute()
Delete PPSK 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
profileId := "profileId_example" // string | PPSK profile Id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.DeletePPSKProfile(context.Background(), omadacId, siteId, profileId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeletePPSKProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeletePPSKProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeletePPSKProfile`: %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 | |
| profileId | string | PPSK profile Id |
Other Parameters
Other parameters are passed through a pointer to a apiDeletePPSKProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeletePSKsToPPSKProfile
OperationResponseWithoutResult DeletePSKsToPPSKProfile(ctx, omadacId, siteId, profileId).DeletePSKsOpenApiVO(deletePSKsOpenApiVO).Execute()
Delete PSKs to PPSK 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
profileId := "profileId_example" // string | PPSK profile Id
deletePSKsOpenApiVO := *openapiclient.NewDeletePSKsOpenApiVO([]string{"PpskNameList_example"}) // DeletePSKsOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.DeletePSKsToPPSKProfile(context.Background(), omadacId, siteId, profileId).DeletePSKsOpenApiVO(deletePSKsOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeletePSKsToPPSKProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeletePSKsToPPSKProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeletePSKsToPPSKProfile`: %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 | |
| profileId | string | PPSK profile Id |
Other Parameters
Other parameters are passed through a pointer to a apiDeletePSKsToPPSKProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
deletePSKsOpenApiVO | DeletePSKsOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteRadiusProfile
OperationResponseWithoutResult DeleteRadiusProfile(ctx, omadacId, siteId, radiusProfileId).Execute()
Delete an exist Radius 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
radiusProfileId := "radiusProfileId_example" // string | Radius profile Id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.DeleteRadiusProfile(context.Background(), omadacId, siteId, radiusProfileId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeleteRadiusProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteRadiusProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeleteRadiusProfile`: %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 | |
| radiusProfileId | string | Radius profile Id |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteRadiusProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteRadiusUser
OperationResponseWithoutResult DeleteRadiusUser(ctx, omadacId, siteId, userId).Execute()
Delete an exist Build-in Radius profile user
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
userId := "userId_example" // string | Build-in Radius profile user Id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.DeleteRadiusUser(context.Background(), omadacId, siteId, userId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeleteRadiusUser``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteRadiusUser`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeleteRadiusUser`: %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 | |
| userId | string | Build-in Radius profile user Id |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteRadiusUserRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteRateLimitProfile
OperationResponseWithoutResult DeleteRateLimitProfile(ctx, omadacId, siteId, profileId).Execute()
Delete rate limit 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
profileId := "profileId_example" // string | Profile ID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.DeleteRateLimitProfile(context.Background(), omadacId, siteId, profileId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeleteRateLimitProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteRateLimitProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeleteRateLimitProfile`: %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 | |
| profileId | string | Profile ID |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteRateLimitProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteServiceType
OperationResponseWithoutResult DeleteServiceType(ctx, omadacId, siteId, id).Execute()
Delete an existing Gateway QoS Service
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
id := "id_example" // string | Gateway QoS Service ID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.DeleteServiceType(context.Background(), omadacId, siteId, id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeleteServiceType``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteServiceType`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeleteServiceType`: %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 | |
| id | string | Gateway QoS Service ID |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteServiceTypeRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteTimeRangeProfile
OperationResponseWithoutResult DeleteTimeRangeProfile(ctx, omadacId, siteId, profileId).Execute()
Delete time range 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
profileId := "profileId_example" // string | Profile ID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.DeleteTimeRangeProfile(context.Background(), omadacId, siteId, profileId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.DeleteTimeRangeProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteTimeRangeProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.DeleteTimeRangeProfile`: %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 | |
| profileId | string | Profile ID |
Other Parameters
Other parameters are passed through a pointer to a apiDeleteTimeRangeProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetApnProfileList
OperationResponseListApnProfile GetApnProfileList(ctx, omadacId, siteId).Execute()
Get APN 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
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetApnProfileList(context.Background(), omadacId, siteId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetApnProfileList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetApnProfileList`: OperationResponseListApnProfile
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetApnProfileList`: %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 apiGetApnProfileListRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseListApnProfile
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetApnProfilesForIppt
OperationResponseApnProfileData GetApnProfilesForIppt(ctx, omadacId, siteId, gatewayMac).Execute()
Get APN profile list by mac for ippt
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
gatewayMac := "gatewayMac_example" // string | Device MAC address, like AA-BB-CC-DD-EE-FF
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetApnProfilesForIppt(context.Background(), omadacId, siteId, gatewayMac).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetApnProfilesForIppt``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetApnProfilesForIppt`: OperationResponseApnProfileData
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetApnProfilesForIppt`: %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 | |
| gatewayMac | string | Device MAC address, like AA-BB-CC-DD-EE-FF |
Other Parameters
Other parameters are passed through a pointer to a apiGetApnProfilesForIpptRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseApnProfileData
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetGoogleLdapProfileList
OperationResponseListLdapProfileOpenApiVO GetGoogleLdapProfileList(ctx, omadacId, siteId).Execute()
Get google LDAP 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
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetGoogleLdapProfileList(context.Background(), omadacId, siteId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetGoogleLdapProfileList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGoogleLdapProfileList`: OperationResponseListLdapProfileOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetGoogleLdapProfileList`: %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 apiGetGoogleLdapProfileListRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseListLdapProfileOpenApiVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetGroupProfiles
OperationResponseListGroupOpenApiVO GetGroupProfiles(ctx, omadacId, siteId).Execute()
Get group 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
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetGroupProfiles(context.Background(), omadacId, siteId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetGroupProfiles``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGroupProfiles`: OperationResponseListGroupOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetGroupProfiles`: %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 apiGetGroupProfilesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseListGroupOpenApiVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetGroupProfilesByType
OperationResponseListGroupOpenApiVO GetGroupProfilesByType(ctx, omadacId, siteId, groupType).Execute()
Get group profile list by type
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
groupType := "groupType_example" // string | Type of group profile, 0:IP Group; 1:IP Port Group; 2:Mac Group; 3:IPv6 Group; 4:IPv6 Port Group; 5:Country Group; 7:Domain Group.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetGroupProfilesByType(context.Background(), omadacId, siteId, groupType).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetGroupProfilesByType``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetGroupProfilesByType`: OperationResponseListGroupOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetGroupProfilesByType`: %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 | |
| groupType | string | Type of group profile, 0:IP Group; 1:IP Port Group; 2:Mac Group; 3:IPv6 Group; 4:IPv6 Port Group; 5:Country Group; 7:Domain Group. |
Other Parameters
Other parameters are passed through a pointer to a apiGetGroupProfilesByTypeRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseListGroupOpenApiVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetLdapProfileList
OperationResponseListLdapProfileOpenApiVO GetLdapProfileList(ctx, omadacId, siteId).Execute()
Get LDAP 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
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetLdapProfileList(context.Background(), omadacId, siteId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetLdapProfileList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetLdapProfileList`: OperationResponseListLdapProfileOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetLdapProfileList`: %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 apiGetLdapProfileListRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseListLdapProfileOpenApiVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetOuiProfileFullList
OperationResponseListOuiProfileSummaryOpenApiVO GetOuiProfileFullList(ctx, omadacId, siteId).Execute()
Get OUI profile summary 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
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetOuiProfileFullList(context.Background(), omadacId, siteId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetOuiProfileFullList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetOuiProfileFullList`: OperationResponseListOuiProfileSummaryOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetOuiProfileFullList`: %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 apiGetOuiProfileFullListRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseListOuiProfileSummaryOpenApiVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetOuiProfileList
OperationResponseOuiGridVOOuiProfileQueryOpenApiVO GetOuiProfileList(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()
Get OUI profile list
Example
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)
func main() {
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.
omadacId := "omadacId_example" // string | Omada ID
siteId := "siteId_example" // string | Site ID
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetOuiProfileList(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetOuiProfileList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetOuiProfileList`: OperationResponseOuiGridVOOuiProfileQueryOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetOuiProfileList`: %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 apiGetOuiProfileListRequest 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. |
Return type
OperationResponseOuiGridVOOuiProfileQueryOpenApiVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPPSKProfileDetail
OperationResponsePPSKProfileVO GetPPSKProfileDetail(ctx, omadacId, siteId, profileId).Execute()
Get PPSK profile detail
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
profileId := "profileId_example" // string | PPSK profile Id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetPPSKProfileDetail(context.Background(), omadacId, siteId, profileId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetPPSKProfileDetail``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetPPSKProfileDetail`: OperationResponsePPSKProfileVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetPPSKProfileDetail`: %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 | |
| profileId | string | PPSK profile Id |
Other Parameters
Other parameters are passed through a pointer to a apiGetPPSKProfileDetailRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponsePPSKProfileVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPPSKProfiles
OperationResponseListPpskProfileBriefInfo GetPPSKProfiles(ctx, omadacId, siteId).Execute()
Get PPSK profiles 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
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetPPSKProfiles(context.Background(), omadacId, siteId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetPPSKProfiles``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetPPSKProfiles`: OperationResponseListPpskProfileBriefInfo
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetPPSKProfiles`: %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 apiGetPPSKProfilesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseListPpskProfileBriefInfo
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetRadiusProfileList
OperationResponseListRadiusProfileOpenApiVO GetRadiusProfileList(ctx, omadacId, siteId).Execute()
Get Radius 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
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetRadiusProfileList(context.Background(), omadacId, siteId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetRadiusProfileList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetRadiusProfileList`: OperationResponseListRadiusProfileOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetRadiusProfileList`: %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 apiGetRadiusProfileListRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseListRadiusProfileOpenApiVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetRadiusUserList
OperationResponseGridVORadiusUserOpenApiVO GetRadiusUserList(ctx, omadacId, siteId).Page(page).PageSize(pageSize).SortsUsername(sortsUsername).Execute()
Get Build-in Radius profile user 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.
sortsUsername := "sortsUsername_example" // string | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetRadiusUserList(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).SortsUsername(sortsUsername).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetRadiusUserList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetRadiusUserList`: OperationResponseGridVORadiusUserOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetRadiusUserList`: %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 apiGetRadiusUserListRequest 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. | sortsUsername | string | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
Return type
OperationResponseGridVORadiusUserOpenApiVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetRateLimitProfileList
OperationResponseListRateLimitProfileOpenApiVO GetRateLimitProfileList(ctx, omadacId, siteId).Execute()
Get rate limit 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
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetRateLimitProfileList(context.Background(), omadacId, siteId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetRateLimitProfileList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetRateLimitProfileList`: OperationResponseListRateLimitProfileOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetRateLimitProfileList`: %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 apiGetRateLimitProfileListRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseListRateLimitProfileOpenApiVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetServiceTypeSummary
OperationResponseResponseDataVOGatewayQosServiceSummaryOpenApiVO GetServiceTypeSummary(ctx, omadacId, siteId).Execute()
Get all Gateway QoS Service's ID and name 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
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetServiceTypeSummary(context.Background(), omadacId, siteId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetServiceTypeSummary``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetServiceTypeSummary`: OperationResponseResponseDataVOGatewayQosServiceSummaryOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetServiceTypeSummary`: %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 apiGetServiceTypeSummaryRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseResponseDataVOGatewayQosServiceSummaryOpenApiVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTimeRangeList
OperationResponseListTimeRangeProfileOpenApiVO GetTimeRangeList(ctx, omadacId, siteId).Execute()
Get time range 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
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.GetTimeRangeList(context.Background(), omadacId, siteId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.GetTimeRangeList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetTimeRangeList`: OperationResponseListTimeRangeProfileOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.GetTimeRangeList`: %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 apiGetTimeRangeListRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseListTimeRangeProfileOpenApiVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListMdnsProfile
OperationResponseResponseDataVOBonjourServiceDetailOpenApiVO ListMdnsProfile(ctx, omadacId, siteId).Execute()
Get Bonjour Service 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
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ListMdnsProfile(context.Background(), omadacId, siteId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ListMdnsProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListMdnsProfile`: OperationResponseResponseDataVOBonjourServiceDetailOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ListMdnsProfile`: %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 apiListMdnsProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseResponseDataVOBonjourServiceDetailOpenApiVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListRateLimitForHotspot
OperationResponseListRateLimitProfileVO ListRateLimitForHotspot(ctx, omadacId, siteId).Execute()
get the rate limit 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
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ListRateLimitForHotspot(context.Background(), omadacId, siteId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ListRateLimitForHotspot``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListRateLimitForHotspot`: OperationResponseListRateLimitProfileVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ListRateLimitForHotspot`: %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 apiListRateLimitForHotspotRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
Return type
OperationResponseListRateLimitProfileVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListServiceType
OperationResponseGridVOGatewayQosServiceDetailOpenApiVO ListServiceType(ctx, omadacId, siteId).Page(page).PageSize(pageSize).Execute()
Get Gateway QoS Service 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.ProfilesAPI.ListServiceType(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ListServiceType``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ListServiceType`: OperationResponseGridVOGatewayQosServiceDetailOpenApiVO
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ListServiceType`: %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 apiListServiceTypeRequest 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. |
Return type
OperationResponseGridVOGatewayQosServiceDetailOpenApiVO
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModifyApnProfile
OperationResponseWithoutResult ModifyApnProfile(ctx, omadacId, siteId, profileId).ApnProfileConfig(apnProfileConfig).Execute()
Modify an exist APN 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
profileId := "profileId_example" // string | APN profile ID.
apnProfileConfig := *openapiclient.NewApnProfileConfig(int32(123), int32(123), "Name_example", int32(123)) // ApnProfileConfig |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ModifyApnProfile(context.Background(), omadacId, siteId, profileId).ApnProfileConfig(apnProfileConfig).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ModifyApnProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ModifyApnProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ModifyApnProfile`: %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 | |
| profileId | string | APN profile ID. |
Other Parameters
Other parameters are passed through a pointer to a apiModifyApnProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
apnProfileConfig | ApnProfileConfig | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModifyGoogleLdapProfile
OperationResponseWithoutResult ModifyGoogleLdapProfile(ctx, omadacId, siteId, profileId).Config(config).File(file).Execute()
Modify an exist google LDAP 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
profileId := "profileId_example" // string | LDAP profile ID.
config := *openapiclient.NewCreateGoogleLdapProfileOpenApiVO("BaseDn_example", int32(123), "Cn_example", "Name_example", int32(123), "Server_example", false) // CreateGoogleLdapProfileOpenApiVO |
file := os.NewFile(1234, "some_file") // *os.File | Google LDAP certificate file. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ModifyGoogleLdapProfile(context.Background(), omadacId, siteId, profileId).Config(config).File(file).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ModifyGoogleLdapProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ModifyGoogleLdapProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ModifyGoogleLdapProfile`: %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 | |
| profileId | string | LDAP profile ID. |
Other Parameters
Other parameters are passed through a pointer to a apiModifyGoogleLdapProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
config | CreateGoogleLdapProfileOpenApiVO | | file | *os.File | Google LDAP certificate file. |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: multipart/form-data
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModifyGroupProfile
OperationResponseWithoutResult ModifyGroupProfile(ctx, omadacId, siteId, groupType, groupId).CreateGroupOpenApiVO(createGroupOpenApiVO).Execute()
Modify an exist group 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
groupType := "groupType_example" // string | Type of group profile, 0:IP Group; 1:IP Port Group; 2:Mac Group; 3:IPv6 Group; 4:IPv6 Port Group; 5:Country Group; 7:Domain Group.
groupId := "groupId_example" // string | Group profile id.
createGroupOpenApiVO := *openapiclient.NewCreateGroupOpenApiVO("Name_example", int32(123)) // CreateGroupOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ModifyGroupProfile(context.Background(), omadacId, siteId, groupType, groupId).CreateGroupOpenApiVO(createGroupOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ModifyGroupProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ModifyGroupProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ModifyGroupProfile`: %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 | |
| groupType | string | Type of group profile, 0:IP Group; 1:IP Port Group; 2:Mac Group; 3:IPv6 Group; 4:IPv6 Port Group; 5:Country Group; 7:Domain Group. | |
| groupId | string | Group profile id. |
Other Parameters
Other parameters are passed through a pointer to a apiModifyGroupProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
createGroupOpenApiVO | CreateGroupOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModifyLdapProfile
OperationResponseWithoutResult ModifyLdapProfile(ctx, omadacId, siteId, ldapProfileId).CreateLdapProfileOpenApiVO(createLdapProfileOpenApiVO).Execute()
Modify an exist LDAP 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
ldapProfileId := "ldapProfileId_example" // string | LDAP profile ID.
createLdapProfileOpenApiVO := *openapiclient.NewCreateLdapProfileOpenApiVO("BaseDn_example", int32(123), "Cn_example", int32(123), "Name_example", "Server_example", false, false) // CreateLdapProfileOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ModifyLdapProfile(context.Background(), omadacId, siteId, ldapProfileId).CreateLdapProfileOpenApiVO(createLdapProfileOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ModifyLdapProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ModifyLdapProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ModifyLdapProfile`: %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 | |
| ldapProfileId | string | LDAP profile ID. |
Other Parameters
Other parameters are passed through a pointer to a apiModifyLdapProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
createLdapProfileOpenApiVO | CreateLdapProfileOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModifyMdnsProfile
OperationResponseWithoutResult ModifyMdnsProfile(ctx, omadacId, siteId, id).BonjourServiceOpenApiVO(bonjourServiceOpenApiVO).Execute()
Modify an existing Bonjour Service
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
id := "id_example" // string | Bonjour Service ID
bonjourServiceOpenApiVO := *openapiclient.NewBonjourServiceOpenApiVO("Name_example", []string{"ServiceIds_example"}) // BonjourServiceOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ModifyMdnsProfile(context.Background(), omadacId, siteId, id).BonjourServiceOpenApiVO(bonjourServiceOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ModifyMdnsProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ModifyMdnsProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ModifyMdnsProfile`: %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 | |
| id | string | Bonjour Service ID |
Other Parameters
Other parameters are passed through a pointer to a apiModifyMdnsProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
bonjourServiceOpenApiVO | BonjourServiceOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModifyOuiProfile
OperationResponseWithoutResult ModifyOuiProfile(ctx, omadacId, siteId, ouiId).OuiProfileOpenApiVO(ouiProfileOpenApiVO).Execute()
Modify OUI 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
ouiId := "ouiId_example" // string | OUI ID
ouiProfileOpenApiVO := *openapiclient.NewOuiProfileOpenApiVO("Name_example") // OuiProfileOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ModifyOuiProfile(context.Background(), omadacId, siteId, ouiId).OuiProfileOpenApiVO(ouiProfileOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ModifyOuiProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ModifyOuiProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ModifyOuiProfile`: %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 | |
| ouiId | string | OUI ID |
Other Parameters
Other parameters are passed through a pointer to a apiModifyOuiProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
ouiProfileOpenApiVO | OuiProfileOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModifyPPSKProfile
OperationResponseWithoutResult ModifyPPSKProfile(ctx, omadacId, siteId, profileId).PpskProfile(ppskProfile).Execute()
Modify PPSK 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
profileId := "profileId_example" // string | PPSK profile Id
ppskProfile := *openapiclient.NewPpskProfile([]openapiclient.PpskSetting{*openapiclient.NewPpskSetting("Name_example", "Psk_example")}, "ProfileName_example") // PpskProfile |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ModifyPPSKProfile(context.Background(), omadacId, siteId, profileId).PpskProfile(ppskProfile).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ModifyPPSKProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ModifyPPSKProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ModifyPPSKProfile`: %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 | |
| profileId | string | PPSK profile Id |
Other Parameters
Other parameters are passed through a pointer to a apiModifyPPSKProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
ppskProfile | PpskProfile | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModifyRadiusProfile
OperationResponseWithoutResult ModifyRadiusProfile(ctx, omadacId, siteId, radiusProfileId).CreateRadiusProfileOpenApiVO(createRadiusProfileOpenApiVO).Execute()
Modify an exist Radius 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
radiusProfileId := "radiusProfileId_example" // string | Radius profile Id
createRadiusProfileOpenApiVO := *openapiclient.NewCreateRadiusProfileOpenApiVO([]openapiclient.RadiusAuthServerOpenApiVO{*openapiclient.NewRadiusAuthServerOpenApiVO(int32(123), "RadiusPwd_example", "RadiusServerIp_example")}, "Name_example", false, false) // CreateRadiusProfileOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ModifyRadiusProfile(context.Background(), omadacId, siteId, radiusProfileId).CreateRadiusProfileOpenApiVO(createRadiusProfileOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ModifyRadiusProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ModifyRadiusProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ModifyRadiusProfile`: %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 | |
| radiusProfileId | string | Radius profile Id |
Other Parameters
Other parameters are passed through a pointer to a apiModifyRadiusProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
createRadiusProfileOpenApiVO | CreateRadiusProfileOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModifyRadiusUser
OperationResponseWithoutResult ModifyRadiusUser(ctx, omadacId, siteId, userId).CreateRadiusUserOpenApiVO(createRadiusUserOpenApiVO).Execute()
Modify an exist Build-in Radius profile user
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
userId := "userId_example" // string | Build-in Radius profile user Id
createRadiusUserOpenApiVO := *openapiclient.NewCreateRadiusUserOpenApiVO(int32(123)) // CreateRadiusUserOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ModifyRadiusUser(context.Background(), omadacId, siteId, userId).CreateRadiusUserOpenApiVO(createRadiusUserOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ModifyRadiusUser``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ModifyRadiusUser`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ModifyRadiusUser`: %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 | |
| userId | string | Build-in Radius profile user Id |
Other Parameters
Other parameters are passed through a pointer to a apiModifyRadiusUserRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
createRadiusUserOpenApiVO | CreateRadiusUserOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModifyRateLimitProfile
OperationResponseWithoutResult ModifyRateLimitProfile(ctx, omadacId, siteId, profileId).UpdateRateLimitProfileOpenApiVO(updateRateLimitProfileOpenApiVO).Execute()
Modify rate limit 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
profileId := "profileId_example" // string | Profile ID
updateRateLimitProfileOpenApiVO := *openapiclient.NewUpdateRateLimitProfileOpenApiVO(false, "Name_example", false) // UpdateRateLimitProfileOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ModifyRateLimitProfile(context.Background(), omadacId, siteId, profileId).UpdateRateLimitProfileOpenApiVO(updateRateLimitProfileOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ModifyRateLimitProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ModifyRateLimitProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ModifyRateLimitProfile`: %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 | |
| profileId | string | Profile ID |
Other Parameters
Other parameters are passed through a pointer to a apiModifyRateLimitProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
updateRateLimitProfileOpenApiVO | UpdateRateLimitProfileOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModifyServiceType
OperationResponseWithoutResult ModifyServiceType(ctx, omadacId, siteId, id).GatewayQosServiceOpenApiVO(gatewayQosServiceOpenApiVO).Execute()
Modify an existing Gateway QoS Service
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
id := "id_example" // string | Gateway QoS Service ID
gatewayQosServiceOpenApiVO := *openapiclient.NewGatewayQosServiceOpenApiVO("Name_example", int32(123)) // GatewayQosServiceOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ModifyServiceType(context.Background(), omadacId, siteId, id).GatewayQosServiceOpenApiVO(gatewayQosServiceOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ModifyServiceType``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ModifyServiceType`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ModifyServiceType`: %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 | |
| id | string | Gateway QoS Service ID |
Other Parameters
Other parameters are passed through a pointer to a apiModifyServiceTypeRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
gatewayQosServiceOpenApiVO | GatewayQosServiceOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ModifyTimeRangeProfile
OperationResponseWithoutResult ModifyTimeRangeProfile(ctx, omadacId, siteId, profileId).UpdateTimeRangeProfileOpenApiVO(updateTimeRangeProfileOpenApiVO).Execute()
Modify time range 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
profileId := "profileId_example" // string | Profile ID
updateTimeRangeProfileOpenApiVO := *openapiclient.NewUpdateTimeRangeProfileOpenApiVO(int32(123), "Name_example", []openapiclient.ScheduleTimeOpenApiVO{*openapiclient.NewScheduleTimeOpenApiVO(int32(123), int32(123), int32(123), int32(123), int32(123))}) // UpdateTimeRangeProfileOpenApiVO |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ProfilesAPI.ModifyTimeRangeProfile(context.Background(), omadacId, siteId, profileId).UpdateTimeRangeProfileOpenApiVO(updateTimeRangeProfileOpenApiVO).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProfilesAPI.ModifyTimeRangeProfile``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ModifyTimeRangeProfile`: OperationResponseWithoutResult
fmt.Fprintf(os.Stdout, "Response from `ProfilesAPI.ModifyTimeRangeProfile`: %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 | |
| profileId | string | Profile ID |
Other Parameters
Other parameters are passed through a pointer to a apiModifyTimeRangeProfileRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
updateTimeRangeProfileOpenApiVO | UpdateTimeRangeProfileOpenApiVO | |
Return type
OperationResponseWithoutResult
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]