Blame docs/libnm/html/NMSettingInfiniband.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>NMSettingInfiniband: 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 Service a1bd4f
<link rel="prev" href="NMSettingHostname.html" title="NMSettingHostname">
Packit 5756e2
<link rel="next" href="NMSettingIP4Config.html" title="NMSettingIP4Config">
Packit Service 018b0a
<meta name="generator" content="GTK-Doc V1.33.0 (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 Service a1bd4f
Prev
Packit 5756e2
Next
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

NMSettingInfiniband

Packit 5756e2

NMSettingInfiniband — Describes connection properties for IP-over-InfiniBand networks

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_infiniband_new ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
const char *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_infiniband_get_mac_address ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
guint32
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_infiniband_get_mtu ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
const char *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_infiniband_get_transport_mode ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
int
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_infiniband_get_p_key ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
const char *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_infiniband_get_parent ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
const char *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_infiniband_get_virtual_interface_name ()
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
Packit Service a1bd4f
char *
Packit 5756e2
mac-address
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit 5756e2
guint
Packit 5756e2
mtu
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit Service a1bd4f
int
Packit 5756e2
p-key
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit Service a1bd4f
char *
Packit 5756e2
parent
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit Service a1bd4f
char *
Packit 5756e2
transport-mode
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_INFINIBAND_SETTING_NAME
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_INFINIBAND_MAC_ADDRESS
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_INFINIBAND_MTU
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_INFINIBAND_TRANSPORT_MODE
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_INFINIBAND_P_KEY
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_INFINIBAND_PARENT
Packit 5756e2
Packit 5756e2
Packit 5756e2
 
Packit 5756e2
NMSettingInfiniband
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Object Hierarchy

Packit 5756e2
    GObject
Packit 5756e2
    ╰── NMSetting
Packit 5756e2
        ╰── NMSettingInfiniband
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Description

Packit 5756e2

The NMSettingInfiniband object is a NMSetting subclass that describes properties

Packit 5756e2
necessary for connection to IP-over-InfiniBand networks.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Functions

Packit 5756e2
Packit 5756e2

nm_setting_infiniband_new ()

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

Creates a new NMSettingInfiniband object with default values.

Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the new empty NMSettingInfiniband object.

Packit Service 018b0a

[transfer full]

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_infiniband_get_mac_address ()

Packit 5756e2
const char *
Packit 5756e2
nm_setting_infiniband_get_mac_address (NMSettingInfiniband *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 NMSettingInfiniband

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

Returns

Packit 5756e2

the “mac-address” property of the setting

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_infiniband_get_mtu ()

Packit 5756e2
guint32
Packit 5756e2
nm_setting_infiniband_get_mtu (NMSettingInfiniband *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 NMSettingInfiniband

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

Returns

Packit 5756e2

the “mtu” property of the setting

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_infiniband_get_transport_mode ()

Packit 5756e2
const char *
Packit 5756e2
nm_setting_infiniband_get_transport_mode
Packit 5756e2
                               (NMSettingInfiniband *setting);
Packit 5756e2

Returns the transport mode for this device. Either 'datagram' or

Packit 5756e2
'connected'.

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 NMSettingInfiniband

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

Returns

Packit 5756e2

the IPoIB transport mode

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_infiniband_get_p_key ()

Packit 5756e2
int
Packit 5756e2
nm_setting_infiniband_get_p_key (NMSettingInfiniband *setting);
Packit 5756e2

Returns the P_Key to use for this device. A value of -1 means to

Packit 5756e2
use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is
Packit 5756e2
a 16-bit unsigned integer.

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 NMSettingInfiniband

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

Returns

Packit 5756e2

the IPoIB P_Key

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_infiniband_get_parent ()

Packit 5756e2
const char *
Packit 5756e2
nm_setting_infiniband_get_parent (NMSettingInfiniband *setting);
Packit 5756e2

Returns the parent interface name for this device, if set.

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 NMSettingInfiniband

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

Returns

Packit 5756e2

the parent interface name

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_infiniband_get_virtual_interface_name ()

Packit 5756e2
const char *
Packit 5756e2
nm_setting_infiniband_get_virtual_interface_name
Packit 5756e2
                               (NMSettingInfiniband *setting);
Packit 5756e2

Returns the interface name created by combining “parent”

Packit 5756e2
and “p-key”. (If either property is unset, this will
Packit 5756e2
return NULL.)

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 NMSettingInfiniband

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

Returns

Packit 5756e2

the interface name, or NULL

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

Types and Values

Packit 5756e2
Packit 5756e2

NM_SETTING_INFINIBAND_SETTING_NAME

Packit 5756e2
#define NM_SETTING_INFINIBAND_SETTING_NAME "infiniband"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_INFINIBAND_MAC_ADDRESS

Packit 5756e2
#define NM_SETTING_INFINIBAND_MAC_ADDRESS    "mac-address"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_INFINIBAND_MTU

Packit 5756e2
#define NM_SETTING_INFINIBAND_MTU            "mtu"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_INFINIBAND_TRANSPORT_MODE

Packit 5756e2
#define NM_SETTING_INFINIBAND_TRANSPORT_MODE "transport-mode"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_INFINIBAND_P_KEY

Packit 5756e2
#define NM_SETTING_INFINIBAND_P_KEY          "p-key"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_INFINIBAND_PARENT

Packit 5756e2
#define NM_SETTING_INFINIBAND_PARENT         "parent"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NMSettingInfiniband

Packit 5756e2
typedef struct _NMSettingInfiniband NMSettingInfiniband;
Packit 5756e2

Infiniband Settings

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

Property Details

Packit 5756e2
Packit 5756e2

The “mac-address” property

Packit Service a1bd4f
  “mac-address”              char *
Packit 5756e2

If specified, this connection will only apply to the IPoIB device whose

Packit 5756e2
permanent MAC address matches. This property does not change the MAC
Packit 5756e2
address of the device (i.e. MAC spoofing).

Packit 5756e2

Owner: NMSettingInfiniband

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Default value: NULL

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “mtu” property

Packit 5756e2
  “mtu”                      guint
Packit 5756e2

If non-zero, only transmit packets of the specified size or smaller,

Packit 5756e2
breaking larger packets up into multiple frames.

Packit 5756e2

Owner: NMSettingInfiniband

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Default value: 0

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “p-key” property

Packit Service a1bd4f
  “p-key”                    int
Packit 5756e2

The InfiniBand P_Key to use for this device. A value of -1 means to use

Packit 5756e2
the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit
Packit 5756e2
unsigned integer, whose high bit is set if it is a "full membership"
Packit 5756e2
P_Key.

Packit 5756e2

Owner: NMSettingInfiniband

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Allowed values: [-1,65535]

Packit 5756e2

Default value: -1

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “parent” property

Packit Service a1bd4f
  “parent”                   char *
Packit 5756e2

The interface name of the parent device of this device. Normally NULL,

Packit 5756e2
but if the “p_key” property is set, then you must
Packit 5756e2
specify the base device by setting either this property or
Packit 5756e2
“mac-address”.

Packit 5756e2

Owner: NMSettingInfiniband

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Default value: NULL

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “transport-mode” property

Packit Service a1bd4f
  “transport-mode”           char *
Packit 5756e2

The IP-over-InfiniBand transport mode. Either "datagram" or

Packit 5756e2
"connected".

Packit 5756e2

Owner: NMSettingInfiniband

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Default value: NULL

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit Service 018b0a

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