ApiOvhRouter (OVH Java SDK for OVH router 0.9.15 API)

java.lang.Object
- net.minidev.ovh.core.ApiOvhBase
- - net.minidev.ovh.api.ApiOvhRouter

```
public class ApiOvhRouter
extends ApiOvhBase
```
BasePath:https://eu.api.ovh.com/1.0 ResourcePath:/router version:1.0

Field Summary
- Fields inherited from class net.minidev.ovh.core.ApiOvhBase
  core

Constructor Summary

Constructors
Constructor and Description

ApiOvhRouter(ApiOvhCore core)

Constructors
Constructor and Description
`ApiOvhRouter(ApiOvhCore core)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ArrayList<String>`	`GET()` List available services REST: GET /router
`String`	`serviceName_confirmTermination_POST(String serviceName, OvhTerminationFutureUseEnum futureUse, OvhTerminationReasonEnum reason, String commentary, String token)` Confirm termination of your service REST: POST /router/{serviceName}/confirmTermination
`OvhRouter`	`serviceName_GET(String serviceName)` Get this object properties REST: GET /router/{serviceName}
`ArrayList<String>`	`serviceName_network_GET(String serviceName)` Networks mounted on this Router REST: GET /router/{serviceName}/network
`OvhTask`	`serviceName_network_ipNet_DELETE(String serviceName, String ipNet)` Remove this network from your router REST: DELETE /router/{serviceName}/network/{ipNet}
`OvhNetwork`	`serviceName_network_ipNet_GET(String serviceName, String ipNet)` Get this object properties REST: GET /router/{serviceName}/network/{ipNet}
`void`	`serviceName_network_ipNet_PUT(String serviceName, String ipNet, OvhNetwork body)` Alter this object properties REST: PUT /router/{serviceName}/network/{ipNet}
`OvhTask`	`serviceName_network_POST(String serviceName, Long vlanTag, String ipNet, String description)` Add a network to your router REST: POST /router/{serviceName}/network
`ArrayList<String>`	`serviceName_privateLink_GET(String serviceName)` Private links set up on this router REST: GET /router/{serviceName}/privateLink
`OvhTask`	`serviceName_privateLink_peerServiceName_DELETE(String serviceName, String peerServiceName)` Remove an existing Private Link from your Router service REST: DELETE /router/{serviceName}/privateLink/{peerServiceName}
`OvhPrivateLink`	`serviceName_privateLink_peerServiceName_GET(String serviceName, String peerServiceName)` Get this object properties REST: GET /router/{serviceName}/privateLink/{peerServiceName}
`void`	`serviceName_privateLink_peerServiceName_PUT(String serviceName, String peerServiceName, OvhPrivateLink body)` Alter this object properties REST: PUT /router/{serviceName}/privateLink/{peerServiceName}
`OvhPrivateLinkRequest`	`serviceName_privateLink_peerServiceName_request_GET(String serviceName, String peerServiceName)` Get this object properties REST: GET /router/{serviceName}/privateLink/{peerServiceName}/request
`String`	`serviceName_privateLink_peerServiceName_request_manage_POST(String serviceName, String peerServiceName, OvhPrivLinkReqActionEnum action)` Accept, reject or cancel a pending request REST: POST /router/{serviceName}/privateLink/{peerServiceName}/request/manage
`ArrayList<String>`	`serviceName_privateLink_peerServiceName_route_GET(String serviceName, String peerServiceName)` Routes set up in a Private Link REST: GET /router/{serviceName}/privateLink/{peerServiceName}/route
`OvhTask`	`serviceName_privateLink_peerServiceName_route_network_DELETE(String serviceName, String peerServiceName, String network)` Delete an existing route from your router REST: DELETE /router/{serviceName}/privateLink/{peerServiceName}/route/{network}
`OvhPrivateLinkRoute`	`serviceName_privateLink_peerServiceName_route_network_GET(String serviceName, String peerServiceName, String network)` Get this object properties REST: GET /router/{serviceName}/privateLink/{peerServiceName}/route/{network}
`OvhTask`	`serviceName_privateLink_peerServiceName_route_POST(String serviceName, String peerServiceName, String network)` Add a new outgoing route to your router REST: POST /router/{serviceName}/privateLink/{peerServiceName}/route
`String`	`serviceName_privateLink_POST(String serviceName, String peerServiceName, String name)` Add a new Private Link to your Router service REST: POST /router/{serviceName}/privateLink
`OvhService`	`serviceName_serviceInfos_GET(String serviceName)` Get this object properties REST: GET /router/{serviceName}/serviceInfos
`void`	`serviceName_serviceInfos_PUT(String serviceName, OvhService body)` Alter this object properties REST: PUT /router/{serviceName}/serviceInfos
`ArrayList<Long>`	`serviceName_task_GET(String serviceName, OvhTaskFunctionEnum function, OvhTaskStatusEnum status)` Tasks for this Router REST: GET /router/{serviceName}/task
`OvhTask`	`serviceName_task_id_GET(String serviceName, Long id)` Get this object properties REST: GET /router/{serviceName}/task/{id}
`String`	`serviceName_terminate_POST(String serviceName)` Terminate your service REST: POST /router/{serviceName}/terminate
`ArrayList<Long>`	`serviceName_vpn_GET(String serviceName)` VPN associated with this Router REST: GET /router/{serviceName}/vpn
`OvhTask`	`serviceName_vpn_id_DELETE(String serviceName, Long id)` Delete a VPN from your router REST: DELETE /router/{serviceName}/vpn/{id}
`OvhVpn`	`serviceName_vpn_id_GET(String serviceName, Long id)` Get this object properties REST: GET /router/{serviceName}/vpn/{id}
`void`	`serviceName_vpn_id_PUT(String serviceName, Long id, OvhVpn body)` Alter this object properties REST: PUT /router/{serviceName}/vpn/{id}
`OvhTask`	`serviceName_vpn_id_setPsk_POST(String serviceName, Long id, String psk)` Change your VPN's PSK REST: POST /router/{serviceName}/vpn/{id}/setPsk
`OvhVpn`	`serviceName_vpn_POST(String serviceName, String psk, String clientIp, String serverPrivNet, String clientPrivNet)` Add a VPN to your router REST: POST /router/{serviceName}/vpn

Methods inherited from class net.minidev.ovh.core.ApiOvhBase
addBody, convertTo, convertTo, exec, execN, getCore, getNic, path, query

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ApiOvhRouter
```
public ApiOvhRouter(ApiOvhCore core)
```

Method Detail

serviceName_serviceInfos_GET
```
public OvhService serviceName_serviceInfos_GET(String serviceName)
                                        throws IOException
```
Get this object properties REST: GET /router/{serviceName}/serviceInfos

Parameters:

serviceName - [required] The internal name of your Router offer

Throws:

IOException

serviceName_serviceInfos_PUT
```
public void serviceName_serviceInfos_PUT(String serviceName,
                                         OvhService body)
                                  throws IOException
```
Alter this object properties REST: PUT /router/{serviceName}/serviceInfos

Parameters:

body - [required] New object properties

serviceName - [required] The internal name of your Router offer

Throws:

IOException

serviceName_GET
```
public OvhRouter serviceName_GET(String serviceName)
                          throws IOException
```
Get this object properties REST: GET /router/{serviceName}

Parameters:

serviceName - [required] The internal name of your Router offer

Throws:

IOException

serviceName_network_GET
```
public ArrayList<String> serviceName_network_GET(String serviceName)
                                          throws IOException
```
Networks mounted on this Router REST: GET /router/{serviceName}/network

Parameters:

serviceName - [required] The internal name of your Router offer

Throws:

IOException

serviceName_network_POST

public OvhTask serviceName_network_POST(String serviceName,
                                        Long vlanTag,
                                        String ipNet,
                                        String description)
                                 throws IOException

Add a network to your router REST: POST /router/{serviceName}/network

Parameters:: vlanTag - [required] Vlan tag from range 1 to 4094 or NULL for untagged traffic; ipNet - [required] Gateway IP / CIDR Netmask, (e.g. 192.168.1.254/24); description - [required]; serviceName - [required] The internal name of your Router offer
Throws:: IOException

serviceName_network_ipNet_GET

public OvhNetwork serviceName_network_ipNet_GET(String serviceName,
                                                String ipNet)
                                         throws IOException

Get this object properties REST: GET /router/{serviceName}/network/{ipNet}

Parameters:: serviceName - [required] The internal name of your Router offer; ipNet - [required] Gateway IP / CIDR Netmask
Throws:: IOException

serviceName_network_ipNet_PUT

public void serviceName_network_ipNet_PUT(String serviceName,
                                          String ipNet,
                                          OvhNetwork body)
                                   throws IOException

Alter this object properties REST: PUT /router/{serviceName}/network/{ipNet}

Parameters:: body - [required] New object properties; serviceName - [required] The internal name of your Router offer; ipNet - [required] Gateway IP / CIDR Netmask
Throws:: IOException

serviceName_network_ipNet_DELETE
```
public OvhTask serviceName_network_ipNet_DELETE(String serviceName,
                                                String ipNet)
                                         throws IOException
```
Remove this network from your router REST: DELETE /router/{serviceName}/network/{ipNet}

Parameters:

serviceName - [required] The internal name of your Router offer

ipNet - [required] Gateway IP / CIDR Netmask

Throws:

IOException

serviceName_confirmTermination_POST

public String serviceName_confirmTermination_POST(String serviceName,
                                                  OvhTerminationFutureUseEnum futureUse,
                                                  OvhTerminationReasonEnum reason,
                                                  String commentary,
                                                  String token)
                                           throws IOException

Confirm termination of your service REST: POST /router/{serviceName}/confirmTermination

Parameters:: futureUse - What next after your termination request; reason - Reason of your termination request; commentary - Commentary about your termination request; token - [required] The termination token sent by mail to the admin contact; serviceName - [required] The internal name of your Router offer
Throws:: IOException

serviceName_terminate_POST
```
public String serviceName_terminate_POST(String serviceName)
                                  throws IOException
```
Terminate your service REST: POST /router/{serviceName}/terminate

Parameters:

serviceName - [required] The internal name of your Router offer

Throws:

IOException

serviceName_task_GET

public ArrayList<Long> serviceName_task_GET(String serviceName,
                                            OvhTaskFunctionEnum function,
                                            OvhTaskStatusEnum status)
                                     throws IOException

Tasks for this Router REST: GET /router/{serviceName}/task

Parameters:: function - [required] Filter the value of function property (=); status - [required] Filter the value of status property (=); serviceName - [required] The internal name of your Router offer
Throws:: IOException

serviceName_task_id_GET

public OvhTask serviceName_task_id_GET(String serviceName,
                                       Long id)
                                throws IOException

Get this object properties REST: GET /router/{serviceName}/task/{id}

Parameters:: serviceName - [required] The internal name of your Router offer; id - [required]
Throws:: IOException

serviceName_privateLink_GET
```
public ArrayList<String> serviceName_privateLink_GET(String serviceName)
                                              throws IOException
```
Private links set up on this router REST: GET /router/{serviceName}/privateLink

Parameters:

serviceName - [required] The internal name of your Router offer

Throws:

IOException

serviceName_privateLink_POST
```
public String serviceName_privateLink_POST(String serviceName,
                                           String peerServiceName,
                                           String name)
                                    throws IOException
```
Add a new Private Link to your Router service REST: POST /router/{serviceName}/privateLink

Parameters:

peerServiceName - [required] serviceName of the router service you want to create a private link with

name - [required] Your memory-friendly name for this private link

serviceName - [required] The internal name of your Router offer

Throws:

IOException

serviceName_privateLink_peerServiceName_request_GET

public OvhPrivateLinkRequest serviceName_privateLink_peerServiceName_request_GET(String serviceName,
                                                                                 String peerServiceName)
                                                                          throws IOException

Get this object properties REST: GET /router/{serviceName}/privateLink/{peerServiceName}/request

Parameters:: serviceName - [required] The internal name of your Router offer; peerServiceName - [required] Service name of the other side of this link
Throws:: IOException

serviceName_privateLink_peerServiceName_request_manage_POST

public String serviceName_privateLink_peerServiceName_request_manage_POST(String serviceName,
                                                                          String peerServiceName,
                                                                          OvhPrivLinkReqActionEnum action)
                                                                   throws IOException

Accept, reject or cancel a pending request REST: POST /router/{serviceName}/privateLink/{peerServiceName}/request/manage

Parameters:: action - [required]; serviceName - [required] The internal name of your Router offer; peerServiceName - [required] Service name of the other side of this link
Throws:: IOException

serviceName_privateLink_peerServiceName_GET

public OvhPrivateLink serviceName_privateLink_peerServiceName_GET(String serviceName,
                                                                  String peerServiceName)
                                                           throws IOException

Get this object properties REST: GET /router/{serviceName}/privateLink/{peerServiceName}

Parameters:: serviceName - [required] The internal name of your Router offer; peerServiceName - [required] Service name of the other side of this link
Throws:: IOException

serviceName_privateLink_peerServiceName_PUT

public void serviceName_privateLink_peerServiceName_PUT(String serviceName,
                                                        String peerServiceName,
                                                        OvhPrivateLink body)
                                                 throws IOException

Alter this object properties REST: PUT /router/{serviceName}/privateLink/{peerServiceName}

Parameters:: body - [required] New object properties; serviceName - [required] The internal name of your Router offer; peerServiceName - [required] Service name of the other side of this link
Throws:: IOException

serviceName_privateLink_peerServiceName_DELETE
```
public OvhTask serviceName_privateLink_peerServiceName_DELETE(String serviceName,
                                                              String peerServiceName)
                                                       throws IOException
```
Remove an existing Private Link from your Router service REST: DELETE /router/{serviceName}/privateLink/{peerServiceName}

Parameters:

serviceName - [required] The internal name of your Router offer

peerServiceName - [required] Service name of the other side of this link

Throws:

IOException

serviceName_privateLink_peerServiceName_route_GET

public ArrayList<String> serviceName_privateLink_peerServiceName_route_GET(String serviceName,
                                                                           String peerServiceName)
                                                                    throws IOException

Routes set up in a Private Link REST: GET /router/{serviceName}/privateLink/{peerServiceName}/route

Parameters:: serviceName - [required] The internal name of your Router offer; peerServiceName - [required] Service name of the other side of this link
Throws:: IOException

serviceName_privateLink_peerServiceName_route_POST

public OvhTask serviceName_privateLink_peerServiceName_route_POST(String serviceName,
                                                                  String peerServiceName,
                                                                  String network)
                                                           throws IOException

Add a new outgoing route to your router REST: POST /router/{serviceName}/privateLink/{peerServiceName}/route

Parameters:: network - [required] Network to be routed outside your router (CIDR format, e.g. 10.1.0.0./16; serviceName - [required] The internal name of your Router offer; peerServiceName - [required] Service name of the other side of this link
Throws:: IOException

serviceName_privateLink_peerServiceName_route_network_GET

public OvhPrivateLinkRoute serviceName_privateLink_peerServiceName_route_network_GET(String serviceName,
                                                                                     String peerServiceName,
                                                                                     String network)
                                                                              throws IOException

Get this object properties REST: GET /router/{serviceName}/privateLink/{peerServiceName}/route/{network}

Parameters:: serviceName - [required] The internal name of your Router offer; peerServiceName - [required] Service name of the other side of this link; network - [required] Network allowed to be routed outside
Throws:: IOException

serviceName_privateLink_peerServiceName_route_network_DELETE

public OvhTask serviceName_privateLink_peerServiceName_route_network_DELETE(String serviceName,
                                                                            String peerServiceName,
                                                                            String network)
                                                                     throws IOException

Delete an existing route from your router REST: DELETE /router/{serviceName}/privateLink/{peerServiceName}/route/{network}

Parameters:: serviceName - [required] The internal name of your Router offer; peerServiceName - [required] Service name of the other side of this link; network - [required] Network allowed to be routed outside
Throws:: IOException

serviceName_vpn_GET
```
public ArrayList<Long> serviceName_vpn_GET(String serviceName)
                                    throws IOException
```
VPN associated with this Router REST: GET /router/{serviceName}/vpn

Parameters:

serviceName - [required] The internal name of your Router offer

Throws:

IOException

serviceName_vpn_POST

public OvhVpn serviceName_vpn_POST(String serviceName,
                                   String psk,
                                   String clientIp,
                                   String serverPrivNet,
                                   String clientPrivNet)
                            throws IOException

Add a VPN to your router REST: POST /router/{serviceName}/vpn

Parameters:: psk - [required] Your PSK key; clientIp - [required] IP you will be connecting from / NULL (allow all); serverPrivNet - [required] Server's private network; clientPrivNet - [required] Client's private network; serviceName - [required] The internal name of your Router offer
Throws:: IOException

serviceName_vpn_id_GET

public OvhVpn serviceName_vpn_id_GET(String serviceName,
                                     Long id)
                              throws IOException

Get this object properties REST: GET /router/{serviceName}/vpn/{id}

Parameters:: serviceName - [required] The internal name of your Router offer; id - [required]
Throws:: IOException

serviceName_vpn_id_PUT

public void serviceName_vpn_id_PUT(String serviceName,
                                   Long id,
                                   OvhVpn body)
                            throws IOException

Alter this object properties REST: PUT /router/{serviceName}/vpn/{id}

Parameters:: body - [required] New object properties; serviceName - [required] The internal name of your Router offer; id - [required]
Throws:: IOException

serviceName_vpn_id_DELETE

public OvhTask serviceName_vpn_id_DELETE(String serviceName,
                                         Long id)
                                  throws IOException

Delete a VPN from your router REST: DELETE /router/{serviceName}/vpn/{id}

Parameters:: serviceName - [required] The internal name of your Router offer; id - [required]
Throws:: IOException

serviceName_vpn_id_setPsk_POST

public OvhTask serviceName_vpn_id_setPsk_POST(String serviceName,
                                              Long id,
                                              String psk)
                                       throws IOException

Change your VPN's PSK REST: POST /router/{serviceName}/vpn/{id}/setPsk

Parameters:: psk - [required] Your PSK key; serviceName - [required] The internal name of your Router offer; id - [required]
Throws:: IOException

GET

public ArrayList<String> GET()
                      throws IOException

List available services REST: GET /router

Throws:: IOException

Class ApiOvhRouter

Field Summary

Fields inherited from class net.minidev.ovh.core.ApiOvhBase

Constructor Summary

Method Summary

Methods inherited from class net.minidev.ovh.core.ApiOvhBase

Methods inherited from class java.lang.Object

Constructor Detail

ApiOvhRouter

Method Detail

serviceName_serviceInfos_GET

serviceName_serviceInfos_PUT

serviceName_GET

serviceName_network_GET