From 85563b7fc7ec2cd21e38debb9b28db342e2e8e7c Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 21 Apr 2019 21:09:51 +0200 Subject: New upstream version 1.18.0 --- docs/libnm/html/NMSettingBridge.html | 1056 ++++++++++++++++++++++++++++++++-- 1 file changed, 1015 insertions(+), 41 deletions(-) (limited to 'docs/libnm/html/NMSettingBridge.html') diff --git a/docs/libnm/html/NMSettingBridge.html b/docs/libnm/html/NMSettingBridge.html index 8f374b6a..a92e1abe 100644 --- a/docs/libnm/html/NMSettingBridge.html +++ b/docs/libnm/html/NMSettingBridge.html @@ -120,6 +120,182 @@ nm_setting_bridge_get_multicast_snooping () + + +gboolean + + +nm_setting_bridge_get_vlan_filtering () + + + + +guint16 + + +nm_setting_bridge_get_vlan_default_pvid () + + + + +void + + +nm_setting_bridge_add_vlan () + + + + +guint + + +nm_setting_bridge_get_num_vlans () + + + + +NMBridgeVlan * + + +nm_setting_bridge_get_vlan () + + + + +void + + +nm_setting_bridge_remove_vlan () + + + + +gboolean + + +nm_setting_bridge_remove_vlan_by_vid () + + + + +void + + +nm_setting_bridge_clear_vlans () + + + + +NMBridgeVlan * + + +nm_bridge_vlan_new () + + + + +NMBridgeVlan * + + +nm_bridge_vlan_ref () + + + + +void + + +nm_bridge_vlan_unref () + + + + +NMBridgeVlan * + + +nm_bridge_vlan_new_clone () + + + + +int + + +nm_bridge_vlan_cmp () + + + + +void + + +nm_bridge_vlan_seal () + + + + +gboolean + + +nm_bridge_vlan_is_sealed () + + + + +void + + +nm_bridge_vlan_set_untagged () + + + + +void + + +nm_bridge_vlan_set_pvid () + + + + +gboolean + + +nm_bridge_vlan_get_vid_range () + + + + +gboolean + + +nm_bridge_vlan_is_untagged () + + + + +gboolean + + +nm_bridge_vlan_is_pvid () + + + + +char * + + +nm_bridge_vlan_to_str () + + + + +NMBridgeVlan * + + +nm_bridge_vlan_from_str () + + @@ -178,10 +354,26 @@ stp Read / Write / Construct + +guint +vlan-default-pvid +Read / Write / Construct + + +gboolean +vlan-filtering +Read / Write / Construct + + + +GPtrArray * +vlans +Read / Write + -
+

Types and Values

@@ -230,6 +422,26 @@ + + + + + + + + + + + + + + + + + + + + @@ -238,7 +450,9 @@

Object Hierarchy

-
    GObject
+
    GBoxed
+    ╰── NMBridgeVlan
+    GObject
     ╰── NMSetting
         ╰── NMSettingBridge
 

@@ -490,60 +704,754 @@ nm_setting_bridge_get_multicast_snooping

Since: 1.2

- -
-

Types and Values

-
-

NM_SETTING_BRIDGE_SETTING_NAME

-
#define NM_SETTING_BRIDGE_SETTING_NAME "bridge"
-
-
-

NM_SETTING_BRIDGE_MAC_ADDRESS

-
#define NM_SETTING_BRIDGE_MAC_ADDRESS    "mac-address"
-
+

nm_setting_bridge_get_vlan_filtering ()

+
gboolean
+nm_setting_bridge_get_vlan_filtering (NMSettingBridge *setting);
+
+

Parameters

+
NM_SETTING_BRIDGE_MULTICAST_SNOOPING
#defineNM_SETTING_BRIDGE_VLAN_FILTERING
#defineNM_SETTING_BRIDGE_VLAN_DEFAULT_PVID
#defineNM_SETTING_BRIDGE_VLANS
#defineNM_BRIDGE_VLAN_VID_MIN
#defineNM_BRIDGE_VLAN_VID_MAX
  NMSettingBridge
+++++ + + + + + +

setting

the NMSettingBridge

 
-
-
-

NM_SETTING_BRIDGE_STP

-
#define NM_SETTING_BRIDGE_STP            "stp"
-
+
+

Returns

+

the “vlan-filtering” property of the setting

-
-
-

NM_SETTING_BRIDGE_PRIORITY

-
#define NM_SETTING_BRIDGE_PRIORITY       "priority"
-
+

Since: 1.18

-

NM_SETTING_BRIDGE_FORWARD_DELAY

-
#define NM_SETTING_BRIDGE_FORWARD_DELAY  "forward-delay"
-
+

nm_setting_bridge_get_vlan_default_pvid ()

+
guint16
+nm_setting_bridge_get_vlan_default_pvid
+                               (NMSettingBridge *setting);
+
+

Parameters

+
+++++ + + + + + +

setting

the NMSettingBridge

 
-
-
-

NM_SETTING_BRIDGE_HELLO_TIME

-
#define NM_SETTING_BRIDGE_HELLO_TIME     "hello-time"
-
+
+

Returns

+

the “vlan-default-pvid” property of the setting

-
-
-

NM_SETTING_BRIDGE_MAX_AGE

-
#define NM_SETTING_BRIDGE_MAX_AGE        "max-age"
-
+

Since: 1.18

-

NM_SETTING_BRIDGE_AGEING_TIME

-
#define NM_SETTING_BRIDGE_AGEING_TIME    "ageing-time"
-
+

nm_setting_bridge_add_vlan ()

+
void
+nm_setting_bridge_add_vlan (NMSettingBridge *setting,
+                            NMBridgeVlan *vlan);
+

Appends a new vlan and associated information to the setting. The +given vlan gets sealed and a reference to it is added.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

setting

the NMSettingBridge

 

vlan

the vlan to add

 
+
+

Since: 1.18

-

NM_SETTING_BRIDGE_GROUP_FORWARD_MASK

-
#define NM_SETTING_BRIDGE_GROUP_FORWARD_MASK "group-forward-mask"
+
nm_setting_bridge_get_num_vlans ()

+
guint
+nm_setting_bridge_get_num_vlans (NMSettingBridge *setting);

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSettingBridge
 

+

+

+
Returns

+
 the number of VLANs

+

+
Since: 1.18

+
+
+
+

nm_setting_bridge_get_vlan ()

+
NMBridgeVlan *
+nm_setting_bridge_get_vlan (NMSettingBridge *setting,
+                            guint idx);
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

setting

the NMSettingBridge

 

idx

index number of the VLAN to return

 
+
+
+

Returns

+

the VLAN at index idx +.

+

[transfer none]

+
+

Since: 1.18

+
+
+
+

nm_setting_bridge_remove_vlan ()

+
void
+nm_setting_bridge_remove_vlan (NMSettingBridge *setting,
+                               guint idx);
+

Removes the vlan at index idx +.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

setting

the NMSettingBridge

 

idx

index number of the VLAN.

 
+
+

Since: 1.18

+
+
+
+

nm_setting_bridge_remove_vlan_by_vid ()

+
gboolean
+nm_setting_bridge_remove_vlan_by_vid (NMSettingBridge *setting,
+                                      guint16 vid_start,
+                                      guint16 vid_end);
+

Remove the VLAN with range vid_start + to vid_end +. +If vid_end + is zero, it is assumed to be equal to vid_start + +and so the single-id VLAN with id vid_start + is removed.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

setting

the NMSettingBridge

 

vid_start

the vlan start index

 

vid_end

the vlan end index

 
+
+
+

Returns

+

TRUE if the vlan was found and removed; FALSE otherwise

+
+

Since: 1.18

+
+
+
+

nm_setting_bridge_clear_vlans ()

+
void
+nm_setting_bridge_clear_vlans (NMSettingBridge *setting);
+

Removes all configured VLANs.

+
+

Parameters

+
+++++ + + + + + +

setting

the NMSettingBridge

 
+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_new ()

+
NMBridgeVlan *
+nm_bridge_vlan_new (guint16 vid_start,
+                    guint16 vid_end);
+

Creates a new NMBridgeVlan object for the given VLAN id range. +Setting vid_end + to 0 is equivalent to setting it to vid_start + +and creates a single-id VLAN.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vid_start

the start VLAN id, must be between 1 and 4094.

 

vid_end

the end VLAN id, must be 0 or between vid_start +and 4094.

 
+
+
+

Returns

+

the new NMBridgeVlan object.

+

[transfer full]

+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_ref ()

+
NMBridgeVlan *
+nm_bridge_vlan_ref (NMBridgeVlan *vlan);
+

Increases the reference count of the object.

+
+

Parameters

+
+++++ + + + + + +

vlan

the NMBridgeVlan

 
+
+
+

Returns

+

the input argument vlan +object.

+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_unref ()

+
void
+nm_bridge_vlan_unref (NMBridgeVlan *vlan);
+

Decreases the reference count of the object. If the reference count +reaches zero the object will be destroyed.

+
+

Parameters

+
+++++ + + + + + +

vlan

the NMBridgeVlan

 
+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_new_clone ()

+
NMBridgeVlan *
+nm_bridge_vlan_new_clone (const NMBridgeVlan *vlan);
+
+

Parameters

+
+++++ + + + + + +

vlan

the NMBridgeVlan instance to copy

 
+
+
+

Returns

+

a clone of vlan +. This instance +is always unsealed.

+

[transfer full]

+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_cmp ()

+
int
+nm_bridge_vlan_cmp (const NMBridgeVlan *a,
+                    const NMBridgeVlan *b);
+

Compare two bridge VLAN objects.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

a

a NMBridgeVlan

 

b

another NMBridgeVlan

 
+
+
+

Returns

+

zero of the two instances are equivalent or +a non-zero integer otherwise. This defines a total ordering +over the VLANs. Whether a VLAN is sealed or not does not +affect the comparison.

+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_seal ()

+
void
+nm_bridge_vlan_seal (NMBridgeVlan *vlan);
+

Seal the NMBridgeVlan instance. Afterwards, it is a bug +to call all functions that modify the instance (except ref/unref). +A sealed instance cannot be unsealed again, but you can create +an unsealed copy with nm_bridge_vlan_new_clone().

+
+

Parameters

+
+++++ + + + + + +

vlan

the NMBridgeVlan instance

 
+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_is_sealed ()

+
gboolean
+nm_bridge_vlan_is_sealed (const NMBridgeVlan *vlan);
+
+

Parameters

+
+++++ + + + + + +

vlan

the NMBridgeVlan instance

 
+
+
+

Returns

+

whether self +is sealed or not.

+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_set_untagged ()

+
void
+nm_bridge_vlan_set_untagged (NMBridgeVlan *vlan,
+                             gboolean value);
+

Change the value of the untagged property of the VLAN.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vlan

the NMBridgeVlan

 

value

the new value

 
+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_set_pvid ()

+
void
+nm_bridge_vlan_set_pvid (NMBridgeVlan *vlan,
+                         gboolean value);
+

Change the value of the PVID property of the VLAN. It +is invalid to set the value to TRUE for non-single-id +VLANs.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vlan

the NMBridgeVlan

 

value

the new value

 
+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_get_vid_range ()

+
gboolean
+nm_bridge_vlan_get_vid_range (const NMBridgeVlan *vlan,
+                              guint16 *vid_start,
+                              guint16 *vid_end);
+

Gets the VLAN id range.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

vlan

the NMBridgeVlan

 

vid_start

location to store the VLAN id range start.

 

vid_end

location to store the VLAN id range end

 
+
+
+

Returns

+

TRUE is the VLAN specifies a range, FALSE if it is +a single-id VLAN.

+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_is_untagged ()

+
gboolean
+nm_bridge_vlan_is_untagged (const NMBridgeVlan *vlan);
+

Returns whether the VLAN is untagged.

+
+

Parameters

+
+++++ + + + + + +

vlan

the NMBridgeVlan

 
+
+
+

Returns

+

TRUE if the VLAN is untagged, FALSE otherwise

+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_is_pvid ()

+
gboolean
+nm_bridge_vlan_is_pvid (const NMBridgeVlan *vlan);
+

Returns whether the VLAN is the PVID for the port.

+
+

Parameters

+
+++++ + + + + + +

vlan

the NMBridgeVlan

 
+
+
+

Returns

+

TRUE if the VLAN is the PVID

+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_to_str ()

+
char *
+nm_bridge_vlan_to_str (const NMBridgeVlan *vlan,
+                       GError **error);
+

Convert a NMBridgeVlan to a string.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vlan

the NMBridgeVlan

 

error

location of the error

 
+
+
+

Returns

+

formatted string or NULL

+
+

Since: 1.18

+
+
+
+

nm_bridge_vlan_from_str ()

+
NMBridgeVlan *
+nm_bridge_vlan_from_str (const char *str,
+                         GError **error);
+

Parses the string representation of the queueing +discipline to a NMBridgeVlan instance.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

str

the string representation of a bridge VLAN

 

error

location of the error

 
+
+
+

Returns

+

the NMBridgeVlan or NULL

+
+

Since: 1.18

+
+
+
+

Types and Values

+
+

NM_SETTING_BRIDGE_SETTING_NAME

+
#define NM_SETTING_BRIDGE_SETTING_NAME "bridge"
+
+
+
+
+

NM_SETTING_BRIDGE_MAC_ADDRESS

+
#define NM_SETTING_BRIDGE_MAC_ADDRESS    "mac-address"
+
+
+
+
+

NM_SETTING_BRIDGE_STP

+
#define NM_SETTING_BRIDGE_STP            "stp"
+
+
+
+
+

NM_SETTING_BRIDGE_PRIORITY

+
#define NM_SETTING_BRIDGE_PRIORITY       "priority"
+
+
+
+
+

NM_SETTING_BRIDGE_FORWARD_DELAY

+
#define NM_SETTING_BRIDGE_FORWARD_DELAY  "forward-delay"
+
+
+
+
+

NM_SETTING_BRIDGE_HELLO_TIME

+
#define NM_SETTING_BRIDGE_HELLO_TIME     "hello-time"
+
+
+
+
+

NM_SETTING_BRIDGE_MAX_AGE

+
#define NM_SETTING_BRIDGE_MAX_AGE        "max-age"
+
+
+
+
+

NM_SETTING_BRIDGE_AGEING_TIME

+
#define NM_SETTING_BRIDGE_AGEING_TIME    "ageing-time"
+
+
+
+
+

NM_SETTING_BRIDGE_GROUP_FORWARD_MASK

+
#define NM_SETTING_BRIDGE_GROUP_FORWARD_MASK "group-forward-mask"
@@ -554,6 +1462,36 @@ nm_setting_bridge_get_multicast_snooping
+

NM_SETTING_BRIDGE_VLAN_FILTERING

+
#define NM_SETTING_BRIDGE_VLAN_FILTERING     "vlan-filtering"
+
+
+
+
+

NM_SETTING_BRIDGE_VLAN_DEFAULT_PVID

+
#define NM_SETTING_BRIDGE_VLAN_DEFAULT_PVID  "vlan-default-pvid"
+
+
+
+
+

NM_SETTING_BRIDGE_VLANS

+
#define NM_SETTING_BRIDGE_VLANS              "vlans"
+
+
+
+
+

NM_BRIDGE_VLAN_VID_MIN

+
#define NM_BRIDGE_VLAN_VID_MIN            1
+
+
+
+
+

NM_BRIDGE_VLAN_VID_MAX

+
#define NM_BRIDGE_VLAN_VID_MAX            4094
+
+
+
+

NMSettingBridge

typedef struct _NMSettingBridge NMSettingBridge;

Bridging Settings

@@ -660,6 +1598,42 @@ bridge.

Flags: Read / Write / Construct

Default value: TRUE

+
+
+

The “vlan-default-pvid” property

+
  “vlan-default-pvid”        guint
+

The default PVID for the ports of the bridge, that is the VLAN id +assigned to incoming untagged frames.

+

Flags: Read / Write / Construct

+

Allowed values: <= 4094

+

Default value: 1

+

Since: 1.18

+
+
+
+

The “vlan-filtering” property

+
  “vlan-filtering”           gboolean
+

Control whether VLAN filtering is enabled on the bridge.

+

Flags: Read / Write / Construct

+

Default value: FALSE

+

Since: 1.18

+
+
+
+

The “vlans” property

+
  “vlans”                    GPtrArray *
+

Array of bridge VLAN objects. In addition to the VLANs +specified here, the bridge will also have the default-pvid +VLAN configured by the bridge.vlan-default-pvid property.

+

In nmcli the VLAN list can be specified with the following +syntax:

+

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

+

where $vid is either a single id between 1 and 4094 or a +range, represented as a couple of ids separated by a dash.

+

[type GPtrArray(NMBridgeVlan)]

+

Flags: Read / Write

+

Since: 1.18

+
-- cgit 1.3.0-6-gf8a5