ZentriOS-WZ-3.1 Command API - Zentri Documentation

Ethernet Interface

Available for NXP_SCCK only.

eth.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

save and reboot to apply change

Supported Platforms

NXP-SCCK

Get example

> get et a e
R000003
0

Set example

> set et a e true
R000008
Set OK

eth.auto_start.retries

Abbreviation	et a r
Access	get/set

Description

Maximum number of attempts to auto-join a network. 0 = retry indefinitely.

Arguments

<0-255>

Default

3

Properties

save and reboot to apply change

Supported Platforms

NXP-SCCK

Get example

> get et a r
R000003
3

Set example

> set et a r 5
R000008
Set OK

eth.auto_start.retry_delay

Abbreviation	et a d
Access	get/set

Description

The period between auto-join attempts in seconds.

Arguments

<0-255>

Default

10

Properties

save and reboot to apply change

Supported Platforms

NXP-SCCK

Get example

> get et a d
R000004
10

Set example

> set et a d 5
R000008
Set OK

eth.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

takes effect immediately

Supported Platforms

NXP-SCCK

Get example

> get et d e
R000003
1

Set example

> set et d e off
R000008
Set OK

eth.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

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

Properties

takes effect immediately

Supported Platforms

NXP-SCCK

Get example

> get et d h
R000009
Zentri-#

Set example

> set et d h my_dhcp_client
R000008
Set OK

eth.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 eth.dhcp.enabled.

Arguments

<timeout_seconds> Range: 1-255 seconds

Default

15

Properties

takes effect immediately

Supported Platforms

NXP-SCCK

Get example

> get et d t
R000004
15

Set example

> set et d t 25
R000008
Set OK

eth.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 eth.static.dns variable.

Arguments

-

Default

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

Supported Platforms

NXP-SCCK

Get example

> get et n d
10.5.6.1

eth.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 eth.static.gateway variable.

Arguments

-

Default

0.0.0.0

Supported Platforms

NXP-SCCK

Get example

> get et n g
R000013
192.168.0.1

eth.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 eth.static.ip variable.

Arguments

-

Default

0.0.0.0

Supported Platforms

NXP-SCCK

Get example

> get et n i
R000014
192.168.0.79

eth.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 eth.static.netmask variable.

Arguments

-

Default

0.0.0.0

Supported Platforms

NXP-SCCK

Get example

> get et n n
R000015
255.255.255.0

eth.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

NXP-SCCK

Get example

> get et n s
R000003
2

eth.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.

eth.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

takes effect immediately

Supported Platforms

NXP-SCCK

Get example

> get et s d
R000009
8.8.8.8

Set example

> set et s d 8.8.4.4
R000008
Set OK

eth.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

takes effect immediately

Supported Platforms

NXP-SCCK

Get example

> get et s g
R000009
0.0.0.0

Set example

> set et s g 192.168.0.1
R000008
Set OK

eth.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

takes effect immediately

Supported Platforms

NXP-SCCK

Get example

> get et s i
R000009
0.0.0.0

Set example

> set et s i 192.168.0.2
R000008
Set OK

eth.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

0.0.0.0

Properties

takes effect immediately

Supported Platforms

NXP-SCCK

Get example

> get et s n
R000009
0.0.0.0

Set example

> set et s n 255.255.255.0
R000008
Set OK