From 7514efc2f38c9ace4557d4e69d68e7d380389030 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 26 Aug 2016 02:18:32 +0200 Subject: Imported Upstream version 1.4.0 --- docs/libnm/html/NMSettingWired.html | 192 ++++++++++++++++++++++++++---------- 1 file changed, 142 insertions(+), 50 deletions(-) (limited to 'docs/libnm/html/NMSettingWired.html') diff --git a/docs/libnm/html/NMSettingWired.html b/docs/libnm/html/NMSettingWired.html index 568b9d5e..41bdca30 100644 --- a/docs/libnm/html/NMSettingWired.html +++ b/docs/libnm/html/NMSettingWired.html @@ -8,7 +8,7 @@ - + @@ -94,6 +94,13 @@ +const char * + + +nm_setting_wired_get_generate_mac_address_mask () + + + const char * const * @@ -262,6 +269,12 @@ gchar * +generate-mac-address-mask +Read / Write + + + +gchar * mac-address Read / Write @@ -359,6 +372,10 @@ #define +NM_SETTING_WIRED_GENERATE_MAC_ADDRESS_MASK + + +#define NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST @@ -414,7 +431,7 @@ necessary for connection to Ethernet networks.

nm_setting_wired_new (void);

Creates a new NMSettingWired object with default values.

-

Returns

+

Returns

the new empty NMSettingWired object.

[transfer full]

@@ -425,7 +442,7 @@ nm_setting_wired_new (void
const char *
 nm_setting_wired_get_port (NMSettingWired *setting);
-

Parameters

+

Parameters

@@ -440,7 +457,7 @@ nm_setting_wired_get_port ( -

Returns

+

Returns

the “port” property of the setting

@@ -450,7 +467,7 @@ nm_setting_wired_get_port (guint32 nm_setting_wired_get_speed (NMSettingWired *setting);
-

Parameters

+

Parameters

@@ -465,7 +482,7 @@ nm_setting_wired_get_speed ( -

Returns

+

Returns

the “speed” property of the setting

@@ -475,7 +492,7 @@ nm_setting_wired_get_speed (const char * nm_setting_wired_get_duplex (NMSettingWired *setting);
-

Parameters

+

Parameters

@@ -490,7 +507,7 @@ nm_setting_wired_get_duplex ( -

Returns

+

Returns

the “duplex” property of the setting

@@ -500,7 +517,7 @@ nm_setting_wired_get_duplex (gboolean nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);
-

Parameters

+

Parameters

@@ -515,7 +532,7 @@ nm_setting_wired_get_auto_negotiate (
-

Returns

+

Returns

the “auto-negotiate” property of the setting

@@ -525,7 +542,7 @@ nm_setting_wired_get_auto_negotiate (const char * nm_setting_wired_get_mac_address (NMSettingWired *setting);
-

Parameters

+

Parameters

@@ -540,7 +557,7 @@ nm_setting_wired_get_mac_address (
-

Returns

+

Returns

the “mac-address” property of the setting

@@ -551,7 +568,7 @@ nm_setting_wired_get_mac_address (NMSettingWired *setting);
-

Parameters

+

Parameters

@@ -566,18 +583,45 @@ nm_setting_wired_get_cloned_mac_address
-

Returns

+

Returns

the “cloned-mac-address” property of the setting


+

nm_setting_wired_get_generate_mac_address_mask ()

+
const char *
+nm_setting_wired_get_generate_mac_address_mask
+                               (NMSettingWired *setting);
+
+

Parameters

+
+++++ + + + + + +

setting

the NMSettingWired

 
+
+
+

Returns

+

the “generate-mac-address-mask” property of the setting

+
+

Since: 1.4

+
+
+

nm_setting_wired_get_mac_address_blacklist ()

const char * const *
 nm_setting_wired_get_mac_address_blacklist
                                (NMSettingWired *setting);
-

Parameters

+

Parameters

@@ -592,7 +636,7 @@ nm_setting_wired_get_mac_address_blacklist
-

Returns

+

Returns

the “mac-address-blacklist” property of the setting

@@ -603,7 +647,7 @@ nm_setting_wired_get_mac_address_blacklist nm_setting_wired_get_num_mac_blacklist_items (NMSettingWired *setting);
-

Parameters

+

Parameters

@@ -618,7 +662,7 @@ nm_setting_wired_get_num_mac_blacklist_items
-

Returns

+

Returns

the number of blacklisted MAC addresses

@@ -630,7 +674,7 @@ nm_setting_wired_get_mac_blacklist_item (NMSettingWired *setting, guint32 idx);
-

Parameters

+

Parameters

@@ -652,7 +696,7 @@ nm_setting_wired_get_mac_blacklist_item
-

Returns

+

Returns

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

@@ -667,7 +711,7 @@ nm_setting_wired_add_mac_blacklist_item const char *mac);

Adds a new MAC address to the “mac-address-blacklist” property.

-

Parameters

+

Parameters

@@ -689,7 +733,7 @@ nm_setting_wired_add_mac_blacklist_item
-

Returns

+

Returns

TRUE if the MAC address was added; FALSE if the MAC address is invalid or was already present

@@ -704,7 +748,7 @@ nm_setting_wired_remove_mac_blacklist_item

Removes the MAC address at index idx from the blacklist.

-

Parameters

+

Parameters

@@ -736,7 +780,7 @@ nm_setting_wired_remove_mac_blacklist_item_by_value

Removes the MAC address mac from the blacklist.

-

Parameters

+

Parameters

@@ -759,7 +803,7 @@ the blacklist

-

Returns

+

Returns

TRUE if the MAC address was found and removed; FALSE if it was not.

@@ -771,7 +815,7 @@ nm_setting_wired_clear_mac_blacklist_items (NMSettingWired *setting);

Removes all blacklisted MAC addresses.

-

Parameters

+

Parameters

@@ -792,7 +836,7 @@ nm_setting_wired_clear_mac_blacklist_items
guint32
 nm_setting_wired_get_mtu (NMSettingWired *setting);
-

Parameters

+

Parameters

@@ -807,7 +851,7 @@ nm_setting_wired_get_mtu ( -

Returns

+

Returns

the “mtu” property of the setting

@@ -820,7 +864,7 @@ nm_setting_wired_get_s390_subchannels ( -

Parameters

+

Parameters

@@ -835,7 +879,7 @@ conjunction with that device.

-

Returns

+

Returns

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

[transfer none][element-type utf8]

@@ -849,7 +893,7 @@ nm_setting_wired_get_s390_nettype (Returns the s390 device type this connection should apply to. Will be one of 'qeth', 'lcs', or 'ctc'.

-

Parameters

+

Parameters

@@ -864,7 +908,7 @@ of 'qeth', 'lcs', or 'ctc'.

-

Returns

+

Returns

the s390 device type

@@ -877,7 +921,7 @@ nm_setting_wired_get_num_s390_options (nm_setting_wired_get_s390_option().

-

Parameters

+

Parameters

@@ -892,7 +936,7 @@ option individually using -

Returns

+

Returns

the number of s390-specific device options

@@ -910,7 +954,7 @@ are *not* guaranteed to be static across modifications to options done by and should not be used to refer to options except for short periods of time such as during option iteration.

-

Parameters

+

Parameters

@@ -946,7 +990,7 @@ modified.

-

Returns

+

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)

@@ -963,7 +1007,7 @@ nm_setting_wired_get_s390_option_by_key key , if it exists.

-

Parameters

+

Parameters

@@ -985,7 +1029,7 @@ nm_setting_wired_get_s390_option_by_key
-

Returns

+

Returns

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

@@ -1002,7 +1046,7 @@ of allowed options. Key names may contain only alphanumeric characters (ie [a-zA-Z0-9]). Adding a new key replaces any existing key/value pair that may already exist.

-

Parameters

+

Parameters

@@ -1029,7 +1073,7 @@ may already exist.

-

Returns

+

Returns

TRUE if the option was valid and was added to the internal option list, FALSE if it was not.

@@ -1044,7 +1088,7 @@ nm_setting_wired_remove_s390_option (
-

Parameters

+

Parameters

@@ -1066,7 +1110,7 @@ list.

-

Returns

+

Returns

TRUE if the option was found and removed from the internal option list, FALSE if it was not.

@@ -1079,7 +1123,7 @@ nm_setting_wired_get_valid_s390_options (NMSettingWired *setting);

Returns a list of valid s390 options.

-

Parameters

+

Parameters

@@ -1094,7 +1138,7 @@ nm_setting_wired_get_valid_s390_options
-

Returns

+

Returns

a NULL-terminated array of strings of valid s390 options.

[transfer none]

@@ -1106,7 +1150,7 @@ nm_setting_wired_get_valid_s390_options nm_setting_wired_get_wake_on_lan (NMSettingWired *setting);

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

-

Parameters

+

Parameters

@@ -1121,7 +1165,7 @@ nm_setting_wired_get_wake_on_lan (
-

Returns

+

Returns

the Wake-on-LAN options

Since: 1.2

@@ -1135,7 +1179,7 @@ nm_setting_wired_get_wake_on_lan_password

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

-

Parameters

+

Parameters

@@ -1150,7 +1194,7 @@ nm_setting_wired_get_wake_on_lan_password
-

Returns

+

Returns

the Wake-on-LAN setting password, or NULL if there is no password.

Since: 1.2

@@ -1169,7 +1213,7 @@ nm_setting_wired_get_wake_on_lan_password

Options for “wake-on-lan”. Note that not all options are supported by all devices.

-

Members

+

Members

@@ -1307,6 +1351,12 @@ are supported by all devices.


+

NM_SETTING_WIRED_GENERATE_MAC_ADDRESS_MASK

+
#define NM_SETTING_WIRED_GENERATE_MAC_ADDRESS_MASK "generate-mac-address-mask"
+
+
+
+

NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST

#define NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
 
@@ -1370,6 +1420,17 @@ are supported by all devices.

  “cloned-mac-address”       gchar *

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

+

Beside explicitly specifing 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 of the device. +"random" creates a random MAC address on each connect. +"stable" creates a hashed MAC address based on connection.stable-id (or +the connection's UUID) 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 "permanent".

+

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

Flags: Read / Write

Default value: NULL

@@ -1384,6 +1445,37 @@ Either "half" or "full".


+

The “generate-mac-address-mask” property

+
  “generate-mac-address-mask” gchar *
+

With “cloned-mac-address” 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 NULL, it is eligible to be overwritten by a default +connection setting. If the value is still NULL 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 then 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.

+

Flags: Read / Write

+

Default value: NULL

+
+
+

The “mac-address” property

  “mac-address”              gchar *

If specified, this connection will only apply to the Ethernet device @@ -1494,6 +1586,6 @@ no password will be required.

+
Generated by GTK-Doc V1.25 \ No newline at end of file -- cgit 1.3.0-6-gf8a5