Top |
Functions
Properties
guint | app-fcoe-flags | Read / Write |
gchar * | app-fcoe-mode | Read / Write / Construct |
gint | app-fcoe-priority | Read / Write / Construct |
guint | app-fip-flags | Read / Write |
gint | app-fip-priority | Read / Write / Construct |
guint | app-iscsi-flags | Read / Write |
gint | app-iscsi-priority | Read / Write / Construct |
GArray_guint_ * | priority-bandwidth | Read / Write |
GArray_guint_ * | priority-flow-control | Read / Write |
guint | priority-flow-control-flags | Read / Write |
GArray_guint_ * | priority-group-bandwidth | Read / Write |
guint | priority-group-flags | Read / Write |
GArray_guint_ * | priority-group-id | Read / Write |
GArray_guint_ * | priority-strict-bandwidth | Read / Write |
GArray_guint_ * | priority-traffic-class | Read / Write |
Types and Values
#define | NM_SETTING_DCB_SETTING_NAME |
enum | NMSettingDcbError |
#define | NM_SETTING_DCB_ERROR |
enum | NMSettingDcbFlags |
#define | NM_SETTING_DCB_FCOE_MODE_FABRIC |
#define | NM_SETTING_DCB_FCOE_MODE_VN2VN |
#define | NM_SETTING_DCB_APP_FCOE_FLAGS |
#define | NM_SETTING_DCB_APP_FCOE_PRIORITY |
#define | NM_SETTING_DCB_APP_FCOE_MODE |
#define | NM_SETTING_DCB_APP_ISCSI_FLAGS |
#define | NM_SETTING_DCB_APP_ISCSI_PRIORITY |
#define | NM_SETTING_DCB_APP_FIP_FLAGS |
#define | NM_SETTING_DCB_APP_FIP_PRIORITY |
#define | NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS |
#define | NM_SETTING_DCB_PRIORITY_FLOW_CONTROL |
#define | NM_SETTING_DCB_PRIORITY_GROUP_FLAGS |
#define | NM_SETTING_DCB_PRIORITY_GROUP_ID |
#define | NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH |
#define | NM_SETTING_DCB_PRIORITY_BANDWIDTH |
#define | NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH |
#define | NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS |
Object Hierarchy
GEnum ├── NMSettingDcbError ╰── NMSettingDcbFlags GObject ╰── NMSetting ╰── NMSettingDcb
Description
The NMSettingDcb object is a NMSetting subclass that describes properties for enabling and using Data Center Bridging (DCB) on Ethernet networks. DCB is a set of protocols (including 802.1Qbb, 802.1Qaz, 802.1Qau, and 802.1AB) to eliminate packet loss in Ethernet networks and support the use of storage technologies like Fibre Channel over Ethernet (FCoE) and iSCSI.
Functions
nm_setting_dcb_error_quark ()
GQuark
nm_setting_dcb_error_quark (void
);
Registers an error quark for NMSettingDcb if necessary.
Since 0.9.10
nm_setting_dcb_new ()
NMSetting *
nm_setting_dcb_new (void
);
Creates a new NMSettingDcb object with default values.
Since 0.9.10
nm_setting_dcb_get_app_fcoe_flags ()
NMSettingDcbFlags
nm_setting_dcb_get_app_fcoe_flags (NMSettingDcb *setting
);
Since 0.9.10
nm_setting_dcb_get_app_fcoe_priority ()
gint
nm_setting_dcb_get_app_fcoe_priority (NMSettingDcb *setting
);
Since 0.9.10
nm_setting_dcb_get_app_fcoe_mode ()
const char *
nm_setting_dcb_get_app_fcoe_mode (NMSettingDcb *setting
);
Since 0.9.10
nm_setting_dcb_get_app_iscsi_flags ()
NMSettingDcbFlags
nm_setting_dcb_get_app_iscsi_flags (NMSettingDcb *setting
);
Since 0.9.10
nm_setting_dcb_get_app_iscsi_priority ()
gint
nm_setting_dcb_get_app_iscsi_priority (NMSettingDcb *setting
);
Since 0.9.10
nm_setting_dcb_get_app_fip_flags ()
NMSettingDcbFlags
nm_setting_dcb_get_app_fip_flags (NMSettingDcb *setting
);
Since 0.9.10
nm_setting_dcb_get_app_fip_priority ()
gint
nm_setting_dcb_get_app_fip_priority (NMSettingDcb *setting
);
Since 0.9.10
nm_setting_dcb_get_priority_flow_control_flags ()
NMSettingDcbFlags
nm_setting_dcb_get_priority_flow_control_flags
(NMSettingDcb *setting
);
Since 0.9.10
nm_setting_dcb_get_priority_flow_control ()
gboolean nm_setting_dcb_get_priority_flow_control (NMSettingDcb *setting
,guint user_priority
);
Parameters
setting |
the NMSettingDcb |
|
user_priority |
the User Priority (0 - 7) to retrieve flow control for |
Since 0.9.10
nm_setting_dcb_set_priority_flow_control ()
void nm_setting_dcb_set_priority_flow_control (NMSettingDcb *setting
,guint user_priority
,gboolean enabled
);
These values are only valid when “priority-flow-control” includes
the NM_SETTING_DCB_FLAG_ENABLE
flag.
Parameters
setting |
the NMSettingDcb |
|
user_priority |
the User Priority (0 - 7) to set flow control for |
|
enabled |
|
Since 0.9.10
nm_setting_dcb_get_priority_group_flags ()
NMSettingDcbFlags
nm_setting_dcb_get_priority_group_flags
(NMSettingDcb *setting
);
Since 0.9.10
nm_setting_dcb_get_priority_group_id ()
guint nm_setting_dcb_get_priority_group_id (NMSettingDcb *setting
,guint user_priority
);
Parameters
setting |
the NMSettingDcb |
|
user_priority |
the User Priority (0 - 7) to retrieve the group ID for |
Returns
the group number user_priority
is assigned to. These values are
only valid when “priority-group-flags” includes the
NM_SETTING_DCB_FLAG_ENABLE
flag.
Since 0.9.10
nm_setting_dcb_set_priority_group_id ()
void nm_setting_dcb_set_priority_group_id (NMSettingDcb *setting
,guint user_priority
,guint group_id
);
These values are only valid when “priority-group-flags” includes
the NM_SETTING_DCB_FLAG_ENABLE
flag.
Parameters
setting |
the NMSettingDcb |
|
user_priority |
the User Priority (0 - 7) to set flow control for |
|
group_id |
the group (0 - 7) to assign |
Since 0.9.10
nm_setting_dcb_get_priority_group_bandwidth ()
guint nm_setting_dcb_get_priority_group_bandwidth (NMSettingDcb *setting
,guint group_id
);
Parameters
setting |
the NMSettingDcb |
|
group_id |
the priority group (0 - 7) to retrieve the bandwidth percentage for |
Returns
the bandwidth percentage assigned to group_id
. These values are
only valid when “priority-group-flags” includes the
NM_SETTING_DCB_FLAG_ENABLE
flag.
Since 0.9.10
nm_setting_dcb_set_priority_group_bandwidth ()
void nm_setting_dcb_set_priority_group_bandwidth (NMSettingDcb *setting
,guint group_id
,guint bandwidth_percent
);
These values are only valid when “priority-group-flags” includes
the NM_SETTING_DCB_FLAG_ENABLE
flag.
Parameters
setting |
the NMSettingDcb |
|
group_id |
the priority group (0 - 7) to set the bandwidth percentage for |
|
bandwidth_percent |
the bandwidth percentage (0 - 100) to assign to |
Since 0.9.10
nm_setting_dcb_get_priority_bandwidth ()
guint nm_setting_dcb_get_priority_bandwidth (NMSettingDcb *setting
,guint user_priority
);
Parameters
setting |
the NMSettingDcb |
|
user_priority |
the User Priority (0 - 7) to retrieve the group bandwidth percentage for |
Returns
the allowed bandwidth percentage of user_priority
in its priority group.
These values are only valid when “priority-group-flags” includes the
NM_SETTING_DCB_FLAG_ENABLE
flag.
Since 0.9.10
nm_setting_dcb_set_priority_bandwidth ()
void nm_setting_dcb_set_priority_bandwidth (NMSettingDcb *setting
,guint user_priority
,guint bandwidth_percent
);
These values are only valid when “priority-group-flags” includes
the NM_SETTING_DCB_FLAG_ENABLE
flag.
Parameters
setting |
the NMSettingDcb |
|
user_priority |
the User Priority (0 - 7) to set the bandwidth percentage for |
|
bandwidth_percent |
the bandwidth percentage (0 - 100) that |
Since 0.9.10
nm_setting_dcb_get_priority_strict_bandwidth ()
gboolean nm_setting_dcb_get_priority_strict_bandwidth (NMSettingDcb *setting
,guint user_priority
);
Parameters
setting |
the NMSettingDcb |
|
user_priority |
the User Priority (0 - 7) to retrieve strict bandwidth for |
Returns
TRUE
if user_priority
may use all of the bandwidth allocated to its
assigned group, or FALSE
if not. These values are only valid when
“priority-group-flags” includes the NM_SETTING_DCB_FLAG_ENABLE
flag.
Since 0.9.10
nm_setting_dcb_set_priority_strict_bandwidth ()
void nm_setting_dcb_set_priority_strict_bandwidth (NMSettingDcb *setting
,guint user_priority
,gboolean strict
);
These values are only valid when “priority-group-flags” includes
the NM_SETTING_DCB_FLAG_ENABLE
flag.
Parameters
setting |
the NMSettingDcb |
|
user_priority |
the User Priority (0 - 7) to set strict bandwidth for |
|
strict |
|
Since 0.9.10
nm_setting_dcb_get_priority_traffic_class ()
guint nm_setting_dcb_get_priority_traffic_class (NMSettingDcb *setting
,guint user_priority
);
Parameters
setting |
the NMSettingDcb |
|
user_priority |
the User Priority (0 - 7) to retrieve the traffic class for |
Returns
the traffic class assigned to user_priority
. These values are only
valid when “priority-group-flags” includes the
NM_SETTING_DCB_FLAG_ENABLE
flag.
Since 0.9.10
nm_setting_dcb_set_priority_traffic_class ()
void nm_setting_dcb_set_priority_traffic_class (NMSettingDcb *setting
,guint user_priority
,guint traffic_class
);
Types and Values
NM_SETTING_DCB_FCOE_MODE_FABRIC
#define NM_SETTING_DCB_FCOE_MODE_FABRIC "fabric"
Indicates that the FCoE controller should use "fabric" mode (default)
Since 0.9.10
NM_SETTING_DCB_FCOE_MODE_VN2VN
#define NM_SETTING_DCB_FCOE_MODE_VN2VN "vn2vn"
Indicates that the FCoE controller should use "VN2VN" mode.
Since 0.9.10
NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS
#define NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS "priority-flow-control-flags"
NM_SETTING_DCB_PRIORITY_FLOW_CONTROL
#define NM_SETTING_DCB_PRIORITY_FLOW_CONTROL "priority-flow-control"
NM_SETTING_DCB_PRIORITY_GROUP_FLAGS
#define NM_SETTING_DCB_PRIORITY_GROUP_FLAGS "priority-group-flags"
NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH
#define NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH "priority-group-bandwidth"
NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH
#define NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH "priority-strict-bandwidth"
Property Details
The “app-fcoe-flags”
property
“app-fcoe-flags” guint
Flags: Read / Write
Allowed values: <= 7
Default value: 0
Since 0.9.10
The “app-fcoe-mode”
property
“app-fcoe-mode” gchar *
Flags: Read / Write / Construct
Default value: "fabric"
Since 0.9.10
The “app-fcoe-priority”
property
“app-fcoe-priority” gint
Flags: Read / Write / Construct
Allowed values: [-1,7]
Default value: -1
Since 0.9.10
The “app-fip-flags”
property
“app-fip-flags” guint
Flags: Read / Write
Allowed values: <= 7
Default value: 0
Since 0.9.10
The “app-fip-priority”
property
“app-fip-priority” gint
Flags: Read / Write / Construct
Allowed values: [-1,7]
Default value: -1
Since 0.9.10
The “app-iscsi-flags”
property
“app-iscsi-flags” guint
Flags: Read / Write
Allowed values: <= 7
Default value: 0
Since 0.9.10
The “app-iscsi-priority”
property
“app-iscsi-priority” gint
Flags: Read / Write / Construct
Allowed values: [-1,7]
Default value: -1
Since 0.9.10
The “priority-bandwidth”
property
“priority-bandwidth” GArray_guint_ *
Flags: Read / Write
Since 0.9.10
The “priority-flow-control”
property
“priority-flow-control” GArray_guint_ *
Flags: Read / Write
Since 0.9.10
The “priority-flow-control-flags”
property
“priority-flow-control-flags” guint
Flags: Read / Write
Allowed values: <= 7
Default value: 0
Since 0.9.10
The “priority-group-bandwidth”
property
“priority-group-bandwidth” GArray_guint_ *
Flags: Read / Write
Since 0.9.10
The “priority-group-flags”
property
“priority-group-flags” guint
Flags: Read / Write
Allowed values: <= 7
Default value: 0
Since 0.9.10
The “priority-group-id”
property
“priority-group-id” GArray_guint_ *
Flags: Read / Write
Since 0.9.10
The “priority-strict-bandwidth”
property
“priority-strict-bandwidth” GArray_guint_ *
Flags: Read / Write
Since 0.9.10