Ethernet Interface

ethernet.auto_start.enabled

Abbreviation

et a e

Access

get/set

Description

Enable/disable network auto-join using the ethernet interface on bootup.

Arguments

<0|off|false/1|on|true>

Default

0

Properties

Supported Platforms

Get example 

> get et a e
R000003
0

Set example 

> set et a e true
R000008
Set OK

ethernet.auto_start.retry_delay

Abbreviation

et a d

Access

get/set

Description

The period between auto-join attempts in seconds.

Arguments

<0-255>

Default

3

Properties

Supported Platforms

Get example 

> get et a d
R000004
10

Set example 

> set et a d 5
R000008
Set OK

ethernet.dhcp.cache_enabled

Abbreviation

et d c

Access

get/set

Description

When DHCP caching is enabled, the received DHCP IP address and corresponding lease time is cached to RAM. When the device is rebooted via the reboot command the RAM cache and corresponding timestamp is saved to NVM.

Upon rebooting the saved DHCP IP is restored and the lease time is updated with the amount of time that has elapsed since it was last stored. DHCP IP caching can save a considerable amount of time when re-connecting to the network as the full DHCP sequence is skipped (assuming there is enough time left on the DHCP lease).

See Networking and Security, DHCP Client .

Arguments

<1|true|on/0|false|off>

where

Default

0

Properties

Gecko OS Kernel Plugin

Get example 

> get et d c
R000003
0

Set example 

> set et d c 0
R000008
Set OK

ethernet.dhcp.enabled

Abbreviation

et d e

Access

get/set

Description

Select whether DHCP is used to automatically obtain an IPv4 IP address on the ethernet interface.

Arguments

<0|off|false/1|on|true>

Default

1

Properties

Supported Platforms

Get example 

> get et d e
R000003
1

Set example 

> set et d e off
R000008
Set OK

ethernet.dhcp.hostname

Abbreviation

et d h

Access

get/set

Description

Configures the DHCP client's hostname (DHCP option 12) sent to the DHCP server.

Arguments

<hostname>

Default

Gecko_OS-# where # is replaced by the last three digits of the Ethernet MAC address

Properties

Supported Platforms

Get example 

> get et d h
R000009
Gecko_OS-#

Set example 

> set et d h my_dhcp_client
R000008
Set OK

ethernet.dhcp.timeout

Abbreviation

et d t

Access

get/set

Description

Amount of time in seconds the module waits as a client for an IP from a DHCP server. See ethernet.dhcp.enabled .

Arguments

<timeout_seconds> Range: 1-255 seconds

Default

15

Properties

Supported Platforms

Get example 

> get et d t
R000004
15

Set example 

> set et d t 25
R000008
Set OK

Abbreviation

et l

Access

get/set

Description

Time in seconds to wait for for an ethernet link when bringing up the ethernet interface.

Arguments

<seconds>

where:

Default

7

Properties

Gecko OS Kernel Plugin

Get example 

> get et l
R000003
7

Set example 

> set et l 10
Set OK

Abbreviation

et i e

Access

get/set

Description

Enables and disables the link local feature.

The device obtains an IP address using the following sequence:

  1. IF ethernet.dhcp.enabled == true THEN Attempt DHCP
  2. IF ethernet.static.ip != 0.0.0.0 THEN Use static IP
  3. IF ethernet.link_local.enabled == true THEN Attempt Link Local IP (e.g. Auto IP)

If all three steps fail to obtain an IP address then the network_up sequence fails.

Arguments

<1|true|on/0|false|off>

Default

0

Get example 

> get ethernet.link_local.enabled
0

Set example 

> set et i e 1
R000008
Set OK

Abbreviation

et i t

Access

get/set

Description

Configures the maximum time in seconds to obtain an IP via link local protocol.

Arguments

<timeout in seconds>

where:

Default

20

Get example 

> get ethernet.link_local.timeout
20

Set example 

> set et i t 30
R000008
Set OK

ethernet.mac

Abbreviation

et m

Access

get

Description

Returns the ethernet MAC address.

Arguments

-

Default

varies

Properties

Gecko OS Kernel Plugin

Get example 

> get et m
R000019
4C:55:CC:01:23:45

ethernet.multicast.address

Abbreviation

et m a

Access

get

Description

Configure UDP multicast address range.

When the ethernet interface is brought up, it joins the configured multicast group address. When the interface is brought down it leaves the multicast group address.

Notes

The valid multicast group address range is 224.0.0.0 to 239.255.255.255

0.0.0.0 disables the multicast feature

Multicast is supported only by the UDP client and server. The TCP protocol does not support multicast.

Arguments

<IP address range>

where:

Default

0.0.0.0

Properties

Gecko OS Kernel Plugin

Get example 

> get et m a
0.0.0.0

Set example 

> set et m a 239.0.0.255
Set OK

ethernet.network.dns

Abbreviation

et n d

Access

get

Description

Return a comma separated list of the DNS server addresses that the Ethernet interface is using.

Note : To set a static DNS address list, use the ethernet.static.dns variable.

Arguments

-

Default

0.0.0.0 (i.e. No DNS addresses in use)

Supported Platforms

Get example 

> get et n d
10.5.6.1

ethernet.network.gateway

Abbreviation

et n g

Access

get

Description

Returns the Ethernet interface IPv4 gateway IP address resolved by DHCP.

Note : To set a static gateway, use the ethernet.static.gateway variable.

Arguments

-

Default

0.0.0.0

Supported Platforms

Get example 

> get et n g
R000013
192.168.0.1

ethernet.network.ip

Abbreviation

et n i

Access

get

Description

Returns the Ethernet interface IPv4 IP address resolved by DHCP.

Note : To set a static IP address, use the ethernet.static.ip variable.

Arguments

-

Default

0.0.0.0

Supported Platforms

Get example 

> get et n i
R000014
192.168.0.79

ethernet.network.netmask

Abbreviation

et n n

Access

get

Description

Returns the Ethernet interface IPv4 netmask resolved by DHCP.

Note : To set a static netmask, use the ethernet.static.netmask variable.

Arguments

-

Default

0.0.0.0

Supported Platforms

Get example 

> get et n n
R000015
255.255.255.0

ethernet.network.status

Abbreviation

et n s

Access

get

Description

Returns the Ethernet network status. 0 = down, 1 = connected, 2 = IP network connected (with a valid IP address)

Arguments

-

Default

0

Supported Platforms

Get example 

> get et n s
R000003
2

ethernet.network.status_gpio

Abbreviation

et n o

Access

get/set

Description

The GPIO used to indicate network connectivity status. GPIO low = not connected, GPIO high = the default network interface is connected and has an IP address.

See also system.oob.gpio .

Arguments

<GPIO#>

Default

-1

Properties

Supported Platforms

Get example 

> get et n o
R000004
-1

Set example 

> set wl n o 4
R000008
Set OK

ethernet.static.dns

Abbreviation

et s d

Access

get/set

Description

DNS server address if static network settings are used for the Ethernet interface.

Arguments

<[IP address]/[host name]>

Default

8.8.8.8

Properties

Supported Platforms

Get example 

> get et s d
R000009
8.8.8.8

Set example 

> set et s d 8.8.4.4
R000008
Set OK

ethernet.static.gateway

Abbreviation

et s g

Access

get/set

Description

Gateway address if static network settings are used for the Ethernet interface.

Arguments

<IP address>

Default

0.0.0.0

Properties

Supported Platforms

Get example 

> get et s g
R000009
0.0.0.0

Set example 

> set et s g 192.168.0.1
R000008
Set OK

ethernet.static.ip

Abbreviation

et s i

Access

get/set

Description

Local IP address if static network settings are used for the Ethernet interface.

Arguments

<IP address>

Default

0.0.0.0

Properties

Supported Platforms

Get example 

> get et s i
R000009
0.0.0.0

Set example 

> set et s i 192.168.0.2
R000008
Set OK

ethernet.static.netmask

Abbreviation

et s n

Access

get/set

Description

Netmask if static network settings are used for the Ethernet interface.

Arguments

<network mask>

Default

255.255.255.0

Properties

Supported Platforms

Get example 

> get et s n
R000009
0.0.0.0

Set example 

> set et s n 255.255.255.0
R000008
Set OK