GI.NM.Objects.SettingSriov

SR-IOV settings

Since: 1.14

Exported types

newtype SettingSriov

Memory-managed wrapper type.

Constructors

SettingSriov (ManagedPtr SettingSriov)

Instances

Eq SettingSriov

Defined in GI.NM.Objects.SettingSriov

Methods

(==) :: SettingSriov -> SettingSriov -> Bool

(/=) :: SettingSriov -> SettingSriov -> Bool

GObject SettingSriov

Defined in GI.NM.Objects.SettingSriov

ManagedPtrNewtype SettingSriov

Defined in GI.NM.Objects.SettingSriov

Methods

toManagedPtr :: SettingSriov -> ManagedPtr SettingSriov

TypedObject SettingSriov

Defined in GI.NM.Objects.SettingSriov

Methods

glibType :: IO GType

HasParentTypes SettingSriov

Defined in GI.NM.Objects.SettingSriov

IsGValue (Maybe SettingSriov)

Convert SettingSriov to and from GValue. See toGValue and fromGValue.

Defined in GI.NM.Objects.SettingSriov

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe SettingSriov -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe SettingSriov)

type ParentTypes SettingSriov

Defined in GI.NM.Objects.SettingSriov

type ParentTypes SettingSriov = '[Setting, Object]

class (GObject o, IsDescendantOf SettingSriov o) => IsSettingSriov o

Type class for types which can be safely cast to SettingSriov, for instance with toSettingSriov.

Instances

(GObject o, IsDescendantOf SettingSriov o) => IsSettingSriov o

Defined in GI.NM.Objects.SettingSriov

toSettingSriov :: (MonadIO m, IsSettingSriov o) => o -> m SettingSriov

Cast to SettingSriov, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

addVf, bindProperty, bindPropertyFull, clearVfs, compare, diff, duplicate, enumerateValues, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, optionClearByName, optionGet, optionGetAllNames, optionGetBoolean, optionGetUint32, optionSet, optionSetBoolean, optionSetUint32, ref, refSink, removeVf, removeVfByIndex, runDispose, stealData, stealQdata, thawNotify, toString, unref, verify, verifySecrets, watchClosure.

Getters

getAutoprobeDrivers, getData, getDbusPropertyType, getEswitchEncapMode, getEswitchInlineMode, getEswitchMode, getName, getNumVfs, getProperty, getQdata, getSecretFlags, getTotalVfs, getVf.

Setters

setData, setDataFull, setProperty, setSecretFlags.

addVf

settingSriovAddVf

Arguments

:: (HasCallStack, MonadIO m, IsSettingSriov a)

=> a

setting: the SettingSriov

-> SriovVF

vf: the VF to add

-> m ()

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

Since: 1.14

clearVfs

settingSriovClearVfs

Arguments

:: (HasCallStack, MonadIO m, IsSettingSriov a)

=> a

setting: the SettingSriov

-> m ()

Removes all configured VFs.

Since: 1.14

getAutoprobeDrivers

settingSriovGetAutoprobeDrivers

Arguments

:: (HasCallStack, MonadIO m, IsSettingSriov a)

=> a

setting: the SettingSriov

-> m Ternary

Returns: the autoprobe-drivers property value

Returns the value contained in the SettingSriov:autoprobeDrivers property.

Since: 1.14

getEswitchEncapMode

settingSriovGetEswitchEncapMode

Arguments

:: (HasCallStack, MonadIO m, IsSettingSriov a)

=> a

setting: the SettingSriov

-> m SriovEswitchEncapMode

Returns: the value contained in the SettingSriov:eswitchEncapMode property.

No description available in the introspection data.

Since: 1.46

getEswitchInlineMode

settingSriovGetEswitchInlineMode

Arguments

:: (HasCallStack, MonadIO m, IsSettingSriov a)

=> a

setting: the SettingSriov

-> m SriovEswitchInlineMode

Returns: the value contained in the SettingSriov:eswitchInlineMode property.

No description available in the introspection data.

Since: 1.46

getEswitchMode

settingSriovGetEswitchMode

Arguments

:: (HasCallStack, MonadIO m, IsSettingSriov a)

=> a

setting: the SettingSriov

-> m SriovEswitchMode

Returns: the value contained in the SettingSriov:eswitchMode property.

No description available in the introspection data.

Since: 1.46

getNumVfs

settingSriovGetNumVfs

Arguments

:: (HasCallStack, MonadIO m, IsSettingSriov a)

=> a

setting: the SettingSriov

-> m Word32

Returns: the number of configured VFs

No description available in the introspection data.

Since: 1.14

getTotalVfs

settingSriovGetTotalVfs

Arguments

:: (HasCallStack, MonadIO m, IsSettingSriov a)

=> a

setting: the SettingSriov

-> m Word32

Returns: the total number of SR-IOV virtual functions to create

Returns the value contained in the SettingSriov:totalVfs property.

Since: 1.14

getVf

settingSriovGetVf

Arguments

:: (HasCallStack, MonadIO m, IsSettingSriov a)

=> a

setting: the SettingSriov

-> Word32

idx: index number of the VF to return

-> m SriovVF

Returns: the VF at index idx

No description available in the introspection data.

Since: 1.14

new

settingSriovNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingSriov

Returns: the new empty SettingSriov object

Creates a new SettingSriov object with default values.

Since: 1.14

removeVf

settingSriovRemoveVf

Arguments

:: (HasCallStack, MonadIO m, IsSettingSriov a)

=> a

setting: the SettingSriov

-> Word32

idx: index number of the VF

-> m ()

Removes the VF at index idx.

Since: 1.14

removeVfByIndex

settingSriovRemoveVfByIndex

Arguments

:: (HasCallStack, MonadIO m, IsSettingSriov a)

=> a

setting: the SettingSriov

-> Word32

index: the VF index of the VF to remove

-> m Bool

Returns: True if the VF was found and removed; False if it was not

Removes the VF with VF index index.

Since: 1.14

Properties

autoprobeDrivers

Whether to autoprobe virtual functions by a compatible driver.

If set to TernaryTrue, 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 TernaryFalse, VFs will not be claimed and no network interfaces will be created for them.

When set to TernaryDefault, the global default is used; in case the global default is unspecified it is assumed to be TernaryTrue.

Since: 1.14

constructSettingSriovAutoprobeDrivers :: (IsSettingSriov o, MonadIO m) => Ternary -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “autoprobe-drivers” property. This is rarely needed directly, but it is used by new.

getSettingSriovAutoprobeDrivers :: (MonadIO m, IsSettingSriov o) => o -> m Ternary

Get the value of the “autoprobe-drivers” property. When overloading is enabled, this is equivalent to

get settingSriov #autoprobeDrivers

setSettingSriovAutoprobeDrivers :: (MonadIO m, IsSettingSriov o) => o -> Ternary -> m ()

Set the value of the “autoprobe-drivers” property. When overloading is enabled, this is equivalent to

set settingSriov [ #autoprobeDrivers := value ]

eswitchEncapMode

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 SriovEswitchEncapModePreserve (default) the eswitch encap-mode won't be modified by NetworkManager.

Since: 1.46

constructSettingSriovEswitchEncapMode :: (IsSettingSriov o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “eswitch-encap-mode” property. This is rarely needed directly, but it is used by new.

getSettingSriovEswitchEncapMode :: (MonadIO m, IsSettingSriov o) => o -> m Int32

Get the value of the “eswitch-encap-mode” property. When overloading is enabled, this is equivalent to

get settingSriov #eswitchEncapMode

setSettingSriovEswitchEncapMode :: (MonadIO m, IsSettingSriov o) => o -> Int32 -> m ()

Set the value of the “eswitch-encap-mode” property. When overloading is enabled, this is equivalent to

set settingSriov [ #eswitchEncapMode := value ]

eswitchInlineMode

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 SriovEswitchInlineModePreserve (default) the eswitch inline-mode won't be modified by NetworkManager.

Since: 1.46

constructSettingSriovEswitchInlineMode :: (IsSettingSriov o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “eswitch-inline-mode” property. This is rarely needed directly, but it is used by new.

getSettingSriovEswitchInlineMode :: (MonadIO m, IsSettingSriov o) => o -> m Int32

Get the value of the “eswitch-inline-mode” property. When overloading is enabled, this is equivalent to

get settingSriov #eswitchInlineMode

setSettingSriovEswitchInlineMode :: (MonadIO m, IsSettingSriov o) => o -> Int32 -> m ()

Set the value of the “eswitch-inline-mode” property. When overloading is enabled, this is equivalent to

set settingSriov [ #eswitchInlineMode := value ]

eswitchMode

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 SriovEswitchModePreserve (default) the eswitch mode won't be modified by NetworkManager.

Since: 1.46

constructSettingSriovEswitchMode :: (IsSettingSriov o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “eswitch-mode” property. This is rarely needed directly, but it is used by new.

getSettingSriovEswitchMode :: (MonadIO m, IsSettingSriov o) => o -> m Int32

Get the value of the “eswitch-mode” property. When overloading is enabled, this is equivalent to

get settingSriov #eswitchMode

setSettingSriovEswitchMode :: (MonadIO m, IsSettingSriov o) => o -> Int32 -> m ()

Set the value of the “eswitch-mode” property. When overloading is enabled, this is equivalent to

set settingSriov [ #eswitchMode := value ]

totalVfs

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.

Since: 1.14

constructSettingSriovTotalVfs :: (IsSettingSriov o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “total-vfs” property. This is rarely needed directly, but it is used by new.

getSettingSriovTotalVfs :: (MonadIO m, IsSettingSriov o) => o -> m Word32

Get the value of the “total-vfs” property. When overloading is enabled, this is equivalent to

get settingSriov #totalVfs

setSettingSriovTotalVfs :: (MonadIO m, IsSettingSriov o) => o -> Word32 -> m ()

Set the value of the “total-vfs” property. When overloading is enabled, this is equivalent to

set settingSriov [ #totalVfs := value ]

vfs