Skip to content

Latest commit

 

History

History
84 lines (69 loc) · 1.55 KB

README.md

File metadata and controls

84 lines (69 loc) · 1.55 KB
Raw

SoftEther VPN Server JSON-RPC API in Golang

This is the SoftEther VPN Server JSON-RPC API wrapper in Go. See a document for more information.

support

supported API methods

  • Test
  • GetServerInfo
  • GetServerStatus
  • CreateListener
  • EnumListener
  • DeleteListener
  • EnableListener
  • SetServerPassword
  • CreateHub
  • SetHub
  • EnumHub
  • DeleteHub
  • GetHubStatus
  • SetHubOnline
  • EnumConnection
  • DisconnectConnection
  • GetConnectionInfo
  • CreateLink
  • GetLink
  • SetLink
  • EnumLink
  • SetLinkOnline
  • SetLinkOffline
  • DeleteLink
  • CreateUser
  • SetUser
  • GetUser
  • EnumUser
  • EnableSecureNAT
  • DisableSecureNAT
  • SetSecureNATOption
  • GetSecureNATOption
  • EnumNAT
  • EnumDHCP
  • EnumEthernet
  • AddLocalBridge
  • DeleteLocalBridge
  • EnumLocalBridge
  • GetBridgeSupport

Usage

To use this package, import this package like bellow.

import softether "github.com/terassyi/go-softether-api"

First, you have to create a new Api instance.

api := softether.New("localhost", 443, "default", "password")

Second, You can create api methods you want to call. API methods are in methods package. These methods implement the Method interface. For example, to call Test method.

method := methods.NewTest()

And execute api.Call(). Then, result will return as map[string](interface{}).

res, err := api.Call(method)
	if err != nil {
		panic(err)
	}
	fmt.Println(res)

Future works

I'm making api methods as needed. Other methods will be supported.