Class: networksriov

Last published : Oct 01, 2026
networksriov which connects logical pif and physical pif
Related information
XenServer 9 Management API

Fields for class: networksriov

Field Type Qualifier Description
configuration_mode sriov_configuration_mode RO/runtime The mode for configure network sriov
logical_PIF PIF ref RO/constructor The logical PIF to connect to the SR-IOV network after enable SR-IOV on the physical PIF
physical_PIF PIF ref RO/constructor The PIF that has SR-IOV enabled
requires_reboot bool RO/runtime Indicates whether the host need to be rebooted before SR-IOV is enabled on the physical PIF
uuid string RO/runtime Unique identifier/object reference

RPCs associated with class: networksriov

RPC name: create

Overview:
Enable SRIOV on the specific PIF. It will create a networksriov based on the specific PIF and automatically create a logical PIF to connect the specific network.
Signature:
network_sriov ref create (session ref session_ref, PIF ref pif, network ref network)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PIF ref pif PIF on which to enable SR-IOV
network ref network Network to connect SR-IOV virtual functions with VM VIFs
Minimum Role: pool-operator
Return Type: network_sriov ref
The reference of the created networksriov object

RPC name: destroy

Overview:
Disable SRIOV on the specific PIF. It will destroy the networksriov and the logical PIF accordingly.
Signature:
void destroy (session ref session_ref, network_sriov ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
network_sriov ref self SRIOV to destroy
Minimum Role: pool-operator
Return Type: void

RPC name: getall

Overview:
Return a list of all the networksriovs known to the system.
Signature:
network_sriov ref set get_all (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: network_sriov ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of networksriov references to networksriov records for all networksriovs known to the system.
Signature:
(network_sriov ref -> network_sriov record) map get_all_records (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: (network_sriov ref -> network_sriov record) map
records of all objects

RPC name: getbyuuid

Overview:
Get a reference to the networksriov instance with the specified UUID.
Signature:
network_sriov ref get_by_uuid (session ref session_ref, string uuid)
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: network_sriov ref
reference to the object

RPC name: getconfigurationmode

Overview:
Get the configurationmode field of the given networksriov.
Signature:
sriov_configuration_mode get_configuration_mode (session ref session_ref, network_sriov ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
network_sriov ref self reference to the object
Minimum Role: read-only
Return Type: sriov_configuration_mode
value of the field

RPC name: getlogicalPIF

Overview:
Get the logicalPIF field of the given networksriov.
Signature:
PIF ref get_logical_PIF (session ref session_ref, network_sriov ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
network_sriov ref self reference to the object
Minimum Role: read-only
Return Type: PIF ref
value of the field

RPC name: getphysicalPIF

Overview:
Get the physicalPIF field of the given networksriov.
Signature:
PIF ref get_physical_PIF (session ref session_ref, network_sriov ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
network_sriov ref self reference to the object
Minimum Role: read-only
Return Type: PIF ref
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given networksriov.
Signature:
network_sriov record get_record (session ref session_ref, network_sriov ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
network_sriov ref self reference to the object
Minimum Role: read-only
Return Type: network_sriov record
all fields from the object

RPC name: getremainingcapacity

Overview:
Get the number of free SRIOV VFs on the associated PIF
Signature:
int get_remaining_capacity (session ref session_ref, network_sriov ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
network_sriov ref self the NETWORK_SRIOV object
Minimum Role: read-only
Return Type: int
The number of free SRIOV VFs on the associated PIF

RPC name: getrequiresreboot

Overview:
Get the requiresreboot field of the given networksriov.
Signature:
bool get_requires_reboot (session ref session_ref, network_sriov ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
network_sriov ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getuuid

Overview:
Get the uuid field of the given networksriov.
Signature:
string get_uuid (session ref session_ref, network_sriov ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
network_sriov ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field