Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inexio/eve-ng-restapi-go-client
An API client for eve-ng written in go
https://github.com/inexio/eve-ng-restapi-go-client
eve-ng golang
Last synced: 2 months ago
JSON representation
An API client for eve-ng written in go
- Host: GitHub
- URL: https://github.com/inexio/eve-ng-restapi-go-client
- Owner: inexio
- License: other
- Created: 2020-02-21T16:19:54.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-14T08:41:30.000Z (over 4 years ago)
- Last Synced: 2024-08-02T02:13:45.018Z (5 months ago)
- Topics: eve-ng, golang
- Language: Go
- Size: 178 KB
- Stars: 7
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# eve-ng-restapi-go-client
[](https://goreportcard.com/report/github.com/inexio/eve-ng-restapi-go-client)
[](https://github.com/inexio/check_eve_ng/blob/master/LICENSE)
[](https://github.com/uber-go/guide/blob/master/style.md)
[](https://godoc.org/github.com/inexio/eve-ng-restapi-go-client)
## Description
Golang package - client library for the [Eve-NG REST API](https://www.eve-ng.net/index.php/documentation/howtos/how-to-eve-ng-api/).
This client is an open-source library for communicating with Eve-NG Server applications that are written in php.
## Code Style
This project was written according to the **[uber-go](https://github.com/uber-go/guide/blob/master/style.md)** coding style.
## Features
### Full Eve-NG Support
This client allows you to create:
- Folders
- Labs
- Nodes
- Networks
- Users
and also enables you to:
- Move folders and labs
- Edit existing labs, nodes, networks and users
- Connect nodes to networks
- Start / stop nodes (single or bulk operations)
- Wipe / export node starting configurations
- Check the system status
## Requirements
Requires a running instance of Eve-NG.
Further information about Eve-NG can be found [here](https://www.eve-ng.net)
To check if your setup works, follow the steps provided in the **'Tests'** section of this document.
## Installation
```
go get github.com/inexio/eve-ng-restapi-go-client
```
or
```
git clone https://github.com/inexio/eve-ng-restapi-go-client.git
```
## Setup
After installing the library you have to either declare a path to your config file or set certain environment variables for the client to work.
These can be set as follows:
#### Config File
In the **client.go** file, in the **init()** function you can see the following lines of code:
```
viper.AddConfigPath("config/")
viper.SetConfigType("yaml")
viper.SetConfigName("eve-ng-api")
```
ConfigPath is relativ to the package location.
ConfigType and name can also be changed to match your desired type of config.
#### Environment Variables
Also in the **client.go** file, in the **init()** function you will find:
```
//Set env var prefix to only match certain vars
viper.SetEnvPrefix("eve_ng_api")
```
SetEnvPrefix can be changed to whatever prefix you prefer to have in your environment vars.
The needed environment vars can then be added as follows:
```
export EVE_NG_API_BASEURL=""
export EVE_NG_API_USERNAME=""
export EVE_NG_API_PASSWORD=""
```
## Usage
The following section will show you how to create a lab and do various operations in it.
```go
baseUrl := "https://"
username :=
password :=
eveNgClient, err := NewEveNgClient(baseUrl)
_ := eveNgClient.SetUsernameAndPassword(username, password)
_ = eveNgClient.Login()
defer func() {
_ = eveNgClient.Logout()
}()
_ = eveNgClient.AddFolder("/", "TestFolder")
labFolder := "/TestFolder" //path to the desired folder
labName := "TestLaboratory" //name of the laboratory
_ = eveNgClient.AddLab(labFolder, labName, "1", "admin", "A test laboratory", "Test laboratory for unit and integration tests")
networkID, _ = eveNgClient.AddNetwork("/TestFolder/TestLaboratory.unl", "nat0", "TestNetwork", "69", "420", 1, 0)
nodeID, _ := eveNgClient.AddNode("/TestFolder/TestLaboratory.unl", "qemu", "veos", "0", 0, "AristaSW.png", "veos-4.16.14M", "vEOS", "420", "69", "512", "telnet", 1, "undefined", 4, "", "", "", "", 1)
_ = eveNgClient.ConnectNodeInterfaceToNetwork("/TestFolder/TestLaboratory.unl", nodeID, 1, networkID)
_ = eveNgClient.StartNode("/TestFolder/TestLaboratory.unl", nodeID)
labTopology, _ := eveNgClient.GetTopology("/TestFolder/TestLaboratory.unl")
_ = eveNgClient.StartNodes("/TestFolder/TestLaboratory.unl")
```
After running the code above, the lab you just created should look like this when viewed from the web-interface
## Tests
The library comes with a few unit and integrations tests. To use these tests you have to either use a config file giving the client the correct base-url, username and password or set certain environment variables.
In order to run these test, run the follwing command inside root directory of this repository:
```
go test
```
If you want to check if your setup works, run:
```
go test -run TestEveNgClient_Nodes
```
## Getting Help
If there are any problems or something does not work as intended, open an issue on GitHub.
## Contribution
Contributions to the project are welcome.
We are looking forward to your bug reports, suggestions and fixes.
If you want to make any contributions make sure your go report does match up with our projects score of **A+**.
When you contribute make sure your code is conform to the **uber-go** coding style.
Happy Coding!