Develop for XenServer

Class: VIF_metrics

June 19, 2024

Contributed by:

X X

This class is removed.

The metrics associated with a virtual network device

Fields for class: VIF_metrics

Field	Type	Qualifier	Description
`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	Removed. Time at which this information was last updated
`other_config`	`(string -> string) map`	RW	Removed. additional configuration
`uuid`	`string`	RO/runtime	Removed. Unique identifier/object reference

RPCs associated with class: VIF_metrics

RPC name: add_to_other_config

This message is removed.

Overview:

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

Signature:

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

Arguments:

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

Minimum Role: vm-admin

Return Type: void

RPC name: get_all

This message is removed.

Overview:

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

Signature:

VIF_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: VIF_metrics ref set

references to all objects

RPC name: get_all_records

This message is removed.

Overview:

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

Signature:

(VIF_metrics ref -> VIF_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: (VIF_metrics ref -> VIF_metrics record) map

records of all objects

RPC name: get_by_uuid

This message is removed.

Overview:

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

Signature:

VIF_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: VIF_metrics ref

reference to the object

RPC name: get_io_read_kbs

This message is removed.

Overview:

Get the io/read_kbs field of the given VIF_metrics.

Signature:

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

Arguments:

Type	Name	Description
`session ref`	`session_ref`	Reference to a valid session
`VIF_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 VIF_metrics.

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: float

value of the field

RPC name: get_last_updated

This message is removed.

Overview:

Get the last_updated field of the given VIF_metrics.

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: datetime

value of the field

RPC name: get_other_config

This message is removed.

Overview:

Get the other_config field of the given VIF_metrics.

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: (string -> string) map

value of the field

RPC name: get_record

This message is removed.

Overview:

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

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: VIF_metrics record

all fields from the object

RPC name: get_uuid

This message is removed.

Overview:

Get the uuid field of the given VIF_metrics.

Signature:

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

Arguments:

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

Minimum Role: read-only

Return Type: string

value of the field

RPC name: remove_from_other_config

This message is removed.

Overview:

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

Signature:

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

Arguments:

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

Minimum Role: vm-admin

Return Type: void

RPC name: set_other_config

This message is removed.

Overview:

Set the other_config field of the given VIF_metrics.

Signature:

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

Arguments:

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

Minimum Role: vm-admin

Return Type: void

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Class: VIF_metrics

June 19, 2024

Contributed by:

X X

June 19, 2024

Contributed by:

X X

Class: VIF_metrics

Fields for class: VIF_metrics

RPCs associated with class: VIF_metrics

RPC name: add_to_other_config

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_uuid

RPC name: get_io_read_kbs

RPC name: get_io_write_kbs

RPC name: get_last_updated

RPC name: get_other_config

RPC name: get_record

RPC name: get_uuid

RPC name: remove_from_other_config

RPC name: set_other_config

In this article