gi-nm-1.0.1: NM bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.NM.Objects.SettingWired

Description

Wired Ethernet Settings

Synopsis

Exported types

class (GObject o, IsDescendantOf SettingWired o) => IsSettingWired o Source #

Type class for types which can be safely cast to SettingWired, for instance with toSettingWired.

Instances

Instances details
(GObject o, IsDescendantOf SettingWired o) => IsSettingWired o Source # 
Instance details

Defined in GI.NM.Objects.SettingWired

toSettingWired :: (MonadIO m, IsSettingWired o) => o -> m SettingWired Source #

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

Methods

addMacBlacklistItem

settingWiredAddMacBlacklistItem Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> Text

mac: the MAC address string (hex-digits-and-colons notation) to blacklist

-> m Bool

Returns: True if the MAC address was added; False if the MAC address is invalid or was already present

Deprecated: (Since version 1.48.)Use settingWiredAddMacDenylistItem instead.

Adds a new MAC address to the SettingWired:macAddressBlacklist property.

addMacDenylistItem

settingWiredAddMacDenylistItem Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> Text

mac: the MAC address string (hex-digits-and-colons notation) to denylist

-> m Bool

Returns: True if the MAC address was added; False if the MAC address is invalid or was already present

Adds a new MAC address to the SettingWired:macAddressDenylist property.

Since: 1.48

addS390Option

settingWiredAddS390Option Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> Text

key: key name for the option

-> Text

value: value for the option

-> m Bool

Returns: since 1.32 this always returns True.

Add an option to the table. If the key already exists, the value gets replaced.

Before 1.32, the function would assert that the key is valid. Since then, an invalid key gets silently added but renders the profile as invalid.

clearMacBlacklistItems

settingWiredClearMacBlacklistItems Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m () 

Deprecated: (Since version 1.48.)Use settingWiredClearMacDenylistItems instead.

Removes all blacklisted MAC addresses.

clearMacDenylistItems

settingWiredClearMacDenylistItems Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m () 

Removes all denylisted MAC addresses.

Since: 1.48

getAcceptAllMacAddresses

settingWiredGetAcceptAllMacAddresses Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Ternary

Returns: the SettingWired:acceptAllMacAddresses property of the setting

No description available in the introspection data.

Since: 1.32

getAutoNegotiate

settingWiredGetAutoNegotiate Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Bool

Returns: the SettingWired:autoNegotiate property of the setting

No description available in the introspection data.

getClonedMacAddress

settingWiredGetClonedMacAddress Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Text

Returns: the SettingWired:clonedMacAddress property of the setting

No description available in the introspection data.

getDuplex

settingWiredGetDuplex Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Text

Returns: the SettingWired:duplex property of the setting

No description available in the introspection data.

getGenerateMacAddressMask

settingWiredGetGenerateMacAddressMask Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Text

Returns: the SettingWired:generateMacAddressMask property of the setting

No description available in the introspection data.

Since: 1.4

getMacAddress

settingWiredGetMacAddress Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Text

Returns: the SettingWired:macAddress property of the setting

No description available in the introspection data.

getMacAddressBlacklist

settingWiredGetMacAddressBlacklist Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m [Text]

Returns: the SettingWired:macAddressBlacklist property of the setting

Deprecated: (Since version 1.48.)Use settingWiredGetMacAddressDenylist instead.

No description available in the introspection data.

getMacAddressDenylist

settingWiredGetMacAddressDenylist Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m [Text]

Returns: the SettingWired:macAddressDenylist property of the setting

No description available in the introspection data.

Since: 1.48

getMacBlacklistItem

settingWiredGetMacBlacklistItem Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> Word32

idx: the zero-based index of the MAC address entry

-> m Text

Returns: the blacklisted MAC address string (hex-digits-and-colons notation) at index idx

Deprecated: (Since version 1.48.)Use settingWiredGetMacDenylistItem instead.

Since 1.48, access at index "len" is allowed and returns NULL.

getMacDenylistItem

settingWiredGetMacDenylistItem Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> Word32

idx: the zero-based index of the MAC address entry

-> m Text

Returns: the denylisted MAC address string (hex-digits-and-colons notation) at index idx

No description available in the introspection data.

Since: 1.48

getMtu

settingWiredGetMtu Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Word32

Returns: the SettingWired:mtu property of the setting

No description available in the introspection data.

getNumMacBlacklistItems

settingWiredGetNumMacBlacklistItems Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Word32

Returns: the number of blacklisted MAC addresses

Deprecated: (Since version 1.48.)Use settingWiredGetNumMacDenylistItems instead.

No description available in the introspection data.

getNumMacDenylistItems

settingWiredGetNumMacDenylistItems Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Word32

Returns: the number of denylisted MAC addresses

No description available in the introspection data.

Since: 1.48

getNumS390Options

settingWiredGetNumS390Options Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Word32

Returns: the number of s390-specific device options

Returns the number of s390-specific options that should be set for this device when it is activated. This can be used to retrieve each s390 option individually using settingWiredGetS390Option.

getPort

settingWiredGetPort Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Text

Returns: the SettingWired:port property of the setting

No description available in the introspection data.

getS390Nettype

settingWiredGetS390Nettype Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Text

Returns: the s390 device type

Returns the s390 device type this connection should apply to. Will be one of 'qeth', 'lcs', or 'ctc'.

getS390Option

settingWiredGetS390Option Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> Word32

idx: index of the desired option, from 0 to settingWiredGetNumS390Options - 1

-> m (Bool, Maybe Text, Maybe Text)

Returns: True on success if the index was valid and an option was found, False if the index was invalid (ie, greater than the number of options currently held by the setting)

Given an index, return the value of the s390 option at that index. indexes are *not* guaranteed to be static across modifications to options done by settingWiredAddS390Option and settingWiredRemoveS390Option, and should not be used to refer to options except for short periods of time such as during option iteration.

getS390OptionByKey

settingWiredGetS390OptionByKey Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> Text

key: the key for which to retrieve the value

-> m Text

Returns: the value, or Nothing if the key/value pair was never added to the setting; the value is owned by the setting and must not be modified

Returns the value associated with the s390-specific option specified by key, if it exists.

getS390Subchannels

settingWiredGetS390Subchannels Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m [Text]

Returns: array of strings, each specifying one subchannel the s390 device uses to communicate to the host.

Return the list of s390 subchannels that identify the device that this connection is applicable to. The connection should only be used in conjunction with that device.

getSpeed

settingWiredGetSpeed Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Word32

Returns: the SettingWired:speed property of the setting

No description available in the introspection data.

getValidS390Options

settingWiredGetValidS390Options Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> Maybe a

setting: the SettingWired. This argument is unused and you may pass Nothing.

-> m [Text]

Returns: a Nothing-terminated array of strings of valid s390 options.

Returns a list of valid s390 options.

The setting argument is unused and Nothing may be passed instead.

getWakeOnLan

settingWiredGetWakeOnLan Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m [SettingWiredWakeOnLan]

Returns: the Wake-on-LAN options

Returns the Wake-on-LAN options enabled for the connection

Since: 1.2

getWakeOnLanPassword

settingWiredGetWakeOnLanPassword Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> m Text

Returns: the Wake-on-LAN setting password, or Nothing if there is no password.

Returns the Wake-on-LAN password. This only applies to SettingWiredWakeOnLanMagic.

Since: 1.2

new

settingWiredNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m SettingWired

Returns: the new empty SettingWired object

Creates a new SettingWired object with default values.

removeMacBlacklistItem

settingWiredRemoveMacBlacklistItem Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> Word32

idx: index number of the MAC address

-> m () 

Deprecated: (Since version 1.48.)Use settingWiredRemoveMacDenylistItem instead.

Removes the MAC address at index idx from the blacklist.

removeMacBlacklistItemByValue

settingWiredRemoveMacBlacklistItemByValue Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> Text

mac: the MAC address string (hex-digits-and-colons notation) to remove from the blacklist

-> m Bool

Returns: True if the MAC address was found and removed; False if it was not.

Deprecated: (Since version 1.48.)Use settingWiredRemoveMacDenylistItemByValue instead.

Removes the MAC address mac from the blacklist.

removeMacDenylistItem

settingWiredRemoveMacDenylistItem Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> Word32

idx: index number of the MAC address

-> m () 

Removes the MAC address at index idx from the denylist.

Since: 1.48

removeMacDenylistItemByValue

settingWiredRemoveMacDenylistItemByValue Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> Text

mac: the MAC address string (hex-digits-and-colons notation) to remove from the denylist

-> m Bool

Returns: True if the MAC address was found and removed; False if it was not.

Removes the MAC address mac from the denylist.

Since: 1.48

removeS390Option

settingWiredRemoveS390Option Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingWired a) 
=> a

setting: the SettingWired

-> Text

key: key name for the option to remove

-> m Bool

Returns: True if the option was found and removed from the internal option list, False if it was not.

Remove the s390-specific option referenced by key from the internal option list.

Properties

acceptAllMacAddresses

When True, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When False, the interface will only accept the packets with the interface destination mac address or broadcast.

Since: 1.32

constructSettingWiredAcceptAllMacAddresses :: (IsSettingWired o, MonadIO m) => Ternary -> m (GValueConstruct o) Source #

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

getSettingWiredAcceptAllMacAddresses :: (MonadIO m, IsSettingWired o) => o -> m Ternary Source #

Get the value of the “accept-all-mac-addresses” property. When overloading is enabled, this is equivalent to

get settingWired #acceptAllMacAddresses

setSettingWiredAcceptAllMacAddresses :: (MonadIO m, IsSettingWired o) => o -> Ternary -> m () Source #

Set the value of the “accept-all-mac-addresses” property. When overloading is enabled, this is equivalent to

set settingWired [ #acceptAllMacAddresses := value ]

autoNegotiate

When True, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When False, "speed" and "duplex" properties should be both set or link configuration will be skipped.

constructSettingWiredAutoNegotiate :: (IsSettingWired o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getSettingWiredAutoNegotiate :: (MonadIO m, IsSettingWired o) => o -> m Bool Source #

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

get settingWired #autoNegotiate

setSettingWiredAutoNegotiate :: (MonadIO m, IsSettingWired o) => o -> Bool -> m () Source #

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

set settingWired [ #autoNegotiate := value ]

clonedMacAddress

If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.

Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address if the device has one (otherwise this is treated as "preserve"). "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.

If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).

On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".

clearSettingWiredClonedMacAddress :: (MonadIO m, IsSettingWired o) => o -> m () Source #

Set the value of the “cloned-mac-address” property to Nothing. When overloading is enabled, this is equivalent to

clear #clonedMacAddress

constructSettingWiredClonedMacAddress :: (IsSettingWired o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingWiredClonedMacAddress :: (MonadIO m, IsSettingWired o) => o -> m Text Source #

Get the value of the “cloned-mac-address” property. When overloading is enabled, this is equivalent to

get settingWired #clonedMacAddress

setSettingWiredClonedMacAddress :: (MonadIO m, IsSettingWired o) => o -> Text -> m () Source #

Set the value of the “cloned-mac-address” property. When overloading is enabled, this is equivalent to

set settingWired [ #clonedMacAddress := value ]

duplex

When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.

clearSettingWiredDuplex :: (MonadIO m, IsSettingWired o) => o -> m () Source #

Set the value of the “duplex” property to Nothing. When overloading is enabled, this is equivalent to

clear #duplex

constructSettingWiredDuplex :: (IsSettingWired o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingWiredDuplex :: (MonadIO m, IsSettingWired o) => o -> m Text Source #

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

get settingWired #duplex

setSettingWiredDuplex :: (MonadIO m, IsSettingWired o) => o -> Text -> m () Source #

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

set settingWired [ #duplex := value ]

generateMacAddressMask

With SettingWired:clonedMacAddress setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.

If the property is Nothing, it is eligible to be overwritten by a default connection setting. If the value is still Nothing or an empty string, the default is to create a locally-administered, unicast MAC address.

If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.

If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.

If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.

clearSettingWiredGenerateMacAddressMask :: (MonadIO m, IsSettingWired o) => o -> m () Source #

Set the value of the “generate-mac-address-mask” property to Nothing. When overloading is enabled, this is equivalent to

clear #generateMacAddressMask

constructSettingWiredGenerateMacAddressMask :: (IsSettingWired o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingWiredGenerateMacAddressMask :: (MonadIO m, IsSettingWired o) => o -> m Text Source #

Get the value of the “generate-mac-address-mask” property. When overloading is enabled, this is equivalent to

get settingWired #generateMacAddressMask

setSettingWiredGenerateMacAddressMask :: (MonadIO m, IsSettingWired o) => o -> Text -> m () Source #

Set the value of the “generate-mac-address-mask” property. When overloading is enabled, this is equivalent to

set settingWired [ #generateMacAddressMask := value ]

macAddress

If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

clearSettingWiredMacAddress :: (MonadIO m, IsSettingWired o) => o -> m () Source #

Set the value of the “mac-address” property to Nothing. When overloading is enabled, this is equivalent to

clear #macAddress

constructSettingWiredMacAddress :: (IsSettingWired o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingWiredMacAddress :: (MonadIO m, IsSettingWired o) => o -> m Text Source #

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

get settingWired #macAddress

setSettingWiredMacAddress :: (MonadIO m, IsSettingWired o) => o -> Text -> m () Source #

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

set settingWired [ #macAddress := value ]

macAddressBlacklist

If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).

clearSettingWiredMacAddressBlacklist :: (MonadIO m, IsSettingWired o) => o -> m () Source #

Set the value of the “mac-address-blacklist” property to Nothing. When overloading is enabled, this is equivalent to

clear #macAddressBlacklist

constructSettingWiredMacAddressBlacklist :: (IsSettingWired o, MonadIO m) => [Text] -> m (GValueConstruct o) Source #

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

getSettingWiredMacAddressBlacklist :: (MonadIO m, IsSettingWired o) => o -> m [Text] Source #

Get the value of the “mac-address-blacklist” property. When overloading is enabled, this is equivalent to

get settingWired #macAddressBlacklist

setSettingWiredMacAddressBlacklist :: (MonadIO m, IsSettingWired o) => o -> [Text] -> m () Source #

Set the value of the “mac-address-blacklist” property. When overloading is enabled, this is equivalent to

set settingWired [ #macAddressBlacklist := value ]

macAddressDenylist

If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).

clearSettingWiredMacAddressDenylist :: (MonadIO m, IsSettingWired o) => o -> m () Source #

Set the value of the “mac-address-denylist” property to Nothing. When overloading is enabled, this is equivalent to

clear #macAddressDenylist

constructSettingWiredMacAddressDenylist :: (IsSettingWired o, MonadIO m) => [Text] -> m (GValueConstruct o) Source #

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

getSettingWiredMacAddressDenylist :: (MonadIO m, IsSettingWired o) => o -> m [Text] Source #

Get the value of the “mac-address-denylist” property. When overloading is enabled, this is equivalent to

get settingWired #macAddressDenylist

setSettingWiredMacAddressDenylist :: (MonadIO m, IsSettingWired o) => o -> [Text] -> m () Source #

Set the value of the “mac-address-denylist” property. When overloading is enabled, this is equivalent to

set settingWired [ #macAddressDenylist := value ]

mtu

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

constructSettingWiredMtu :: (IsSettingWired o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

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

getSettingWiredMtu :: (MonadIO m, IsSettingWired o) => o -> m Word32 Source #

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

get settingWired #mtu

setSettingWiredMtu :: (MonadIO m, IsSettingWired o) => o -> Word32 -> m () Source #

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

set settingWired [ #mtu := value ]

port

Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.

clearSettingWiredPort :: (MonadIO m, IsSettingWired o) => o -> m () Source #

Set the value of the “port” property to Nothing. When overloading is enabled, this is equivalent to

clear #port

constructSettingWiredPort :: (IsSettingWired o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingWiredPort :: (MonadIO m, IsSettingWired o) => o -> m Text Source #

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

get settingWired #port

setSettingWiredPort :: (MonadIO m, IsSettingWired o) => o -> Text -> m () Source #

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

set settingWired [ #port := value ]

s390Nettype

s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.

clearSettingWiredS390Nettype :: (MonadIO m, IsSettingWired o) => o -> m () Source #

Set the value of the “s390-nettype” property to Nothing. When overloading is enabled, this is equivalent to

clear #s390Nettype

constructSettingWiredS390Nettype :: (IsSettingWired o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingWiredS390Nettype :: (MonadIO m, IsSettingWired o) => o -> m Text Source #

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

get settingWired #s390Nettype

setSettingWiredS390Nettype :: (MonadIO m, IsSettingWired o) => o -> Text -> m () Source #

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

set settingWired [ #s390Nettype := value ]

s390Options

Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).

Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.

clearSettingWiredS390Options :: (MonadIO m, IsSettingWired o) => o -> m () Source #

Set the value of the “s390-options” property to Nothing. When overloading is enabled, this is equivalent to

clear #s390Options

constructSettingWiredS390Options :: (IsSettingWired o, MonadIO m) => Map Text Text -> m (GValueConstruct o) Source #

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

getSettingWiredS390Options :: (MonadIO m, IsSettingWired o) => o -> m (Maybe (Map Text Text)) Source #

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

get settingWired #s390Options

setSettingWiredS390Options :: (MonadIO m, IsSettingWired o) => o -> Map Text Text -> m () Source #

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

set settingWired [ #s390Options := value ]

s390Subchannels

Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the SettingWired:macAddress property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.

clearSettingWiredS390Subchannels :: (MonadIO m, IsSettingWired o) => o -> m () Source #

Set the value of the “s390-subchannels” property to Nothing. When overloading is enabled, this is equivalent to

clear #s390Subchannels

constructSettingWiredS390Subchannels :: (IsSettingWired o, MonadIO m) => [Text] -> m (GValueConstruct o) Source #

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

getSettingWiredS390Subchannels :: (MonadIO m, IsSettingWired o) => o -> m [Text] Source #

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

get settingWired #s390Subchannels

setSettingWiredS390Subchannels :: (MonadIO m, IsSettingWired o) => o -> [Text] -> m () Source #

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

set settingWired [ #s390Subchannels := value ]

speed

When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.

constructSettingWiredSpeed :: (IsSettingWired o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

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

getSettingWiredSpeed :: (MonadIO m, IsSettingWired o) => o -> m Word32 Source #

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

get settingWired #speed

setSettingWiredSpeed :: (MonadIO m, IsSettingWired o) => o -> Word32 -> m () Source #

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

set settingWired [ #speed := value ]

wakeOnLan

The SettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of SettingWiredWakeOnLanPhy, SettingWiredWakeOnLanUnicast, SettingWiredWakeOnLanMulticast, SettingWiredWakeOnLanBroadcast, SettingWiredWakeOnLanArp, SettingWiredWakeOnLanMagic or the special values SettingWiredWakeOnLanDefault (to use global settings) and SettingWiredWakeOnLanIgnore (to disable management of Wake-on-LAN in NetworkManager).

Since: 1.2

constructSettingWiredWakeOnLan :: (IsSettingWired o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

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

getSettingWiredWakeOnLan :: (MonadIO m, IsSettingWired o) => o -> m Word32 Source #

Get the value of the “wake-on-lan” property. When overloading is enabled, this is equivalent to

get settingWired #wakeOnLan

setSettingWiredWakeOnLan :: (MonadIO m, IsSettingWired o) => o -> Word32 -> m () Source #

Set the value of the “wake-on-lan” property. When overloading is enabled, this is equivalent to

set settingWired [ #wakeOnLan := value ]

wakeOnLanPassword

If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If Nothing, no password will be required.

Since: 1.2

clearSettingWiredWakeOnLanPassword :: (MonadIO m, IsSettingWired o) => o -> m () Source #

Set the value of the “wake-on-lan-password” property to Nothing. When overloading is enabled, this is equivalent to

clear #wakeOnLanPassword

constructSettingWiredWakeOnLanPassword :: (IsSettingWired o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingWiredWakeOnLanPassword :: (MonadIO m, IsSettingWired o) => o -> m Text Source #

Get the value of the “wake-on-lan-password” property. When overloading is enabled, this is equivalent to

get settingWired #wakeOnLanPassword

setSettingWiredWakeOnLanPassword :: (MonadIO m, IsSettingWired o) => o -> Text -> m () Source #

Set the value of the “wake-on-lan-password” property. When overloading is enabled, this is equivalent to

set settingWired [ #wakeOnLanPassword := value ]