IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


Command shell: TCP/IP commands


CGISTAT: List Installed CGI handlers
This function will list all installed CGI handlers.
Example:
cgistat
Since:
SC2x3 V1.00


CLOSETELNET: Close current telnet session
Close current telnet session. This command will finish the current Telnet session.
Example:
closetelnet
Since:
SC2x3 V1.00


DHCP 0/1: Enable/Disable DHCP
Enables (1) or disables (0) the use of DHCP for the internal Ethernet interface to obtain an IP configuration. DHCP is an abbreviation for "Dynamic Host Configuration Protocol". Using a DHCP Server, the network administrator can define the IP configuration of the network, without manually configuring each device on the network. Network servers and some ISDN routers offer a DHCP server.
Example:
dhcp 1
Since:
SC2x3 V1.00


FTP 0/1: Enable/Disable FTP
Enables (1) or disables (0) the FTP server. Additionally a resp. entry is added to the CHIP.INI configuration file to preserve the FTP server's running status after a reboot. Note that CHIP.INI is not changed if the command is issued from within a batch file.
Example:
ftp 1
Since:
SC2x3 V1.00


FTPSTAT: Show the current settings of the FTP server
This function will show the current settings of the FTP server: e.g. root directory, root drive etc. See CHIP.INI FTP configuration.
Example:
ftpstat
Since:
SC2x3 V1.00


GATEWAY address: Sets the IPv4 address of the default gateway to use
Sets the IPv4 address of the default gateway to use. This command modifies the information stored in A:\CHIP.INI. The DHCP option is also switched off. The new gateway address is not used until after a IPETH command or a restart of the system.
Example:
gateway 172.30.0.125
Since:
SC2x3 V1.00
See also:
CHIP.INI IP section


IP address: Sets the IPv4 address of the Ethernet interface
Sets the IPv4 address of the Ethernet interface. This command modifies the information stored in A:\CHIP.INI. The DHCP option is also switched off. The new address is not used until after a IPETH command or a restart of the system.
Example:
ip 172.30.8.36
Since:
SC2x3 V1.00
See also:
CHIP.INI IP section


IPCFG: Display current IPv4 configuration
This command displays the current IPv4 configuration of all installed TCP/IP device interfaces. The fields shown for each installed TCP/IP device interface are:

         Device: Interface name
         Type: ETH(Ethernet), LPK(Internal loopback), PPP or Unknown
         Idx: Internal index number of the device interface
         IP address
         Network mask
         MAC address: (If Ethernet type)
         Gateway: Default gateway, if one is set
The current link state and operating mode of the Ethernet controller are displayed with the IPv4 address configuration of the internal Ethernet device.
Example:
ipcfg
Since:
SC2x3 V1.00


IPV6CFG: Display current IPv6 configuration
This command displays the current IPv6 address configuration of all installed TCP/IP device interfaces. The fields shown for each installed TCP/IP device interface are:

         Device: Interface name
         Type: ETH(Ethernet), LPK(Internal loopback), PPP or Unknown
         Idx: Internal index number of the device interface
         IPv6 addresses
         MAC address
The current link state and operating mode of the Ethernet controller are displayed with the IPv6 addresses.
Example:
ipv6cfg
Since:
SC2x3 V1.00


IPV6 AddressIndex Address : Set an IPv6 address entry for the internal Ethernet interface.
It is possible to configure up to 5 IPv6 addresses (index 0 through 4). This command modifies the IPv6 settings stored in A:\chip.ini. The new address is not used until after a ipeth command was issued or after rebooting the system. The prefix length is always required (e.g. the "/64" in examples below). The ipv6cfg command can be used to verify your entry before restarting the system.
Example:
IPv6 0 3ffe:ffff:0:f101::1/64
IPv6 1 4ffe:ffff:0:f101::1/64
IPv6 4 2ffe:ffff:0:f101::1/64
Since:
SC2x3 V1.00


IPETH: Restart/Reconfigure the internal Ethernet interface,
e.g. after changing the IP configuration, without rebooting the system.

Opt. parameter 'N': Reconfigures the IP settings with physical init of the ethernet controller
Opt. parameter 'A': Reconfigure ethernet with an AutoIP address
If the restart command prints an error message, check your IP parameters.
In most cases an invalid gateway IP address is the reason why the restart failed.
The error code EALREADY signals that a Ethernet configuration was already in progress.

Please note: If the specified number of DHCP_TRIALS is larger than default 3, the command will not wait for completion of the DHCP process.
The AutoIP procedure is also usable by the chip.ini entry AUTOIP.
Example:
ipeth
ipeth N
ipeth A
Since:
SC2x3 V1.00


IKE: Lists IP Security and IKE status information to console.
A list of established Security Associations (SA) is provided.

START is an optional parameter to this command which can be used to start up the IKE task if this has not already been started. Starting the IKE task enables use of the IP Security, see IPsec_Start().

The error codes listed here are provided to help resolve problems with either IP security startup processing or IKE negotiation with a peer.

When IKE negotiations are failing in phase 2 (Quick mode), the Security Association (SA) parameters that we propose (initiator role) or can accept (responder role) from the respective peer are displayed for diagnostic purposes. When we are the responder and the peer is the initiator, the peer's SA proposals will also be listed (this recording is limited to the first 6 transforms received). Therefore more Quick mode diagnostic information is available here when the peer side initiates the IKE.
Example:
IKE
IKE START
Since:
SC2x3 V1.00


NETMASK mask: Set the network mask for IPv4 addressing of the Ethernet interface
Sets the subnet mask for IPv4 addressing of the internal Ethernet interface. This command modifies the information stored in A:\CHIP.INI. The DHCP option is also switched off. The new subnet mask is not used until after a IPETH command or a restart of the system.
Example:
netmask 255.255.240.0
Since:
SC2x3 V1.00
See also:
CHIP.INI IP section


PING address: The ICMP echo request (ping)
Test the network connection with the ICMP command ping. This command sends 4 ICMP echo requests (64 Bytes) to the remote host, with an interval of 1 second and shows the results. DNS names are supported.
Example:
ping 192.168.200.10
ping www.beck-ipc.com
Since:
SC2x3 V1.00


PPPSTAT: Show the current settings of the PPP server/client
This function will show the current settings of the PPP server/client: e.g. init and connect strings, port settings etc. See CHIP.INI PPPSERVER configuration and PPPCLIENT configuration.
Example:
pppstat
Since:
SC2x3 V1.00


TCPIPMEM: Display TCP/IP memory usage
Displays TCP/IP memory usage. This command shows the maximum reserved memory for the TCP/IP stack and the current TCP/IP stack memory used.
Example:
tcpipmem
Since:
SC2x3 V1.00


TFTP 0/1: Enable/Disable TFTP
Enables (1) or disables (0) the TFTP server. Additionally a resp. entry is added to the CHIP.INI configuration file to preserve the TFTP server's running status after a reboot. Note that CHIP.INI is not changed if the command is issued from within a batch file. By default the TFTP server is disabled to avoid security leaks.
Example:
tftp 1
Since:
SC2x3 V1.00


WEBSTAT: Show the current settings of the Web server
This function will show the current settings of the Web server: e.g. root directory, root drive, default start page etc. See CHIP.INI WEB configuration.
Example:
webstat
Since:
SC2x3 V1.00


SNIFF DirPath [Interface]/0: Enable/disable network tracing

This command starts and stops internal network tracing. Due to the CAP file format used to store the data, the trace files are readable by network analyzer tools such as Wireshark.

If network tracing is enabled, the network traffic will be written into trace files at the specified path (e.g. B:\Sniff, C:, ...). A trace file will be created for each network interface which sends or receives data. The names of the trace files are derived from the device name with the .CAP extension appended, e.g. FEC.CAP or PPPSRV.CAP. Any SNIFF files left over from a previous power up session for a particular device will be overwritten when that device starts to record network data.

Typing SNIFF 0 stops the tracing. If trace is later re-enabled during the same power up period, the existing trace files will be appended.

If no interface name is given the traffic of all interface will be captured. If an interface name is specified the traffic of this single interface is captured. Note: The interface name is case sensitive.

Due to the limited write cycles of the internal flash device it is recommended to specify a path located on an external disk or on the internal C: ram drive.

Please note that network tracing can place a significant load on the CPU and will slow down the speed of the network communication.
Example:
Sniff B:\Sniff
Sniff C:
Sniff C: FEC
Sniff 0
Since:
SC2x3 V1.05
Changes:
SC2x3 V1.10 - Add option to specify interface





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:35 2017 by Doxygen 1.6.1