Home

Documentation

Project Support

Changes in Version 7 of GraspSwControllerCmdIfconfig

Author:
isani
Timestamp:
Wed Jun 27 11:17:23 2012

Legend:

Unmodified
Added
Removed
Modified
  • GraspSwControllerCmdIfconfig

    v6 v7
    1 1  '''[wiki:GraspSwControllerCmd ifconfig]''' 
    2 2  [[TracNav(GraspContents)]] 
    3 3  ||Command:||'''ifconfig'''|| 
    4 4  ||Contexts:||Network socket, serial console.|| 
    5 5  ||Function:||Displays or sets the STARGRASP controller's network configuration|| 
    6 6  ||Required Parameters:||none.|| 
    7 7  ||Optional Parameters:||dynamic|| 
    8    ||                    ||static ipaddress netmask logaddress defaultrouter|| 
      8  ||                    ||static '''ipaddress''' '''netmask''' '''logaddress''' '''defaultrouter'''|| 
      8  ||                    ||loghost '''ipaddress'''|| 
      9  ||                    ||loghost auto|| 
    8 10  ||                    ||mtu '''max-enet-transmit-size'''|| 
    9 11  With no parameters, this command displays the current configuration and basic stats of the STARGRASP controller's network interface. This includes the link status, MAC address, configuration (dynamic or static), IP address information and packet counts. For example: 
    10 12   {{{ 
    11 13  Link: up                                                                          
    12 14  HWaddr 00:50:C2:64:90:5A                                                          
    13 15  IP address configuration: Dynamic                                                 
    14 16  inet addr: 10.213.1.170  Mask:255.255.0.0  Router:10.213.1.1                      
    15 17  MTU:1500 
    16 18  RX packets:2244219                                                                
    17 19  TX packets:323158 errors:0 
    18 20  }}} 
    19 21  Additionally, the ifconfig command can be used to choose between two methods of obtaining an IP address: ''dynamic'', which obtains an IP address and other information via DHCP; or ''static'' which assigns a specific IP address to the controller. 
    20 22  === Dynamic IP === 
    21 23  When set, the STARGRASP controller will negotiate an IP address via DHCP with a server on the network. In this mode, it takes the IP address, netmask and gateway IP assigned by the DHCP server, and will send log messages to the address specified by the configured next-server parameter (see the DHCP server's documentation for how to set this). 
    22 24  Usage: 
    23 25   {{{ 
    24 26  ifconfig dynamic 
    25 27  }}} 
    26 28  === Static IP === 
    27 29  In this mode, the STARGRASP controller uses a preconfigured IP address to communicate on the network. 
    28 30  Usage: 
    29 31   {{{ 
    30 32  ifconfig static ipaddress netmask logaddress defaultrouter 
    31 33  }}} 
    32 34  The four required parameters after the ''static'' option are as follows: 
    33 35   * '''ipaddress''' - the IP address that the system should use. 
    34 36   * '''netmask''' - the netmask for the subnet the system is on. 
    35 37   * '''logaddress''' - the IP address where the system should log to. 
    36 38   * '''defaultrouter''' - the gateway for the network the system is connected to. 
    37 39  All four parameters must be supplied in dotted-decimal format. 
    38 40  '''Note:''' ''When switching between dynamic and static mode or setting a new static IP address, the controller must be rebooted for the change to take effect.'' 
    39 41  === MTU === 
    40 42  If '''ifconfig''' by itself displays "MTU:", then it is possible to change the packet size used by the UDP/CATP protocol which the controller uses to send pixel data to the pixel server.  Variable packet size is only supported by embedded code versions >= r5338. 
    41 43  Usage: 
    42 44  {{{ 
    43 45  ifconfig mtu 9000 
    44 46  }}} 
    45 47  The above example enables "Jumbo" packet transmission.  Note that the maximum value is limited to 1500 unless the embedded code was compiled with HAVE_EMAC_JUMBO defined (at the moment, HAVE_EMAC_JUMBO ''is'' the default for builds >= r5338, as long as we don't discover any downside.)  The receiving pixel server Ethernet interface and and switch hardware in between must also be configured to accept non-standard "Jumbo" packets if mtu > 1500. 
    46 48  === Log Host (running grasp_receiver) === 
    47 49  By default, the controller attempts to send log messages to the "next-server" host specified by DHCP.  This can be overridden by an ifconfig command: 
    48 50  Usage 
    49 51  {{{ 
    50 52  ifconfig loghost IP-Address 
    51 53  }}} 
    52 54  or 
    53 55  {{{ 
    54 56  ifconfig loghost auto 
    55 57  }}} 
    56 58  The latter syntax returns log messages to the IP address which DHCP had set.  Log messages are always sent to port 55500 to 55515 (depending on chassis ID.)