Develop for XenServer

Class: PIF_metrics

The metrics associated with a physical network interface

Fields for class: PIF_metrics

Field Type Qualifier Description
carrier bool RO/runtime Report if the PIF got a carrier or not
device_id string RO/runtime Report device ID
device_name string RO/runtime Report device name
duplex bool RO/runtime Full duplex capability of the link (if available)
io_read_kbs float RO/runtime Removed. Read bandwidth (KiB/s)
io_write_kbs float RO/runtime Removed. Write bandwidth (KiB/s)
last_updated datetime RO/runtime Time at which this information was last updated
other_config (string -> string) map RW additional configuration
pci_bus_path string RO/runtime PCI bus path of the pif (if available)
speed int RO/runtime Speed of the link in Mbit/s (if available)
uuid string RO/runtime Unique identifier/object reference
vendor_id string RO/runtime Report vendor ID
vendor_name string RO/runtime Report vendor name

RPCs associated with class: PIF_metrics

RPC name: add_to_other_config

Overview:

Add the given key-value pair to the other_config field of the given PIF_metrics.

Signature:

void add_to_other_config (session ref session_ref, PIF_metrics ref self, string key, string value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object
string key Key to add
string value Value to add

Minimum Role: pool-operator

Return Type: void

RPC name: get_all

Overview:

Return a list of all the PIF_metrics instances known to the system.

Signature:

PIF_metrics ref set get_all (session ref session_ref)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session

Minimum Role: read-only

Return Type: PIF_metrics ref set

references to all objects

RPC name: get_all_records

Overview:

Return a map of PIF_metrics references to PIF_metrics records for all PIF_metrics instances known to the system.

Signature:

(PIF_metrics ref -> PIF_metrics record) map get_all_records (session ref session_ref)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session

Minimum Role: read-only

Return Type: (PIF_metrics ref -> PIF_metrics record) map

records of all objects

RPC name: get_by_uuid

Overview:

Get a reference to the PIF_metrics instance with the specified UUID.

Signature:

PIF_metrics ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
string uuid UUID of object to return

Minimum Role: read-only

Return Type: PIF_metrics ref

reference to the object

RPC name: get_carrier

Overview:

Get the carrier field of the given PIF_metrics.

Signature:

bool get_carrier (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_device_id

Overview:

Get the device_id field of the given PIF_metrics.

Signature:

string get_device_id (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_device_name

Overview:

Get the device_name field of the given PIF_metrics.

Signature:

string get_device_name (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_duplex

Overview:

Get the duplex field of the given PIF_metrics.

Signature:

bool get_duplex (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: bool

value of the field

RPC name: get_io_read_kbs

This message is removed.

Overview:

Get the io/read_kbs field of the given PIF_metrics.

Signature:

float get_io_read_kbs (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: float

value of the field

RPC name: get_io_write_kbs

This message is removed.

Overview:

Get the io/write_kbs field of the given PIF_metrics.

Signature:

float get_io_write_kbs (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: float

value of the field

RPC name: get_last_updated

Overview:

Get the last_updated field of the given PIF_metrics.

Signature:

datetime get_last_updated (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: datetime

value of the field

RPC name: get_other_config

Overview:

Get the other_config field of the given PIF_metrics.

Signature:

(string -> string) map get_other_config (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_pci_bus_path

Overview:

Get the pci_bus_path field of the given PIF_metrics.

Signature:

string get_pci_bus_path (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_record

Overview:

Get a record containing the current state of the given PIF_metrics.

Signature:

PIF_metrics record get_record (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: PIF_metrics record

all fields from the object

RPC name: get_speed

Overview:

Get the speed field of the given PIF_metrics.

Signature:

int get_speed (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: int

value of the field

RPC name: get_uuid

Overview:

Get the uuid field of the given PIF_metrics.

Signature:

string get_uuid (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_vendor_id

Overview:

Get the vendor_id field of the given PIF_metrics.

Signature:

string get_vendor_id (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: get_vendor_name

Overview:

Get the vendor_name field of the given PIF_metrics.

Signature:

string get_vendor_name (session ref session_ref, PIF_metrics ref self)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object

Minimum Role: read-only

Return Type: string

value of the field

RPC name: remove_from_other_config

Overview:

Remove the given key and its corresponding value from the other_config field of the given PIF_metrics. If the key is not in that Map, then do nothing.

Signature:

void remove_from_other_config (session ref session_ref, PIF_metrics ref self, string key)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object
string key Key to remove

Minimum Role: pool-operator

Return Type: void

RPC name: set_other_config

Overview:

Set the other_config field of the given PIF_metrics.

Signature:

void set_other_config (session ref session_ref, PIF_metrics ref self, (string -> string) map value)
<!--NeedCopy-->

Arguments:

Type Name Description
session ref session_ref Reference to a valid session
PIF_metrics ref self reference to the object
(string -> string) map value New value to set

Minimum Role: pool-operator

Return Type: void