NMSettingWired: libnm Reference Manual

## NMSettingWired

NMSettingWired

## Functions

NMSetting * | nm_setting_wired_new ()
const char * | nm_setting_wired_get_port ()
guint32 | nm_setting_wired_get_speed ()
const char * | nm_setting_wired_get_duplex ()
gboolean | nm_setting_wired_get_auto_negotiate ()
const char * | nm_setting_wired_get_mac_address ()
const char * | nm_setting_wired_get_cloned_mac_address ()
NMTernary | nm_setting_wired_get_accept_all_mac_addresses ()
const char * | nm_setting_wired_get_generate_mac_address_mask ()
const char *const * | nm_setting_wired_get_mac_address_blacklist ()
guint32 | nm_setting_wired_get_num_mac_blacklist_items ()
const char * | nm_setting_wired_get_mac_blacklist_item ()
gboolean | nm_setting_wired_add_mac_blacklist_item ()
void | nm_setting_wired_remove_mac_blacklist_item ()
gboolean | nm_setting_wired_remove_mac_blacklist_item_by_value ()
void | nm_setting_wired_clear_mac_blacklist_items ()
guint32 | nm_setting_wired_get_mtu ()
const char *const * | nm_setting_wired_get_s390_subchannels ()
const char * | nm_setting_wired_get_s390_nettype ()
guint32 | nm_setting_wired_get_num_s390_options ()
gboolean | nm_setting_wired_get_s390_option ()
const char * | nm_setting_wired_get_s390_option_by_key ()
gboolean | nm_setting_wired_add_s390_option ()
gboolean | nm_setting_wired_remove_s390_option ()
const char ** | nm_setting_wired_get_valid_s390_options ()
NMSettingWiredWakeOnLan | nm_setting_wired_get_wake_on_lan ()
const char * | nm_setting_wired_get_wake_on_lan_password ()

## Types and Values

#define | NM_SETTING_WIRED_SETTING_NAME
enum | NMSettingWiredWakeOnLan
#define | NM_SETTING_WIRED_PORT
#define | NM_SETTING_WIRED_SPEED
#define | NM_SETTING_WIRED_DUPLEX
#define | NM_SETTING_WIRED_AUTO_NEGOTIATE
#define | NM_SETTING_WIRED_MAC_ADDRESS
#define | NM_SETTING_WIRED_CLONED_MAC_ADDRESS
#define | NM_SETTING_WIRED_GENERATE_MAC_ADDRESS_MASK
#define | NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST
#define | NM_SETTING_WIRED_MTU
#define | NM_SETTING_WIRED_S390_SUBCHANNELS
#define | NM_SETTING_WIRED_S390_NETTYPE
#define | NM_SETTING_WIRED_S390_OPTIONS
#define | NM_SETTING_WIRED_WAKE_ON_LAN
#define | NM_SETTING_WIRED_WAKE_ON_LAN_PASSWORD
#define | NM_SETTING_WIRED_ACCEPT_ALL_MAC_ADDRESSES

## Object Hierarchy

        GFlags
        ╰── NMSettingWiredWakeOnLan

## Description

## Functions

### nm_setting_wired_new ()

    NMSetting *
    nm_setting_wired_new (void);

### nm_setting_wired_get_port ()

    const char *
    nm_setting_wired_get_port (NMSettingWired *setting);

### nm_setting_wired_get_speed ()

    guint32
    nm_setting_wired_get_speed (NMSettingWired *setting);

### nm_setting_wired_get_duplex ()

    const char *
    nm_setting_wired_get_duplex (NMSettingWired *setting);

### nm_setting_wired_get_auto_negotiate ()

    gboolean
    nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);

### nm_setting_wired_get_mac_address ()

    const char *
    nm_setting_wired_get_mac_address (NMSettingWired *setting);

### nm_setting_wired_get_cloned_mac_address ()

    const char *
    nm_setting_wired_get_cloned_mac_address
                                   (NMSettingWired *setting);

### nm_setting_wired_get_accept_all_mac_addresses ()

    NMTernary
    nm_setting_wired_get_accept_all_mac_addresses
                                   (NMSettingWired *setting);

### nm_setting_wired_get_generate_mac_address_mask ()

    const char *
    nm_setting_wired_get_generate_mac_address_mask
                                   (NMSettingWired *setting);

### nm_setting_wired_get_mac_address_blacklist ()

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

### nm_setting_wired_get_num_mac_blacklist_items ()

    guint32
    nm_setting_wired_get_num_mac_blacklist_items
                                   (NMSettingWired *setting);

### nm_setting_wired_get_mac_blacklist_item ()

    const char *
    nm_setting_wired_get_mac_blacklist_item
                                   (NMSettingWired *setting,
                                    guint32 idx);

### nm_setting_wired_add_mac_blacklist_item ()

    gboolean
    nm_setting_wired_add_mac_blacklist_item
                                   (NMSettingWired *setting,
                                    const char *mac);

### nm_setting_wired_remove_mac_blacklist_item ()

    void
    nm_setting_wired_remove_mac_blacklist_item
                                   (NMSettingWired *setting,
                                    guint32 idx);

### nm_setting_wired_remove_mac_blacklist_item_by_value ()

    gboolean
    nm_setting_wired_remove_mac_blacklist_item_by_value
                                   (NMSettingWired *setting,
                                    const char *mac);

### nm_setting_wired_clear_mac_blacklist_items ()

    void
    nm_setting_wired_clear_mac_blacklist_items
                                   (NMSettingWired *setting);

### nm_setting_wired_get_mtu ()

    guint32
    nm_setting_wired_get_mtu (NMSettingWired *setting);

### nm_setting_wired_get_s390_subchannels ()

    const char *const *
    nm_setting_wired_get_s390_subchannels (NMSettingWired *setting);

### nm_setting_wired_get_s390_nettype ()

    const char *
    nm_setting_wired_get_s390_nettype (NMSettingWired *setting);

### nm_setting_wired_get_num_s390_options ()

    guint32
    nm_setting_wired_get_num_s390_options (NMSettingWired *setting);

### nm_setting_wired_get_s390_option ()

    gboolean
    nm_setting_wired_get_s390_option (NMSettingWired *setting,
                                      guint32 idx,
                                      const char **out_key,
                                      const char **out_value);

### nm_setting_wired_get_s390_option_by_key ()

    const char *
    nm_setting_wired_get_s390_option_by_key
                                   (NMSettingWired *setting,
                                    const char *key);

### nm_setting_wired_add_s390_option ()

    gboolean
    nm_setting_wired_add_s390_option (NMSettingWired *setting,
                                      const char *key,
                                      const char *value);

### nm_setting_wired_remove_s390_option ()

    gboolean
    nm_setting_wired_remove_s390_option (NMSettingWired *setting,
                                         const char *key);

### nm_setting_wired_get_valid_s390_options ()

    const char **
    nm_setting_wired_get_valid_s390_options
                                   (NMSettingWired *setting);

### nm_setting_wired_get_wake_on_lan ()

    NMSettingWiredWakeOnLan
    nm_setting_wired_get_wake_on_lan (NMSettingWired *setting);

### nm_setting_wired_get_wake_on_lan_password ()

    const char *
    nm_setting_wired_get_wake_on_lan_password
                                   (NMSettingWired *setting);

## Types and Values

### NM_SETTING_WIRED_SETTING_NAME

    #define NM_SETTING_WIRED_SETTING_NAME "802-3-ethernet"

### enum NMSettingWiredWakeOnLan

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

#### Members

NM_SETTING_WIRED_WAKE_ON_LAN_NONE | Wake-on-LAN disabled |
NM_SETTING_WIRED_WAKE_ON_LAN_PHY | Wake on PHY activity |
NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST | Wake on unicast messages |
NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST | Wake on multicast messages |
NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST | Wake on broadcast messages |
NM_SETTING_WIRED_WAKE_ON_LAN_ARP | Wake on ARP |
NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC | Wake on magic packet |
NM_SETTING_WIRED_WAKE_ON_LAN_ALL | Wake on all events. This does not include the exclusive flags `NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT` or `NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE` . |
NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT | Use the default value |
NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE | Don't change configured settings |
NM_SETTING_WIRED_WAKE_ON_LAN_EXCLUSIVE_FLAGS | Mask of flags that are incompatible with other flags |

Since: 1.2

### NM_SETTING_WIRED_PORT

    #define NM_SETTING_WIRED_PORT                      "port"

### NM_SETTING_WIRED_SPEED

    #define NM_SETTING_WIRED_SPEED                     "speed"

### NM_SETTING_WIRED_DUPLEX

    #define NM_SETTING_WIRED_DUPLEX                    "duplex"

### NM_SETTING_WIRED_AUTO_NEGOTIATE

    #define NM_SETTING_WIRED_AUTO_NEGOTIATE            "auto-negotiate"

### NM_SETTING_WIRED_MAC_ADDRESS

    #define NM_SETTING_WIRED_MAC_ADDRESS               "mac-address"

### NM_SETTING_WIRED_CLONED_MAC_ADDRESS

    #define NM_SETTING_WIRED_CLONED_MAC_ADDRESS        "cloned-mac-address"

### 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"

### NM_SETTING_WIRED_MTU

    #define NM_SETTING_WIRED_MTU                       "mtu"

### NM_SETTING_WIRED_S390_SUBCHANNELS

    #define NM_SETTING_WIRED_S390_SUBCHANNELS          "s390-subchannels"

### NM_SETTING_WIRED_S390_NETTYPE

    #define NM_SETTING_WIRED_S390_NETTYPE              "s390-nettype"

### NM_SETTING_WIRED_S390_OPTIONS

    #define NM_SETTING_WIRED_S390_OPTIONS              "s390-options"

### NM_SETTING_WIRED_WAKE_ON_LAN

    #define NM_SETTING_WIRED_WAKE_ON_LAN               "wake-on-lan"

### NM_SETTING_WIRED_WAKE_ON_LAN_PASSWORD

    #define NM_SETTING_WIRED_WAKE_ON_LAN_PASSWORD      "wake-on-lan-password"

### NM_SETTING_WIRED_ACCEPT_ALL_MAC_ADDRESSES

    #define NM_SETTING_WIRED_ACCEPT_ALL_MAC_ADDRESSES  "accept-all-mac-addresses"