pcextreme/cloudstack-client

Generic Cloudstack Client, compatible with the PCextreme Aurora Compute platform.

This package is deprecated and will be replaced in the near future, _(*1)

Cloudstack Client

The cloudstack-client is a PHP based Cloudstack API ORM., _(*2)

The Cloudstack Client utilises the kevindierkx/elicit API ORM and supports all major functionality., _(*3)

Installation

Currently the Cloudstack Client only supports Laravel based applications, support for native PHP will be added in the future., _(*4)

To install this package you will need:, _(*5)

• Laravel >= 4.2
• PHP >= 5.4

You must then modify your composer.json file and run composer update to include the latest version of the package in your project:, _(*6)

"require": {
    "pcextreme/cloudstack-client": "~0.1"
}

Or you can run the composer require command from your terminal:, _(*7)

composer require pcextreme/cloudstack-client:~0.1

Once the package is installed you need to open app/config/app.php and register the required service provider:, _(*8)

'providers' => [
    'PCextreme\CloudstackClient\Providers\LaravelServiceProvider'
]

Optionaly you can add the following line to your aliases to utilise the provided facade:, _(*9)

'aliases' => [
    'Cloudstack' => 'PCextreme\CloudstackClient\Providers\Facades\Cloudstack',
]

Configuration

Run the following command to publish the package configuration:, _(*10)

php artisan config:publish pcextreme/cloudstack-client

This will add the package configuration to your packages folder app/config/packages/pcextreme/cloudstack-client/config.php, here you will be providing the required connection details., _(*11)

SSO keys are generally only for Cloudstack administrators and are not required., _(*12)

Usage

When using the Cloudstack facade you can call all commands available to your Cloudstack user directly., _(*13)

For example calling listVirtualMachines with the listall parameter would look like the following:, _(*14)

Cloudstack::listVirtualMachines(['listall' => 'true']);

The above would return null when the return count is 0. This happens when you don't have any instances, the same would happen for other list calls. When Cloudstack returns multiple results the Cloudstack Client would return an instance of KevinDierkx\Elicit\Elicit\Collection you can use the methods provided within this instance to manipulate the resulted data., _(*15)

Please note that the api-list.php is required for every direct request. The Cloudstack Client provides this file by default and is located in the cache/ folder withing this package., _(*16)

Credits

• Kevin Dierkx

License

The MIT License (MIT). Please see License File for more information., _(*17)