PHP Class Scalr\Service\CloudStack\DataType\VirtualMachineInstancesData

Since: 4.5.2

Author: Vlad Dobrovolskiy ([email protected])

Inheritance: extends Scalr\Service\CloudStack\DataType\JobStatusData

Public Properties

Property	Type	Description
$account	string	The account associated with the virtual machine
$cpunumber	string	The number of cpu this virtual machine is running with
$cpuspeed	string	The speed of each cpu
$cpuused	string	The amount of the vm's CPU currently used
$created	DateTime	The date when this virtual machine was created
$diskioread	string	The read (io) of disk on the vm
$diskiowrite	string	The write (io) of disk on the vm
$diskkbsread	string	The read (bytes) of disk on the vm
$diskkbswrite	string	The write (bytes) of disk on the vm
$displayname	string	The name of the virtual machine is returned if no displayname exists.
$displayvm	string	An optional field whether to the display the vm to the end user or not.
$domain	string	The name of the domain in which the virtual machine exists
$domainid	string	The ID of the domain in which the virtual machine exists
$forvirtualnetwork	string	The virtual network for the service offering
$group	string	The group name of the virtual machine
$groupid	string	The group ID of the virtual machine
$guestosid	string	Os type ID of the virtual machine
$haenable	string	true if high-availability is enabled, false otherwise
$hostid	string	The ID of the host for the virtual machine
$hostname	string	The name of the host for the virtual machine
$hypervisor	string	The hypervisor on which the template runs
$id	string	The ID of the virtual machine
$instancename	string	Instance name of the user vm; this parameter is returned to the ROOT admin only
$isdynamicallyscalable	string	true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.
$isodisplaytext	string	An alternate display text of the ISO attached to the virtual machine
$isoid	string	The ID of the ISO attached to the virtual machine
$isoname	string	The name of the ISO attached to the virtual machine
$keypair	string	Ssh key-pair
$memory	string	The memory allocated for the virtual machine
$name	string	The name of the virtual machine
$networkkbsread	string	The incoming network traffic on the vm
$networkkbswrite	string	The outgoing network traffic on the host
$password	string	The password (if exists) of the virtual machine
$passwordenabled	string	true if the password rest feature is enabled, false otherwise
$project	string	The project name of the vm
$projectid	string	The project id of the vm
$publicip	string	Public IP address associated with vm via Static nat rule
$publicipid	string	Public IP address id associated with vm via Static nat rule
$rootdeviceid	string	Device ID of the root volume
$rootdevicetype	string	Device type of the root volume
$serviceofferingid	string	The ID of the service offering of the virtual machine
$serviceofferingname	string	The name of the service offering of the virtual machine
$servicestate	string	State of the Service from LB rule
$state	string	The state of the virtual machine
$templatedisplaytext	string	An alternate display text of the template for the virtual machine
$templateid	string	A -1 is returned if the virtual machine was created from an ISO file.
$templatename	string	The name of the template for the virtual machine
$zoneid	string	The ID of the availablility zone for the virtual machine
$zonename	string	The name of the availability zone for the virtual machine

Protected Properties

Property	Type	Description
$_properties	array	List of the public properties which is managed by magic getter and setters internally.

Public Methods

Method	Description
setAffinitygroup ( Scalr\Service\CloudStack\DataType\AffinityGroupList $affinitygroup = null ) : VirtualMachineInstancesData	Sets affinity group list
setDetails ( Scalr\Service\CloudStack\DataType\VirtualDetailsData $details = null ) : VirtualMachineInstancesData	Sets details
setNic ( Scalr\Service\CloudStack\DataType\NicList $nic = null ) : VirtualMachineInstancesData	Sets nic list
setSecuritygroup ( Scalr\Service\CloudStack\DataType\SecurityGroupList $securitygroup = null ) : VirtualMachineInstancesData	Sets security group list
setTags ( Scalr\Service\CloudStack\DataType\ResponseTagsList $tags = null ) : VirtualMachineInstancesData	Sets tags

Method Details

setAffinitygroup() public method

Sets affinity group list

public setAffinitygroup ( Scalr\Service\CloudStack\DataType\AffinityGroupList $affinitygroup = null ) : VirtualMachineInstancesData
$affinitygroup	Scalr\Service\CloudStack\DataType\AffinityGroupList
return	VirtualMachineInstancesData

setDetails() public method

Sets details

public setDetails ( Scalr\Service\CloudStack\DataType\VirtualDetailsData $details = null ) : VirtualMachineInstancesData
$details	Scalr\Service\CloudStack\DataType\VirtualDetailsData
return	VirtualMachineInstancesData

setNic() public method

Sets nic list

public setNic ( Scalr\Service\CloudStack\DataType\NicList $nic = null ) : VirtualMachineInstancesData
$nic	Scalr\Service\CloudStack\DataType\NicList
return	VirtualMachineInstancesData

setSecuritygroup() public method

Sets security group list

public setSecuritygroup ( Scalr\Service\CloudStack\DataType\SecurityGroupList $securitygroup = null ) : VirtualMachineInstancesData
$securitygroup	Scalr\Service\CloudStack\DataType\SecurityGroupList
return	VirtualMachineInstancesData

setTags() public method

Sets tags

public setTags ( Scalr\Service\CloudStack\DataType\ResponseTagsList $tags = null ) : VirtualMachineInstancesData
$tags	Scalr\Service\CloudStack\DataType\ResponseTagsList
return	VirtualMachineInstancesData

Property Details

$_properties protected property

List of the public properties which is managed by magic getter and setters internally.

protected array $_properties
return	array

$account public property

The account associated with the virtual machine

public string $account
return	string

$cpunumber public property

The number of cpu this virtual machine is running with

public string $cpunumber
return	string

$cpuspeed public property

The speed of each cpu

public string $cpuspeed
return	string

$cpuused public property

The amount of the vm's CPU currently used

public string $cpuused
return	string

$created public property

The date when this virtual machine was created

public DateTime $created
return	DateTime

$diskioread public property

The read (io) of disk on the vm

public string $diskioread
return	string

$diskiowrite public property

The write (io) of disk on the vm

public string $diskiowrite
return	string

$diskkbsread public property

The read (bytes) of disk on the vm

public string $diskkbsread
return	string

$diskkbswrite public property

The write (bytes) of disk on the vm

public string $diskkbswrite
return	string

$displayname public property

The name of the virtual machine is returned if no displayname exists.

public string $displayname
return	string

$displayvm public property

An optional field whether to the display the vm to the end user or not.

public string $displayvm
return	string

$domain public property

The name of the domain in which the virtual machine exists

public string $domain
return	string

$domainid public property

The ID of the domain in which the virtual machine exists

public string $domainid
return	string

$forvirtualnetwork public property

The virtual network for the service offering

public string $forvirtualnetwork
return	string

$group public property

The group name of the virtual machine

public string $group
return	string

$groupid public property

The group ID of the virtual machine

public string $groupid
return	string

$guestosid public property

Os type ID of the virtual machine

public string $guestosid
return	string

$haenable public property

true if high-availability is enabled, false otherwise

public string $haenable
return	string

$hostid public property

The ID of the host for the virtual machine

public string $hostid
return	string

$hostname public property

The name of the host for the virtual machine

public string $hostname
return	string

$hypervisor public property

The hypervisor on which the template runs

public string $hypervisor
return	string

$id public property

The ID of the virtual machine

public string $id
return	string

$instancename public property

Instance name of the user vm; this parameter is returned to the ROOT admin only

public string $instancename
return	string

$isdynamicallyscalable public property

true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.

public string $isdynamicallyscalable
return	string

$isodisplaytext public property

An alternate display text of the ISO attached to the virtual machine

public string $isodisplaytext
return	string

$isoid public property

The ID of the ISO attached to the virtual machine

public string $isoid
return	string

$isoname public property

The name of the ISO attached to the virtual machine

public string $isoname
return	string

$keypair public property

Ssh key-pair

public string $keypair
return	string

$memory public property

The memory allocated for the virtual machine

public string $memory
return	string

$name public property

The name of the virtual machine

public string $name
return	string

$networkkbsread public property

The incoming network traffic on the vm

public string $networkkbsread
return	string

$networkkbswrite public property

The outgoing network traffic on the host

public string $networkkbswrite
return	string

$password public property

The password (if exists) of the virtual machine

public string $password
return	string

$passwordenabled public property

true if the password rest feature is enabled, false otherwise

public string $passwordenabled
return	string

$project public property

The project name of the vm

public string $project
return	string

$projectid public property

The project id of the vm

public string $projectid
return	string

$publicip public property

Public IP address associated with vm via Static nat rule

public string $publicip
return	string

$publicipid public property

Public IP address id associated with vm via Static nat rule

public string $publicipid
return	string

$rootdeviceid public property

Device ID of the root volume

public string $rootdeviceid
return	string

$rootdevicetype public property

Device type of the root volume

public string $rootdevicetype
return	string

$serviceofferingid public property

The ID of the service offering of the virtual machine

public string $serviceofferingid
return	string

$serviceofferingname public property

The name of the service offering of the virtual machine

public string $serviceofferingname
return	string

$servicestate public property

State of the Service from LB rule

public string $servicestate
return	string

$state public property

The state of the virtual machine

public string $state
return	string

$templatedisplaytext public property

An alternate display text of the template for the virtual machine

public string $templatedisplaytext
return	string

$templateid public property

A -1 is returned if the virtual machine was created from an ISO file.

public string $templateid
return	string

$templatename public property

The name of the template for the virtual machine

public string $templatename
return	string

$zoneid public property

The ID of the availablility zone for the virtual machine

public string $zoneid
return	string

$zonename public property

The name of the availability zone for the virtual machine

public string $zonename
return	string