Interface BearerConfiguration

Aliased as BearerConfiguration from the Bearer "Properties" property from ModemManager.

See

https://www.freedesktop.org/software/ModemManager/doc/latest/ModemManager/gdbus-org.freedesktop.ModemManager1.Bearer.html#gdbus-property-org-freedesktop-ModemManager1-Bearer.Properties

List of settings used to create the bearer. Bearers may be implicitly created (e.g. the default initial EPS bearer created during the network registration process in 4G and 5G networks) or explicitly created by the user (e.g. via the CreateBearer() or Connect() calls).

The following settings apply to 3GPP (GSM/UMTS/LTE/5GNR) devices:

"apn"
"ip-type"
"apn-type"
"allowed-auth"
"user"
"password"
"access-type-preference"
"roaming-allowance"
"profile-id"
"profile-name"
"profile-enabled"
"profile-source"

The following settings apply to 3GPP2 (CDMA/EVDO) devices:

"rm-protocol"

The following settings apply to all devices types:

"allow-roaming"
"multiplex"

The following settings are no longer supported, but they are kept on the interface for compatibility purposes:

"number"

Hierarchy

  • BearerConfiguration

Properties

access-type-preference: BearerAccessTypePreference

Access type preference for 5G devices, given as a MMBearerAccessTypePreference value (signature "u". Since 1.20.

allow-roaming: boolean

Specifies whether the connections are allowed even when the device is registered in a roaming (partner or non-partner) network, given as a boolean value (signature "b"). This setting applies only to the connection attempts started via Simple.Connect() or Bearer.Connect(). This is a volatile setting, never stored in the device.

allowed-auth: BearerAllowedAuth

The authentication method to use, given as a MMBearerAllowedAuth value (signature "u").

apn: string

The Access Point Name to use in the connection, given as a string value (signature "s"). For 5G NGC, this field contains the Data Network Name (DNN).

apn-type: BearerApnType

The purposes of the specified APN, given as a MMBearerApnType value (signature "u").

The IP addressing type to use, given as a MMBearerIpFamily value (signature "u").

The multiplex support requested by the user, given as a MMBearerMultiplexSupport value (signature "u"). Since 1.18.

number: string

Number to dial for the data connection, given as a string value (signature "s"). Deprecated since version 1.10.0.

password: string

The password (if any) required by the network, given as a string value (signature "s").

profile-enabled: boolean

Boolean flag specifying whether the profile is enabled or disabled, given as a boolean value (signature "b"). Profiles that are disabled will not be automatically connected by the modem in any way, and attempting to connect them explicitly will fail. This setting only applies on profile management operations, it should not be used as part of the settings of an explicit connection attempt. Since 1.20.

profile-id: number

The ID of the 3GPP profile to connect to (signature "i"), as given in the profile list. In this case, if additional profile settings are given in the properties and they already exist in the profile (e.g. "apn"), the new settings will be explicitly ignored; the settings stored in the profile itself always take preference. The value -1 is used to indicate an invalid or uninitialized profile id. Since 1.18.

profile-name: string

The name of the profile, given as a string value (signature "s"). This value has no effect on the connection, but can be used by the host to identify the profiles. This setting only applies on profile management operations, it should not be used as part of the settings of an explicit connection attempt. Since 1.20.

profile-source: BearerProfileSource

A MMBearerProfileSource value (signature "u", specifying how the profile was created. This setting only applies on profile management operations, it should not be used as part of the settings of an explicit connection attempt. Since 1.20.

rm-protocol: ModemCdmaRmProtocol

The protocol of the Rm interface, given as a MMModemCdmaRmProtocol value (signature "u").

roaming-allowance: BearerRoamingAllowance

Roaming allowance, given as a MMBearerRoamingAllowance value (signature "u". If supported, this setting should be used instead of 'allow-roaming'. Since 1.20.

user: string

The user name (if any) required by the network, given as a string value (signature "s").

Generated using TypeDoc