Package prlsdkapi :: Class VmStat

Class VmStat

  object --+        
           |        
 prlsdk.Base --+    
               |    
prlsdk.BaseAsync --+
                   |
                  VmStat

Provides methods for obtaining performance statistics hosts and virtual machines.

Instance Methods

[hide private]

get_cpu_stat(self, index)
Obtain and return CPU statistics.

get_iface_stat(self, index)
Obtain and return network interface statistics.

get_user_stat(self, index)
Obtain and return the user session statistics.

get_disk_stat(self, index)
Obtain and return disk drive statistics.

get_proc_stat(self, index)
Obtain and return system process statistics.

Inherited from prlsdk.BaseAsync: __cmp__, __init__, __new__, __repr__, cancel, wait

Inherited from object: __delattr__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __setattr__, __str__

Class Variables

[hide private]

__prefix__ = 'stat'

__ht__ = 268435488

Properties

[hide private]

total_ram_size
Total RAM size in bytes.

usage_ram_size
The amount of used RAM in bytes.

free_ram_size
The amount of free RAM in bytes.

total_swap_size
Total swap size in bytes.

usage_swap_size
The amount of used swap in bytes.

free_swap_size
The amount of free swap in bytes.

os_uptime
The operating system uptime in seconds.

disp_uptime
The Parallels Service uptime in secounds.

cpus_stats_count
Indicates the number of instances of VmCPUStat contained in this object.

ifaces_stats_count
Indicates the number of instance of VmIFaceStat contained in this object.

users_stats_count
Indicates the number of instances of VmUserStat contained in this object.

disks_stats_count
Indicates the number of instances of VmDiskStat contained in this object.

procs_stats_count
Indicates the number of instances of VmProcStat contained in this object.

cpu_stats
An iterator/sequence that allows to traverse through VmCPUStat instances.

iface_stats
An iterator/sequence that allows to traverse through VmIFaceStat instances.

user_stats
An iterator/sequence that allows to traverse through VmUserStat instances.

disk_stats
An iterator/sequence that allows to traverse through VmDiskStat instances.

proc_stats
An iterator/sequence that allows to traverse through VmProcStat instances.

Inherited from prlsdk.BaseAsync: __expected_h_type__, __job__, finished, handle_type

Inherited from prlsdk.Base: __handle__

Inherited from object: __class__

Method Details

[hide private]

get_cpu_stat(self, index)

Obtain and return CPU statistics.

Parameters:

index - A numeric index identifying a CPU instance. To obtain the instance count, use VmStat.cpus_stats_count.

Returns:

An instance of VmCPUStat.

get_iface_stat(self, index)

Obtain and return network interface statistics.

Parameters:

index - A numeric instance identifying a network interface. To obtain the net interface count, use VmStat.ifaces_stats_count.

Returns:

An instance of VmIFaceStat.

get_user_stat(self, index)

Obtain and return the user session statistics.

Parameters:

index - A numeric index identifying a user session. To obtain the user session count, use VmStat.users_stats_count.

Returns:

An instance of VmUserStat.

get_disk_stat(self, index)

Obtain and return disk drive statistics.

Parameters:

index - A numeric index identifying a disk. To obtain the disk count, use VmStat.disks_stats_count.

Returns:

An instance of VmDiskStat.

get_proc_stat(self, index)

Obtain and return system process statistics.

Parameters:

index - A numeric index identifying a process. To obtain the process count, use VmStat.procs_stats_count.

Returns:

An instance of VmProcStat.

Property Details

[hide private]

total_ram_size

Total RAM size in bytes.

Get Method:: unreachable.stat__get_total_ram_size(stat, Stat) - Returns total RAM size in bytes.

usage_ram_size

The amount of used RAM in bytes.

Get Method:: unreachable.stat__get_usage_ram_size(stat, Stat) - Returns usage RAM size in bytes.

free_ram_size

The amount of free RAM in bytes.

Get Method:: unreachable.stat__get_free_ram_size(stat, Stat) - Returns free RAM size in bytes.

total_swap_size

Total swap size in bytes.

Get Method:: unreachable.stat__get_total_swap_size(stat, Stat) - Returns total swap size in bytes.

usage_swap_size

The amount of used swap in bytes.

Get Method:: unreachable.stat__get_usage_swap_size(stat, Stat) - Returns usage swap size in bytes.

free_swap_size

The amount of free swap in bytes.

Get Method:: unreachable.stat__get_free_swap_size(stat, Stat) - Returns free swap size in bytes.

os_uptime

The operating system uptime in seconds.

Get Method:: unreachable.stat__get_os_uptime(stat, Stat) - Returns OS uptime in secs.

disp_uptime

The Parallels Service uptime in secounds.

Get Method:: unreachable.stat__get_disp_uptime(stat, Stat) - Returns dispatcher uptime in secs.

cpus_stats_count

Indicates the number of instances of VmCPUStat contained in this object.

Get Method:: unreachable.stat__get_cpus_stats_count(stat, Stat) - Returns CPUs statistics elements count.

ifaces_stats_count

Indicates the number of instance of VmIFaceStat contained in this object.

Get Method:: unreachable.stat__get_ifaces_stats_count(stat, Stat) - Returns net ifaces statistics elements count.

users_stats_count

Indicates the number of instances of VmUserStat contained in this object.

Get Method:: unreachable.stat__get_users_stats_count(stat, Stat) - Returns users sessions statistics elements count.

disks_stats_count

Indicates the number of instances of VmDiskStat contained in this object.

Get Method:: unreachable.stat__get_disks_stats_count(stat, Stat) - Returns disks statistics elements count.

procs_stats_count

Indicates the number of instances of VmProcStat contained in this object.

Get Method:: unreachable.stat__get_procs_stats_count(stat, Stat) - Returns processes statistics elements count.

cpu_stats

An iterator/sequence that allows to traverse through VmCPUStat instances.

Get Method:: unreachable(s)

iface_stats

An iterator/sequence that allows to traverse through VmIFaceStat instances.

Get Method:: unreachable(s)

user_stats

An iterator/sequence that allows to traverse through VmUserStat instances.

Get Method:: unreachable(s)

disk_stats

An iterator/sequence that allows to traverse through VmDiskStat instances.

Get Method:: unreachable(s)

proc_stats

An iterator/sequence that allows to traverse through VmProcStat instances.

Get Method:: unreachable(s)