net.minidev.ovh.api

Class ApiOvhVps

java.lang.Object

net.minidev.ovh.core.ApiOvhBase

net.minidev.ovh.api.ApiOvhVps

public class ApiOvhVps
extends ApiOvhBase

BasePath:https://eu.api.ovh.com/1.0 ResourcePath:/vps version:1.0

Field Summary

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

core

Constructor Summary

Constructors

Constructor and Description
ApiOvhVps(ApiOvhCore core)

Method Summary

Modifier and Type	Method and Description
ArrayList<String>	datacenter_GET(OvhCountryEnum country) List all the datacenters for a specific country REST: GET /vps/datacenter
ArrayList<String>	GET() List available services REST: GET /vps
ArrayList<OvhVpsOptionEnum>	serviceName_activeOptions_GET(String serviceName) Deprecated.
ArrayList<OvhAttached>	serviceName_automatedBackup_attachedBackup_GET(String serviceName) Backup attached to your VPS REST: GET /vps/{serviceName}/automatedBackup/attachedBackup
OvhTask	serviceName_automatedBackup_detachBackup_POST(String serviceName, Date restorePoint) Create a VPS.Task that will umount a restored backup on your VPS REST: POST /vps/{serviceName}/automatedBackup/detachBackup
OvhAutomatedBackup	serviceName_automatedBackup_GET(String serviceName) Get this object properties REST: GET /vps/{serviceName}/automatedBackup
OvhTask	serviceName_automatedBackup_restore_POST(String serviceName, Boolean changePassword, Date restorePoint, OvhRestoreTypeEnum type) Creates a VPS.Task that will restore the given restorePoint REST: POST /vps/{serviceName}/automatedBackup/restore
ArrayList<Date>	serviceName_automatedBackup_restorePoints_GET(String serviceName, OvhRestoreStateEnum state) Get available Restore Points REST: GET /vps/{serviceName}/automatedBackup/restorePoints
ArrayList<OvhModel>	serviceName_availableUpgrade_GET(String serviceName) Return all models the virtual server can be upgraded to REST: GET /vps/{serviceName}/availableUpgrade
ArrayList<String>	serviceName_backupftp_access_GET(String serviceName) List of IP blocks (and protocols to allow on these blocks) authorized on your backup FTP REST: GET /vps/{serviceName}/backupftp/access
OvhTask	serviceName_backupftp_access_ipBlock_DELETE(String serviceName, String ipBlock) Revoke this ACL REST: DELETE /vps/{serviceName}/backupftp/access/{ipBlock}
OvhBackupFtpAcl	serviceName_backupftp_access_ipBlock_GET(String serviceName, String ipBlock) Get this object properties REST: GET /vps/{serviceName}/backupftp/access/{ipBlock}
void	serviceName_backupftp_access_ipBlock_PUT(String serviceName, String ipBlock, OvhBackupFtpAcl body) Alter this object properties REST: PUT /vps/{serviceName}/backupftp/access/{ipBlock}
OvhTask	serviceName_backupftp_access_POST(String serviceName, Boolean cifs, Boolean ftp, String ipBlock, Boolean nfs) Create a new Backup FTP ACL REST: POST /vps/{serviceName}/backupftp/access
ArrayList<String>	serviceName_backupftp_authorizableBlocks_GET(String serviceName) Get all IP blocks that can be used in the ACL REST: GET /vps/{serviceName}/backupftp/authorizableBlocks
OvhBackupFtp	serviceName_backupftp_GET(String serviceName) Get this object properties REST: GET /vps/{serviceName}/backupftp
OvhTask	serviceName_backupftp_password_POST(String serviceName) Change your Backup FTP password REST: POST /vps/{serviceName}/backupftp/password
ArrayList<Long>	serviceName_changeContact_POST(String serviceName, String contactAdmin, String contactBilling, String contactTech) Launch a contact change procedure REST: POST /vps/{serviceName}/changeContact
String	serviceName_confirmTermination_POST(String serviceName, String commentary, OvhTerminationFutureUseEnum futureUse, OvhTerminationReasonEnum reason, String token) Confirm termination of your service REST: POST /vps/{serviceName}/confirmTermination
OvhTask	serviceName_createSnapshot_POST(String serviceName, String description) Create a snapshot of the Virtual Server if the snapshot option is enabled and if there is no existing snapshot REST: POST /vps/{serviceName}/createSnapshot
OvhDatacenter	serviceName_datacenter_GET(String serviceName) Get this object properties REST: GET /vps/{serviceName}/datacenter
ArrayList<Long>	serviceName_disks_GET(String serviceName) Disks associated to this virtual server REST: GET /vps/{serviceName}/disks
OvhDisk	serviceName_disks_id_GET(String serviceName, Long id) Get this object properties REST: GET /vps/{serviceName}/disks/{id}
OvhUnitAndValues<OvhVpsTimestampValue>	serviceName_disks_id_monitoring_GET(String serviceName, Long id, OvhVpsMonitoringPeriodEnum period, OvhStatisticTypeEnum type) Return many statistics about the disk for a given period REST: GET /vps/{serviceName}/disks/{id}/monitoring
void	serviceName_disks_id_PUT(String serviceName, Long id, OvhDisk body) Alter this object properties REST: PUT /vps/{serviceName}/disks/{id}
OvhUnitAndValue<Double>	serviceName_disks_id_use_GET(String serviceName, Long id, OvhStatisticTypeEnum type) Return many statistics about the disk at that time REST: GET /vps/{serviceName}/disks/{id}/use
OvhTemplate	serviceName_distribution_GET(String serviceName) Get this object properties REST: GET /vps/{serviceName}/distribution
ArrayList<Long>	serviceName_distribution_software_GET(String serviceName) List available softwares for this template Id REST: GET /vps/{serviceName}/distribution/software
OvhSoftware	serviceName_distribution_software_softwareId_GET(String serviceName, Long softwareId) Get this object properties REST: GET /vps/{serviceName}/distribution/software/{softwareId}
OvhVPS	serviceName_GET(String serviceName) Get this object properties REST: GET /vps/{serviceName}
String	serviceName_getConsoleUrl_POST(String serviceName) Return the VPS console URL REST: POST /vps/{serviceName}/getConsoleUrl
ArrayList<OvhGeolocationEnum>	serviceName_ipCountryAvailable_GET(String serviceName) Get the countries you can select for your IPs geolocation REST: GET /vps/{serviceName}/ipCountryAvailable
ArrayList<String>	serviceName_ips_GET(String serviceName) Ips associated to this virtual server REST: GET /vps/{serviceName}/ips
void	serviceName_ips_ipAddress_DELETE(String serviceName, String ipAddress) Release a given Ip (Additional Ip) REST: DELETE /vps/{serviceName}/ips/{ipAddress}
OvhIp	serviceName_ips_ipAddress_GET(String serviceName, String ipAddress) Get this object properties REST: GET /vps/{serviceName}/ips/{ipAddress}
void	serviceName_ips_ipAddress_PUT(String serviceName, String ipAddress, OvhIp body) Alter this object properties REST: PUT /vps/{serviceName}/ips/{ipAddress}
ArrayList<OvhModel>	serviceName_models_GET(String serviceName) Return all models for the range of the virtual server REST: GET /vps/{serviceName}/models
OvhUnitAndValues<OvhVpsTimestampValue>	serviceName_monitoring_GET(String serviceName, OvhVpsMonitoringPeriodEnum period, OvhVpsStatisticTypeEnum type) Return many statistics about the virtual machine for a given period REST: GET /vps/{serviceName}/monitoring
OvhVnc	serviceName_openConsoleAccess_POST(String serviceName, OvhVncProtocolEnum protocol) Return the necessary informations to open a VNC connection to your VPS REST: POST /vps/{serviceName}/openConsoleAccess
ArrayList<OvhVpsOptionEnum>	serviceName_option_GET(String serviceName) List of VPS options REST: GET /vps/{serviceName}/option
void	serviceName_option_option_DELETE(String serviceName, OvhVpsOptionEnum option) Release a given option REST: DELETE /vps/{serviceName}/option/{option}
OvhOption	serviceName_option_option_GET(String serviceName, OvhVpsOptionEnum option) Get this object properties REST: GET /vps/{serviceName}/option/{option}
void	serviceName_PUT(String serviceName, OvhVPS body) Alter this object properties REST: PUT /vps/{serviceName}
OvhTask	serviceName_reboot_POST(String serviceName) Request a reboot of the machine REST: POST /vps/{serviceName}/reboot
OvhTask	serviceName_reinstall_POST(String serviceName, Boolean doNotSendPassword, String language, Long[] softwareId, String[] sshKey, Long templateId) Reinstall the virtual server REST: POST /vps/{serviceName}/reinstall
void	serviceName_secondaryDnsDomains_domain_DELETE(String serviceName, String domain) remove this domain REST: DELETE /vps/{serviceName}/secondaryDnsDomains/{domain}
OvhSecondaryDNSNameServer	serviceName_secondaryDnsDomains_domain_dnsServer_GET(String serviceName, String domain) domain name server informations REST: GET /vps/{serviceName}/secondaryDnsDomains/{domain}/dnsServer
OvhSecondaryDNS	serviceName_secondaryDnsDomains_domain_GET(String serviceName, String domain) Get this object properties REST: GET /vps/{serviceName}/secondaryDnsDomains/{domain}
void	serviceName_secondaryDnsDomains_domain_PUT(String serviceName, String domain, OvhSecondaryDNS body) Alter this object properties REST: PUT /vps/{serviceName}/secondaryDnsDomains/{domain}
ArrayList<String>	serviceName_secondaryDnsDomains_GET(String serviceName) List of secondary dns domain name REST: GET /vps/{serviceName}/secondaryDnsDomains
void	serviceName_secondaryDnsDomains_POST(String serviceName, String domain, String ip) add a domain on secondary dns REST: POST /vps/{serviceName}/secondaryDnsDomains
OvhSecondaryDNSNameServer	serviceName_secondaryDnsNameServerAvailable_GET(String serviceName) Secondary nameServer available for your Server REST: GET /vps/{serviceName}/secondaryDnsNameServerAvailable
OvhService	serviceName_serviceInfos_GET(String serviceName) Get this object properties REST: GET /vps/{serviceName}/serviceInfos
void	serviceName_serviceInfos_PUT(String serviceName, OvhService body) Alter this object properties REST: PUT /vps/{serviceName}/serviceInfos
OvhTask	serviceName_setPassword_POST(String serviceName) Start the process in order to set the root password of the virtual machine.
OvhTask	serviceName_snapshot_DELETE(String serviceName) Creates a vps.Task that will delete the Snapshot REST: DELETE /vps/{serviceName}/snapshot
OvhSnapshot	serviceName_snapshot_GET(String serviceName) Get this object properties REST: GET /vps/{serviceName}/snapshot
void	serviceName_snapshot_PUT(String serviceName, OvhSnapshot body) Alter this object properties REST: PUT /vps/{serviceName}/snapshot
OvhTask	serviceName_snapshot_revert_POST(String serviceName) Revert the Virtual Server to this snapshot REST: POST /vps/{serviceName}/snapshot/revert
OvhTask	serviceName_start_POST(String serviceName) Request the machine to start REST: POST /vps/{serviceName}/start
OvhServiceStatus	serviceName_status_GET(String serviceName) Give the status of the services of the main IP REST: GET /vps/{serviceName}/status
OvhTask	serviceName_stop_POST(String serviceName) Request the machine to stop REST: POST /vps/{serviceName}/stop
ArrayList<Long>	serviceName_tasks_GET(String serviceName, OvhTaskStateEnum state, OvhTaskTypeEnum type) Tasks associated to this virtual server REST: GET /vps/{serviceName}/tasks
OvhTask	serviceName_tasks_id_GET(String serviceName, Long id) Get this object properties REST: GET /vps/{serviceName}/tasks/{id}
ArrayList<Long>	serviceName_templates_GET(String serviceName) Templates available for this virtual server REST: GET /vps/{serviceName}/templates
OvhTemplate	serviceName_templates_id_GET(String serviceName, Long id) Get this object properties REST: GET /vps/{serviceName}/templates/{id}
ArrayList<Long>	serviceName_templates_id_software_GET(String serviceName, Long id) List available softwares for this template Id REST: GET /vps/{serviceName}/templates/{id}/software
OvhSoftware	serviceName_templates_id_software_softwareId_GET(String serviceName, Long id, Long softwareId) Get this object properties REST: GET /vps/{serviceName}/templates/{id}/software/{softwareId}
String	serviceName_terminate_POST(String serviceName) Terminate your service REST: POST /vps/{serviceName}/terminate
OvhUnitAndValue<Double>	serviceName_use_GET(String serviceName, OvhVpsStatisticTypeEnum type) Return many statistics about the virtual machine at that time REST: GET /vps/{serviceName}/use
OvhVeeam	serviceName_veeam_GET(String serviceName) Get this object properties REST: GET /vps/{serviceName}/veeam
OvhTask	serviceName_veeam_restoredBackup_DELETE(String serviceName) Creates a VPS.Task that will unmount the backup REST: DELETE /vps/{serviceName}/veeam/restoredBackup
OvhRestoredBackup	serviceName_veeam_restoredBackup_GET(String serviceName) Get this object properties REST: GET /vps/{serviceName}/veeam/restoredBackup
ArrayList<Long>	serviceName_veeam_restorePoints_GET(String serviceName, Date creationTime) Veeam restore points for the VPS REST: GET /vps/{serviceName}/veeam/restorePoints
OvhRestorePoint	serviceName_veeam_restorePoints_id_GET(String serviceName, Long id) Get this object properties REST: GET /vps/{serviceName}/veeam/restorePoints/{id}
OvhTask	serviceName_veeam_restorePoints_id_restore_POST(String serviceName, Long id, Boolean changePassword, OvhExportTypeEnum export, Boolean full) Creates a VPS.Task that will restore the given restorePoint REST: POST /vps/{serviceName}/veeam/restorePoints/{id}/restore

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

ApiOvhVps

public ApiOvhVps(ApiOvhCore core)

Method Detail

datacenter_GET

public ArrayList<String> datacenter_GET(OvhCountryEnum country)
                                 throws IOException

List all the datacenters for a specific country REST: GET /vps/datacenter

Parameters:

country - [required] Country targeted

Throws:

IOException

serviceName_veeam_GET

public OvhVeeam serviceName_veeam_GET(String serviceName)
                               throws IOException

Get this object properties REST: GET /vps/{serviceName}/veeam

Parameters:

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

Throws:

IOException

serviceName_veeam_restoredBackup_GET

public OvhRestoredBackup serviceName_veeam_restoredBackup_GET(String serviceName)
                                                       throws IOException

Get this object properties REST: GET /vps/{serviceName}/veeam/restoredBackup

Parameters:

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

Throws:

IOException

serviceName_veeam_restoredBackup_DELETE

public OvhTask serviceName_veeam_restoredBackup_DELETE(String serviceName)
                                                throws IOException

Creates a VPS.Task that will unmount the backup REST: DELETE /vps/{serviceName}/veeam/restoredBackup

Parameters:

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

Throws:

IOException

serviceName_veeam_restorePoints_id_GET

public OvhRestorePoint serviceName_veeam_restorePoints_id_GET(String serviceName,
                                                              Long id)
                                                       throws IOException

Get this object properties REST: GET /vps/{serviceName}/veeam/restorePoints/{id}

Parameters:

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

id - [required] Id of the object

Throws:

IOException

serviceName_veeam_restorePoints_id_restore_POST

public OvhTask serviceName_veeam_restorePoints_id_restore_POST(String serviceName,
                                                               Long id,
                                                               Boolean changePassword,
                                                               OvhExportTypeEnum export,
                                                               Boolean full)
                                                        throws IOException

Creates a VPS.Task that will restore the given restorePoint REST: POST /vps/{serviceName}/veeam/restorePoints/{id}/restore

Parameters:

export - [required] (Except full) The export method for your restore - defaults to both

changePassword - [required] (Full only) Change the restored VPS root password when done

full - [required] Replace your current VPS by the restorePoint

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

id - [required] Id of the object

Throws:

IOException

serviceName_veeam_restorePoints_GET

public ArrayList<Long> serviceName_veeam_restorePoints_GET(String serviceName,
                                                           Date creationTime)
                                                    throws IOException

Veeam restore points for the VPS REST: GET /vps/{serviceName}/veeam/restorePoints

Parameters:

creationTime - [required] Filter the value of creationTime property (like)

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

Throws:

IOException

serviceName_serviceInfos_GET

public OvhService serviceName_serviceInfos_GET(String serviceName)
                                        throws IOException

Get this object properties REST: GET /vps/{serviceName}/serviceInfos

Parameters:

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

Throws:

IOException

serviceName_serviceInfos_PUT

public void serviceName_serviceInfos_PUT(String serviceName,
                                         OvhService body)
                                  throws IOException

Alter this object properties REST: PUT /vps/{serviceName}/serviceInfos

Parameters:

body - [required] New object properties

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

Throws:

IOException

serviceName_setPassword_POST

public OvhTask serviceName_setPassword_POST(String serviceName)
                                     throws IOException

Start the process in order to set the root password of the virtual machine. Be careful, in case of Cloud model, a reboot is mandatory. REST: POST /vps/{serviceName}/setPassword

Parameters:

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

Throws:

IOException

serviceName_reinstall_POST

public OvhTask serviceName_reinstall_POST(String serviceName,
                                          Boolean doNotSendPassword,
                                          String language,
                                          Long[] softwareId,
                                          String[] sshKey,
                                          Long templateId)
                                   throws IOException

Reinstall the virtual server REST: POST /vps/{serviceName}/reinstall

Parameters:

softwareId - [required] Id of the vps.Software type fetched in /template/{id}/software

language - [required] Distribution language. default : en

doNotSendPassword - [required] If asked, the installation password will NOT be sent (only if sshKey defined)

templateId - [required] Id of the vps.Template fetched in /templates list

sshKey - [required] SSH key names to pre-install on your VPS (name from /me/sshKey)

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

Throws:

IOException

serviceName_reboot_POST

public OvhTask serviceName_reboot_POST(String serviceName)
                                throws IOException

Request a reboot of the machine REST: POST /vps/{serviceName}/reboot

Parameters:

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

Throws:

IOException

serviceName_snapshot_revert_POST

public OvhTask serviceName_snapshot_revert_POST(String serviceName)
                                         throws IOException

Revert the Virtual Server to this snapshot REST: POST /vps/{serviceName}/snapshot/revert

Parameters:

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

Throws:

IOException

serviceName_snapshot_GET

public OvhSnapshot serviceName_snapshot_GET(String serviceName)
                                     throws IOException

Get this object properties REST: GET /vps/{serviceName}/snapshot

Parameters:

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

Throws:

IOException

serviceName_snapshot_PUT

public void serviceName_snapshot_PUT(String serviceName,
                                     OvhSnapshot body)
                              throws IOException

Alter this object properties REST: PUT /vps/{serviceName}/snapshot

Parameters:

body - [required] New object properties

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

Throws:

IOException

serviceName_snapshot_DELETE

public OvhTask serviceName_snapshot_DELETE(String serviceName)
                                    throws IOException

Creates a vps.Task that will delete the Snapshot REST: DELETE /vps/{serviceName}/snapshot

Parameters:

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

Throws:

IOException

serviceName_start_POST

public OvhTask serviceName_start_POST(String serviceName)
                               throws IOException

Request the machine to start REST: POST /vps/{serviceName}/start

Parameters:

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

Throws:

IOException

serviceName_secondaryDnsNameServerAvailable_GET

public OvhSecondaryDNSNameServer serviceName_secondaryDnsNameServerAvailable_GET(String serviceName)
                                                                          throws IOException

Secondary nameServer available for your Server REST: GET /vps/{serviceName}/secondaryDnsNameServerAvailable

Parameters:

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

Throws:

IOException

serviceName_backupftp_authorizableBlocks_GET

public ArrayList<String> serviceName_backupftp_authorizableBlocks_GET(String serviceName)
                                                               throws IOException

Get all IP blocks that can be used in the ACL REST: GET /vps/{serviceName}/backupftp/authorizableBlocks

Parameters:

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

Throws:

IOException

serviceName_backupftp_GET

public OvhBackupFtp serviceName_backupftp_GET(String serviceName)
                                       throws IOException

Get this object properties REST: GET /vps/{serviceName}/backupftp

Parameters:

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

Throws:

IOException

serviceName_backupftp_access_GET

public ArrayList<String> serviceName_backupftp_access_GET(String serviceName)
                                                   throws IOException

List of IP blocks (and protocols to allow on these blocks) authorized on your backup FTP REST: GET /vps/{serviceName}/backupftp/access

Parameters:

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

Throws:

IOException

serviceName_backupftp_access_POST

public OvhTask serviceName_backupftp_access_POST(String serviceName,
                                                 Boolean cifs,
                                                 Boolean ftp,
                                                 String ipBlock,
                                                 Boolean nfs)
                                          throws IOException

Create a new Backup FTP ACL REST: POST /vps/{serviceName}/backupftp/access

Parameters:

cifs - [required] Wether to allow the CIFS (SMB) protocol for this ACL

ftp - [required] Wether to allow the FTP protocol for this ACL

nfs - [required] Wether to allow the NFS protocol for this ACL

ipBlock - [required] The IP Block specific to this ACL. It musts belong to your server.

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

Throws:

IOException

serviceName_backupftp_access_ipBlock_GET

public OvhBackupFtpAcl serviceName_backupftp_access_ipBlock_GET(String serviceName,
                                                                String ipBlock)
                                                         throws IOException

Get this object properties REST: GET /vps/{serviceName}/backupftp/access/{ipBlock}

Parameters:

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

ipBlock - [required] The IP Block specific to this ACL

Throws:

IOException

serviceName_backupftp_access_ipBlock_PUT

public void serviceName_backupftp_access_ipBlock_PUT(String serviceName,
                                                     String ipBlock,
                                                     OvhBackupFtpAcl body)
                                              throws IOException

Alter this object properties REST: PUT /vps/{serviceName}/backupftp/access/{ipBlock}

Parameters:

body - [required] New object properties

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

ipBlock - [required] The IP Block specific to this ACL

Throws:

IOException

serviceName_backupftp_access_ipBlock_DELETE

public OvhTask serviceName_backupftp_access_ipBlock_DELETE(String serviceName,
                                                           String ipBlock)
                                                    throws IOException

Revoke this ACL REST: DELETE /vps/{serviceName}/backupftp/access/{ipBlock}

Parameters:

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

ipBlock - [required] The IP Block specific to this ACL

Throws:

IOException

serviceName_backupftp_password_POST

public OvhTask serviceName_backupftp_password_POST(String serviceName)
                                            throws IOException

Change your Backup FTP password REST: POST /vps/{serviceName}/backupftp/password

Parameters:

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

Throws:

IOException

serviceName_createSnapshot_POST

public OvhTask serviceName_createSnapshot_POST(String serviceName,
                                               String description)
                                        throws IOException

Create a snapshot of the Virtual Server if the snapshot option is enabled and if there is no existing snapshot REST: POST /vps/{serviceName}/createSnapshot

Parameters:

description - [required] A textual description for your snapshot

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

Throws:

IOException

serviceName_datacenter_GET

public OvhDatacenter serviceName_datacenter_GET(String serviceName)
                                         throws IOException

Get this object properties REST: GET /vps/{serviceName}/datacenter

Parameters:

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

Throws:

IOException

serviceName_use_GET

public OvhUnitAndValue<Double> serviceName_use_GET(String serviceName,
                                                   OvhVpsStatisticTypeEnum type)
                                            throws IOException

Return many statistics about the virtual machine at that time REST: GET /vps/{serviceName}/use

Parameters:

type - [required] The type of statistic to be fetched

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

Throws:

IOException

serviceName_automatedBackup_attachedBackup_GET

public ArrayList<OvhAttached> serviceName_automatedBackup_attachedBackup_GET(String serviceName)
                                                                      throws IOException

Backup attached to your VPS REST: GET /vps/{serviceName}/automatedBackup/attachedBackup

Parameters:

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

Throws:

IOException

serviceName_automatedBackup_detachBackup_POST

public OvhTask serviceName_automatedBackup_detachBackup_POST(String serviceName,
                                                             Date restorePoint)
                                                      throws IOException

Create a VPS.Task that will umount a restored backup on your VPS REST: POST /vps/{serviceName}/automatedBackup/detachBackup

Parameters:

restorePoint - [required] restorePoint fetched in /vps/{serviceName}/automatedBackup/attachedBackup

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

Throws:

IOException

serviceName_automatedBackup_restorePoints_GET

public ArrayList<Date> serviceName_automatedBackup_restorePoints_GET(String serviceName,
                                                                     OvhRestoreStateEnum state)
                                                              throws IOException

Get available Restore Points REST: GET /vps/{serviceName}/automatedBackup/restorePoints

Parameters:

state - [required] The state of the restore point

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

Throws:

IOException

serviceName_automatedBackup_restore_POST

public OvhTask serviceName_automatedBackup_restore_POST(String serviceName,
                                                        Boolean changePassword,
                                                        Date restorePoint,
                                                        OvhRestoreTypeEnum type)
                                                 throws IOException

Creates a VPS.Task that will restore the given restorePoint REST: POST /vps/{serviceName}/automatedBackup/restore

Parameters:

type - [required] [default=file] file: Attach/export restored disk to your current VPS - full: Replace your current VPS by the given restorePoint

restorePoint - [required] Restore Point fetched in /automatedBackup/restorePoints

changePassword - [required] [default=0] Only with restore full on VPS Cloud 2014

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

Throws:

IOException

serviceName_automatedBackup_GET

public OvhAutomatedBackup serviceName_automatedBackup_GET(String serviceName)
                                                   throws IOException

Get this object properties REST: GET /vps/{serviceName}/automatedBackup

Parameters:

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

Throws:

IOException

serviceName_openConsoleAccess_POST

public OvhVnc serviceName_openConsoleAccess_POST(String serviceName,
                                                 OvhVncProtocolEnum protocol)
                                          throws IOException

Return the necessary informations to open a VNC connection to your VPS REST: POST /vps/{serviceName}/openConsoleAccess

Parameters:

protocol - [required] The console protocol you want

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

Throws:

IOException

serviceName_tasks_GET

public ArrayList<Long> serviceName_tasks_GET(String serviceName,
                                             OvhTaskStateEnum state,
                                             OvhTaskTypeEnum type)
                                      throws IOException

Tasks associated to this virtual server REST: GET /vps/{serviceName}/tasks

Parameters:

type - [required] Filter the value of type property (=)

state - [required] Filter the value of state property (=)

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

Throws:

IOException

serviceName_tasks_id_GET

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

Get this object properties REST: GET /vps/{serviceName}/tasks/{id}

Parameters:

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

id - [required] Id of the object

Throws:

IOException

serviceName_disks_GET

public ArrayList<Long> serviceName_disks_GET(String serviceName)
                                      throws IOException

Disks associated to this virtual server REST: GET /vps/{serviceName}/disks

Parameters:

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

Throws:

IOException

serviceName_disks_id_use_GET

public OvhUnitAndValue<Double> serviceName_disks_id_use_GET(String serviceName,
                                                            Long id,
                                                            OvhStatisticTypeEnum type)
                                                     throws IOException

Return many statistics about the disk at that time REST: GET /vps/{serviceName}/disks/{id}/use

Parameters:

type - [required] The type of statistic to be fetched

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

id - [required] Id of the object

Throws:

IOException

serviceName_disks_id_GET

public OvhDisk serviceName_disks_id_GET(String serviceName,
                                        Long id)
                                 throws IOException

Get this object properties REST: GET /vps/{serviceName}/disks/{id}

Parameters:

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

id - [required] Id of the object

Throws:

IOException

serviceName_disks_id_PUT

public void serviceName_disks_id_PUT(String serviceName,
                                     Long id,
                                     OvhDisk body)
                              throws IOException

Alter this object properties REST: PUT /vps/{serviceName}/disks/{id}

Parameters:

body - [required] New object properties

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

id - [required] Id of the object

Throws:

IOException

serviceName_disks_id_monitoring_GET

public OvhUnitAndValues<OvhVpsTimestampValue> serviceName_disks_id_monitoring_GET(String serviceName,
                                                                                  Long id,
                                                                                  OvhVpsMonitoringPeriodEnum period,
                                                                                  OvhStatisticTypeEnum type)
                                                                           throws IOException

Return many statistics about the disk for a given period REST: GET /vps/{serviceName}/disks/{id}/monitoring

Parameters:

period - [required] The period the statistics are fetched for

type - [required] The type of statistic to be fetched

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

id - [required] Id of the object

Throws:

IOException

serviceName_GET

public OvhVPS serviceName_GET(String serviceName)
                       throws IOException

Get this object properties REST: GET /vps/{serviceName}

Parameters:

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

Throws:

IOException

serviceName_PUT

public void serviceName_PUT(String serviceName,
                            OvhVPS body)
                     throws IOException

Alter this object properties REST: PUT /vps/{serviceName}

Parameters:

body - [required] New object properties

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

Throws:

IOException

serviceName_monitoring_GET

public OvhUnitAndValues<OvhVpsTimestampValue> serviceName_monitoring_GET(String serviceName,
                                                                         OvhVpsMonitoringPeriodEnum period,
                                                                         OvhVpsStatisticTypeEnum type)
                                                                  throws IOException

Return many statistics about the virtual machine for a given period REST: GET /vps/{serviceName}/monitoring

Parameters:

type - [required] The type of statistic to be fetched

period - [required] The period the statistics are fetched for

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

Throws:

IOException

serviceName_terminate_POST

public String serviceName_terminate_POST(String serviceName)
                                  throws IOException

Terminate your service REST: POST /vps/{serviceName}/terminate

Parameters:

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

Throws:

IOException

serviceName_option_option_GET

public OvhOption serviceName_option_option_GET(String serviceName,
                                               OvhVpsOptionEnum option)
                                        throws IOException

Get this object properties REST: GET /vps/{serviceName}/option/{option}

Parameters:

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

option - [required] The option name

Throws:

IOException

serviceName_option_option_DELETE

public void serviceName_option_option_DELETE(String serviceName,
                                             OvhVpsOptionEnum option)
                                      throws IOException

Release a given option REST: DELETE /vps/{serviceName}/option/{option}

Parameters:

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

option - [required] The option name

Throws:

IOException

serviceName_option_GET

public ArrayList<OvhVpsOptionEnum> serviceName_option_GET(String serviceName)
                                                   throws IOException

List of VPS options REST: GET /vps/{serviceName}/option

Parameters:

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

Throws:

IOException

serviceName_templates_id_GET

public OvhTemplate serviceName_templates_id_GET(String serviceName,
                                                Long id)
                                         throws IOException

Get this object properties REST: GET /vps/{serviceName}/templates/{id}

Parameters:

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

id - [required] Id of the object

Throws:

IOException

serviceName_templates_id_software_softwareId_GET

public OvhSoftware serviceName_templates_id_software_softwareId_GET(String serviceName,
                                                                    Long id,
                                                                    Long softwareId)
                                                             throws IOException

Get this object properties REST: GET /vps/{serviceName}/templates/{id}/software/{softwareId}

Parameters:

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

id - [required] Id of the object

softwareId - [required]

Throws:

IOException

serviceName_templates_id_software_GET

public ArrayList<Long> serviceName_templates_id_software_GET(String serviceName,
                                                             Long id)
                                                      throws IOException

List available softwares for this template Id REST: GET /vps/{serviceName}/templates/{id}/software

Parameters:

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

id - [required] Id of the object

Throws:

IOException

serviceName_templates_GET

public ArrayList<Long> serviceName_templates_GET(String serviceName)
                                          throws IOException

Templates available for this virtual server REST: GET /vps/{serviceName}/templates

Parameters:

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

Throws:

IOException

serviceName_ips_ipAddress_GET

public OvhIp serviceName_ips_ipAddress_GET(String serviceName,
                                           String ipAddress)
                                    throws IOException

Get this object properties REST: GET /vps/{serviceName}/ips/{ipAddress}

Parameters:

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

ipAddress - [required] The effective ip address of the Ip object

Throws:

IOException

serviceName_ips_ipAddress_PUT

public void serviceName_ips_ipAddress_PUT(String serviceName,
                                          String ipAddress,
                                          OvhIp body)
                                   throws IOException

Alter this object properties REST: PUT /vps/{serviceName}/ips/{ipAddress}

Parameters:

body - [required] New object properties

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

ipAddress - [required] The effective ip address of the Ip object

Throws:

IOException

serviceName_ips_ipAddress_DELETE

public void serviceName_ips_ipAddress_DELETE(String serviceName,
                                             String ipAddress)
                                      throws IOException

Release a given Ip (Additional Ip) REST: DELETE /vps/{serviceName}/ips/{ipAddress}

Parameters:

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

ipAddress - [required] The effective ip address of the Ip object

Throws:

IOException

serviceName_ips_GET

public ArrayList<String> serviceName_ips_GET(String serviceName)
                                      throws IOException

Ips associated to this virtual server REST: GET /vps/{serviceName}/ips

Parameters:

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

Throws:

IOException

serviceName_secondaryDnsDomains_domain_GET

public OvhSecondaryDNS serviceName_secondaryDnsDomains_domain_GET(String serviceName,
                                                                  String domain)
                                                           throws IOException

Get this object properties REST: GET /vps/{serviceName}/secondaryDnsDomains/{domain}

Parameters:

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

domain - [required] domain on slave server

Throws:

IOException

serviceName_secondaryDnsDomains_domain_PUT

public void serviceName_secondaryDnsDomains_domain_PUT(String serviceName,
                                                       String domain,
                                                       OvhSecondaryDNS body)
                                                throws IOException

Alter this object properties REST: PUT /vps/{serviceName}/secondaryDnsDomains/{domain}

Parameters:

body - [required] New object properties

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

domain - [required] domain on slave server

Throws:

IOException

serviceName_secondaryDnsDomains_domain_DELETE

public void serviceName_secondaryDnsDomains_domain_DELETE(String serviceName,
                                                          String domain)
                                                   throws IOException

remove this domain REST: DELETE /vps/{serviceName}/secondaryDnsDomains/{domain}

Parameters:

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

domain - [required] domain on slave server

Throws:

IOException

serviceName_secondaryDnsDomains_domain_dnsServer_GET

public OvhSecondaryDNSNameServer serviceName_secondaryDnsDomains_domain_dnsServer_GET(String serviceName,
                                                                                      String domain)
                                                                               throws IOException

domain name server informations REST: GET /vps/{serviceName}/secondaryDnsDomains/{domain}/dnsServer

Parameters:

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

domain - [required] domain on slave server

Throws:

IOException

serviceName_secondaryDnsDomains_GET

public ArrayList<String> serviceName_secondaryDnsDomains_GET(String serviceName)
                                                      throws IOException

List of secondary dns domain name REST: GET /vps/{serviceName}/secondaryDnsDomains

Parameters:

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

Throws:

IOException

serviceName_secondaryDnsDomains_POST

public void serviceName_secondaryDnsDomains_POST(String serviceName,
                                                 String domain,
                                                 String ip)
                                          throws IOException

add a domain on secondary dns REST: POST /vps/{serviceName}/secondaryDnsDomains

Parameters:

ip - [required]

domain - [required] The domain to add

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

Throws:

IOException

serviceName_getConsoleUrl_POST

public String serviceName_getConsoleUrl_POST(String serviceName)
                                      throws IOException

Return the VPS console URL REST: POST /vps/{serviceName}/getConsoleUrl

Parameters:

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

Throws:

IOException

serviceName_confirmTermination_POST

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

Confirm termination of your service REST: POST /vps/{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 VPS offer

Throws:

IOException

serviceName_changeContact_POST

public ArrayList<Long> serviceName_changeContact_POST(String serviceName,
                                                      String contactAdmin,
                                                      String contactBilling,
                                                      String contactTech)
                                               throws IOException

Launch a contact change procedure REST: POST /vps/{serviceName}/changeContact

Parameters:

contactAdmin - The contact to set as admin contact

contactTech - The contact to set as tech contact

contactBilling - The contact to set as billing contact

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

Throws:

IOException

serviceName_stop_POST

public OvhTask serviceName_stop_POST(String serviceName)
                              throws IOException

Request the machine to stop REST: POST /vps/{serviceName}/stop

Parameters:

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

Throws:

IOException

serviceName_status_GET

public OvhServiceStatus serviceName_status_GET(String serviceName)
                                        throws IOException

Give the status of the services of the main IP REST: GET /vps/{serviceName}/status

Parameters:

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

Throws:

IOException

serviceName_ipCountryAvailable_GET

public ArrayList<OvhGeolocationEnum> serviceName_ipCountryAvailable_GET(String serviceName)
                                                                 throws IOException

Get the countries you can select for your IPs geolocation REST: GET /vps/{serviceName}/ipCountryAvailable

Parameters:

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

Throws:

IOException

serviceName_activeOptions_GET

public ArrayList<OvhVpsOptionEnum> serviceName_activeOptions_GET(String serviceName)
                                                          throws IOException

Deprecated.

Return all active options for the virtual server REST: GET /vps/{serviceName}/activeOptions

Parameters:

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

Throws:

IOException

serviceName_distribution_GET

public OvhTemplate serviceName_distribution_GET(String serviceName)
                                         throws IOException

Get this object properties REST: GET /vps/{serviceName}/distribution

Parameters:

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

Throws:

IOException

serviceName_distribution_software_softwareId_GET

public OvhSoftware serviceName_distribution_software_softwareId_GET(String serviceName,
                                                                    Long softwareId)
                                                             throws IOException

Get this object properties REST: GET /vps/{serviceName}/distribution/software/{softwareId}

Parameters:

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

softwareId - [required]

Throws:

IOException

serviceName_distribution_software_GET

public ArrayList<Long> serviceName_distribution_software_GET(String serviceName)
                                                      throws IOException

List available softwares for this template Id REST: GET /vps/{serviceName}/distribution/software

Parameters:

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

Throws:

IOException

serviceName_availableUpgrade_GET

public ArrayList<OvhModel> serviceName_availableUpgrade_GET(String serviceName)
                                                     throws IOException

Return all models the virtual server can be upgraded to REST: GET /vps/{serviceName}/availableUpgrade

Parameters:

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

Throws:

IOException

serviceName_models_GET

public ArrayList<OvhModel> serviceName_models_GET(String serviceName)
                                           throws IOException

Return all models for the range of the virtual server REST: GET /vps/{serviceName}/models

Parameters:

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

Throws:

IOException

GET

public ArrayList<String> GET()
                      throws IOException

List available services REST: GET /vps

Throws:

IOException