gsm: NetworkManager Reference Manual

## gsm gsm — GSM-based Mobile Broadband Settings |

## Properties

Table 50.

Key Name | Value Type | Default Value | Value Description
--- | --- | --- | ---
    apn
    string
| The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9. If the APN is unset (the default) then it may be detected based on "auto-config" setting. The property can be explicitly set to the empty string to prevent that and use no APN.
    auto-config
    boolean
    FALSE
| When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.
    device-id
    string
| The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.
    home-only
    boolean
    FALSE
| When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.
    initial-eps-bearer-apn
    string
| For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE.
    initial-eps-bearer-configure
    boolean
    FALSE
| For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection. It is inferred TRUE if initial-eps-bearer-apn is set.
    mtu
    uint32
    0
| If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
    network-id
    string
| The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.
    number
    string
| Legacy setting that used to help establishing PPP data sessions for GSM-based modems.
    password
    string
| The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.
    password-flags
    NMSettingSecretFlags (uint32)
| Flags indicating how to handle the "password" property.
    pin
    string
| If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.
    pin-flags
    NMSettingSecretFlags (uint32)
| Flags indicating how to handle the "pin" property.
    sim-id
    string
| The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.
    sim-operator-id
    string
| A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.
    username
    string
| The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.