Interfaces Parameters
Last updated: 04-Dec-2024
Note
The following parameters are not configurable using SET_PARM command. Refer to Parameters Not Configurable with SET_PARM for more details on the list parameters.
Parameters for GPRS Interface
Config.usr1/Parameter DLD Name | Description | Valid/Max Values | Default Value | Name in PropertiesData.xml |
---|---|---|---|---|
INTERFACETIMEOUT | This parameter allows to configure the maximum time that a connection should be attempted on a particular interface. Typically, the overall connection timeout (set by “CONNECTTIMEOUT”) is distributed over the various interfaces configured. For example, if the environment includes Ethernet, WiFi and GPRS, then the connection timeout would be overall value of all interfaces. Hence, it is important to set the Interface timeouts, to be in sync with the overall connect timeout. | Numeric. Set in milliseconds. For example - 20000, indicating 20 seconds. 20000 is the recommended value for WiFi. NOTE: This parameter has underscore (_) at the end. | 30000 | timeout |
PRIMARYGPRSAPN, SECONDARYGPRSAPN (For Secondary Interface) | Name of the access point. | Alphanumeric, 100 (String) | [empty] | apn |
PRIMARYGPRSSIMSLOT, SECONDARYGPRSSIMSLOT (For Secondary Interface) | Primary and secondary GPRS SIM slot to use. |
|
0 | sim_slot |
PRIMARYGPRSRESTARTNETWORKONFAIL, SECONDARYGPRSRESTARTNETWORKONFAIL (For Secondary Interface) | Resets the primary and secondary GPRS network if a host connection fails. | 0 or 1 | 0, however the recommended value is 1. | RESTART_NETWORK_ON_HOST_FAILURE |
PRIMARYGPRSSTARTUPMODE, SECONDARYGPRSSTARTUPMODE (For Secondary Interface) | Defines the network start up behavior. |
|
AUTO | startup_mode |
PRIMARYGPRSAUTHENTICATION, SECONDARYGPRSAUTHENTICATION (For Secondary Interface) | Primary and secondary GPRS authentication mode. NOTE: CHAP_PAP is note supported for VOS2. |
|
[empty] | authentication |
PRIMARYGPRSUSERNAME, SECONDARYGPRSUSERNAME (For Secondary Interface) | Primary and secondary GPRS username, required for authentication. | Alphanumeric, 100 (String) | [empty] | username |
PRIMARYGPRSPASSWORD, SECONDARYGPRSPASSWORD (For Secondary Interface) | Primary and secondary GPRS password, required for authentication. | Alphanumeric, 100 (String) | [empty] | password |
PRIMARYGPRSROAMINGMODE, SECONDARYGPRSROAMINGMODE (For Secondary Interface) | Primary and secondary GPRS roaming mode. 0 = auto, 1 = manual. NOTE: For manual mode, MCCMNC must be set to specify the desired network operator. | Alphabetic, 100 (Integer) | [empty] | mode |
PRIMARYGPRSMCCMNC, SECONDARYGPRSMCCMNC (For Secondary Interface) | Desired network operator to connect with. NOTE: This is mandatory if MODE is set to 1. | Alphanumeric, 100 (Integer) | [empty] | mccmnc |
PRIMINTERFACETYPE, SECINTERFACETYPE (For Secondary Interface), TERINTERFACETYPE (For Tertiary Interface) | Type of the network profile. Type refers to the mandatory profile properties. Primary, secondary and tertiary interface type. |
|
User defined | type |
PRIMINTERFACEDEVICENAME, SECINTERFACEDEVICENAME (For Secondary Interface), TERINTERFACEDEVICENAME (For Tertiary Interface) | Defined symbol for the network interface. Primary, secondary and tertiary interface device name. |
|
User defined | device_name |
Parameters for LAN Interface
- For Com Control Panel (CCP), the below list of common network profile related parameters with ‘_1’ will go to the eth0 (LAN) and with ‘_2’ will go to the wlan0 (WLAN) profile based on the current implementation: DHCP_ENABLED, DNS_1, DNS_2, GATEWAY, IP_ADDRESS and NETMASK.
- As of this publication, eth0 and wlan0 profiles are only supported. For CCP, to configure WiFi, it is recommended to use primary WiFi configuration parameters.
- Few parameters from Interfaces/LAN Parameters, are not configurable using SET_PARM command. Refer to Parameters Not Configurable with SET_PARM for more details on the list parameters.
Note
Config.usr1/Parameter DLD Name | Description | Valid/Max Values | Default Value | Name in PropertiesData.xml |
---|---|---|---|---|
PRIMINTERFACETYPE, SECINTERFACETYPE (For Secondary Interface), TERINTERFACETYPE (For Tertiary Interface) | Type of the network profile. Type refers to the mandatory profile properties. Primary, secondary and tertiary interface type. |
|
User defined | type |
PRIMINTERFACEDEVICENAME, SECINTERFACEDEVICENAME (For Secondary Interface), TERINTERFACEDEVICENAME (For Tertiary Interface) |
|
|
User defined | device_name |
STARTUP_MODE | Defines the network’s start-up behavior. |
|
AUTO | STARTUP_MODE |
START_NETWORK_1 (For Primary Interface), START_NETWORK_2 (For Secondary Interface), START_NETWORK_3 (For Tertiary Interface) | This parameter is used for bringing up the same network interface for Host connection, if it goes down for any reason. |
|
1 | start_network |
INTERFACETIMEOUT | This parameter allows to configure the maximum time that a connection should be attempted on a particular interface. Typically, the overall connection timeout (set by “CONNECTTIMEOUT”) is distributed over the various interfaces configured. For example, if the environment includes Ethernet, WiFi and GPRS, then the connection timeout would be overall value of all interfaces. Hence, it is important to set the Interface timeouts, to be in sync with the overall connect timeout. | Numeric. Set in milliseconds. For example - 20000, indicating 20 seconds. 20000 is the recommended value for WiFi. NOTE: This parameter has underscore (_) at the end. | 30000 | timeout |
DHCP_ENABLED_1 (For EPP Interface), DHCP_ENABLED_2 (For Primary Interface), DHCP_ENABLED_3 (For Secondary Interface) | Dynamic Host Configuration Protocol. DHCP client usage for this network. NOTE: This parameter name with ‘_1’ and ‘_2’ are applicable if ADVCOMMSENABLED is set to N. |
|
1 | dhcp_enabled |
DHCP_HOSTNAME | DHCP client hostname to display on DHCP server side (used only if DHCP_ENABLED = 1). The maximum string length is 127 In case of longer string, it gets truncated. If not specified, this will default to VFI-<SN> where <SN> is the terminals serial number. | String | Empty | |
DHCP_CLIENTID | DHCP client identifier is used to uniquely identify the client on DHCP server side (used only if DHCP_ENABLED = 1). The maximum string length is 15. In case of longer the string, it gets truncated. If not specified, the terminal will automatically send the interfaces hardware address as Client ID. | String | Empty | |
IP_ADDRESS_1 (For EPP Interface), IP_ADDRESS_2 (For Primary Interface), IP_ADDRESS_3 (For Secondary Interface) | IPv4 Address if DHCP is disabled. NOTE: This parameter name with ‘_1’ and ‘_2’ are applicable if ADVCOMMSENABLED is set to N. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | ip_address |
NETMASK_1 (For EPP Interface), NETMASK_2 (For Primary Interface), NETMASK_3 (For Secondary Interface) | IPv4 network mask if DHCP is disabled. NOTE: This parameter name with ‘_1’ and ‘_2’ are applicable if ADVCOMMSENABLED is set to N. | Alphanumeric, 23. Example: 255.255.255.0 | Empty | netmask |
GATEWAY_1 (For EPP Interface), GATEWAY_2 (For Primary Interface), GATEWAY_3 (For Secondary Interface) | IPv4 Gateway if DHCP is disabled. NOTE: This parameter name with ‘_1’ and ‘_2’ are applicable if ADVCOMMSENABLED is set to N. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | gateway |
DNS_1_1 (For EPP Interface), DNS_1_2 (For Primary Interface), DNS_1_3 (For Secondary Interface) | First DNS server if DHCP is disabled. NOTE: This parameter name with ‘_1’ and ‘_2’ are applicable if ADVCOMMSENABLED is set to N. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | dns_1 |
DNS_2_1 (For EPP Interface), DNS_2_2 (For Primary Interface), DNS_2_3 (For Secondary Interface) | Second DNS server if DHCP is disabled. NOTE: This parameter name with ‘_1’ and ‘_2’ are applicable if ADVCOMMSENABLED is set to N. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | dns_2 |
IPV4_ENABLED | This parameter is used to enable or disable IPv4 TCP/IP Stack support for the specified interface. |
|
||
IPV6_ENABLED | This parameter is used to enable or disable IPv6 TCP/IP Stack support for the specified interface. |
|
||
IPV6_MODE | This parameter defines IPv6 mode for IPv6 auto configuration or use static IPv6 address information. |
|
||
IPV6_GLOBAL_ADDRESS | The IPv6 address with global scope. This is used only if IPV6_MODE = STATIC. | String | Empty | |
IPV6_GLOBAL_PREFIX | IPv6 global prefix length. This is used only if IPV6_MODE = STATIC. | Value ranges: 1 - 128 | Empty | |
IPV6_UNIQUE_LOCAL_ADDRESS | The IPv6 unique local address. This is used only if IPV6_MODE = STATIC. | String | Empty | |
IPV6_UNIQUE_LOCAL_PREFIX | The IPv6 unique local address prefix length. This is used only if IPV6_MODE = STATIC. | Value ranges: 1 - 128 | Empty | |
IPV6_GATEWAY | IPv6 gateway address. This is used only if IPV6_MODE = STATIC. | String | Empty | |
IPV6_DNS_1 | IPv6 DNS server address. This is used only if IPV6_MODE = STATIC. | String | Empty | |
IPV6_DNS_2 | IPv6 alternative DNS server address. This is used only if IPV6_MODE = STATIC. | String | Empty | |
WLAN_NODE | Encapsulates one WLAN Node within a WLAN Network profile. Up to 10 WLAN Nodes can be defined for a WLAN Network Profile. | Subtag in XML or InfoDB | Empty |
LAN for CCP
- The list of common network profile related parameters with ‘_1’ will go to eth0 (LAN) profile based and parameters with ‘_2’ will go to wlan0 (WLAN) profile based.
- ADVCOMMSENABLED parameter must be set to Y.
Note
Config.usr1/Parameter DLD Name | Description | Valid/Max Values | Default Value | Name in PropertiesData.xml |
---|---|---|---|---|
DHCP_ENABLED_1 (For CCP Primary Interface), DHCP_ENABLED_2 (For CCP Secondary Interface) | Dynamic Host Configuration Protocol. DHCP client usage for this network. |
|
1 | dhcp_enabled |
IP_ADDRESS_1 (For CCP Primary Interface), IP_ADDRESS_2 (For CCP Secondary Interface) | IPv4 Address if DHCP is disabled. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | ip_address |
NETMASK_1 (For CCP Primary Interface), NETMASK_2 (For CCP Secondary Interface) | IPv4 network mask if DHCP is disabled. | Alphanumeric, 23. Example: 255.255.255.0 | Empty | netmask |
GATEWAY_1 (For CCP Primary Interface), GATEWAY_2 (For CCP Secondary Interface) | IPv4 Gateway if DHCP is disabled. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | gateway |
DNS_1_1 (For CCP Primary Interface), DNS_1_2 (For CCP Secondary Interface) | First DNS server if DHCP is disabled. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | dns_1 |
DNS_2_1 (For CCP Primary Interface), DNS_2_2 (For CCP Secondary Interface) | Second DNS server if DHCP is disabled. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | dns_2 |
Parameters for WLAN Interface
- For Com Control Panel (CCP), the below list of common network profile related parameters with ‘_1’ will go to the eth0 (LAN) and with ‘_2’ will go to the wlan0 (WLAN) profile based on the current implementation: DHCP_ENABLED, DNS_1, DNS_2, GATEWAY, IP_ADDRESS and NETMASK.
- As of this publication, eth0 and wlan0 profiles are only supported. For CCP, to configure WiFi, it is recommended to use primary WiFi configuration parameters.
- Few parameters from Interfaces/WLAN Parameters, are not configurable using SET_PARM command. Refer to Parameters Not Configurable with SET_PARM for more details on the list parameters.
Note
Config.usr1/Parameter DLD Name | Description | Valid/Max Values | Default Value | Name in PropertiesData.xml |
---|---|---|---|---|
PRIMINTERFACETYPE, SECINTERFACETYPE, TERINTERFACETYPE | Type of the network profile. Type refers to the mandatory profile properties. Primary, secondary and tertiary interface type. |
|
WLAN | type |
PRIMINTERFACEDEVICENAME, SECINTERFACEDEVICENAME, TERINTERFACEDEVICENAME | Defined symbol for the network interface. Primary, secondary and tertiary interface device name. |
|
WLAN0 | device_name |
STARTUP_MODE | Defines the network’s start-up behavior. |
|
AUTO | STARTUP_MODE |
INTERFACETIMEOUT | This parameter allows to configure the maximum time that a connection should be attempted on a particular interface. Typically, the overall connection timeout (set by “CONNECTTIMEOUT”) is distributed over the various interfaces configured. For example, if the environment includes Ethernet, WiFi and GPRS, then the connection timeout would be overall value of all interfaces. Hence, it is important to set the Interface timeouts, to be in sync with the overall connect timeout. | Numeric. Set in milliseconds. For example - 20000, indicating 20 seconds. 20000 is the recommended value for WiFi. NOTE: This parameter has underscore (_) at the end. | 30000 | timeout |
DHCP_ENABLED_1 (For EPP Interface), DHCP_ENABLED_2 (For Primary Interface), DHCP_ENABLED_3 (For Secondary Interface) | Dynamic Host Configuration Protocol. DHCP client usage for this network. NOTE: This parameter name with ‘_1’ and ‘_2’ are applicable if ADVCOMMSENABLED is set to N. |
|
1 | dhcp_enabled |
DHCP_HOSTNAME | DHCP client hostname is used to display on DHCP server side (used only if DHCP_ENABLED = 1). The maximum string length is 127. In case of longer string, it gets truncated. If not specified, this will default to VFI-<SN> where <SN> is the terminals serial number. | String | Empty | |
DHCP_CLIENTID | DHCP client identifier is used to uniquely identify the client on DHCP server side (used only if DHCP_ENABLED = 1). The maximum string length is 15. In case of longer the string, it gets truncated. If not specified, the terminal will automatically send the interfaces hardware address as Client ID. | String | Empty | |
IP_ADDRESS_1 (For EPP Interface), IP_ADDRESS_2 (For Primary Interface), IP_ADDRESS_3 (For Secondary Interface) | IPv4 Address if DHCP disabled. NOTE: This parameter name with ‘_1’ and ‘_2’ are applicable if ADVCOMMSENABLED is set to N. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | ip_address |
NETMASK_1 (For EPP Interface), NETMASK_2 (For Primary Interface), NETMASK_3 (For Secondary Interface) | IPv4 network mask if DHCP is disabled. NOTE: This parameter name with ‘_1’ and ‘_2’ are applicable if ADVCOMMSENABLED is set to N. | Alphanumeric, 23. Example: 255.255.255.0 | Empty | netmask |
GATEWAY_1 (For EPP Interface), GATEWAY_2 (For Primary Interface), GATEWAY_3 (For Secondary Interface) | IPv4 Gateway if DHCP is disabled. NOTE: This parameter name with ‘_1’ and ‘_2’ are applicable if ADVCOMMSENABLED is set to N. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | gateway |
DNS_1_1 (For EPP Interface), DNS_1_2 (For Primary Interface), DNS_1_3 (For Secondary Interface) | First DNS server if DHCP is disabled. NOTE: This parameter name with ‘_1’ and ‘_2’ are applicable if ADVCOMMSENABLED is set to N. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | dns_1 |
DNS_2_1 (For EPP Interface), DNS_2_2 (For Primary Interface), DNS_2_3 (For Secondary Interface) | Second DNS server if DHCP is disabled. NOTE: This parameter name with ‘_1’ and ‘_2’ are applicable if ADVCOMMSENABLED is set to N. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | dns_2 |
IPV4_ENABLED | This parameter is used to enable or disable IPv4 TCP/IP Stack support for the specified interface. |
|
||
IPV6_ENABLED | This parameter is used to enable or disable IPv6 TCP/IP Stack support for the specified interface. |
|
||
IPV6_MODE | This parameter defines IPv6 mode for IPv6 auto configuration or use static IPv6 address information. |
|
||
IPV6_GLOBAL_ADDRESS | The IPv6 address with global scope. This is used only if IPV6_MODE = STATIC. | String | Empty | |
IPV6_GLOBAL_PREFIX | IPv6 global prefix length. This is used only if IPV6_MODE = STATIC. | Value ranges: 1 - 128 | Empty | |
IPV6_UNIQUE_LOCAL_ADDRESS | The IPv6 unique local address. This is used only if IPV6_MODE = STATIC. | String | Empty | |
IPV6_UNIQUE_LOCAL_PREFIX | The IPv6 unique local address prefix length. This is used only if IPV6_MODE = STATIC. | Value ranges: 1 - 128 | Empty | |
IPV6_GATEWAY | IPv6 gateway address. This is used only if IPV6_MODE = STATIC. | String | Empty | |
IPV6_DNS_1 | IPv6 DNS server address. This is used only if IPV6_MODE = STATIC. | String | Empty | |
IPV6_DNS_2 | IPv6 alternative DNS server address. This is used only if IPV6_MODE = STATIC. | String | Empty | |
WLAN_NODE | Encapsulates one WLAN Node within a WLAN Network profile. Up to 10 WLAN Nodes can be defined for a WLAN Network Profile. | Subtag in XML or InfoDB | Empty |
WLAN for CCP
- The list of common network profile related parameters with ‘_1’ will go to eth0 (LAN) profile based and parameters with ‘_2’ will go to wlan0 (WLAN) profile based.
- ADVCOMMSENABLED parameter must be set to Y.
Note
Config.usr1/Parameter DLD Name | Description | Valid/Max Values | Default Value | Name in PropertiesData.xml |
---|---|---|---|---|
DHCP_ENABLED_1 (For CCP Primary Interface), DHCP_ENABLED_2 (For CCP Secondary Interface) | Dynamic Host Configuration Protocol. DHCP client usage for this network. |
|
1 | dhcp_enabled |
IP_ADDRESS_1 (For CCP Primary Interface), IP_ADDRESS_2 (For CCP Secondary Interface) | IPv4 Address if DHCP disabled. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | ip_address |
NETMASK_1 (For CCP Primary Interface), NETMASK_2 (For CCP Secondary Interface) | IPv4 network mask if DHCP is disabled. | Alphanumeric, 23. Example: 255.255.255.0 | Empty | netmask |
GATEWAY_1 (For CCP Primary Interface), GATEWAY_2 (For CCP Secondary Interface) | IPv4 Gateway if DHCP is disabled. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | gateway |
DNS_1_1 (For CCP Primary Interface), DNS_1_2 (For CCP Secondary Interface) | First DNS server if DHCP is disabled. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | dns_1 |
DNS_2_1 (For CCP Primary Interface), DNS_2_2 (For CCP Secondary Interface) | Second DNS server if DHCP is disabled. | Alphanumeric, 23. Example: 12.34.56.78 | Empty | dns_2 |
Note
The following parameters are not configurable using SET_PARM command. Refer to Parameters Not Configurable with SET_PARM for more details on the list parameters.
Parameters for WLAN_NODE Interface
This node section is accessed directly by the ADK COM, which will be used to set up the WiFi profile. Configure when wlan type = wlan.
- For Com Control Panel (CCP), these primary WiFi specific parameters with ‘_1’ are applicable for wlan0 (WLAN). For example: ‘BAND_1’.
- The following parameters in the table have underscore (_) at the end of the parameter name.
Note
Config.usr1/Parameter DLD Name | Description | Valid/Max Values | Default Value | Name in PropertiesData.xml |
---|---|---|---|---|
SSID, SEC_SSID (For Secondary Interface) | WLAN network name (Server Set Identification) informal name of the BSS. NOTE: This is case sensitive. | Alphanumeric | [blank] | ssid |
PROTO, SEC_PROTO (For Secondary Interface) | Defines acceptable protocol types. This is used if KEY_MGMT is EAP or PSK. |
|
[blank] | Proto |
KEY_MGMT, SEC_KEY_MGMT (For Secondary Interface) | Defines the key management protocol. |
|
[blank] | Key_mgmt |
PSK, SEC_PSK (For Secondary Interface) | WPA/WPA2 Pre-Shared Key. NOTE: Length 8-63 is pass-phrase, 64 character length is HEX-Keys (HEX digits). | Alphanumeric 8-64 | [blank] | Psk |
GROUP, SEC_GROUP (For Secondary Interface) | Group cipher to be used. This is used if KEY_MGMT is EAP or PSK. |
|
[blank] | group |
PAIRWISE, SEC_PAIRWISE (For Secondary Interface) | Pairwise cipher to be used. This is used if KEY_MGMT is EAP or PSK. |
|
[blank] | pairwise |
EAPTYPE, SEC_EAPTYPE (For Secondary Interface) | Mandatory if KEY_MGMT is EAP. Inner authentication used for PEAP is MSCHAPv2. |
|
[blank] | eap_type |
EAPCACERT, SEC_EAPCERT (For Secondary Interface) | File path to CA certificate file. This is mandatory if EAP_TYPE is set to TLS. Optional if EAP_TYPE is PEAP or TTLS. | Alphanumeric | [blank] | eap_cacert |
EAPCLIENTCERT, SEC_EAPCLIENTCERT (For Secondary Interface) | File path to client certificate file. This is mandatory if EAP_TYPE is TLS. | Alphanumeric | [blank] | eap_clientcert |
EAPPRIVKEY, SEC_EAPPRIVKEY (For Secondary Interface) | File path to private key file. File format: PEM/DER/PFX. This is optional if EAP_TYPE is TLS. | Alphanumeric | [blank] | eap_privkey |
EAPPRIVKEYPWD, SEC_EAPPRIVKEYPWD (For Secondary Interface) | Password for private key file. This is optional if EAP_TYPE is TLS. | Alphanumeric | [blank] | eap_privkey_pwd |
EAPIDENTITY, SEC_EAPIDENTITY (For Secondary Interface) | Identity needed for EAP authentication. This is mandatory for all EAP types. | Alphanumeric | [blank] | eap_identity |
EAPPWD, SEC_EAPPWD (For Secondary Interface) | Password needed for EAP authentication. This is mandatory if EAP_TYPE is PEAP, FAST, TTLS, PWD, PSK or GPSK. For PSK and GPSK this must be a HEX string. For PSK it must be exactly 16 bytes (32 characters) long. For GPSK the minimum length is 16 bytes (32 characters). | Alphanumeric | [blank] | eap_password |
EAPANONYMOUSID, SEC_EAPANONYMOUSID (For Secondary Interface) | Anonymous identity for EAP modes. Optional for all modes with inner authentication. | Alphanumeric | [blank] | eap_anonymous_id |
EAPFASTPACFILE, SEC_EAPFASTPACFILE (For Secondary Interface) | This is mandatory for EAP FAST only. Full path + file name of a pre-loaded PAC file. If not specified, then automatic PAC provisioning will be enabled allowing both, unauthenticated and authenticated provisioning. | Alphanumeric | [blank] | eap_fast_pac_file |
VISIBILITY, SEC_VISIBILITY (For Secondary Interface) | Visibility settings of SSID. The network SSID is hidden. |
|
Visible | visibility |
BAND, SEC_BAND (For Secondary Interface) | Band frequencies to be set, frequencies of 2.4GHz, 5GHz or of both bands. |
|
User defined | band |
PRIORITY, SEC_PRIORITY (For Secondary Interface) | The priority in selecting network to be set. Higher values are preferred to lower values. | Alphanumeric | [blank] | priority |
Rate this article: