Gjsify LogoGjsify Logo

Interface SettingGsm_ConstructProps

Hierarchy

Index

Properties

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.

auto_config?: boolean

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

When %TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.

mtu?: number

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?: NM.SettingSecretFlags

Flags indicating how to handle the #NMSettingGsm: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.

Flags indicating how to handle the #NMSettingGsm: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 #NMSettingGsm: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 #NMSettingGsm:device-id and #NMSettingGsm: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.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method