NMSettingTeamPort

## NMSettingTeamPort NMSettingTeamPort — Describes connection properties for team ports |

## Synopsis

    #include <nm-setting-team-port.h>

    #define             NM_SETTING_TEAM_PORT_SETTING_NAME
    enum                NMSettingTeamPortError;
    #define             NM_SETTING_TEAM_PORT_ERROR
    GQuark              nm_setting_team_port_error_quark    (void);
    #define             NM_SETTING_TEAM_PORT_CONFIG
                        NMSettingTeamPort;
                        NMSettingTeamPortClass;
    NMSetting *         nm_setting_team_port_new            (void);
    const char *        nm_setting_team_port_get_config     (NMSettingTeamPort *setting);

## Object Hierarchy

      GEnum
       +----NMSettingTeamPortError

      GObject
       +----NMSetting
             +----NMSettingTeamPort

## Properties

      "config"                   gchar*                : Read / Write

## Description

The NMSettingTeamPort object is a NMSetting subclass that describes optional properties that apply to team ports.

## Details

### NM_SETTING_TEAM_PORT_SETTING_NAME

    #define NM_SETTING_TEAM_PORT_SETTING_NAME "team-port"

### enum NMSettingTeamPortError

    typedef enum {
    	NM_SETTING_TEAM_PORT_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
    	NM_SETTING_TEAM_PORT_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
    	NM_SETTING_TEAM_PORT_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
    } NMSettingTeamPortError;

`NM_SETTING_TEAM_PORT_ERROR_UNKNOWN` | unknown or unclassified error
`NM_SETTING_TEAM_PORT_ERROR_INVALID_PROPERTY` | the property was invalid
`NM_SETTING_TEAM_PORT_ERROR_MISSING_PROPERTY` | the property was missing and is required

### NM_SETTING_TEAM_PORT_ERROR

    #define NM_SETTING_TEAM_PORT_ERROR nm_setting_team_port_error_quark ()

### nm_setting_team_port_error_quark ()

    GQuark              nm_setting_team_port_error_quark    (void);

Registers an error quark for NMSettingTeamPort if necessary.

Returns : | the error quark used for NMSettingTeamPort errors.

Since 0.9.10

### NM_SETTING_TEAM_PORT_CONFIG

    #define NM_SETTING_TEAM_PORT_CONFIG     "config"

### NMSettingTeamPort

    typedef struct _NMSettingTeamPort NMSettingTeamPort;

### NMSettingTeamPortClass

    typedef struct {
    	NMSettingClass parent;

    	/* Padding for future expansion */
    	void (*_reserved1) (void);
    	void (*_reserved2) (void);
    	void (*_reserved3) (void);
    	void (*_reserved4) (void);
    } NMSettingTeamPortClass;

### nm_setting_team_port_new ()

    NMSetting *         nm_setting_team_port_new            (void);

Creates a new NMSettingTeamPort object with default values.

Returns : | the new empty NMSettingTeamPort object. [transfer full]

Since 0.9.10

### nm_setting_team_port_get_config ()

    const char *        nm_setting_team_port_get_config     (NMSettingTeamPort *setting);

`setting` : | the NMSettingTeamPort
Returns : | the "config" property of the setting

Since 0.9.10

## Property Details

### The `"config"` property

      "config"                   gchar*                : Read / Write

The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.

Default value: NULL