NM.SettingDcb¶

Subclasses:: None

Methods¶

Inherited:: NM.Setting (21), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`get_app_fcoe_flags` ()
	`get_app_fcoe_mode` ()
	`get_app_fcoe_priority` ()
	`get_app_fip_flags` ()
	`get_app_fip_priority` ()
	`get_app_iscsi_flags` ()
	`get_app_iscsi_priority` ()
	`get_priority_bandwidth` (user_priority)
	`get_priority_flow_control` (user_priority)
	`get_priority_flow_control_flags` ()
	`get_priority_group_bandwidth` (group_id)
	`get_priority_group_flags` ()
	`get_priority_group_id` (user_priority)
	`get_priority_strict_bandwidth` (user_priority)
	`get_priority_traffic_class` (user_priority)
	`set_priority_bandwidth` (user_priority, bandwidth_percent)
	`set_priority_flow_control` (user_priority, enabled)
	`set_priority_group_bandwidth` (group_id, bandwidth_percent)
	`set_priority_group_id` (user_priority, group_id)
	`set_priority_strict_bandwidth` (user_priority, strict)
	`set_priority_traffic_class` (user_priority, traffic_class)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Inherited:: NM.Setting (1)

Name	Type	Flags
`app-fcoe-flags`	`NM.SettingDcbFlags`	r/w/en
`app-fcoe-mode`	`str`	r/w/en
`app-fcoe-priority`	`int`	r/w/en
`app-fip-flags`	`NM.SettingDcbFlags`	r/w/en
`app-fip-priority`	`int`	r/w/en
`app-iscsi-flags`	`NM.SettingDcbFlags`	r/w/en
`app-iscsi-priority`	`int`	r/w/en
`priority-bandwidth`	`GLib.Array`	r/w
`priority-flow-control`	`GLib.Array`	r/w
`priority-flow-control-flags`	`NM.SettingDcbFlags`	r/w/en
`priority-group-bandwidth`	`GLib.Array`	r/w
`priority-group-flags`	`NM.SettingDcbFlags`	r/w/en
`priority-group-id`	`GLib.Array`	r/w
`priority-strict-bandwidth`	`GLib.Array`	r/w
`priority-traffic-class`	`GLib.Array`	r/w

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class NM.SettingDcb(**kwargs)¶

Bases:: NM.Setting
Abstract:: No
Structure:: NM.SettingDcbClass

Data Center Bridging Settings

classmethod new()¶

Returns:: the new empty NM.SettingDcb object
Return type:: NM.Setting

Creates a new NM.SettingDcb object with default values.

get_app_fcoe_flags()¶

Returns:: the NM.SettingDcb :app-fcoe-flags property of the setting
Return type:: NM.SettingDcbFlags

get_app_fcoe_mode()¶

Returns:: the NM.SettingDcb :app-fcoe-mode property of the setting
Return type:: str

get_app_fcoe_priority()¶

Returns:: the NM.SettingDcb :app-fcoe-priority property of the setting
Return type:: int

get_app_fip_flags()¶

Returns:: the NM.SettingDcb :app-fip-flags property of the setting
Return type:: NM.SettingDcbFlags

get_app_fip_priority()¶

Returns:: the NM.SettingDcb :app-fip-priority property of the setting
Return type:: int

get_app_iscsi_flags()¶

Returns:: the NM.SettingDcb :app-iscsi-flags property of the setting
Return type:: NM.SettingDcbFlags

get_app_iscsi_priority()¶

Returns:: the NM.SettingDcb :app-iscsi-priority property of the setting
Return type:: int

get_priority_bandwidth(user_priority)¶

Parameters:: user_priority (int) – 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 NM.SettingDcb :priority-group-flags includes the NM.SettingDcbFlags.ENABLE flag.
Return type:: int

get_priority_flow_control(user_priority)¶

Parameters:: user_priority (int) – the User Priority (0 - 7) to retrieve flow control for
Returns:: True if flow control is enabled for the given user_priority, False if not enabled
Return type:: bool

get_priority_flow_control_flags()¶

Returns:: the NM.SettingDcb :priority-flow-control-flags property of the setting
Return type:: NM.SettingDcbFlags

get_priority_group_bandwidth(group_id)¶

Parameters:: group_id (int) – 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 NM.SettingDcb :priority-group-flags includes the NM.SettingDcbFlags.ENABLE flag.
Return type:: int

get_priority_group_flags()¶

Returns:: the NM.SettingDcb :priority-group-flags property of the setting
Return type:: NM.SettingDcbFlags

get_priority_group_id(user_priority)¶

Parameters:: user_priority (int) – 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 NM.SettingDcb :priority-group-flags includes the NM.SettingDcbFlags.ENABLE flag.
Return type:: int

get_priority_strict_bandwidth(user_priority)¶

Parameters:: user_priority (int) – 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 NM.SettingDcb :priority-group-flags includes the NM.SettingDcbFlags.ENABLE flag.
Return type:: bool

get_priority_traffic_class(user_priority)¶

Parameters:: user_priority (int) – 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 NM.SettingDcb :priority-group-flags includes the NM.SettingDcbFlags.ENABLE flag.
Return type:: int

set_priority_bandwidth(user_priority, bandwidth_percent)¶

Parameters:

user_priority (int) – the User Priority (0 - 7) to set the bandwidth percentage for
bandwidth_percent (int) – the bandwidth percentage (0 - 100) that user_priority is allowed to use within its priority group

These values are only valid when NM.SettingDcb :priority-group-flags includes the NM.SettingDcbFlags.ENABLE flag.

set_priority_flow_control(user_priority, enabled)¶

Parameters:

user_priority (int) – the User Priority (0 - 7) to set flow control for
enabled (bool) – True to enable flow control for this priority, False to disable it

These values are only valid when NM.SettingDcb :priority-flow-control includes the NM.SettingDcbFlags.ENABLE flag.

set_priority_group_bandwidth(group_id, bandwidth_percent)¶

Parameters:

group_id (int) – the priority group (0 - 7) to set the bandwidth percentage for
bandwidth_percent (int) – the bandwidth percentage (0 - 100) to assign to group_id to

These values are only valid when NM.SettingDcb :priority-group-flags includes the NM.SettingDcbFlags.ENABLE flag.

set_priority_group_id(user_priority, group_id)¶

Parameters:

user_priority (int) – the User Priority (0 - 7) to set flow control for
group_id (int) – the group (0 - 7) to assign user_priority to, or 15 for the unrestricted group.

These values are only valid when NM.SettingDcb :priority-group-flags includes the NM.SettingDcbFlags.ENABLE flag.

set_priority_strict_bandwidth(user_priority, strict)¶

Parameters:

user_priority (int) – the User Priority (0 - 7) to set strict bandwidth for
strict (bool) – True to allow user_priority to use all the bandwidth allocated to its priority group, or False if not

These values are only valid when NM.SettingDcb :priority-group-flags includes the NM.SettingDcbFlags.ENABLE flag.

set_priority_traffic_class(user_priority, traffic_class)¶

Parameters:

user_priority (int) –
traffic_class (int) –

Property Details¶

NM.SettingDcb.props.app_fcoe_flags¶

Name:: app-fcoe-flags
Type:: NM.SettingDcbFlags
Default Value:: NM.SettingDcbFlags.NONE
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Specifies the NM.SettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM.SettingDcbFlags.ENABLE, NM.SettingDcbFlags.ADVERTISE, and NM.SettingDcbFlags.WILLING.

NM.SettingDcb.props.app_fcoe_mode¶

Name:: app-fcoe-mode
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The FCoE controller mode; either NM.SETTING_DCB_FCOE_MODE_FABRIC or NM.SETTING_DCB_FCOE_MODE_VN2VN.

Since 1.34, None is the default and means NM.SETTING_DCB_FCOE_MODE_FABRIC. Before 1.34, None was rejected as invalid and the default was NM.SETTING_DCB_FCOE_MODE_FABRIC.

NM.SettingDcb.props.app_fcoe_priority¶

Name:: app-fcoe-priority
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the NM.SettingDcb :app-fcoe-flags property includes the NM.SettingDcbFlags.ENABLE flag.

NM.SettingDcb.props.app_fip_flags¶

Name:: app-fip-flags
Type:: NM.SettingDcbFlags
Default Value:: NM.SettingDcbFlags.NONE
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Specifies the NM.SettingDcbFlags for the DCB FIP application. Flags may be any combination of NM.SettingDcbFlags.ENABLE, NM.SettingDcbFlags.ADVERTISE, and NM.SettingDcbFlags.WILLING.

NM.SettingDcb.props.app_fip_priority¶

Name:: app-fip-priority
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the NM.SettingDcb :app-fip-flags property includes the NM.SettingDcbFlags.ENABLE flag.

NM.SettingDcb.props.app_iscsi_flags¶

Name:: app-iscsi-flags
Type:: NM.SettingDcbFlags
Default Value:: NM.SettingDcbFlags.NONE
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Specifies the NM.SettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM.SettingDcbFlags.ENABLE, NM.SettingDcbFlags.ADVERTISE, and NM.SettingDcbFlags.WILLING.

NM.SettingDcb.props.app_iscsi_priority¶

Name:: app-iscsi-priority
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the NM.SettingDcb :app-iscsi-flags property includes the NM.SettingDcbFlags.ENABLE flag.

NM.SettingDcb.props.priority_bandwidth¶

Name:: priority-bandwidth
Type:: GLib.Array
Default Value:: None
Flags:: READABLE, WRITABLE

An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority’s assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.

NM.SettingDcb.props.priority_flow_control¶

Name:: priority-flow-control
Type:: GLib.Array
Default Value:: None
Flags:: READABLE, WRITABLE

An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.

NM.SettingDcb.props.priority_flow_control_flags¶

Name:: priority-flow-control-flags
Type:: NM.SettingDcbFlags
Default Value:: NM.SettingDcbFlags.NONE
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Specifies the NM.SettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM.SettingDcbFlags.ENABLE, NM.SettingDcbFlags.ADVERTISE, and NM.SettingDcbFlags.WILLING.

NM.SettingDcb.props.priority_group_bandwidth¶

Name:: priority-group-bandwidth
Type:: GLib.Array
Default Value:: None
Flags:: READABLE, WRITABLE

An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.

NM.SettingDcb.props.priority_group_flags¶

Name:: priority-group-flags
Type:: NM.SettingDcbFlags
Default Value:: NM.SettingDcbFlags.NONE
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Specifies the NM.SettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM.SettingDcbFlags.ENABLE, NM.SettingDcbFlags.ADVERTISE, and NM.SettingDcbFlags.WILLING.

NM.SettingDcb.props.priority_group_id¶

Name:: priority-group-id
Type:: GLib.Array
Default Value:: None
Flags:: READABLE, WRITABLE

An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.

NM.SettingDcb.props.priority_strict_bandwidth¶

Name:: priority-strict-bandwidth
Type:: GLib.Array
Default Value:: None
Flags:: READABLE, WRITABLE

An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.

NM.SettingDcb.props.priority_traffic_class¶

Name:: priority-traffic-class
Type:: GLib.Array
Default Value:: None
Flags:: READABLE, WRITABLE

An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.