Blame docs/libnm/html/NMSettingBridgePort.html

Packit 5756e2
Packit 5756e2
<html>
Packit 5756e2
<head>
Packit 5756e2
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 5756e2
<title>NMSettingBridgePort: libnm Reference Manual</title>
Packit 5756e2
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit 5756e2
<link rel="home" href="index.html" title="libnm Reference Manual">
Packit 5756e2
<link rel="up" href="ch03.html" title="Connection and Setting API Reference">
Packit 5756e2
<link rel="prev" href="NMSettingBond.html" title="NMSettingBond">
Packit 5756e2
<link rel="next" href="NMSettingBridge.html" title="NMSettingBridge">
Packit Service 87a54e
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
Packit 5756e2
<link rel="stylesheet" href="style.css" type="text/css">
Packit 5756e2
</head>
Packit 5756e2
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 5756e2
Packit 5756e2
Packit 5756e2
Top  | 
Packit 5756e2
                  Description  | 
Packit 5756e2
                  Object Hierarchy  | 
Packit 5756e2
                  Properties
Packit 5756e2
Packit 5756e2
Home
Packit 5756e2
Up
Packit 5756e2
Prev
Packit 5756e2
Next
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

NMSettingBridgePort

Packit 5756e2

NMSettingBridgePort — Describes connection properties for bridge ports

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Functions

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
NMSetting *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_bridge_port_new ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
guint16
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_bridge_port_get_priority ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
guint16
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_bridge_port_get_path_cost ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
gboolean
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_bridge_port_get_hairpin_mode ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_bridge_port_add_vlan ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
guint
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_bridge_port_get_num_vlans ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
NMBridgeVlan *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_bridge_port_get_vlan ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_bridge_port_remove_vlan ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
gboolean
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_bridge_port_remove_vlan_by_vid ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_bridge_port_clear_vlans ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Properties

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
gboolean
Packit 5756e2
hairpin-mode
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit 5756e2
guint
Packit 5756e2
path-cost
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit 5756e2
guint
Packit 5756e2
priority
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
GPtrArray *
Packit 5756e2
vlans
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Types and Values

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_BRIDGE_PORT_SETTING_NAME
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_BRIDGE_PORT_PRIORITY
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_BRIDGE_PORT_PATH_COST
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_BRIDGE_PORT_VLANS
Packit 5756e2
Packit 5756e2
Packit 5756e2
 
Packit 5756e2
NMSettingBridgePort
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Object Hierarchy

Packit 5756e2
    GObject
Packit 5756e2
    ╰── NMSetting
Packit 5756e2
        ╰── NMSettingBridgePort
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Description

Packit 5756e2

The NMSettingBridgePort object is a NMSetting subclass that describes

Packit 5756e2
optional properties that apply to bridge ports.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Functions

Packit 5756e2
Packit 5756e2

nm_setting_bridge_port_new ()

Packit 5756e2
NMSetting *
Packit 5756e2
nm_setting_bridge_port_new (void);
Packit 5756e2

Creates a new NMSettingBridgePort object with default values.

Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the new empty NMSettingBridgePort object.

Packit Service 87a54e

[transfer full]

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_bridge_port_get_priority ()

Packit 5756e2
guint16
Packit 5756e2
nm_setting_bridge_port_get_priority (NMSettingBridgePort *setting);
Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingBridgePort

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the “priority” property of the setting

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_bridge_port_get_path_cost ()

Packit 5756e2
guint16
Packit 5756e2
nm_setting_bridge_port_get_path_cost (NMSettingBridgePort *setting);
Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingBridgePort

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the “path-cost” property of the setting

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_bridge_port_get_hairpin_mode ()

Packit 5756e2
gboolean
Packit 5756e2
nm_setting_bridge_port_get_hairpin_mode
Packit 5756e2
                               (NMSettingBridgePort *setting);
Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingBridgePort

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the “hairpin-mode” property of the setting

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_bridge_port_add_vlan ()

Packit 5756e2
void
Packit 5756e2
nm_setting_bridge_port_add_vlan (NMSettingBridgePort *setting,
Packit 5756e2
                                 NMBridgeVlan *vlan);
Packit 5756e2

Appends a new vlan and associated information to the setting. The

Packit 5756e2
given vlan gets sealed and a reference to it is added.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingBridgePort

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2

vlan

Packit 5756e2

the vlan to add

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Since: 1.18

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_bridge_port_get_num_vlans ()

Packit 5756e2
guint
Packit 5756e2
nm_setting_bridge_port_get_num_vlans (NMSettingBridgePort *setting);
Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingBridgePort

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the number of VLANs

Packit 5756e2
Packit 5756e2

Since: 1.18

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_bridge_port_get_vlan ()

Packit 5756e2
NMBridgeVlan *
Packit 5756e2
nm_setting_bridge_port_get_vlan (NMSettingBridgePort *setting,
Packit 5756e2
                                 guint idx);
Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingBridgePort

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2

idx

Packit 5756e2

index number of the VLAN to return

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the VLAN at index idx

Packit 5756e2
. 

Packit Service 87a54e

[transfer none]

Packit 5756e2
Packit 5756e2

Since: 1.18

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_bridge_port_remove_vlan ()

Packit 5756e2
void
Packit 5756e2
nm_setting_bridge_port_remove_vlan (NMSettingBridgePort *setting,
Packit 5756e2
                                    guint idx);
Packit 5756e2

Removes the vlan at index idx

Packit 5756e2
.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingBridgePort

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2

idx

Packit 5756e2

index number of the VLAN.

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Since: 1.18

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_bridge_port_remove_vlan_by_vid ()

Packit 5756e2
gboolean
Packit 5756e2
nm_setting_bridge_port_remove_vlan_by_vid
Packit 5756e2
                               (NMSettingBridgePort *setting,
Packit 5756e2
                                guint16 vid_start,
Packit 5756e2
                                guint16 vid_end);
Packit 5756e2

Remove the VLAN with range vid_start

Packit 5756e2
 to vid_end
Packit 5756e2
.
Packit 5756e2
If vid_end
Packit 5756e2
 is zero, it is assumed to be equal to vid_start
Packit 5756e2
Packit 5756e2
and so the single-id VLAN with id vid_start
Packit 5756e2
 is removed.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingBridgePort

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2

vid_start

Packit 5756e2

the vlan start index

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2

vid_end

Packit 5756e2

the vlan end index

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

TRUE if the vlan was found and removed; FALSE otherwise

Packit 5756e2
Packit 5756e2

Since: 1.18

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_bridge_port_clear_vlans ()

Packit 5756e2
void
Packit 5756e2
nm_setting_bridge_port_clear_vlans (NMSettingBridgePort *setting);
Packit 5756e2

Removes all configured VLANs.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingBridgePort

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Since: 1.18

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Types and Values

Packit 5756e2
Packit 5756e2

NM_SETTING_BRIDGE_PORT_SETTING_NAME

Packit 5756e2
#define NM_SETTING_BRIDGE_PORT_SETTING_NAME "bridge-port"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_BRIDGE_PORT_PRIORITY

Packit 5756e2
#define NM_SETTING_BRIDGE_PORT_PRIORITY     "priority"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_BRIDGE_PORT_PATH_COST

Packit 5756e2
#define NM_SETTING_BRIDGE_PORT_PATH_COST    "path-cost"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE

Packit 5756e2
#define NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE "hairpin-mode"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_BRIDGE_PORT_VLANS

Packit 5756e2
#define NM_SETTING_BRIDGE_PORT_VLANS        "vlans"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NMSettingBridgePort

Packit 5756e2
typedef struct _NMSettingBridgePort NMSettingBridgePort;
Packit 5756e2

Bridge Port Settings

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Property Details

Packit 5756e2
Packit 5756e2

The “hairpin-mode” property

Packit 5756e2
  “hairpin-mode”             gboolean
Packit 5756e2

Enables or disables "hairpin mode" for the port, which allows frames to

Packit 5756e2
be sent back out through the port the frame was received on.

Packit 5756e2

Owner: NMSettingBridgePort

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Default value: FALSE

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “path-cost” property

Packit 5756e2
  “path-cost”                guint
Packit 5756e2

The Spanning Tree Protocol (STP) port cost for destinations via this

Packit 5756e2
port.

Packit 5756e2

Owner: NMSettingBridgePort

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Allowed values: <= 65535

Packit 5756e2

Default value: 100

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “priority” property

Packit 5756e2
  “priority”                 guint
Packit 5756e2

The Spanning Tree Protocol (STP) priority of this bridge port.

Packit 5756e2

Owner: NMSettingBridgePort

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Allowed values: <= 63

Packit 5756e2

Default value: 32

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “vlans” property

Packit 5756e2
  “vlans”                    GPtrArray *
Packit 5756e2

Array of bridge VLAN objects. In addition to the VLANs

Packit 5756e2
specified here, the port will also have the default-pvid
Packit 5756e2
VLAN configured on the bridge by the bridge.vlan-default-pvid
Packit 5756e2
property.

Packit 5756e2

In nmcli the VLAN list can be specified with the following

Packit 5756e2
syntax:

Packit 5756e2

$vid pvid [, $vid pvid]...

Packit 5756e2

where $vid is either a single id between 1 and 4094 or a

Packit 5756e2
range, represented as a couple of ids separated by a dash.

Packit 5756e2

[type GPtrArray(NMBridgeVlan)]

Packit 5756e2

Owner: NMSettingBridgePort

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Since: 1.18

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit Service 87a54e

Generated by GTK-Doc V1.33.1
Packit 5756e2
</body>
Packit 5756e2
</html>