Version: profitbricks-sdk-php 4.0.0

• Description
• Getting Started
  • Installation
  • Authenticating
• Reference
  • Data Centers
    • List Data Centers
    • Retrieve a Data Center
    • Create a Data Center
    • Update a Data Center
    • Delete a Data Center
  • Locations
    • List Locations
    • Get a Location
  • Servers
    • List Servers
    • Retrieve a Server
    • Create a Server
    • Update a Server
    • Delete a Server
    • List Attached Volumes
    • Attach a Volume
    • Retrieve an Attached Volume
    • Detach a Volume
    • List Attached CD-ROMs
    • Attach a CD-ROM
    • Retrieve an Attached CD-ROM
    • Detach a CD-ROM
    • Reboot a Server
    • Start a Server
    • Stop a Server
  • Images
    • List Images
    • Get an Image
  • Volumes
    • List Volumes
    • Get a Volume
    • Create a Volume
    • Update a Volume
    • Delete a Volume
    • Create a Volume Snapshot
    • Restore a Volume Snapshot
  • Snapshots
    • List Snapshots
    • Get a Snapshot
    • Update a Snapshot
    • Delete a Snapshot
  • IP Blocks
    • List IP Blocks
    • Get an IP Block
    • Create an IP Block
    • Delete an IP Block
  • LANs
    • List LANs
    • Create a LAN
    • Get a LAN
    • Update a LAN
    • Delete a LAN
  • Network Interfaces (NICs)
    • List NICs
    • Get a NIC
    • Create a NIC
    • Update a NIC
    • Delete a NIC
  • Firewall Rules
    • List Firewall Rules
    • Get a Firewall Rule
    • Create a Firewall Rule
    • Update a Firewall Rule
    • Delete a Firewall Rule
  • Load Balancers
    • List Load Balancers
    • Get a Load Balancer
    • Create a Load Balancer
    • Update a Load Balancer
    • List Load Balanced NICs
    • Get a Load Balanced NIC
    • Associate NIC to a Load Balancer
    • Remove a NIC Association
  • Contract Resources
    • List Contract Resources
  • User Management
    • List Groups
    • Retrieve Group
    • Create Group
    • Update Group
    • Delete Group
    • List Shares
    • Retrieve Share
    • Create Share
    • Update Share
    • Delete Share
    • List Users
    • Retrieve User
    • Create User
    • Update User
    • Delete User
    • List Users In Group
    • Add User To Group
    • Remove User From Group
    • List Resources
    • List Resources Of Type
    • Find Resource By Id
  • Requests
    • List Requests
    • Get a Request
    • Get a Request Status
• Examples
• Support
• Testing
• Contributing

The ProfitBricks Client Library for PHP provides you with access to the ProfitBricks REST API. It is designed for developers who are building applications in PHP.

This guide will walk you through getting setup with the library and performing various actions against the API.

Before you begin you will need to have signed-up for a ProfitBricks account. The credentials you setup during sign-up will be used to authenticate against the API.

Install the PHP language from: PHP Installation

• You can install the latest stable version using Composer. Simply add the snippet below to your composer.json file:

{
    "require": {
        "profitbricks/profitbricks-sdk-php": ">=1.0"
    }
}

• Run the command composer install to download required dependencies.

• Include require_once(__DIR__.'/vendor/autoload.php'); in your php file to use the library.

Connecting to ProfitBricks is handled by first setting up your authentication credentials.

Add your credentials for connecting to ProfitBricks:

$config = (new ProfitBricks\Client\Configuration())
      ->setHost('https://api.profitbricks.com/cloudapi/v4')
      ->setUsername(getenv('PROFITBRICKS_USERNAME'))
      ->setPassword(getenv('PROFITBRICKS_PASSWORD'));
$api_client = new ProfitBricks\Client\ApiClient($config);

Set depth:

$datacenter_api->findById($testDatacenter->getId(), false, 5);

Depth controls the amount of data returned from the REST server ( range 1-5 ). The larger the number the more information is returned from the server. This is especially useful if you are looking for the information in the nested objects.

Caution: You will want to ensure you follow security best practices when using credentials within your code or from system environment variables.

This section provides details on all the available operations and the parameters they accept. Brief code snippets demonstrating usage are also included.

Virtual data centers (VDCs) are the foundation of the ProfitBricks platform. VDCs act as logical containers for all other objects you will be creating, e.g., servers. You can provision as many VDCs as you want. VDCs have their own private network and are logically segmented from each other to create isolation.

Create an instace of the api class:

     $datacenter_api = new ProfitBricks\Client\Api\DataCenterApi($api_client);

This operation will list all currently provisioned VDCs that your account credentials provide access to.

The optional depth parameter defines the level, one being the least and five being the most, of information returned with the response.

$datacenters = $datacenter_api->findAll();

Use this to retrieve details about a specific VDC.

The following table describes the request arguments:

$datacenter = $datacenter_api->findById($datacenter_id);

Use this operation to create a new VDC. You can create a "simple" VDC by supplying just the required name and location parameters. This operation also has the capability of provisioning a "complex" VDC by supplying additional parameters for servers, volumes, LANs, and/or load balancers.

The following table describes the request arguments:

The following table outlines the locations currently supported:

NOTES:

• The value for $name cannot contain the following characters: (@, /, , |, ‘’, ‘).
• You cannot change the virtual data center $location once it has been provisioned.

$datacenter_composite = new \ProfitBricks\Client\Model\Datacenter();

$props = new \ProfitBricks\Client\Model\DatacenterProperties();
$props->setName("test-data-center");
$props->setDescription("example description");
$props->setLocation('us/las');

$servers=new \ProfitBricks\Client\Model\Servers();
$server = new \ProfitBricks\Client\Model\Server();
$server_props = new \ProfitBricks\Client\Model\ServerProperties();
$server_props->setName("composite-node")->setCores(1)->setRam(1024);
$server->setProperties($server_props);
$servers->setItems(array($server));

$entities= new \ProfitBricks\Client\Model\DatacenterEntities();
$entities->setServers($servers);

$datacenter_composite->setProperties($props);
$datacenter_composite->setEntities($entities);
$testDatacenterComposite = $datacenter_api->create($datacenter_composite);

After retrieving a data center, either by getting it by id, or as a create response object, you can change its properties by calling the update method. Some parameters may not be changed using either of the update methods.

The following table describes the available request arguments:

$datacenter = new \ProfitBricks\Client\Model\Datacenter();
$props = new \ProfitBricks\Client\Model\DatacenterProperties();
$props->setName("new-name");
$datacenter->setProperties($props);

$updatedDatacenter = $datacenter_api->update($datacenter_id, $datacenter);

This will remove all objects within the virtual data center AND remove the virtual data center object itself.

NOTE: This is a highly destructive operation which should be used with extreme caution!

The following table describes the available request arguments:

$datacenter_api->delete($datacenter_id);

Locations are the physical ProfitBricks data centers where you can provision your VDCs.

Create an instace of the api class:

    $location_api = new ProfitBricks\Client\Api\LocationApi($api_client);

This operation will return the list of currently available locations.

The optional depth parameter defines the level, one being the least and five being the most, of information returned with the response.

$locations = $location_api->findAll();

Retrieves the attributes of a specific location.

The following table describes the request arguments:

$location_parts = explode("/", $location_id);
$location = $location_api->findById($location_parts[0], $location_parts[1]);

Create an instace of these api classes:

$server_api = new ProfitBricks\Client\Api\ServerApi($api_client);
$volume_api = new ProfitBricks\Client\Api\VolumeApi($api_client);
$attached_volume_api = new ProfitBricks\Client\Api\AttachedVolumesApi($api_client);
$cdrom_api = new ProfitBricks\Client\Api\AttachedCDROMsApi($api_client);

You can retrieve a list of all the servers provisioned inside a specific VDC.

The following table describes the request arguments:

$servers = $server_api->findAll($datacenter_id);

Returns information about a specific server such as its configuration, provisioning status, etc.

The following table describes the request arguments:

$server = $server_api->findById($datacenter_id,$server_id);

Creates a server within an existing VDC. You can configure additional properties such as specifying a boot volume and connecting the server to a LAN.

The following table describes the request arguments:

The following table outlines the server availability zones currently supported:

$server_composite = new \ProfitBricks\Client\Model\Server();
$props = new \ProfitBricks\Client\Model\ServerProperties();
$props->setName("composite-node")->setCores(1)->setRam(1024);
$server_composite->setProperties($props);

$entities= new \ProfitBricks\Client\Model\ServerEntities();

$volume = new ProfitBricks\Client\Model\Volume();
$v_props = new \ProfitBricks\Client\Model\VolumeProperties();
$v_props->setName("test-volume")
    ->setSize(3)
    ->setType('HDD')
    ->setImage($image_id)
    ->setImagePassword("testpassword123")
    ->setSshKeys(array("hQGOEJeFL91EG3+l9TtRbWNjzhDVHeLuL3NWee6bekA="));
$volume->setProperties($v_props);
$attachedVolumes= new \ProfitBricks\Client\Model\Volumes();
$attachedVolumes->setItems(array($volume));
$entities->setVolumes($attachedVolumes);
$server_composite->setEntities($entities);

$testServer_Composite = $server_api->create($datacenter_id, $server_composite);

Perform updates to the attributes of a server.

The following table describes the request arguments:

After retrieving a server, either by getting it by id, or as a create response object, you can change its properties and call the partialUpdate method:

$server = new \ProfitBricks\Client\Model\Server();
$props = new \ProfitBricks\Client\Model\ServerProperties();
$props->setName("new-name")->setCores(2)->setRam(1024 * 2);
$server->setProperties($props);

$server_api->partialUpdate($datacenter_id, $server_id, $props);

NOTE: You can also use update, for that operation you will update all the properties.

This will remove a server from a data center. NOTE: This will not automatically remove the storage volume(s) attached to a server. A separate operation is required to delete a storage volume.

The following table describes the request arguments:

After retrieving a server, either by getting it by id, or as a create response object, you can call the delete method directly:

$server_api->delete($datacenter_id, $server_id);

Retrieves a list of volumes attached to the server.

The following table describes the request arguments:

After retrieving a server, either by getting it by id, or as a create response object, you can call the findAll method directly:

$volumes = $volume_api->findAll($datacenter_id, $server_id);

This will attach a pre-existing storage volume to the server.

The following table describes the request arguments:

After retrieving a server, either by getting it by id, or as a create response object, you can call the attachVolume method directly.

$volume = new ProfitBricks\Client\Model\Volume();
$props = new \ProfitBricks\Client\Model\VolumeProperties();
$props->setName("test-volume")->setSize(3)->setType('HDD')->setLicenceType('LINUX');
$volume->setProperties($props);

$attached_volume_api->attachVolume($testDatacenter->getId(), $testServer->getId(), $volume);

This will retrieve the properties of an attached volume.

The following table describes the request arguments:

After retrieving a server, either by getting it by id, or as a create response object, you can call the findById method directly.

$testVolume = $attached_volume_api->findById($datacenter_id, $server_id, $volume_id);

This will detach the volume from the server. Depending on the volume hot_unplug settings, this may result in the server being rebooted.

This will NOT delete the volume from your virtual data center. You will need to make a separate request to delete a volume.

The following table describes the request arguments:

After retrieving a server, either by getting it by id, or as a create response object, you can call the delete method directly.

 $attached_volume_api->delete($datacenter_id, $server_id, $volume_id);

Retrieves a list of CD-ROMs attached to a server.

The following table describes the request arguments:

After retrieving a server, either by getting it by id, or as a create response object, you can call the findAll method directly.

$cdroms = $cdrom_api->findAll($datacenter_id, $server_id);

You can attach a CD-ROM to an existing server.

The following table describes the request arguments:

After retrieving a server, either by getting it by id, or as a create response object, you can call the create method directly.

$testCdrom = $cdrom_api->create($datacenter_id, $server_id, $cdrom_id);

You can retrieve a specific CD-ROM attached to the server.

The following table describes the request arguments:

After retrieving a server, either by getting it by id, or as a create response object, you can call the findById method directly.

$cdrom = $cdrom_api->findById($datacenter_id, $server_id, $cdrom_id);

This will detach a CD-ROM from the server.

The following table describes the request arguments:

After retrieving a server, either by getting it by id, or as a create response object, you can call the delete method directly.

$cdrom_api->delete($datacenter_id, $server_id, $cdrom_id);

This will force a hard reboot of the server. Do not use this method if you want to gracefully reboot the machine. This is the equivalent of powering off the machine and turning it back on.

The following table describes the request arguments:

After retrieving a server, either by getting it by id, or as a create response object, you can call the reboot method directly.

$server_api->reboot($datacenter_id, $server_id);

This will start a server. If the server's public IP was deallocated then a new IP will be assigned.

The following table describes the request arguments:

After retrieving a server, either by getting it by id, or as a create response object, you can call the start method directly.

$server_api->start($datacenter_id), $server_id);

This will stop a server. The machine will be forcefully powered off, billing will cease, and the public IP, if one is allocated, will be deallocated.

The following table describes the request arguments:

After retrieving a server, either by getting it by id, or as a create response object, you can call the stop method directly.

$server_api->stop($datacenter_id, $server_id);

Create an instace of the api class:

     $image_api = new ProfitBricks\Client\Api\ImageApi($api_client);

Retrieve a list of images.

The optional depth parameter defines the level, one being the least and five being the most, of information returned with the response.

$images = $image_api->findAll();

Retrieves the attributes of a specific image.

The following table describes the request arguments:

$image = $image_api->findById($image_id);

Create an instace of the api class:

      $volume_api = new ProfitBricks\Client\Api\VolumeApi($api_client);
	  $snapshot_api = new ProfitBricks\Client\Api\SnapshotApi($api_client);

Retrieve a list of volumes within the virtual data center. If you want to retrieve a list of volumes attached to a server please see the List Attached Volumes entry in the Server section for details.

The following table describes the request arguments:

$volumes = $volume_api->findAll($datacenter_id);

Retrieves the attributes of a given volume.

The following table describes the request arguments:

$volume = $volume_api->findById($datacenter_id, $volume_id);

Creates a volume within the virtual data center. This will NOT attach the volume to a server. Please see the Attach a Volume entry in the Server section for details on how to attach storage volumes.

The following table describes the request arguments:

The following table outlines the various licence types you can define:

The following table outlines the storage availability zones currently supported:

• You will need to provide either the $image or the $licence_type parameters. $licence_type is required, but if $image is supplied, it is already set and cannot be changed. Similarly either the $image_password or $ssh_keys parameters need to be supplied when creating a volume. We recommend setting a valid value for $image_password even when using $ssh_keys so that it is possible to authenticate using the remote console feature of the DCD.

$volume = new ProfitBricks\Client\Model\Volume();
$props = new \ProfitBricks\Client\Model\VolumeProperties();
$props->setName("test-volume")
  ->setSize(3)
  ->setType('HDD')
  ->setImage($image_id)
  ->setImagePassword("testpassword123")
  ->setSshKeys(array("hQGOEJeFL91EG3+l9TtRbWNjzhDVHeLuL3NWee6bekA="));
$volume->setProperties($props);

$testVolume = $volume_api->create($testDatacenter->getId(), $volume);

You can update -- in full or partially -- various attributes on the volume; however, some restrictions are in place:

You can increase the size of an existing storage volume. You cannot reduce the size of an existing storage volume. The volume size will be increased without requiring a reboot if the relevant hot plug settings have been set to true. The additional capacity is not added automatically added to any partition, therefore you will need to handle that inside the OS afterwards. Once you have increased the volume size you cannot decrease the volume size.

Since an existing volume is being modified, none of the request parameters are specifically required as long as the changes being made satisfy the requirements for creating a volume.

The following table describes the request arguments:

After retrieving a volume, either by getting it by id, or as a create response object, you can change its properties and call the partialUpdate method:

$volume_api->partialUpdate($datacenter_id, $volume_id, $props);

NOTE: You can also use update(), for that operation you will update all the properties.

Deletes the specified volume. This will result in the volume being removed from your data center. Use this with caution.

The following table describes the request arguments:

After retrieving a volume, either by getting it by id, or as a create response object, you can call the delete method directly.

$volume_api->delete($datacenter_id, $volume_id);

Creates a snapshot of a volume within the virtual data center. You can use a snapshot to create a new storage volume or to restore a storage volume.

The following table describes the request arguments:

After retrieving a volume, either by getting it by id, or as a create response object, you can call the createSnapshot method directly.

$testSnapshot = $volume_api->createSnapshot($datacenter_id,$volume_id);

This will restore a snapshot onto a volume. A snapshot is created as just another image that can be used to create new volumes or to restore an existing volume.

The following table describes the request arguments:

After retrieving a volume, either by getting it by id, or as a create response object, you can call the restoreSnapshot method directly.

$volume_api->restoreSnapshot($datacenter_id, $volume_id, $snapshot_id);

Create an instace of the api class:

     $volume_api = new ProfitBricks\Client\Api\VolumeApi($api_client);
	 $snapshot_api = new ProfitBricks\Client\Api\SnapshotApi($api_client);

You can retrieve a list of all available snapshots.

The optional $depth parameter defines the level, one being the least and five being the most, of information returned with the response.

$snapshots = $snapshot_api->findAll();

Retrieves the attributes of a specific snapshot.

The following table describes the request arguments:

$snapshot = $snapshot_api->findById($snapshot_id);

Perform updates to attributes of a snapshot.

The following table describes the request arguments:

After retrieving a snapshot, either by getting it by id, or as a create response object, you can change its properties and call the partialUpdate method:

$props = new \ProfitBricks\Client\Model\SnapshotProperties();
$props->setName("new-name");

$snapshot_api->partialUpdate($snapshot_id, $props);

NOTE: You can also use update(), for that operation you will update all the properties.

Deletes the specified snapshot.

The following table describes the request arguments:

After retrieving a snapshot, either by getting it by id, or as a create response object, you can call the delete method directly.

$snapshot_api->delete($testSnapshot->getId());

The IP block operations assist with managing reserved /static public IP addresses.

Create an instace of the api class:

     $ipblocks_api = new ProfitBricks\Client\Api\IPBlocksApi($api_client);

Retrieve a list of available IP blocks.

The optional $depth parameter defines the level, one being the least and five being the most, of information returned with the response.

$ipblocks = $ipblocks_api->findAll();

Retrieves the attributes of a specific IP block.

The following table describes the request arguments:

$block = $ipblocks_api->findById($ipblock_id);

Creates an IP block. IP blocks are attached to a location, so you must specify a valid $location along with a $size parameter indicating the number of IP addresses you want to reserve in the IP block. Servers or other resources using an IP address from an IP block must be in the same $location.

The following table describes the request arguments:

The following table outlines the locations currently supported:

To create an IP block, establish the parameters and then call create.

$block = new \ProfitBricks\Client\Model\IpBlock();
$props = new \ProfitBricks\Client\Model\IpBlockProperties();
$props->setSize(2)->setLocation("us/las");
$block->setProperties($props);

$testIpBlock = $ipblocks_api->create($block);

Deletes the specified IP Block.

The following table describes the request arguments:

After retrieving an IP block, either by getting it by id, or as a create response object, you can call the Delete method directly.

$ipblocks_api->delete($ipblock_id);

Retrieve a list of LANs within the virtual data center.

The following table describes the request arguments:

$lans = $lan_api->findAll($testDatacenter->getId());

Creates a LAN within a virtual data center.

The following table describes the request arguments:

$lan = new \ProfitBricks\Client\Model\Lan();
$props = new \ProfitBricks\Client\Model\LanProperties();
$props->setName("jclouds-lan");
$lan->setProperties($props);

$testLan = $lan_api->create($datacenter_id, $lan);

Retrieves the attributes of a given LAN.

The following table describes the request arguments:

$lan = $lan_api->findById($datacenter_id, $lan_id);

Perform updates to attributes of a LAN.

The following table describes the request arguments:

After retrieving a LAN, either by getting it by id, or as a create response object, you can change its properties and call the partialUpdate method:

$lan = new \ProfitBricks\Client\Model\Lan();
$props = new \ProfitBricks\Client\Model\LanProperties();
$props->setName("new-name")->setPublic(false);
$lan->setProperties($props);

$lan_api->partialUpdate($datacenter_id, $lan_id, $props);

NOTE: You can also use update(), for that operation you will update all the properties.

Deletes the specified LAN.

The following table describes the request arguments:

After retrieving a LAN, either by getting it by id, or as a create response object, you can call the delete method directly.

$lan_api->delete($datacenter_id, $lan_id);

Create an instance of the api class:

     $nic_api = new ProfitBricks\Client\Api\NetworkInterfacesApi($api_client);

Retrieve a list of LANs within the virtual data center.

The following table describes the request arguments:

$nics = $nic_api->findAll(datacenter_id, $server_id);

Retrieves the attributes of a given NIC.

The following table describes the request arguments:

$nic = $nic_api->findById($datacenter_id, $server_id, $nic_id);

Adds a NIC to the target server.

The following table describes the request arguments:

$nic = new \ProfitBricks\Client\Model\Nic();
$props = new \ProfitBricks\Client\Model\NicProperties();
$props->setName("jclouds-nic")->setLan(1);
$nic->setProperties($props);

$testNic = $nic_api->create($datacenter_id, $server_id, $nic);

You can update -- in full or partially -- various attributes on the NIC; however, some restrictions are in place:

The primary address of a NIC connected to a load balancer can only be changed by changing the IP of the load balancer. You can also add additional reserved, public IPs to the NIC.

The user can specify and assign private IPs manually. Valid IP addresses for private networks are 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16.

The following table describes the request arguments:

After retrieving a NIC, either by getting it by id, or as a create response object, you can call the partialUpdate method directly.

$nic = new \ProfitBricks\Client\Model\Nic();
$props = new \ProfitBricks\Client\Model\NicProperties();
$props->setName("new-name");
$nic->setProperties($props);

$nic_api->partialUpdate($datacenter_id, $server_id, $nic_id, $props);

NOTE: You can also use update(), for that operation you will update all the properties.

Deletes the specified NIC.

The following table describes the request arguments:

After retrieving a NIC, either by getting it by id, or as a create response object, you can call the delete method directly.

$nic_api->delete($datacenter_id, $server_id, $nic_id);

Create an instace of the api class:

     $firewall_api = new ProfitBricks\Client\Api\FirewallRuleApi($api_client);

Retrieves a list of firewall rules associated with a particular NIC.

The following table describes the request arguments:

$rules = $firewall_api->findAll($datacenter_id, $server_id, $nic_id);

Retrieves the attributes of a given firewall rule.

The following table describes the request arguments:

$rule = $firewall_api->findById($datacenter_id, $server_id, $nic_id, $firewall_rule_id);

This will add a firewall rule to the NIC.

The following table describes the request arguments:

$rule = new \ProfitBricks\Client\Model\FirewallRule();
$props = new \ProfitBricks\Client\Model\FirewallruleProperties();
$props->setName("jclouds-firewall")->setProtocol("TCP")->setPortRangeStart(1)->setPortRangeEnd(600);
$rule->setProperties($props);

$testRule = $firewall_api->create($datacenter_id, $server_id, $nic_id, $rule);

Perform updates to attributes of a firewall rule.

The following table describes the request arguments:

After retrieving a firewall rule, either by getting it by id, or as a create response object, you can change its properties and call the partialUpdate method:

$rule = new \ProfitBricks\Client\Model\FirewallRule();
$props = new \ProfitBricks\Client\Model\FirewallruleProperties();
$props->setName("new-name");
$rule->setProperties($props);

$firewall_api->partialUpdate($datacenter_id, $server_id, $nic_id, $firewall_rule_id, $props);

NOTE: You can also use update(), for that operation you will update all the properties.

Removes the specific firewall rule.

After retrieving a firewall rule, either by getting it by id, or as a create response object, you can call the delete method directly.

 $firewall_api->delete($datacenter_id, $server_id, $nic_id, $firewall_rule_id);

Create an instace of the api class:

$loadbalancer_api = new ProfitBricks\Client\Api\LoadBalancerApi($api_client);

$loadbalancer_nic_api = new ProfitBricks\Client\Api\LoadBalancerNicApi($api_client);

Retrieve a list of load balancers within the data center.

The following table describes the request arguments:

$balancers = $loadbalancer_api->findAll($datacenter_id);

Retrieves the attributes of a given load balancer.

The following table describes the request arguments:

$balancer = $loadbalancer_api->findById($datacenter_id, $loadbalancer_id);

Creates a load balancer within the virtual data center. Load balancers can be used for public or private IP traffic.

The following table describes the request arguments:

$balancer = new \ProfitBricks\Client\Model\Loadbalancer();
$props = new \ProfitBricks\Client\Model\LoadbalancerProperties();
$props->setName("jclouds-balancer")->setDhcp(false);
$balancer->setProperties($props);

$testLoadBalancer = $loadbalancer_api->create($datacenter_id, $balancer);

Perform updates to attributes of a load balancer.

The following table describes the request arguments:

After retrieving a load balancer, either by getting it by id, or as a create response object, you can change it's properties and call the partialUpdate method:

$balancer = new \ProfitBricks\Client\Model\Loadbalancer();
$props = new \ProfitBricks\Client\Model\LoadbalancerProperties();
$props->setName("new-name");
$balancer->setProperties($props);

$loadbalancer_api->partialUpdate($datacenter_id, $loadbalancer_id, $props);

NOTE: You can also use update(), for that operation you will update all the properties.

Deletes the specified load balancer.

The following table describes the request arguments:

After retrieving a load balancer, either by getting it by id, or as a create response object, you can call the delete method directly.

$loadbalancer_api->delete($datacenter_id, $loadbalancer_id);

This will retrieve a list of NICs associated with the load balancer.

The following table describes the request arguments:

After retrieving a load balancer, either by getting it by id, or as a create response object, you can call the listNics method directly.

$nics = $loadbalancer_nic_api->listNics($datacenter_id, $loadbalancer_id);

Retrieves the attributes of a given load balanced NIC.

The following table describes the request arguments:

After retrieving a load balancer, either by getting it by id, or as a create response object, you can call the getMember method directly.

$testNic = $loadbalancer_nic_api->getMember($datacenter_id, $loadbalancer_id, $nic_id);

This will associate a NIC to a load balancer, enabling the NIC to participate in load-balancing.

The following table describes the request arguments:

After retrieving a load balancer, either by getting it by id, or as a create response object, you can call the attachNic method directly.

$nic = new ProfitBricks\Client\Model\Nic();
$nic->setId($nic_id);
$loadbalancer_nic_api->attachNic($datacenter_id, $loadbalancer_id, $nic);

Removes the association of a NIC with a load balancer.

The following table describes the request arguments:

After retrieving a load balancer, either by getting it by id, or as a create response object, you can call the delete method directly.

$loadbalancer_nic_api->delete($datacenter_id, $loadbalancer_id, $nic_id);

Checking the amount of available resources under a contract can help you to avoid provisioning errors resulting from the attempt to provision more resources than are available.

Create an instance of the api class:

     $contract_resources_api = new ProfitBricks\Client\Api\ContractResourcesApi($api_client);

Returns information about the resource limits for a particular contract and the current resource usage.

The optional depth parameter defines the level, one being the least and five being the most, of information returned with the response.

$contract_resources = $contract_resources_api->findAll();

These operations are designed to allow you to orchestrate users and resources via the Cloud API. Previously this functionality required use of the DCD (Data Center Designer) web application.

Create an instance of the api class:

     $user_management_api = new ProfitBricks\Client\Api\UserManagementApi($api_client);

This retrieves a full list of all groups.

The optional depth parameter defines the level, one being the least and five being the most, of information returned with the response.

$groups = $user_management_api->findAllGroups();

Retrieves detailed information about a specific group.

The following table describes the request arguments:

$group = $user_management_api->findGroupById($group_id);

Use this operation to create a new group and set group privileges.

The following table describes the request arguments:

NOTES:

• The value for $name cannot contain the following characters: (@, /, , |, ‘’, ‘).

$props = new \ProfitBricks\Client\Model\GroupItemProperty();
$props->setName("test-group");
$props->setCreateDataCenter(True);
$props->setCreateSnapshot(True);

$new_group = $user_management_api->createGroup($props);

Use this operation to update a group.

The following table describes the available request arguments:

$props = new \ProfitBricks\Client\Model\GroupItemProperty();
$props->setName("test-group");
$props->setCreateDataCenter(False);
$props->setCreateSnapshot(False);

$new_group = $user_management_api->updateGroup($group_id, $props);

Use this operation to delete a single group. Resources that are assigned to the group are NOT deleted, but are no longer accessible to the group members unless the member is a Contract Owner, Admin, or Resource Owner.

The following table describes the available request arguments:

$user_management_api->deleteGroup($group_id);

Retrieves a full list of all the resources that are shared through this group and lists the permissions granted to the group members for each shared resource.

The optional depth parameter defines the level, one being the least and five being the most, of information returned with the response.

The following table describes the available request arguments:

$shares = $user_management_api->findAllShares($group_id);

Retrieves the details of a specific shared resource available to the specified group.

The following table describes the request arguments:

$share = $user_management_api->findShareById($group_id, $share_id);

Adds a specific resource share to a group and optionally allows the setting of permissions for that resource. As an example, you might use this to grant permissions to use an image or snapshot to a specific group.

The following table describes the request arguments:

$props = new \ProfitBricks\Client\Model\ShareProperties();
$props->setEditPrivilege(True);
$props->setSharePrivilege(True);

$new_share = $user_management_api->addShare($group_id, $resource_id, $props);

Use this to update the permissions that a group has for a specific resource share.

The following table describes the available request arguments:

|| Name| Required | Type | Description | |---|:-:|---|---| | $group_id | yes | string | The ID of the group. | | $resource_id | yes | string | The ID of the share. | | $editPrivilege | no | boolean | The group has permission to edit privileges on this resource. | | $sharePrivilege | no | boolean | The group has permission to share this resource. | | $depth | no | int | The level of details returned. |

$props = new \ProfitBricks\Client\Model\ShareProperties();
$props->setEditPrivilege(False);
$props->setSharePrivilege(False);

$updated_share = $user_management_api->updateShare($group_id, $resource_id, $props);

Removes a resource share from a specified group.

The following table describes the available request arguments:

$deleted_share = $user_management_api->deleteShare($group_id, $share_id);

Retrieve a list of all the users that have been created under a contract.

The optional depth parameter defines the level, one being the least and five being the most, of information returned with the response.

$users = $user_management_api->findAllUsers();

Retrieve details about a specific user including what groups and resources the user is associated with.

The following table describes the request arguments:

$user = $user_management_api->findUserById($user_id);

Creates a new user under a particular contract.

The following table describes the request arguments:

$props = new \ProfitBricks\Client\Model\UserProperties();
$props->setFirstName('Bob');
$props->setLastName('Smith');
$props->setEmail('bob_smith@example.com');
$props->setPassword('testPassword123!');

$new_user = $user_management_api->createUser($props);

Update details about a specific user including their privileges.

The following table describes the available request arguments:

$props = new \ProfitBricks\Client\Model\UserProperties();
$props->setFirstName('Bob');
$props->setLastName('Smith');
$props->setEmail('bob_smith@example.com');
$props->setPassword("secretpassword123");
$props->setAdministrator(True);
$props->setForceSecAuth(True);

$updated_user = $user_management_api->updateUser($user_id, $props);

Blacklists the user, disabling them. The user is not completely purged, therefore if you anticipate needing to create a user with the same name in the future, we suggest renaming the user before you delete it.

The following table describes the available request arguments:

$deleted_user = $user_management_api->deleteUser($user_id);

Retrieves a full list of all the users that are members of a particular group.

The following table describes the request arguments:

$users = $user_management_api->findUsersInGroup($group_id);

Use this operation to add an existing user to a group.

The following table describes the request arguments:

$new_user = $user_management_api->addUserToGroup($group_id, $user_id);

Use this operation to remove a user from a group.

The following table describes the available request arguments:

$deleted_user = $user_management_api->removeUserFromGroup($group_id, $user_id);

Retrieves a list of all resources and optionally their group associations.

The optional depth parameter defines the level, one being the least and five being the most, of information returned with the response.

$resources = $user_management_api->findAllResources();

Lists all shareable resources of a specific type.

The following table describes the request arguments:

$resource_type can be any of the following values:

$resources = $user_management_api->findAllResourcesByType('datacenter');

Retrieve a shareable resource by Id.

The following table describes the request arguments:

$resource_type can be any of the following values:

$resource = $user_management_api->findResourceById('datacenter', $resource_id);

Each call to the ProfitBricks Cloud API is assigned a request ID. These operations can be used to get information about the requests that have been submitted and their current status.

Create an instace of the api class:

     $reqiest_api = new ProfitBricks\Client\Api\RequestApi($api_client);

Retrieve a list of requests.

$requests = $reqiest_api->findAll();

Retrieves the attributes of a specific request.

The following table describes the request arguments:

$request = $reqiest_api->findById($request_id);

Retrieves the status of a request.

The following table describes the request arguments:

$request = $reqiest_api->getStatus($request_id);

ProfitBricks allows servers to be created with individual, customizable components including NICs and volumes. A wait method is necessary to provision components that depends on each other. Below is an example of a waitTillProvisioned method that can be used between dependent requests:

function waitTillProvisioned($url)
{
  //regex to get the request id
  preg_match('/\w{8}-\w{4}-\w{4}-\w{4}-\w{12}/', $url, $matches);
  $config = (new ProfitBricks\Client\Configuration())
      ->setHost('https://api.profitbricks.com/cloudapi/v4')
      ->setUsername(getenv('PROFITBRICKS_USERNAME'))
      ->setPassword(getenv('PROFITBRICKS_PASSWORD'));
  $api_client = new ProfitBricks\Client\ApiClient($config);
  $request_api = new ProfitBricks\Client\Api\RequestApi($api_client);
  $counter = 120;
  for ($i = 0; $i < $counter; $i++) {
    $request = $request_api->getStatus($matches[0]);
    sleep(1);
    if ($request->getMetadata()->getStatus() == "DONE") {
      break;
    }
    if ($request->getMetadata()->getStatus() == "FAILED") {
      throw new Exception("The request execution has failed with following message: " + $request->getMetadata()->getMessage());
    }
  }
}

<?php

require_once(__DIR__.'/vendor/autoload.php');

$test_location = 'us/las';

$config = (new ProfitBricks\Client\Configuration())
    ->setHost('https://api.profitbricks.com/cloudapi/v4/')
    ->setUsername(getenv('PROFITBRICKS_USERNAME'))
    ->setPassword(getenv('PROFITBRICKS_PASSWORD'));
$api_client = new ProfitBricks\Client\ApiClient($config);

$datacenter_api = new ProfitBricks\Client\Api\DataCenterApi($api_client);
$server_api = new ProfitBricks\Client\Api\ServerApi($api_client);
$volume_api = new ProfitBricks\Client\Api\VolumeApi($api_client);
$attached_volume_api = new ProfitBricks\Client\Api\AttachedVolumesApi($api_client);

echo "Creating DataCenter";
echo PHP_EOL ;

$datacenter = new \ProfitBricks\Client\Model\Datacenter();

$props = new \ProfitBricks\Client\Model\DatacenterProperties();
$props->setName("test-data-center");
$props->setDescription("example description");
$props->setLocation($test_location);
$datacenter->setProperties($props);


$testDatacenter = $datacenter_api->create($datacenter);
waitTillProvisioned($testDatacenter->getRequestId());

echo "DataCenter Ready";
echo PHP_EOL ;

echo "Creating Server";
echo PHP_EOL ;

$server_api = new ProfitBricks\Client\Api\ServerApi($api_client);

$server = new \ProfitBricks\Client\Model\Server();
$props = new \ProfitBricks\Client\Model\ServerProperties();
$props->setName("jclouds-node")->setCores(1)->setRam(1024);
$server->setProperties($props);

$testServer = $server_api->create($testDatacenter->getId(), $server);

waitTillProvisioned($testServer->getRequestId());

echo "Server Ready";
echo PHP_EOL ;

echo "looking for a linux image";
echo PHP_EOL ;

$image_api = new ProfitBricks\Client\Api\ImageApi($api_client);
$images=$image_api->findAll(null,5);
$osImage = null;
foreach ($images->getItems() as $image) {
  if ($image->getProperties()->getPublic() == true
      && $image->getProperties()->getLocation() == "us/las"
      && $image->getProperties()->getLicenceType() == "LINUX"
      && $image->getProperties()->getImageType() == "HDD"
  ) {
    $osImage = $image;
  }
}

echo "image found";
echo PHP_EOL ;

echo "Creating Volume with the os Image installed";
echo PHP_EOL ;
$volume_api = new ProfitBricks\Client\Api\VolumeApi($api_client);

$volume = new ProfitBricks\Client\Model\Volume();
$props = new \ProfitBricks\Client\Model\VolumeProperties();
$props->setName("test-volume")
    ->setSize(3)
    ->setType('HDD')
    ->setImage($osImage->getId())
    ->setImagePassword("testpassword123")
    ->setSshKeys(array("hQGOEJeFL91EG3+l9TtRbWNjzhDVHeLuL3NWee6bekA="));
$volume->setProperties($props);

$testVolume = $volume_api->create($testDatacenter->getId(), $volume);

waitTillProvisioned($testVolume->getRequestId());
echo "Volume Ready";
echo PHP_EOL ;

echo "Attaching volume to server";
echo PHP_EOL ;

$attachedVolume=$attached_volume_api->attachVolume($testDatacenter->getId(), $testServer->getId(), $volume);
waitTillProvisioned($attachedVolume->getRequestId());

echo "Volume attached";
echo PHP_EOL ;


echo "Cleaning example";
echo PHP_EOL ;
$datacenter_api->delete($testDatacenter->getId());

function waitTillProvisioned($url)
{
  //regex to get the request id
  preg_match('/\w{8}-\w{4}-\w{4}-\w{4}-\w{12}/', $url, $matches);
  $config = (new ProfitBricks\Client\Configuration())
      ->setHost('https://api.profitbricks.com/cloudapi/v4')
      ->setUsername(getenv('PROFITBRICKS_USERNAME'))
      ->setPassword(getenv('PROFITBRICKS_PASSWORD'));
  $api_client = new ProfitBricks\Client\ApiClient($config);
  $request_api = new ProfitBricks\Client\Api\RequestApi($api_client);
  $counter = 120;
  for ($i = 0; $i < $counter; $i++) {
    $request = $request_api->getStatus($matches[0]);
    sleep(1);
    if ($request->getMetadata()->getStatus() == "DONE") {
      break;
    }
    if ($request->getMetadata()->getStatus() == "FAILED") {
      throw new Exception("The request execution has failed with following message: " + $request->getMetadata()->getMessage());
    }
  }
}
?>

<?php

require_once(__DIR__.'/vendor/autoload.php');

$test_location = 'us/las';

$config = (new ProfitBricks\Client\Configuration())
    ->setHost('https://api.profitbricks.com/cloudapi/v4/')
    ->setUsername(getenv('PROFITBRICKS_USERNAME'))
    ->setPassword(getenv('PROFITBRICKS_PASSWORD'));
$api_client = new ProfitBricks\Client\ApiClient($config);

$datacenter_api = new ProfitBricks\Client\Api\DataCenterApi($api_client);
$server_api = new ProfitBricks\Client\Api\ServerApi($api_client);
$volume_api = new ProfitBricks\Client\Api\VolumeApi($api_client);
$attached_volume_api = new ProfitBricks\Client\Api\AttachedVolumesApi($api_client);

echo "looking for a linux image";
echo PHP_EOL ;

$image_api = new ProfitBricks\Client\Api\ImageApi($api_client);
$images=$image_api->findAll(null,5);
$osImage = null;
foreach ($images->getItems() as $image) {
  if ($image->getProperties()->getPublic() == true
      && $image->getProperties()->getLocation() == "us/las"
      && $image->getProperties()->getLicenceType() == "LINUX"
      && $image->getProperties()->getImageType() == "HDD"
  ) {
    $osImage = $image;
  }
}

echo "image found";
echo PHP_EOL ;

echo "Creating Composite DataCenter";
echo PHP_EOL ;

$datacenter_composite = new \ProfitBricks\Client\Model\Datacenter();

//Configuring DataCenter properties
$props = new \ProfitBricks\Client\Model\DatacenterProperties();
$props->setName("test-data-center-composite");
$props->setDescription("example description");
$props->setLocation("us/las");

//Creating an array of servers to be added within the DataCenter
$servers=new \ProfitBricks\Client\Model\Servers();
$server_composite = new \ProfitBricks\Client\Model\Server();
$server_props = new \ProfitBricks\Client\Model\ServerProperties();
$server_props->setName("composite-node")->setCores(1)->setRam(1024);
$server_composite->setProperties($server_props);

//Creating an array of volumes to be added within the Server
$server_entities= new \ProfitBricks\Client\Model\ServerEntities();

$volume = new ProfitBricks\Client\Model\Volume();
$v_props = new \ProfitBricks\Client\Model\VolumeProperties();
$v_props->setName("test-volume")
    ->setSize(3)
    ->setType('HDD')
    ->setImage($osImage->getId())
    ->setImagePassword("testpassword123")
    ->setSshKeys(array("hQGOEJeFL91EG3+l9TtRbWNjzhDVHeLuL3NWee6bekA="));
$volume->setProperties($v_props);
$attachedVolumes= new \ProfitBricks\Client\Model\Volumes();
$attachedVolumes->setItems(array($volume));
$server_entities->setVolumes($attachedVolumes);
$server_composite->setEntities($server_entities);

$servers->setItems(array($server_composite));
$entities= new \ProfitBricks\Client\Model\DatacenterEntities();
$entities->setServers($servers);

$datacenter_composite->setProperties($props);
$datacenter_composite->setEntities($entities);
$testDatacenterComposite = $datacenter_api->create($datacenter_composite);
waitTillProvisioned($testDatacenterComposite->getRequestId());

echo "DataCenter Ready";
echo PHP_EOL ;



echo "Cleaning example";
echo PHP_EOL ;
$datacenter_api->delete($testDatacenterComposite->getId());

function waitTillProvisioned($url)
{
  //regex to get the request id
  preg_match('/\w{8}-\w{4}-\w{4}-\w{4}-\w{12}/', $url, $matches);
  $config = (new ProfitBricks\Client\Configuration())
      ->setHost('https://api.profitbricks.com/cloudapi/v4')
      ->setUsername(getenv('PROFITBRICKS_USERNAME'))
      ->setPassword(getenv('PROFITBRICKS_PASSWORD'));
  $api_client = new ProfitBricks\Client\ApiClient($config);
  $request_api = new ProfitBricks\Client\Api\RequestApi($api_client);
  $counter = 120;
  for ($i = 0; $i < $counter; $i++) {
    $request = $request_api->getStatus($matches[0]);
    sleep(1);
    if ($request->getMetadata()->getStatus() == "DONE") {
      break;
    }
    if ($request->getMetadata()->getStatus() == "FAILED") {
      throw new Exception("The request execution has failed with following message: " + $request->getMetadata()->getMessage());
    }
  }
}
?>

You are welcome to contact us with questions or comments at ProfitBricks DevOps Central. Please report any issues via GitHub's issue tracker

You can find a full list of tests inside the tests folder.You can run tests using the phpunit tests command.

1. Fork it ( https://github.com/profitbricks/profitbricks-sdk-php/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request