Class: network_sriov
network-sriov which connects logical pif and physical pif
Published in:
XenServer 7.5 (kolkata)
Enums
sriov_configuration_mode
Values:
sysfs
Configure network sriov by sysfs, do not need reboot
modprobe
Configure network sriov by modprobe, need reboot
manual
Configure network sriov manually
unknown
Unknown mode
Fields
enum sriov_configuration_mode
configuration_mode
[RO/runtime]
The mode for configure network sriov
Default value:
unknown
Published in:
XenServer 7.5 (kolkata)
PIF ref
logical_PIF
[RO/constructor]
The logical PIF to connect to the SR-IOV network after enable SR-IOV on the physical PIF
Default value:
Null
Published in:
XenServer 7.5 (kolkata)
PIF ref
physical_PIF
[RO/constructor]
The PIF that has SR-IOV enabled
Default value:
Null
Published in:
XenServer 7.5 (kolkata)
bool
requires_reboot
[RO/runtime]
Indicates whether the host need to be rebooted before SR-IOV is enabled on the physical PIF
Default value:
false
Published in:
XenServer 7.5 (kolkata)
string
uuid
[RO/runtime]
Unique identifier/object reference
Published in:
XenServer 4.0 (rio)
Unique identifier/object reference
Messages
Hide implicit
network_sriov ref
create
(session ref, PIF ref, network ref)
Enable SR-IOV on the specific PIF. It will create a network-sriov based on the specific PIF and automatically create a logical PIF to connect the specific network.
Parameters:
session ref session_id
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
Result:
The reference of the created network_sriov object
Published in:
XenServer 7.5 (kolkata)
void
destroy
(session ref, network_sriov ref)
Disable SR-IOV on the specific PIF. It will destroy the network-sriov and the logical PIF accordingly.
Parameters:
session ref session_id
Reference to a valid session
network_sriov ref self
SRIOV to destroy
Minimum role:
pool-operator
Published in:
XenServer 7.5 (kolkata)
network_sriov ref set
get_all
(session ref)
Return a list of all the network_sriovs known to the system.
Parameters:
session ref session_id
Reference to a valid session
Minimum role:
read-only
Result:
references to all objects
Published in:
XenServer 7.5 (kolkata)
(network_sriov ref → network_sriov record) map
get_all_records
(session ref)
Return a map of network_sriov references to network_sriov records for all network_sriovs known to the system.
Parameters:
session ref session_id
Reference to a valid session
Minimum role:
read-only
Result:
records of all objects
Published in:
XenServer 7.5 (kolkata)
network_sriov ref
get_by_uuid
(session ref, string)
Get a reference to the network_sriov instance with the specified UUID.
Parameters:
session ref session_id
Reference to a valid session
string uuid
UUID of object to return
Minimum role:
read-only
Result:
reference to the object
Published in:
XenServer 7.5 (kolkata)
enum sriov_configuration_mode
get_configuration_mode
(session ref, network_sriov ref)
Get the configuration_mode field of the given network_sriov.
Parameters:
session ref session_id
Reference to a valid session
network_sriov ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 7.5 (kolkata)
PIF ref
get_logical_PIF
(session ref, network_sriov ref)
Get the logical_PIF field of the given network_sriov.
Parameters:
session ref session_id
Reference to a valid session
network_sriov ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 7.5 (kolkata)
PIF ref
get_physical_PIF
(session ref, network_sriov ref)
Get the physical_PIF field of the given network_sriov.
Parameters:
session ref session_id
Reference to a valid session
network_sriov ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 7.5 (kolkata)
network_sriov record
get_record
(session ref, network_sriov ref)
Get a record containing the current state of the given network_sriov.
Parameters:
session ref session_id
Reference to a valid session
network_sriov ref self
reference to the object
Minimum role:
read-only
Result:
all fields from the object
Published in:
XenServer 7.5 (kolkata)
int
get_remaining_capacity
(session ref, network_sriov ref)
Get the number of free SR-IOV VFs on the associated PIF
Parameters:
session ref session_id
Reference to a valid session
network_sriov ref self
the NETWORK_SRIOV object
Minimum role:
read-only
Result:
The number of free SR-IOV VFs on the associated PIF
Published in:
XenServer 7.5 (kolkata)
bool
get_requires_reboot
(session ref, network_sriov ref)
Get the requires_reboot field of the given network_sriov.
Parameters:
session ref session_id
Reference to a valid session
network_sriov ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 7.5 (kolkata)
string
get_uuid
(session ref, network_sriov ref)
Get the uuid field of the given network_sriov.
Parameters:
session ref session_id
Reference to a valid session
network_sriov ref self
reference to the object
Minimum role:
read-only
Result:
value of the field
Published in:
XenServer 4.0 (rio)
Unique identifier/object reference