freebox_api_php/docs/services/config/VPN/Server/Server.md

64 lines
1.4 KiB
Markdown
Raw Normal View History

2016-06-11 21:29:34 +02:00
# Server
2016-06-11 23:16:01 +02:00
**Namespace** : alphayax\freebox\api\v3\services\config\VPN\Server
# Overview
- [User](Server.md#User)
2016-06-25 14:28:08 +02:00
- [IpPool](Server.md#IpPool)
- [Connection](Server.md#Connection)
- [Config](Server.md#Config)
2016-06-11 23:16:01 +02:00
2016-06-11 21:29:34 +02:00
2016-06-25 14:28:08 +02:00
<a name="User"></a>
## User
2016-06-11 21:29:34 +02:00
2016-06-25 14:28:08 +02:00
**Class** : alphayax\freebox\api\v3\services\config\VPN\Server\User
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
2016-06-25 14:28:08 +02:00
| `getAll` | Get the list of VPNUser |
| `getFromLogin` | Gets the VPNUser with the given login |
| `add` | Creates a new VPNUser |
| `delete` | Deletes the VPNUser |
| `deleteFromLogin` | Deletes the VPNUser with the given id |
| `update` | Update a VPN Use |
| `getConfigurationFile` | Generate a new configuration file & download it |
2016-06-11 21:29:34 +02:00
2016-06-25 14:28:08 +02:00
<a name="IpPool"></a>
## IpPool
2016-06-11 21:29:34 +02:00
2016-06-25 14:28:08 +02:00
**Class** : alphayax\freebox\api\v3\services\config\VPN\Server\IpPool
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
2016-06-25 14:28:08 +02:00
| `getReservations` | Get the VPN server IP pool reservations |
2016-06-11 21:29:34 +02:00
2016-06-25 14:28:08 +02:00
<a name="Connection"></a>
## Connection
2016-06-11 21:29:34 +02:00
2016-06-25 14:28:08 +02:00
**Class** : alphayax\freebox\api\v3\services\config\VPN\Server\Connection
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
2016-06-25 14:28:08 +02:00
| `getAll` | Get the list of connections |
| `closeFromId` | Close a given connection |
2016-06-11 21:29:34 +02:00
2016-06-25 14:28:08 +02:00
<a name="Config"></a>
## Config
2016-06-11 21:29:34 +02:00
2016-06-25 14:28:08 +02:00
**Class** : alphayax\freebox\api\v3\services\config\VPN\Server\Config
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
2016-06-25 14:28:08 +02:00
| `getConfigurationFromId` | Get a VPN config |
| `setConfiguration` | Update the VPN configuration |