NM.SettingGsm¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|
||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class NM.SettingGsm(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
GSM-based Mobile Broadband Settings
- classmethod new()¶
- Returns:
the new empty
NM.SettingGsmobject- Return type:
Creates a new
NM.SettingGsmobject with default values.
- get_apn()¶
- Returns:
the
NM.SettingGsm:apnproperty of the setting- Return type:
- get_auto_config()¶
- Returns:
the
NM.SettingGsm:auto-configproperty of the setting- Return type:
New in version 1.22.
- get_device_id()¶
- Returns:
the
NM.SettingGsm:device-idproperty of the setting- Return type:
New in version 1.2.
- get_home_only()¶
- Returns:
the
NM.SettingGsm:home-onlyproperty of the setting- Return type:
- get_initial_eps_apn()¶
- Returns:
the
NM.SettingGsm:initial-eps-bearer-apnproperty of the setting- Return type:
New in version 1.44.
- get_initial_eps_config()¶
- Returns:
the
NM.SettingGsm:initial-eps-bearer-configureproperty of the setting- Return type:
New in version 1.44.
- get_mtu()¶
- Returns:
the
NM.SettingGsm:mtuproperty of the setting- Return type:
New in version 1.8.
- get_network_id()¶
- Returns:
the
NM.SettingGsm:network-idproperty of the setting- Return type:
- get_number()¶
- Returns:
the
NM.SettingGsm:numberproperty of the setting- Return type:
Deprecated since version 1.16: User-provided values for this setting are no longer used.
- get_password()¶
- Returns:
the
NM.SettingGsm:passwordproperty of the setting- Return type:
- get_password_flags()¶
- Returns:
the
NM.SettingSecretFlagspertaining to theNM.SettingGsm:password- Return type:
- get_pin()¶
- Returns:
the
NM.SettingGsm:pinproperty of the setting- Return type:
- get_pin_flags()¶
- Returns:
the
NM.SettingSecretFlagspertaining to theNM.SettingGsm:pin- Return type:
- get_sim_id()¶
- Returns:
the
NM.SettingGsm:sim-idproperty of the setting- Return type:
New in version 1.2.
- get_sim_operator_id()¶
- Returns:
the
NM.SettingGsm:sim-operator-idproperty of the setting- Return type:
New in version 1.2.
- get_username()¶
- Returns:
the
NM.SettingGsm:usernameproperty of the setting- Return type:
Property Details¶
- NM.SettingGsm.props.apn¶
- Name:
apn- Type:
- Default Value:
- Flags:
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.
- NM.SettingGsm.props.auto_config¶
- Name:
auto-config- Type:
- Default Value:
- Flags:
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.New in version 1.22.
- NM.SettingGsm.props.device_id¶
- Name:
device-id- Type:
- Default Value:
- Flags:
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.
New in version 1.2.
- NM.SettingGsm.props.home_only¶
- Name:
home-only- Type:
- Default Value:
- Flags:
When
True, only connections to the home network will be allowed. Connections to roaming networks will not be made.
- NM.SettingGsm.props.initial_eps_bearer_apn¶
- Name:
initial-eps-bearer-apn- Type:
- Default Value:
- Flags:
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.New in version 1.44.
- NM.SettingGsm.props.initial_eps_bearer_configure¶
- Name:
initial-eps-bearer-configure- Type:
- Default Value:
- Flags:
For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection. It is inferred
Trueif initial-eps-bearer-apn is set.New in version 1.44.
- NM.SettingGsm.props.mtu¶
- Name:
mtu- Type:
- Default Value:
0- Flags:
If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
New in version 1.8.
- NM.SettingGsm.props.network_id¶
- Name:
network-id- Type:
- Default Value:
- Flags:
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.
- NM.SettingGsm.props.number¶
- Name:
number- Type:
- Default Value:
- Flags:
Legacy setting that used to help establishing PPP data sessions for GSM-based modems.
Deprecated since version 1.16: User-provided values for this setting are no longer used.
- NM.SettingGsm.props.password¶
- Name:
password- Type:
- Default Value:
- Flags:
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.
- NM.SettingGsm.props.password_flags¶
- Name:
password-flags- Type:
- Default Value:
- Flags:
Flags indicating how to handle the
NM.SettingGsm:passwordproperty.
- NM.SettingGsm.props.pin¶
- Name:
pin- Type:
- Default Value:
- Flags:
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.
- NM.SettingGsm.props.pin_flags¶
- Name:
pin-flags- Type:
- Default Value:
- Flags:
Flags indicating how to handle the
NM.SettingGsm:pinproperty.
- NM.SettingGsm.props.sim_id¶
- Name:
sim-id- Type:
- Default Value:
- Flags:
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
NM.SettingGsm:device-idwhich contains a SIM card matching the given identifier.New in version 1.2.
- NM.SettingGsm.props.sim_operator_id¶
- Name:
sim-operator-id- Type:
- Default Value:
- Flags:
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
NM.SettingGsm:device-idandNM.SettingGsm:sim-idwhich contains a SIM card provisioned by the given operator.New in version 1.2.
- NM.SettingGsm.props.username¶
- Name:
username- Type:
- Default Value:
- Flags:
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.