Top |
Functions
NMSetting * | nm_setting_bond_new () |
guint32 | nm_setting_bond_get_num_options () |
gboolean | nm_setting_bond_get_option () |
const char * | nm_setting_bond_get_option_by_name () |
gboolean | nm_setting_bond_add_option () |
gboolean | nm_setting_bond_remove_option () |
gboolean | nm_setting_bond_validate_option () |
const char ** | nm_setting_bond_get_valid_options () |
const char * | nm_setting_bond_get_option_default () |
Types and Values
Description
The NMSettingBond object is a NMSetting subclass that describes properties necessary for bond connections.
Functions
nm_setting_bond_new ()
NMSetting *
nm_setting_bond_new (void
);
Creates a new NMSettingBond object with default values.
nm_setting_bond_get_num_options ()
guint32
nm_setting_bond_get_num_options (NMSettingBond *setting
);
Returns the number of options that should be set for this bond when it
is activated. This can be used to retrieve each option individually
using nm_setting_bond_get_option()
.
nm_setting_bond_get_option ()
gboolean nm_setting_bond_get_option (NMSettingBond *setting
,guint32 idx
,const char **out_name
,const char **out_value
);
Given an index, return the value of the bonding option at that index. Indexes
are *not* guaranteed to be static across modifications to options done by
nm_setting_bond_add_option()
and nm_setting_bond_remove_option()
,
and should not be used to refer to options except for short periods of time
such as during option iteration.
Parameters
setting |
the NMSettingBond |
|
idx |
index of the desired option, from 0 to
|
|
out_name |
on return, the name of the bonding option; this value is owned by the setting and should not be modified. |
[out][transfer none] |
out_value |
on return, the value of the name of the bonding option; this value is owned by the setting and should not be modified. |
[out][transfer none] |
nm_setting_bond_get_option_by_name ()
const char * nm_setting_bond_get_option_by_name (NMSettingBond *setting
,const char *name
);
Returns the value associated with the bonding option specified by
name
, if it exists.
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
nm_setting_bond_add_option ()
gboolean nm_setting_bond_add_option (NMSettingBond *setting
,const char *name
,const char *value
);
Add an option to the table. The option is compared to an internal list of allowed options. Option names may contain only alphanumeric characters (ie [a-zA-Z0-9]). Adding a new name replaces any existing name/value pair that may already exist.
The order of how to set several options is relevant because there are options that conflict with each other.
nm_setting_bond_remove_option ()
gboolean nm_setting_bond_remove_option (NMSettingBond *setting
,const char *name
);
Remove the bonding option referenced by name
from the internal option
list.
nm_setting_bond_validate_option ()
gboolean nm_setting_bond_validate_option (const char *name
,const char *value
);
Checks whether name
is a valid bond option and value
is a valid value for
the name
. If value
is NULL
, the function only validates the option name.
nm_setting_bond_get_valid_options ()
const char **
nm_setting_bond_get_valid_options (NMSettingBond *setting
);
Returns a list of valid bond options.
The setting
argument is unused and may be passed as NULL
.
nm_setting_bond_get_option_default ()
const char * nm_setting_bond_get_option_default (NMSettingBond *setting
,const char *name
);
Types and Values
NM_SETTING_BOND_OPTION_PRIMARY_RESELECT
#define NM_SETTING_BOND_OPTION_PRIMARY_RESELECT "primary_reselect"
NM_SETTING_BOND_OPTION_XMIT_HASH_POLICY
#define NM_SETTING_BOND_OPTION_XMIT_HASH_POLICY "xmit_hash_policy"
NM_SETTING_BOND_OPTION_AD_ACTOR_SYS_PRIO
#define NM_SETTING_BOND_OPTION_AD_ACTOR_SYS_PRIO "ad_actor_sys_prio"
NM_SETTING_BOND_OPTION_AD_ACTOR_SYSTEM
#define NM_SETTING_BOND_OPTION_AD_ACTOR_SYSTEM "ad_actor_system"
NM_SETTING_BOND_OPTION_AD_USER_PORT_KEY
#define NM_SETTING_BOND_OPTION_AD_USER_PORT_KEY "ad_user_port_key"
NM_SETTING_BOND_OPTION_ALL_SLAVES_ACTIVE
#define NM_SETTING_BOND_OPTION_ALL_SLAVES_ACTIVE "all_slaves_active"
NM_SETTING_BOND_OPTION_ARP_ALL_TARGETS
#define NM_SETTING_BOND_OPTION_ARP_ALL_TARGETS "arp_all_targets"
NM_SETTING_BOND_OPTION_PACKETS_PER_SLAVE
#define NM_SETTING_BOND_OPTION_PACKETS_PER_SLAVE "packets_per_slave"
NM_SETTING_BOND_OPTION_TLB_DYNAMIC_LB
#define NM_SETTING_BOND_OPTION_TLB_DYNAMIC_LB "tlb_dynamic_lb"
Property Details
The “options”
property
“options” GHashTable *
Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).
Type: GHashTable(utf8,utf8)
Flags: Read / Write