PHP Class Scalr\Service\CloudStack\CloudStack

Since: 4.5.2

Author: Vlad Dobrovolskiy ([email protected])

Inheritance: use trait Scalr\Service\CloudStack\Services\TagsTrait, use trait Scalr\Service\CloudStack\Services\UpdateTrait, use trait Scalr\Service\CloudStack\Services\VirtualTrait

Show file Open project: scalr/scalr Class Usage Examples

Public Methods

Method	Description
__construct ( string $endpoint, string $apiKey, string $secretKey, string $platform = 'cloudstack' )	Constructor
__get ( $name )	It's used to retrieve service interface instances as public properties
_loadProductTypesData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\AvailableProductsData	Loads AvailableProductsData from json object
_loadProductTypesList ( object $productsList ) : Scalr\Service\CloudStack\DataType\AvailableProductsList	Loads AvailableProductsList from json object
associateIpAddress ( Scalr\Service\CloudStack\DataType\AssociateIpAddressData \| array $requestData = null ) : IpAddressResponseData	Acquires and associates a public IP to an account.
disassociateIpAddress ( string $id ) : ResponseDeleteData	Disassociates an ip address from the account.
getApiKey ( ) : string	Gets the CloudStack api key
getAvailableServices ( ) : array	Gets a list of available services
getClient ( ) : QueryClient	Gets Client
getCloudIdentifier ( string $userId ) : Scalr\Service\CloudStack\DataType\CloudIdentifierData	Retrieves a cloud identifier.
getEndpoint ( ) : string	Gets the CloudStack api url
getPlatform ( ) : string	Gets the CloudStack platform
getProxy ( ) : array \| boolean	Gets proxy configuration
getSecretKey ( ) : string	Gets the CloudStack secret key
listAccounts ( Scalr\Service\CloudStack\DataType\ListAccountsData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\AccountList \| null	Lists accounts and provides detailed account information for listed accounts
listAsyncJobs ( ListAsyncJobsData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\JobResultList \| null	Lists all pending asynchronous jobs for the account.
listAvailableProductTypes ( ) : Scalr\Service\CloudStack\DataType\AvailableProductsList \| null	It is a command used in checking the list of products provided as those of server and by selecting one of resulted lists, users can check combination of templateid, serviceofferingid, diskofferingid and zoneid which can be created with VM
listCapabilities ( Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : null \| Scalr\Service\CloudStack\DataType\CapabilityData	Lists capabilities
listDiskOfferings ( Scalr\Service\CloudStack\DataType\ListDiskOfferingsData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\DiskOfferingList \| null	Lists all available disk offerings.
listEvents ( ListEventsData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\EventResponseList \| null	A command to list events.
listHypervisors ( string $zoneId = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : null \| Scalr\Service\CloudStack\DataType\HypervisorsList	List hypervisors
listOsCategories ( string $id = null, string $name = null, string $keyword = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\OsCategoryList \| null	Lists all supported OS categories for this cloud.
listOsTypes ( Scalr\Service\CloudStack\DataType\ListOsTypesData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\OsTypeList \| null	Lists all supported OS types for this cloud.
listPublicIpAddresses ( Scalr\Service\CloudStack\DataType\ListIpAddressesData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\IpAddressResponseList \| null	Lists all public ip addresses
listResourceLimits ( Scalr\Service\CloudStack\DataType\ListResourceLimitsData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\ResourceLimitList \| null	Lists resource limits.
listServiceOfferings ( Scalr\Service\CloudStack\DataType\ListServiceOfferingsData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\ServiceOfferingList \| null	Lists all available service offerings.
login ( string $userName, string $password, string $domain = null ) : Scalr\Service\CloudStack\DataType\LoginResponseData	Logs a user into the CloudStack.
logout ( )	Logs out the user
queryAsyncJobResult ( string $jobId ) : JobResultData	Retrieves the current status of asynchronous job.
setApiKey ( string $apiKey ) : CloudStack	Sets the CloudStack api key
setDebug ( boolean $debug = true ) : CloudStack	Enables or disables debug mode
setEndpoint ( string $endpoint ) : CloudStack	Sets the CloudStack api url
setPlatform ( string $platform ) : CloudStack	Sets the CloudStack platform
setProxy ( string $host, integer $port = 3128, string $user = null, string $pass = null, integer $type, integer $authType = 1 )	Set proxy configuration to connect to AWS services
setSecretKey ( string $secretKey ) : CloudStack	Sets the CloudStack secret key

Protected Methods

Method	Description
_loadAccountData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\AccountData	Loads AccountData from json object
_loadAccountList ( object $accountList ) : Scalr\Service\CloudStack\DataType\AccountList	Loads AccountList from json object
_loadCapabilityData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\CapabilityData	Loads CapabilityData from json object
_loadCloudIdentifierData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\CloudIdentifierData	Loads CloudIdentifierData from json object
_loadDiskOfferingData ( object $resultObject ) : DiskOfferingData	Loads DiskOfferingData from json object
_loadDiskOfferingList ( object $serviceList ) : Scalr\Service\CloudStack\DataType\DiskOfferingList	Loads DiskOfferingList from json object
_loadEventData ( object $resultObject ) : EventResponseData	Loads EventResponseData from json object
_loadEventList ( object $eventList ) : Scalr\Service\CloudStack\DataType\EventResponseList	Loads EventResponseList from json object
_loadHypervisorsData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\HypervisorsData	Loads HypervisorsData from json object
_loadHypervisorsList ( object $hypervisorsList ) : Scalr\Service\CloudStack\DataType\HypervisorsList	Loads HypervisorsList from json object
_loadIpAddressData ( object $resultObject ) : IpAddressResponseData	Loads IpAddressResponseData from json object
_loadIpAddressList ( object $addressList ) : Scalr\Service\CloudStack\DataType\IpAddressResponseList	Loads IpAddressResponseList from json object
_loadJobResultData ( object $resultObject ) : JobResultData	Loads JobResultData from json object
_loadJobResultList ( object $jobsList ) : Scalr\Service\CloudStack\DataType\JobResultList	Loads JobResultList from json object
_loadLoginData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\LoginResponseData	Loads LoginResponseData from json object
_loadLogoutData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\LogoutResponseData	Loads LogoutResponseData from json object
_loadOsCategoryData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\OsCategoryData	Loads OsCategoryData from json object
_loadOsCategoryList ( object $categoryList ) : Scalr\Service\CloudStack\DataType\OsCategoryList	Loads OsCategoryList from json object
_loadOsTypeData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\OsTypeData	Loads OsTypeData from json object
_loadOsTypeList ( object $typeList ) : Scalr\Service\CloudStack\DataType\OsTypeList	Loads OsTypeList from json object
_loadResourceLimitData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\ResourceLimitData	Loads ResourceLimitData from json object
_loadResourceLimitList ( object $limitsList ) : Scalr\Service\CloudStack\DataType\ResourceLimitList	Loads ResourceLimitList from json object
_loadServiceOfferingData ( object $resultObject ) : ServiceOfferingData	Loads ServiceOfferingData from json object
_loadServiceOfferingList ( object $serviceList ) : Scalr\Service\CloudStack\DataType\ServiceOfferingList	Loads ServiceOfferingList from json object
_loadUserData ( object $resultObject ) : UserData	Loads UserData from json object
_loadUserList ( object $userList ) : Scalr\Service\CloudStack\DataType\UserList	Loads UserList from json object
escape ( string $str ) : string	Escapes string to pass it over http request

Method Details

__construct() public method

Constructor

public __construct ( string $endpoint, string $apiKey, string $secretKey, string $platform = 'cloudstack' )
$endpoint	string	Api url
$apiKey	string	Api key
$secretKey	string	Api secret key
$platform	string	Platform name (cloudstack, idcf)

__get() public method

It's used to retrieve service interface instances as public properties

public __get ( $name )

_loadAccountData() protected method

Loads AccountData from json object

protected _loadAccountData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\AccountData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\AccountData	Returns AccountData

_loadAccountList() protected method

Loads AccountList from json object

protected _loadAccountList ( object $accountList ) : Scalr\Service\CloudStack\DataType\AccountList
$accountList	object
return	Scalr\Service\CloudStack\DataType\AccountList	Returns AccountList

_loadCapabilityData() protected method

Loads CapabilityData from json object

protected _loadCapabilityData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\CapabilityData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\CapabilityData	Returns CapabilityData

_loadCloudIdentifierData() protected method

Loads CloudIdentifierData from json object

protected _loadCloudIdentifierData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\CloudIdentifierData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\CloudIdentifierData	Returns CloudIdentifierData

_loadDiskOfferingData() protected method

Loads DiskOfferingData from json object

protected _loadDiskOfferingData ( object $resultObject ) : DiskOfferingData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\DiskOfferingData	Returns DiskOfferingData

_loadDiskOfferingList() protected method

Loads DiskOfferingList from json object

protected _loadDiskOfferingList ( object $serviceList ) : Scalr\Service\CloudStack\DataType\DiskOfferingList
$serviceList	object
return	Scalr\Service\CloudStack\DataType\DiskOfferingList	Returns DiskOfferingList

_loadEventData() protected method

Loads EventResponseData from json object

protected _loadEventData ( object $resultObject ) : EventResponseData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\EventResponseData	Returns EventResponseData

_loadEventList() protected method

Loads EventResponseList from json object

protected _loadEventList ( object $eventList ) : Scalr\Service\CloudStack\DataType\EventResponseList
$eventList	object
return	Scalr\Service\CloudStack\DataType\EventResponseList	Returns EventResponseList

_loadHypervisorsData() protected method

Loads HypervisorsData from json object

protected _loadHypervisorsData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\HypervisorsData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\HypervisorsData	Returns HypervisorsData

_loadHypervisorsList() protected method

Loads HypervisorsList from json object

protected _loadHypervisorsList ( object $hypervisorsList ) : Scalr\Service\CloudStack\DataType\HypervisorsList
$hypervisorsList	object
return	Scalr\Service\CloudStack\DataType\HypervisorsList	Returns HypervisorsList

_loadIpAddressData() protected method

Loads IpAddressResponseData from json object

protected _loadIpAddressData ( object $resultObject ) : IpAddressResponseData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\IpAddressResponseData	Returns IpAddressResponseData

_loadIpAddressList() protected method

Loads IpAddressResponseList from json object

protected _loadIpAddressList ( object $addressList ) : Scalr\Service\CloudStack\DataType\IpAddressResponseList
$addressList	object
return	Scalr\Service\CloudStack\DataType\IpAddressResponseList	Returns IpAddressResponseList

_loadJobResultData() protected method

Loads JobResultData from json object

protected _loadJobResultData ( object $resultObject ) : JobResultData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\JobResultData	Returns JobResultData

_loadJobResultList() protected method

Loads JobResultList from json object

protected _loadJobResultList ( object $jobsList ) : Scalr\Service\CloudStack\DataType\JobResultList
$jobsList	object
return	Scalr\Service\CloudStack\DataType\JobResultList	Returns JobResultList

_loadLoginData() protected method

Loads LoginResponseData from json object

protected _loadLoginData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\LoginResponseData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\LoginResponseData	Returns LoginResponseData

_loadLogoutData() protected method

Loads LogoutResponseData from json object

protected _loadLogoutData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\LogoutResponseData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\LogoutResponseData	Returns LogoutResponseData

_loadOsCategoryData() protected method

Loads OsCategoryData from json object

protected _loadOsCategoryData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\OsCategoryData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\OsCategoryData	Returns OsCategoryData

_loadOsCategoryList() protected method

Loads OsCategoryList from json object

protected _loadOsCategoryList ( object $categoryList ) : Scalr\Service\CloudStack\DataType\OsCategoryList
$categoryList	object
return	Scalr\Service\CloudStack\DataType\OsCategoryList	Returns OsCategoryList

_loadOsTypeData() protected method

Loads OsTypeData from json object

protected _loadOsTypeData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\OsTypeData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\OsTypeData	Returns OsTypeData

_loadOsTypeList() protected method

Loads OsTypeList from json object

protected _loadOsTypeList ( object $typeList ) : Scalr\Service\CloudStack\DataType\OsTypeList
$typeList	object
return	Scalr\Service\CloudStack\DataType\OsTypeList	Returns OsTypeList

_loadProductTypesData() public method

Loads AvailableProductsData from json object

public _loadProductTypesData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\AvailableProductsData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\AvailableProductsData	Returns AvailableProductsData

_loadProductTypesList() public method

Loads AvailableProductsList from json object

public _loadProductTypesList ( object $productsList ) : Scalr\Service\CloudStack\DataType\AvailableProductsList
$productsList	object
return	Scalr\Service\CloudStack\DataType\AvailableProductsList	Returns AvailableProductsList

_loadResourceLimitData() protected method

Loads ResourceLimitData from json object

protected _loadResourceLimitData ( object $resultObject ) : Scalr\Service\CloudStack\DataType\ResourceLimitData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\ResourceLimitData	Returns ResourceLimitData

_loadResourceLimitList() protected method

Loads ResourceLimitList from json object

protected _loadResourceLimitList ( object $limitsList ) : Scalr\Service\CloudStack\DataType\ResourceLimitList
$limitsList	object
return	Scalr\Service\CloudStack\DataType\ResourceLimitList	Returns ResourceLimitList

_loadServiceOfferingData() protected method

Loads ServiceOfferingData from json object

protected _loadServiceOfferingData ( object $resultObject ) : ServiceOfferingData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\ServiceOfferingData	Returns ServiceOfferingData

_loadServiceOfferingList() protected method

Loads ServiceOfferingList from json object

protected _loadServiceOfferingList ( object $serviceList ) : Scalr\Service\CloudStack\DataType\ServiceOfferingList
$serviceList	object
return	Scalr\Service\CloudStack\DataType\ServiceOfferingList	Returns ServiceOfferingList

_loadUserData() protected method

Loads UserData from json object

protected _loadUserData ( object $resultObject ) : UserData
$resultObject	object
return	Scalr\Service\CloudStack\DataType\UserData	Returns UserData

_loadUserList() protected method

Loads UserList from json object

protected _loadUserList ( object $userList ) : Scalr\Service\CloudStack\DataType\UserList
$userList	object
return	Scalr\Service\CloudStack\DataType\UserList	Returns UserList

associateIpAddress() public method

Acquires and associates a public IP to an account.

public associateIpAddress ( Scalr\Service\CloudStack\DataType\AssociateIpAddressData \| array $requestData = null ) : IpAddressResponseData
$requestData	Scalr\Service\CloudStack\DataType\AssociateIpAddressData \| array	Request data object
return	Scalr\Service\CloudStack\DataType\IpAddressResponseData

disassociateIpAddress() public method

Disassociates an ip address from the account.

public disassociateIpAddress ( string $id ) : ResponseDeleteData
$id	string	the id of the public ip address to disassociate
return	ResponseDeleteData

escape() protected method

Escapes string to pass it over http request

protected escape ( string $str ) : string
$str	string
return	string

getApiKey() public method

Gets the CloudStack api key

public getApiKey ( ) : string
return	string	Returns api key

getAvailableServices() public static method

Gets a list of available services

public static getAvailableServices ( ) : array
return	array	Returns the list of available services looks like array(serviceName => className)

getClient() public method

Gets Client

public getClient ( ) : QueryClient
return	Scalr\Service\CloudStack\Client\QueryClient	Returns QueryClient

getCloudIdentifier() public method

Retrieves a cloud identifier.

public getCloudIdentifier ( string $userId ) : Scalr\Service\CloudStack\DataType\CloudIdentifierData
$userId	string	the user ID for the cloud identifier
return	Scalr\Service\CloudStack\DataType\CloudIdentifierData

getEndpoint() public method

Gets the CloudStack api url

public getEndpoint ( ) : string
return	string	Returns api url

getPlatform() public method

Gets the CloudStack platform

public getPlatform ( ) : string
return	string	Returns platform

getProxy() public method

Gets proxy configuration

public getProxy ( ) : array \| boolean
return	array \| boolean

getSecretKey() public method

Gets the CloudStack secret key

public getSecretKey ( ) : string
return	string	Returns secret key

listAccounts() public method

Lists accounts and provides detailed account information for listed accounts

public listAccounts ( Scalr\Service\CloudStack\DataType\ListAccountsData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\AccountList \| null
$requestData	Scalr\Service\CloudStack\DataType\ListAccountsData \| array	Request data object
$pagination	Scalr\Service\CloudStack\DataType\PaginationType	Pagination
return	Scalr\Service\CloudStack\DataType\AccountList \| null

listAsyncJobs() public method

Lists all pending asynchronous jobs for the account.

public listAsyncJobs ( ListAsyncJobsData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\JobResultList \| null
$requestData	Scalr\Service\CloudStack\DataType\ListAsyncJobsData \| array	Request data object
$pagination	Scalr\Service\CloudStack\DataType\PaginationType	Pagination
return	Scalr\Service\CloudStack\DataType\JobResultList \| null

listAvailableProductTypes() public method

It is a command used in checking the list of products provided as those of server and by selecting one of resulted lists, users can check combination of templateid, serviceofferingid, diskofferingid and zoneid which can be created with VM

public listAvailableProductTypes ( ) : Scalr\Service\CloudStack\DataType\AvailableProductsList \| null
return	Scalr\Service\CloudStack\DataType\AvailableProductsList \| null

listCapabilities() public method

Lists capabilities

public listCapabilities ( Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : null \| Scalr\Service\CloudStack\DataType\CapabilityData
$pagination	Scalr\Service\CloudStack\DataType\PaginationType	Pagination
return	null \| Scalr\Service\CloudStack\DataType\CapabilityData

listDiskOfferings() public method

Lists all available disk offerings.

public listDiskOfferings ( Scalr\Service\CloudStack\DataType\ListDiskOfferingsData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\DiskOfferingList \| null
$requestData	Scalr\Service\CloudStack\DataType\ListDiskOfferingsData \| array	Request data object
$pagination	Scalr\Service\CloudStack\DataType\PaginationType	Pagination
return	Scalr\Service\CloudStack\DataType\DiskOfferingList \| null

listEvents() public method

A command to list events.

public listEvents ( ListEventsData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\EventResponseList \| null
$requestData	Scalr\Service\CloudStack\DataType\ListEventsData \| array	Request data object
$pagination	Scalr\Service\CloudStack\DataType\PaginationType	Pagination
return	Scalr\Service\CloudStack\DataType\EventResponseList \| null

listHypervisors() public method

List hypervisors

public listHypervisors ( string $zoneId = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : null \| Scalr\Service\CloudStack\DataType\HypervisorsList
$zoneId	string	the zone id for listing hypervisors.
$pagination	Scalr\Service\CloudStack\DataType\PaginationType	Pagination
return	null \| Scalr\Service\CloudStack\DataType\HypervisorsList

listOsCategories() public method

Lists all supported OS categories for this cloud.

public listOsCategories ( string $id = null, string $name = null, string $keyword = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\OsCategoryList \| null
$id	string	List Os category by id
$name	string	List os category by name
$keyword	string	List by keyword
$pagination	Scalr\Service\CloudStack\DataType\PaginationType	Pagination
return	Scalr\Service\CloudStack\DataType\OsCategoryList \| null

listOsTypes() public method

Lists all supported OS types for this cloud.

public listOsTypes ( Scalr\Service\CloudStack\DataType\ListOsTypesData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\OsTypeList \| null
$requestData	Scalr\Service\CloudStack\DataType\ListOsTypesData \| array	Request data object
$pagination	Scalr\Service\CloudStack\DataType\PaginationType	Pagination
return	Scalr\Service\CloudStack\DataType\OsTypeList \| null

listPublicIpAddresses() public method

Lists all public ip addresses

public listPublicIpAddresses ( Scalr\Service\CloudStack\DataType\ListIpAddressesData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\IpAddressResponseList \| null
$requestData	Scalr\Service\CloudStack\DataType\ListIpAddressesData \| array	Request data object
$pagination	Scalr\Service\CloudStack\DataType\PaginationType	Pagination
return	Scalr\Service\CloudStack\DataType\IpAddressResponseList \| null

listResourceLimits() public method

Lists resource limits.

public listResourceLimits ( Scalr\Service\CloudStack\DataType\ListResourceLimitsData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\ResourceLimitList \| null
$requestData	Scalr\Service\CloudStack\DataType\ListResourceLimitsData \| array	Request data object
$pagination	Scalr\Service\CloudStack\DataType\PaginationType	Pagination
return	Scalr\Service\CloudStack\DataType\ResourceLimitList \| null

listServiceOfferings() public method

Lists all available service offerings.

public listServiceOfferings ( Scalr\Service\CloudStack\DataType\ListServiceOfferingsData \| array $requestData = null, Scalr\Service\CloudStack\DataType\PaginationType $pagination = null ) : Scalr\Service\CloudStack\DataType\ServiceOfferingList \| null
$requestData	Scalr\Service\CloudStack\DataType\ListServiceOfferingsData \| array	Request data object
$pagination	Scalr\Service\CloudStack\DataType\PaginationType	Pagination
return	Scalr\Service\CloudStack\DataType\ServiceOfferingList \| null

login() public method

Successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired.

public login ( string $userName, string $password, string $domain = null ) : Scalr\Service\CloudStack\DataType\LoginResponseData
$userName	string	Username
$password	string	Password
$domain	string	path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT domain is assumed.
return	Scalr\Service\CloudStack\DataType\LoginResponseData

logout() public method

return LogoutResponseData

public logout ( )

queryAsyncJobResult() public method

Retrieves the current status of asynchronous job.

public queryAsyncJobResult ( string $jobId ) : JobResultData
$jobId	string	the ID of the asychronous job
return	Scalr\Service\CloudStack\DataType\JobResultData

setApiKey() public method

Sets the CloudStack api key

public setApiKey ( string $apiKey ) : CloudStack
$apiKey	string
return	CloudStack

setDebug() public method

In debug mode all requests and responses will be printed to stdout.

public setDebug ( boolean $debug = true ) : CloudStack
$debug	boolean	optional True to enable debug mode
return	CloudStack

setEndpoint() public method

Sets the CloudStack api url

public setEndpoint ( string $endpoint ) : CloudStack
$endpoint	string
return	CloudStack

setPlatform() public method

Sets the CloudStack platform

public setPlatform ( string $platform ) : CloudStack
$platform	string
return	CloudStack

setProxy() public method

Set proxy configuration to connect to AWS services

public setProxy ( string $host, integer $port = 3128, string $user = null, string $pass = null, integer $type, integer $authType = 1 )
$host	string
$port	integer
$user	string
$pass	string
$type	integer	Allowed values 4 - SOCKS4, 5 - SOCKS5, 0 - HTTP
$authType	integer	Allowed authtypes: 1 - Basic, Digest - 2, GSSNeg - 4, NTLM - 8, any - -1

setSecretKey() public method

Sets the CloudStack secret key

public setSecretKey ( string $secretKey ) : CloudStack
$secretKey	string
return	CloudStack