Overview

Packages

  • PHP
  • Transip

Classes

  • Transip_ApiSettings
  • Transip_AvailabilityZone
  • Transip_ColocationService
  • Transip_Cronjob
  • Transip_DataCenterVisitor
  • Transip_Db
  • Transip_DnsEntry
  • Transip_DnsService
  • Transip_Domain
  • Transip_DomainAction
  • Transip_DomainBranding
  • Transip_DomainCheckResult
  • Transip_DomainService
  • Transip_ExtraContactField
  • Transip_Forward
  • Transip_ForwardService
  • Transip_Haip
  • Transip_HaipService
  • Transip_MailBox
  • Transip_MailForward
  • Transip_Nameserver
  • Transip_OperatingSystem
  • Transip_PrivateNetwork
  • Transip_Product
  • Transip_PropositionService
  • Transip_Snapshot
  • Transip_SubDomain
  • Transip_Tld
  • Transip_Vps
  • Transip_VpsBackup
  • Transip_VpsService
  • Transip_WebHost
  • Transip_WebhostingPackage
  • Transip_WebhostingService
  • Transip_WhoisContact
  • Overview
  • Package
  • Class
  • Tree

Class Transip_VpsService

This is the API endpoint for the VpsService

Package: Transip
Author: TransIP (support@transip.nl)
Class: VpsService
Located at VpsService.php
Methods summary
public static SoapClient
# _getSoapClient( mixed $parameters = array() )

Gets the singleton SoapClient which is used to connect to the TransIP Api.

Gets the singleton SoapClient which is used to connect to the TransIP Api.

Parameters

$parameters
mixed
$parameters Parameters.

Returns

SoapClient
The SoapClient object to which we can connect to the TransIP API
protected static string
# _sign( mixed $parameters )

Calculates the hash to sign our request with based on the given parameters.

Calculates the hash to sign our request with based on the given parameters.

Parameters

$parameters
mixed
$parameters The parameters to sign.

Returns

string
Base64 encoded signing hash.
protected static string
# _sha512Asn1( string $data )

Creates a digest of the given data, with an asn1 header.

Creates a digest of the given data, with an asn1 header.

Parameters

$data
string
$data The data to create a digest of.

Returns

string
The digest of the data, with asn1 header.
protected static string
# _encodeParameters( mixed $parameters, string $keyPrefix = null )

Encodes the given paramaters into a url encoded string based upon RFC 3986.

Encodes the given paramaters into a url encoded string based upon RFC 3986.

Parameters

$parameters
mixed
$parameters The parameters to encode.
$keyPrefix
string
$keyPrefix Key prefix.

Returns

string
The given parameters encoded according to RFC 3986.
protected static string
# _urlencode( string $string )

Our own function to encode a string according to RFC 3986 since. PHP < 5.3.0 encodes the ~ character which is not allowed.

Our own function to encode a string according to RFC 3986 since. PHP < 5.3.0 encodes the ~ character which is not allowed.

Parameters

$string
string
$string The string to encode.

Returns

string
The encoded string according to RFC 3986.
public static Transip_Product[]
# getAvailableProducts( )

Get available VPS products

Get available VPS products

Returns

Transip_Product[]
List of available VPS Products
public static Transip_Product[]
# getAvailableAddons( )

Get available VPS addons

Get available VPS addons

Returns

Transip_Product[]
List of available VPS Products
public static Transip_Product[]
# getActiveAddonsForVps( string $vpsName )

Get all the Active Addons for Vps

Get all the Active Addons for Vps

Parameters

$vpsName
string
$vpsName The name of the VPS

Returns

Transip_Product[]
List of available VPS Products
public static Transip_Product[]
# getAvailableUpgrades( string $vpsName )

Get available VPS upgrades for a specific Vps

Get available VPS upgrades for a specific Vps

Parameters

$vpsName
string
$vpsName The name of the VPS

Returns

Transip_Product[]
List of available VPS Products
public static Transip_Product[]
# getAvailableAddonsForVps( string $vpsName )

Get available Addons for Vps

Get available Addons for Vps

Parameters

$vpsName
string
$vpsName The name of the VPS

Returns

Transip_Product[]
List of available VPS Products
public static Transip_Product[]
# getCancellableAddonsForVps( string $vpsName )

Get cancellable addons for specific Vps

Get cancellable addons for specific Vps

Parameters

$vpsName
string
$vpsName The name of the Vps

Returns

Transip_Product[]
List of cancellable addons for this Vps
public static
# orderVps( string $productName, string[] $addons, string $operatingSystemName, string $hostname )

Order a VPS with optional Addons

Order a VPS with optional Addons

Parameters

$productName
string
$productName Name of the product
$addons
string[]
$addons array with additional addons
$operatingSystemName
string
$operatingSystemName The name of the operatingSystem to install
$hostname
string
$hostname The name for the host

Throws

Exception
public static
# orderVpsInAvailabilityZone( string $productName, string[] $addons, string $operatingSystemName, string $hostname, string $availabilityZone )

Order a VPS with optional Addons

Order a VPS with optional Addons

Parameters

$productName
string
$productName Name of the product
$addons
string[]
$addons array with additional addons
$operatingSystemName
string
$operatingSystemName The name of the operatingSystem to install
$hostname
string
$hostname The name for the host
$availabilityZone
string
$availabilityZone The availability zone the vps should be created in

Throws

Exception
public static
# cloneVps( string $vpsName )

Clone a VPS

Clone a VPS

Parameters

$vpsName
string
$vpsName The vps name

Throws

Exception
public static
# cloneVpsToAvailabilityZone( string $vpsName, string $availabilityZone )

Clone a VPS

Clone a VPS

Parameters

$vpsName
string
$vpsName The vps name
$availabilityZone
string
$availabilityZone The availability zone the clone should be created in.

Throws

Exception
public static
# orderAddon( string $vpsName, string[] $addons )

Order addons to a VPS

Order addons to a VPS

Parameters

$vpsName
string
$vpsName The name of the VPS
$addons
string[]
$addons Array with Addons

Throws

ApiException
on error
public static
# orderPrivateNetwork( )

Order a private Network

Order a private Network

Throws

ApiException
on error
public static
# upgradeVps( string $vpsName, string $upgradeToProductName )

upgrade a Vps

upgrade a Vps

Parameters

$vpsName
string
$vpsName The name of the VPS
$upgradeToProductName
string
$upgradeToProductName The name of the product to upgrade to

Throws

ApiException
on error
public static
# cancelVps( string $vpsName, string $endTime )

Cancel a Vps

Cancel a Vps

Parameters

$vpsName
string
$vpsName The vps to cancel
$endTime
string
$endTime The time to cancel the vps (VpsService::CANCELLATIONTIME_END (end of contract)

Throws

ApiException
on error
public static
# cancelAddon( string $vpsName, string $addonName )

Cancel a Vps Addon

Cancel a Vps Addon

Parameters

$vpsName
string
$vpsName The vps to cancel
$addonName
string
$addonName name of the addon

Throws

ApiException
on error
public static
# cancelPrivateNetwork( string $privateNetworkName, string $endTime )

Cancel a PrivateNetwork

Cancel a PrivateNetwork

Parameters

$privateNetworkName
string
$privateNetworkName the name of the private network to cancel
$endTime
string
$endTime The time to cancel the vps (VpsService::CANCELLATIONTIME_END (end of contract)

Throws

ApiException
on error
public static Transip_PrivateNetwork[]
# getPrivateNetworksByVps( string $vpsName )

Get Private networks for a specific vps

Get Private networks for a specific vps

Parameters

$vpsName
string
$vpsName The name of the VPS

Returns

Transip_PrivateNetwork[]
$privateNetworks Array of PrivateNetwork objects
public static Transip_PrivateNetwork[]
# getAllPrivateNetworks( )

Get all Private networks in your account

Get all Private networks in your account

Returns

Transip_PrivateNetwork[]
$privateNetworks Array of PrivateNetwork objects
public static
# addVpsToPrivateNetwork( string $vpsName, string $privateNetworkName )

Add VPS to a private Network

Add VPS to a private Network

Parameters

$vpsName
string
$vpsName The name of the VPS
$privateNetworkName
string
$privateNetworkName The name of the privateNetwork to add to
public static
# removeVpsFromPrivateNetwork( string $vpsName, string $privateNetworkName )

Remove VPS from a private Network

Remove VPS from a private Network

Parameters

$vpsName
string
$vpsName The name of the VPS
$privateNetworkName
string
$privateNetworkName The name of the private Network
public static array
# getTrafficInformationForVps( string $vpsName )

Get Traffic information by vpsName for this contractPeriod

Get Traffic information by vpsName for this contractPeriod

Parameters

$vpsName
string
$vpsName The name of the VPS

Returns

array
The traffic information for this VPS

Throws

ApiException
on error
public static array
# getPooledTrafficInformation( )

Get PooledTraffic information for the account

Get PooledTraffic information for the account

Returns

array
public static
# start( string $vpsName )

Start a Vps

Start a Vps

Parameters

$vpsName
string
$vpsName The vps name

Throws

ApiException
on error
public static
# stop( string $vpsName )

Stop a Vps

Stop a Vps

Parameters

$vpsName
string
$vpsName The vps name

Throws

ApiException
on error
public static
# reset( string $vpsName )

Reset a Vps

Reset a Vps

Parameters

$vpsName
string
$vpsName The vps name

Throws

ApiException
on error
public static
# createSnapshot( string $vpsName, string $description )

Create a snapshot

Create a snapshot

Parameters

$vpsName
string
$vpsName The vps name
$description
string
$description The snapshot description

Throws

ApiException
on error
public static
# revertSnapshot( string $vpsName, string $snapshotName )

Revert a snapshot

Revert a snapshot

Parameters

$vpsName
string
$vpsName The vps name
$snapshotName
string
$snapshotName The snapshot name

Throws

ApiException
on error
public static
# revertSnapshotToOtherVps( string $sourceVpsName, string $snapshotName, string $destinationVpsName )

Revert a snapshot to another VPS

Revert a snapshot to another VPS

Parameters

$sourceVpsName
string
$sourceVpsName The name of the VPS where the snapshot is made
$snapshotName
string
$snapshotName The snapshot name
$destinationVpsName
string
$destinationVpsName The name of the VPS where the snapshot should be reverted to

Throws

ApiException
on error
public static
# removeSnapshot( string $vpsName, string $snapshotName )

Remove a snapshot

Remove a snapshot

Parameters

$vpsName
string
$vpsName The vps name
$snapshotName
string
$snapshotName The snapshot name

Throws

ApiException
on error
public static
# revertVpsBackup( string $vpsName, integer $vpsBackupId )

Revert a vps backup

Revert a vps backup

Parameters

$vpsName
string
$vpsName The vps name
$vpsBackupId
integer
$vpsBackupId The backup id

Throws

ApiException
on error
public static Transip_Vps
# getVps( string $vpsName )

Get a Vps by name

Get a Vps by name

Parameters

$vpsName
string
$vpsName The vps name

Returns

Transip_Vps
$vps The vps objects
public static Transip_Vps[]
# getVpses( )

Get all Vpss

Get all Vpss

Returns

Transip_Vps[]
Array of Vps objects
public static Transip_Snapshot[]
# getSnapshotsByVps( string $vpsName )

Get all Snapshots for a vps

Get all Snapshots for a vps

Parameters

$vpsName
string
$vpsName The name of the VPS

Returns

Transip_Snapshot[]
$snapshotArray Array of snapshot objects
public static Transip_VpsBackup[]
# getVpsBackupsByVps( string $vpsName )

Get all VpsBackups for a vps

Get all VpsBackups for a vps

Parameters

$vpsName
string
$vpsName The name of the VPS

Returns

Transip_VpsBackup[]
$vpsBackupArray Array of snapshot objects
public static Transip_OperatingSystem[]
# getOperatingSystems( )

Get all operating systems

Get all operating systems

Returns

Transip_OperatingSystem[]
Array of OperatingSystem objects
public static
# installOperatingSystem( string $vpsName, string $operatingSystemName, string $hostname )

Install an operating system on a vps

Install an operating system on a vps

Parameters

$vpsName
string
$vpsName The name of the VPS
$operatingSystemName
string
$operatingSystemName The name of the operating to install
$hostname
string
$hostname preinstallable Only
public static
# installOperatingSystemUnattended( string $vpsName, string $operatingSystemName, string $base64InstallText )

Install an operating system on a vps with a unattended installfile

Install an operating system on a vps with a unattended installfile

Parameters

$vpsName
string
$vpsName The name of the VPS
$operatingSystemName
string
$operatingSystemName The name of the operating to install
$base64InstallText
string
$base64InstallText base64_encoded preseed/kickstart text

Throws

ApiException
public static string[]
# getIpsForVps( string $vpsName )

Get Ips for a specific Vps

Get Ips for a specific Vps

Parameters

$vpsName
string
$vpsName The name of the Vps

Returns

string[]
$ipAddresses Array of ipAddresses
public static string[]
# getAllIps( )

Get All ips

Get All ips

Returns

string[]
$ipAddresses Array of ipAddresses
public static
# addIpv6ToVps( string $vpsName, string $ipv6Address )

Add Ipv6 Address to Vps

Add Ipv6 Address to Vps

Parameters

$vpsName
string
$vpsName The name of the VPS
$ipv6Address
string
$ipv6Address The Ipv6 Address from your range

Throws

ApiException
on error
public static
# updatePtrRecord( string $ipAddress, string $ptrRecord )

Update PTR record (reverse DNS) for an ipAddress

Update PTR record (reverse DNS) for an ipAddress

Parameters

$ipAddress
string
$ipAddress The IP Address to update (ipv4 or ipv6)
$ptrRecord
string
$ptrRecord The PTR Record to update to

Throws

ApiException
on error
public static
# setCustomerLock( string $vpsName, boolean $enabled )

Enable or Disable a Customer Lock for a Vps

Enable or Disable a Customer Lock for a Vps

Parameters

$vpsName
string
$vpsName The name of the Vps
$enabled
boolean
$enabled Enable (true) or Disable (false) the lock

Throws

ApiException
on error
public static
# handoverVps( string $vpsName, string $targetAccountname )

Handover a VPS to another TransIP User

Handover a VPS to another TransIP User

Parameters

$vpsName
string
$vpsName The name of the Vps
$targetAccountname
string
$targetAccountname the target account name

Throws

ApiException
on error
public static Transip_AvailabilityZone[]
# getAvailableAvailabilityZones( )

Returns an array of available AvailabilityZones

Returns an array of available AvailabilityZones

Returns

Transip_AvailabilityZone[]
an array of AvailabilityZones
public static
# convertVpsBackupToSnapshot( string $vpsName, string $description, integer $vpsBackupId )

Convert a backup to a Snapshot

Convert a backup to a Snapshot

Parameters

$vpsName
string
$vpsName The vps name
$description
string
$description The snapshot description
$vpsBackupId
integer
$vpsBackupId The selected backup id

Throws

ApiException
on error
Constants summary
string SERVICE 'VpsService'
#

The SOAP service that corresponds with this class.

The SOAP service that corresponds with this class.
string API_VERSION '5.23'
#

The API version.

The API version.
string CANCELLATIONTIME_END 'end'
#
string CANCELLATIONTIME_IMMEDIATELY 'immediately'
#
string TRACK_ENDPOINT_NAME 'VPS'
#
Properties summary
protected static SoapClient $_soapClient null
#

The SoapClient used to perform the SOAP calls.

The SoapClient used to perform the SOAP calls.
API documentation generated by ApiGen 2.8.0