Struct SettingSriov 

pub struct SettingSriov { /* private fields */ }

Available on crate feature v1_14 only.

SR-IOV settings

Properties

autoprobe-drivers

Whether to autoprobe virtual functions by a compatible driver.

If set to Ternary::True, the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF.

If set to Ternary::False, VFs will not be claimed and no network interfaces will be created for them.

When set to Ternary::Default, the global default is used; in case the global default is unspecified it is assumed to be Ternary::True.

Readable | Writeable

eswitch-encap-mode

Select the eswitch encapsulation support.

Currently it’s only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.

If set to [SriovEswitchEncapMode::Preserve][crate::SriovEswitchEncapMode::Preserve] (default) the eswitch encap-mode won’t be modified by NetworkManager.

Readable | Writeable

eswitch-inline-mode

Select the eswitch inline-mode of the device. Some HWs need the VF driver to put part of the packet headers on the TX descriptor so the e-switch can do proper matching and steering.

Currently it’s only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.

If set to [SriovEswitchInlineMode::Preserve][crate::SriovEswitchInlineMode::Preserve] (default) the eswitch inline-mode won’t be modified by NetworkManager.

Readable | Writeable

eswitch-mode

Select the eswitch mode of the device. Currently it’s only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.

If set to [SriovEswitchMode::Preserve][crate::SriovEswitchMode::Preserve] (default) the eswitch mode won’t be modified by NetworkManager.

Readable | Writeable

preserve-on-down

This controls whether NetworkManager preserves the SR-IOV parameters set on the device when the connection is deactivated, or whether it resets them to their default value. The SR-IOV parameters are those specified in this setting (the “sriov” setting), like the number of VFs to create, the eswitch configuration, etc.

If set to [SriovPreserveOnDown::No][crate::SriovPreserveOnDown::No], NetworkManager resets the SR-IOV parameters when the connection is deactivated. When set to [SriovPreserveOnDown::Yes][crate::SriovPreserveOnDown::Yes], NetworkManager preserves those parameters on the device. If the value is [SriovPreserveOnDown::Default][crate::SriovPreserveOnDown::Default], NetworkManager looks up a global default value in the configuration; in case no such value is defined, it uses [SriovPreserveOnDown::No][crate::SriovPreserveOnDown::No] as fallback.

Readable | Writeable

total-vfs

The total number of virtual functions to create.

Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don’t add a sriov setting to the connection.

Readable | Writeable

vfs

Array of virtual function descriptors.

Each VF descriptor is a dictionary mapping attribute names to GVariant values. The ‘index’ entry is mandatory for each VF.

When represented as string a VF is in the form:

“INDEX [ATTR=VALUE[ ATTR=VALUE]…]”.

for example:

“2 mac=00:11:22:33:44:55 spoof-check=true”.

Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans.

The “vlans” attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form

“ID[.PRIORITY[.PROTO]]”.

PROTO can be either ‘q’ for 802.1Q (the default) or ‘ad’ for 802.1ad.

Readable | Writeable

Setting

name

The setting’s name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example “ppp” or “802-11-wireless” or “802-3-ethernet”.

Readable

Implements

SettingExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl SettingSriov

pub fn new() -> SettingSriov

Creates a new #NMSettingSriov object with default values.

Returns

the new empty #NMSettingSriov object

pub fn builder() -> SettingSriovBuilder

Creates a new builder-pattern struct instance to construct SettingSriov objects.

This method returns an instance of SettingSriovBuilder which can be used to create SettingSriov objects.

pub fn add_vf(&self, vf: &SriovVF)

Appends a new VF and associated information to the setting. The given VF is duplicated internally and is not changed by this function.

vf

the VF to add

pub fn clear_vfs(&self)

Removes all configured VFs.

pub fn autoprobe_drivers(&self) -> Ternary

Returns the value contained in the #NMSettingSriov:autoprobe-drivers property.

Returns

the autoprobe-drivers property value

pub fn num_vfs(&self) -> u32

Returns

the number of configured VFs

pub fn total_vfs(&self) -> u32

Returns the value contained in the #NMSettingSriov:total-vfs property.

Returns

the total number of SR-IOV virtual functions to create

pub fn vf(&self, idx: u32) -> SriovVF

idx

index number of the VF to return

Returns

the VF at index @idx

pub fn remove_vf(&self, idx: u32)

Removes the VF at index @idx.

idx

index number of the VF

pub fn remove_vf_by_index(&self, index: u32) -> bool

Removes the VF with VF index @index.

index

the VF index of the VF to remove

Returns

true if the VF was found and removed; false if it was not

pub fn set_autoprobe_drivers(&self, autoprobe_drivers: Ternary)

Whether to autoprobe virtual functions by a compatible driver.

If set to Ternary::True, the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF.

If set to Ternary::False, VFs will not be claimed and no network interfaces will be created for them.

When set to Ternary::Default, the global default is used; in case the global default is unspecified it is assumed to be Ternary::True.

pub fn set_total_vfs(&self, total_vfs: u32)

The total number of virtual functions to create.

Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don’t add a sriov setting to the connection.

pub fn vfs(&self) -> Vec<SriovVF>

Array of virtual function descriptors.

Each VF descriptor is a dictionary mapping attribute names to GVariant values. The ‘index’ entry is mandatory for each VF.

When represented as string a VF is in the form:

“INDEX [ATTR=VALUE[ ATTR=VALUE]…]”.

for example:

“2 mac=00:11:22:33:44:55 spoof-check=true”.

Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans.

The “vlans” attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form

“ID[.PRIORITY[.PROTO]]”.

PROTO can be either ‘q’ for 802.1Q (the default) or ‘ad’ for 802.1ad.

pub fn set_vfs(&self, vfs: &[&SriovVF])

Array of virtual function descriptors.

Each VF descriptor is a dictionary mapping attribute names to GVariant values. The ‘index’ entry is mandatory for each VF.

When represented as string a VF is in the form:

“INDEX [ATTR=VALUE[ ATTR=VALUE]…]”.

for example:

“2 mac=00:11:22:33:44:55 spoof-check=true”.

Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans.

The “vlans” attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form

“ID[.PRIORITY[.PROTO]]”.

PROTO can be either ‘q’ for 802.1Q (the default) or ‘ad’ for 802.1ad.

pub fn connect_autoprobe_drivers_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_total_vfs_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_vfs_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for SettingSriov

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SettingSriov

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SettingSriov

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SettingSriov

type ParamSpec = ParamSpecObject

type SetValue = SettingSriov

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, SettingSriov>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SettingSriov

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SettingSriov

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for SettingSriov

type Parent = Setting

impl<OT: ObjectType> PartialEq<OT> for SettingSriov

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for SettingSriov

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SettingSriov

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SettingSriov

impl IsA<Setting> for SettingSriov