wiki:Tutorials/g0WmLTE/Tutorial4-OAI/Tutorial0

Version 5 (modified by msherman, 7 years ago) ( diff )

—

Under Construction

Basic OAI Tutorial

  1. WiMAX and LTE Tutorials
    1. Basic WiMax Operations
      1. Prerequisites
      2. Experiment: Image and Ping Nodes Over !WiMAX Interface
      3. About the Base Station
      4. Interacting with the Base Station
      5. Restoring the Base Station to Defaults
      6. Loading a Default Image
      7. Manually Confirming Settings
      8. Connect to the WiMAX Network
      9. Assign an IP Address
      10. Repeat for Other Nodes
      11. Recommended Settings for IP Addresses
      12. Testing Connection
      13. Troubleshooting Connectivity Problems
    1. WiMAX "Hello World" Tutorial
      1. Experimental Scenario
      2. Experiment Description
    1. OMF Based WiMAX Experiment
      1. Prerequisites
      2. About This Experiment
      3. The Code
      4. Dissecting the Experiment
      5. Launch Experiment
      6. Troubleshooting Runtime Problems
      7. Retrieving Results
      8. Final Observations
    1. Basic LTE Tutorial
      1. Objective
      2. Set up
    1. OpenAirInterface LTE Tutorials
      1. Under Construction
      2. Basic OAI Tutorial
      1. OAI Remote Radio Head (RRH)
      1. OAI RRH on ORBIT with eNB Baseband Running on GENI
    1. AmariSoft LTE
      1. Managing the Amarisoft eNB
    1. OpenAirInterface 5G Tutorials
    1. LTE interoperability
      1. Nexus 5, Nexus 5x configuration notes
      2. Notes
      3. OAI eNB with Amarisoft EPC
      4. Amarisoft eNB and EPC
      5. OAI eNB and EPC

Objective

This objective of this tutorial is to establish a LTE connection between the SDR based UE and eNB. In order to that we need to prepare configuration files on two nodes in sandbox 1, node1-1 and node1-2.

The image was built following the tutorial available at: ​OAI no S1

Prepare the nodes

  1. Load the two images with the OAI code to nodes 1-1 and 1-2. This enables running the experiment with no compilation needed.

    Load an Image

    1. Before we begin using the nodes, it's a good idea to check their status first. This is done with the omf stat command.

      omf stat

      This omf command is used to display the power status of the node/domain.

      Usage: omf stat

      username@consoles.outdoor:omf stat
Returns the status of the nodes in a testbed
Usage:
      omf-5.4 stat [-h] [-s] [-t TOPOLOGY] [-c AGGREGATE]
 
      With: 
      -h, --help                print this help message
      -s, --summary             print a summary of the node status for the testbed
      -c, --config AGGREGATE    use testbed AGGREGATE
      -t, --topology TOPOLOGY   a valid topology file or description (defaults to 'system:topo:all')
 
      Some Examples: 
                    omf-5.4 stat
                    omf-5.4 stat -s
                    omf-5.4 stat -t omf.nicta.node1,omf.nicta.node2 -c sb1
                    omf-5.4 stat -t system:topo:all -c grid

      Individual nodes are identified in the output of stat command by their fully qualified domain name (FQDN). This establishes their "coordinates" and the "domain" to which they belong. Nodes in different domains typically can NOT see each other. Node can be in 1 of 3 states:

      POWEROFF Node is Available for use but turned off
      POWERON Node is Available and is on
      NOT REGISTERED Node is not Available for use

      Example: omf stat on the outdoor domain

      user@console.outdoor:~# omf stat -t all

 INFO NodeHandler: OMF Experiment Controller 5.4 (git 6d34264)
 INFO NodeHandler: Slice ID: default_slice (default)
 INFO NodeHandler: Experiment ID: default_slice-2012-10-14t14.42.15-04.00
 INFO NodeHandler: Message authentication is disabled
 INFO Experiment: load system:exp:stdlib
 INFO property.resetDelay: value = 210 (Fixnum)
 INFO property.resetTries: value = 1 (Fixnum)
 INFO Experiment: load system:exp:eventlib
 INFO Experiment: load system:exp:stat
 INFO Topology: Loading topology ''.
 INFO property.nodes: value = "system:topo:all" (String)
 INFO property.summary: value = false (FalseClass)
 INFO Topology: Loading topology 'system:topo:all'.
 Talking to the CMC service, please wait
-----------------------------------------------
 Domain: outdoor.orbit-lab.org
 Node: node3-6.outdoor.orbit-lab.org   	 State: NOT REGISTERED
 Node: node3-3.outdoor.orbit-lab.org   	 State: POWEROFF
 Node: node2-10.outdoor.orbit-lab.org    State: POWEROFF
 Node: node1-10.outdoor.orbit-lab.org    State: POWEROFF
 Node: node1-8.outdoor.orbit-lab.org   	 State: POWERON
 Node: node1-6.outdoor.orbit-lab.org   	 State: POWERON
 Node: node3-2.outdoor.orbit-lab.org   	 State: POWEROFF
 Node: node3-1.outdoor.orbit-lab.org   	 State: POWEROFF
 Node: node1-3.outdoor.orbit-lab.org   	 State: POWERON
 Node: node3-5.outdoor.orbit-lab.org   	 State: POWEROFF
 Node: node2-5.outdoor.orbit-lab.org   	 State: NOT REGISTERED
 Node: node1-2.outdoor.orbit-lab.org   	 State: POWERON
-----------------------------------------------
 INFO Experiment: Switching ON resources which are OFF
 INFO EXPERIMENT_DONE: Event triggered. Starting the associated tasks.
 INFO NodeHandler: 
 INFO NodeHandler: Shutting down experiment, please wait...
 INFO NodeHandler: 
 INFO run: Experiment default_slice-2012-10-14t14.42.15-04.00 finished after 0:6

    2. It is recommended that the node be in the POWEROFF state prior to any experiment process. If the node is in the POWERON state you can use the omf tell command to get the node into the off state.

      omf tell

      OMF command to control the power state/reset the nodes.

      Usage: omf tell

      user@console:omf tell
Switch ON/OFF and reboot the nodes in a testbed
Usage:
      omf tell [-h] -t TOPOLOGY -a ACTION [-c AGGREGATE]
 
      With: 
      -h, --help           print this help message
 
      -a, --action ACTION  specify an action
      ACTION:
      on              turn node(s) ON
      offs            turn node(s) OFF (soft)
      offh            turn node(s) OFF (hard)
      reboot          reboots node(s) (soft)
      reset           resets node(s) (hard)
 
      -h, --help                print this help message
      -t, --topology TOPOLOGY   a valid topology file or description (MANDATORY)
      -c, --config AGGREGATE    use testbed AGGREGATE
 
      Some Examples: 
                    omf tell -a reset -t node1-1.grid.orbit-lab.org
                    omf tell -a on -t system:topo:all -c grid
                    omf tell -a reboot -t node1-1
                    omf tell -a offh -t [1..2,1..5]
                    omf tell -a offh -t system:topo:all
                    omf tell -a reset -t system:topo:imaged

      The commands are: on, offh (equivalent to pulling out the power cord), offs (software shutdown), reboot (software reboot) and reset (hardware reset).

      Example: turn off node1-1 on the outdoor domain

      user@console.outdoor:~# omf tell -a offh -t node1-1

 INFO NodeHandler: OMF Experiment Controller 5.4 (git 3fb37b9)
 INFO NodeHandler: Reading configuration file /etc/omf-expctl-5.4/services.yaml
 INFO NodeHandler: Add domain http - http://internal1.orbit-lab.org:5054/
 INFO NodeHandler: Add domain http - http://repository1.orbit-lab.org:5054/
 INFO NodeHandler: Slice ID: default_slice (default)
 INFO NodeHandler: Experiment ID: default_slice-2014-09-30t00.24.28.504-04.00
 INFO NodeHandler: Message authentication is disabled
 INFO Experiment: load system:exp:stdlib
 INFO property.resetDelay: resetDelay = 230 (Fixnum)
 INFO property.resetTries: resetTries = 1 (Fixnum)
 INFO Experiment: load system:exp:eventlib
 INFO Experiment: load system:exp:winlib
 INFO Experiment: load system:exp:tell
 INFO property.nodes: nodes = "node1-1" (String)
 INFO property.command: command = "offh" (String)

Talking to the CMC service, please wait
-----------------------------------------------
 Node: node1-1.outdoor.orbit-lab.org   	 Reply: OK
-----------------------------------------------

 INFO EXPERIMENT_DONE: Event triggered. Starting the associated tasks.
 INFO NodeHandler: 
 INFO NodeHandler: Shutting down experiment, please wait...
 INFO NodeHandler: 
 INFO run: Experiment default_slice-2014-09-30t00.24.28.504-04.00 finished after 0:10

    3. Once node set is on an POWEROFF state, load an image with omf load command

      omf load

      Load command is used to put an image onto the hard disk of the node.

      Usage: omf load

      Install a given disk image on the nodes in a testbed
Usage:
      omf-5.4 load [-h] [-i IMAGE_PATH] [-o TIMEOUT] [-t TOPOLOGY] [-c AGGREGATE]
 
      With: 
      -h, --help                print this help message
      -c, --config AGGREGATE    use testbed AGGREGATE
      -t, --topology TOPOLOGY   a valid topology file or description (defaults to 'system:topo:all')
                                (if a file 'TOPOLOGY' doesn't exist, interpret it as a comma-separated list of nodes)
      -i, --image IMAGE         disk image to load
                                (default is 'baseline.ndz', the latest stable baseline image)
      -o, --timeout TIMEOUT     a duration (in sec.) after which imageNodes should stop waiting for
                                nodes that have not finished their image installation
                                (default is 800 sec, i.e. 13min 20sec)
          --outpath PATH        Path where the resulting Topologies should be saved
                                (default is '/tmp')
          --outprefix PREFIX    Prefix to use for naming the resulting Topologies
                                (default is your experiment ID)
 
      Some Examples: 
                    omf-5.4 load
                    omf-5.4 load -t system:topo:all -i baseline-2.4.ndz
                    omf-5.4 load -t omf.nicta.node1 -i wireless-2.6.ndz
                    omf-5.4 load -t omf.nicta.node1,omf.nicta.node2 -i baseline.ndz -o 400
                    omf-5.4 load -t system:topo:circle -i my_Own_Image.ndz
                    omf-5.4 load -t my_Own_Topology -i baseline-2.2.ndz -t 600 -c grid
                    omf-5.4 load -t my_Own_Topology --outpath ./ --outprefix my_Own_Prefix

      Two important arguments are TOPOLOGY describing the set of nodes one wishes to image , and !IMAGE specifying the name of the image one wants to load the nodes with. If the imaging process does not does not finish within the default timeout period, that period can be increase by using the -o flag (e.g. -o 1600). Typical command to load both nodes of sandbox 1 with the baseline image would look like:

      Example: omf load-i baseline.ndz -t node1-1

      username@console.sb3:~$ omf load -i baseline.ndz -t node1-1

DEBUG FQDN:console.sb3.orbit-lab.org:
 INFO NodeHandler: OMF Experiment Controller 5.4 (git 861d645)
 INFO NodeHandler: Reading configuration file /etc/omf-expctl-5.4/services.yaml
 INFO NodeHandler: Add domain http - http://internal1.orbit-lab.org:5054/
 INFO NodeHandler: Add domain http - http://repository1.orbit-lab.org:5054/
 INFO NodeHandler: Add domain http - http://external1.orbit-lab.org:5054/
 INFO NodeHandler: Slice ID: pxe_slice
 INFO NodeHandler: Experiment ID: pxe_slice-2018-08-08t13.41.37.814-04.00
 INFO NodeHandler: Message authentication is disabled
 INFO Experiment: load system:exp:stdlib
 INFO property.resetDelay: resetDelay = 230 (Fixnum)
 INFO property.resetTries: resetTries = 1 (Fixnum)
 INFO Experiment: load system:exp:eventlib
 INFO Experiment: load system:exp:winlib
 INFO Experiment: load system:exp:imageNode
 INFO property.nodes: nodes = "node1-1" (String)
 INFO property.image: image = "baseline.ndz" (String)
 INFO property.domain: domain = "sb3.orbit-lab.org" (String)
 INFO property.outpath: outpath = "/tmp" (String)
 INFO property.outprefix: outprefix = "pxe_slice-2018-08-08t13.41.37.814-04.00" (String)
 INFO property.timeout: timeout = 800 (Fixnum)
 INFO property.resize: resize = nil (NilClass)
 INFO Topology: Loaded topology 'system:topo:registered'.
 INFO property.resetDelay: resetDelay = 100 (Fixnum)
 INFO Experiment: Resetting resources
 INFO stdlib: Waiting for nodes (Up/Down/Total): 0/1/1 - (still down: node1-1.sb3.orbit-lab.org) [0 sec.]
 INFO stdlib: Waiting for nodes (Up/Down/Total): 0/1/1 - (still down: node1-1.sb3.orbit-lab.org) [10 sec.]
 INFO stdlib: Waiting for nodes (Up/Down/Total): 0/1/1 - (still down: node1-1.sb3.orbit-lab.org) [20 sec.]
 INFO stdlib: Waiting for nodes (Up/Down/Total): 0/1/1 - (still down: node1-1.sb3.orbit-lab.org) [30 sec.]
 INFO stdlib: Waiting for nodes (Up/Down/Total): 0/1/1 - (still down: node1-1.sb3.orbit-lab.org) [40 sec.]
 INFO stdlib: Waiting for nodes (Up/Down/Total): 0/1/1 - (still down: node1-1.sb3.orbit-lab.org) [50 sec.]
 INFO exp: Progress(0/0/1): 0/0/0 min(node1-1.sb3.orbit-lab.org)/avg/max (59) - Timeout: 790 sec.
 INFO ALL_UP: Event triggered. Starting the associated tasks.
 INFO BRING_UP: Event triggered. Starting the associated tasks.
 INFO Experiment: Bringing up resources
 INFO exp: Progress(0/0/1): 50/50/50 min(node1-1.sb3.orbit-lab.org)/avg/max (59) - Timeout: 780 sec.
 INFO exp: Progress(0/0/1): 80/80/80 min(node1-1.sb3.orbit-lab.org)/avg/max (59) - Timeout: 770 sec.
 INFO exp: Progress(1/0/1): 100/100/100 min()/avg/max (59) - Timeout: 760 sec.
 INFO exp:  -----------------------------
 INFO exp:  Imaging Process Done
 INFO exp:  1 node successfully imaged - Topology saved in '/tmp/pxe_slice-2018-08-08t13.41.37.814-04.00-topo-success.rb'
 INFO exp:  -----------------------------
 INFO EXPERIMENT_DONE: Event triggered. Starting the associated tasks.
 INFO NodeHandler:
 INFO NodeHandler: Shutting down experiment, please wait...
 INFO NodeHandler:
 INFO NodeHandler: Shutdown flag is set - Turning Off the resources
 INFO run: Experiment pxe_slice-2018-08-08t13.41.37.814-04.00 finished after 1:44

      If the node is in the NOT REGISTERED state, you may need to wait for it to recover the POWEROFF state (it some times requires a few moments for the services to sync up). If the node takes more than 60 seconds to come out of the NODE NOT AVAILABLE state please report it to an administrator.
  1. Load the eNB image to node1-1.
    1. omf load -t node1-1 -i mf-oai-enb.ndz
  2. Load the UE image to node1-2.
    1. omf load -t node1-2 -i mf-oai-ue.ndz
  • Turn ON the nodes that successfully imaged (give them some time and check their status with omf stat before proceeding).

    omf tell -a on -t system:topo:imaged

    Turn the Nodes ON

    To turn the nodes on use omf tell command:

    omf tell

    OMF command to control the power state/reset the nodes.

    Usage: omf tell

    user@console:omf tell
Switch ON/OFF and reboot the nodes in a testbed
Usage:
      omf tell [-h] -t TOPOLOGY -a ACTION [-c AGGREGATE]
 
      With: 
      -h, --help           print this help message
 
      -a, --action ACTION  specify an action
      ACTION:
      on              turn node(s) ON
      offs            turn node(s) OFF (soft)
      offh            turn node(s) OFF (hard)
      reboot          reboots node(s) (soft)
      reset           resets node(s) (hard)
 
      -h, --help                print this help message
      -t, --topology TOPOLOGY   a valid topology file or description (MANDATORY)
      -c, --config AGGREGATE    use testbed AGGREGATE
 
      Some Examples: 
                    omf tell -a reset -t node1-1.grid.orbit-lab.org
                    omf tell -a on -t system:topo:all -c grid
                    omf tell -a reboot -t node1-1
                    omf tell -a offh -t [1..2,1..5]
                    omf tell -a offh -t system:topo:all
                    omf tell -a reset -t system:topo:imaged

    The commands are: on, offh (equivalent to pulling out the power cord), offs (software shutdown), reboot (software reboot) and reset (hardware reset).

    Example: turn off node1-1 on the outdoor domain

    user@console.outdoor:~# omf tell -a offh -t node1-1

 INFO NodeHandler: OMF Experiment Controller 5.4 (git 3fb37b9)
 INFO NodeHandler: Reading configuration file /etc/omf-expctl-5.4/services.yaml
 INFO NodeHandler: Add domain http - http://internal1.orbit-lab.org:5054/
 INFO NodeHandler: Add domain http - http://repository1.orbit-lab.org:5054/
 INFO NodeHandler: Slice ID: default_slice (default)
 INFO NodeHandler: Experiment ID: default_slice-2014-09-30t00.24.28.504-04.00
 INFO NodeHandler: Message authentication is disabled
 INFO Experiment: load system:exp:stdlib
 INFO property.resetDelay: resetDelay = 230 (Fixnum)
 INFO property.resetTries: resetTries = 1 (Fixnum)
 INFO Experiment: load system:exp:eventlib
 INFO Experiment: load system:exp:winlib
 INFO Experiment: load system:exp:tell
 INFO property.nodes: nodes = "node1-1" (String)
 INFO property.command: command = "offh" (String)

Talking to the CMC service, please wait
-----------------------------------------------
 Node: node1-1.outdoor.orbit-lab.org   	 Reply: OK
-----------------------------------------------

 INFO EXPERIMENT_DONE: Event triggered. Starting the associated tasks.
 INFO NodeHandler: 
 INFO NodeHandler: Shutting down experiment, please wait...
 INFO NodeHandler: 
 INFO run: Experiment default_slice-2014-09-30t00.24.28.504-04.00 finished after 0:10

    • Execute the experiment

    If you intend to use graphical user interface please make sure to install appropriate tools on your local machine and configure X11 forwarding.

    Remote Graphical Access

    Table of Contents

    1. Access and Account Management
      1. Configuring SSH Keys
      1. Scheduling and Reservation
      1. Status
      1. Changing Password
      1. Changing Profile Information
      1. Remote Graphical Access

    We really don't want to encourage this too much since it depends on network performance especialy on slow links. In ORBIT, remote graphical access is a two step process: tunneling from your local machine to the console of the domain you are working on that is followed by tunneling from the console to the node. Assumption is that one is using Linux baseline images and thus ​X Window System (X11) based graphical environment.

    Remote X11 Access For Linux

    Simply use the -X or -Y flags, e.g. for remote graphical access to node1-1.sb1.orbit-lab.org: 

    ssh -Y -t sb1.orbit-lab.org ssh -Y -t root@node1-1

    If you get an error about ssh keys not matching, you MUST follow the instructions for configuring your ssh keys; you will not b able to do X11 forwarding until this problem is fixed.

    Remote X11 Access For Windows

    In addition to ssh client, remote X11 access on Windows requires installation of X11 Server. Number of open source or free servers is available including:

    1. ​VcXsrv
    2. ​Xming
    3. ​mobaXterm (includes ssh client)

    to name a few.

    As an illustration, we will use configuration based on Putty and VcXsrv and connect with remote graphics capability to the node1-1.sb1:

    • Install Putty and make sure you can log into ORBIT gateway or console
    • Install VcXsrv and make sure it is running say on display 1 (without any applications)
    • Start Putty and load the appropriate session
    • Configure X11 forwarding under "Connection→SSH→X11":
      • Check mark on "Enable X11 forwarding"
      • Set "X display location" to: 127.0.0.1:1 (note matching display number)
    • Save the session
    • Open the session to SB1 i.e. connect to the console.sb1.orbit-lab.org
    • On the console execute 
        ssX -Y -t root@node1-1

    and connect to the node.

    Remote X11 Access For MAC

    1. Mac: You must use an X11 capable ssh client such as FIXME, or install a standalone X11 client such as FIXME
      1. Start x11 capable client
      2. SSH to console
      3. SSH to node

    Quickstart Option

    We have an image available, named oai-dev.ndz. It has all the necessary driver and software pre-installed, and two scripts available to immediately boot up the eNB and UE. This quickstart assumes use of Sandbox1, nodes 1-1, and 1-2.

    1. To proceed, after having a reservation, load the following image.
      • omf load -t node1-1,node1-2 -i oai-dev.ndz
      • The nodes will automatically turn off when imaging is completed.
    2. Turn the nodes on.
      • omf tell -a on -t node1-1,node1-2
    3. Open a terminal to each node. You must enable X11 Forwarding to see the GUI and statistics screens.
      1. You will need at lease one terminal per node, for the statistics screens. Even more if you want to run additional commands. For details, refer to the Remote Graphical Access section.
    4. On the first node, execute script ./CompandRuneNB
    5. On the second node, execute script ./CompandRunUE
    6. For subsequent runs, execute ./runeNB or ./runUE instead, to avoid recompiling.
    7. These scripts will create interface oai0 and assign an address.
      1. Use ifconfig or ip a to see the address assigned.
      2. By default the eNB has address 10.0.1.1, and the UE has addresss 10.0.1.9, but you should double check.
    8. You should be able to ping from one node to the other on these addresses.
      1. From UE, ping 10.0.1.1 or to see live statistics mtr 10.0.1.1

    In your terminals, you will see the following screens upon successful script execution.

    OAI eNB in ORBIT

    UNDER DEVELOPMENT

    1. Load image lte-edge.ndz to a node with a b210
      1. This can be found from the status page
    2. Turn the node on
    3. SSH to the node
    4. cd /opt
    5. Run ./setup.sh --build_enb_ue
    6. Edit the configuration file to match the needed IP using the editor of your choice (example vim)
      1. vim ./conf/enb.band25.tm1.usrpb210.conf
      2. The MME ip address is on the line 
        mme_ip_address      = ( { ipv4       = "10.3.0.21";
        1. Do not change this unless you are using a custom MME, rather than the ORBIT hosted one, or are tunneling.
      3. Set the following four lines to match the interface you will use to connect to the MME. In this example it is set to use eth1 on node8-7.grid.orbit-lab.org. 
        ENB_INTERFACE_NAME_FOR_S1_MME            = "eth0";
ENB_IPV4_ADDRESS_FOR_S1_MME              = "10.40.4.5/16";
ENB_INTERFACE_NAME_FOR_S1U               = "eth0";
ENB_IPV4_ADDRESS_FOR_S1U                 = "10.40.4.5/16";
    7. Run the eNB ./openairinterface5g/cmake_targets/lte_build_oai/build/lte-softmodem -O ./conf/enb.band25.tm1.usrpb210.conf
      1. Some options to append
        1. -d : shows visual displays

    Attachments (5)

    Download all attachments as: .zip

    Note: See TracWiki for help on using the wiki.