blob: cc977f3b84a0b57fd0fbe8e2d02748498e8f8837 [file] [log] [blame]
Matteo Scandoloe383d5d2019-10-25 14:47:27 -07001.. _Operations:
2
3BBSim Operations
4================
5
6If you are testing basic functionality using BBSim no operator intervention is required.
7
8When you ``enable`` the device in VOLTHA the simulator will:
9
10- activate all the configured ONUs
11- wait for the EAPOL flow for each ONU and trigger the authentication state machine as soon as it's received
12- wait for the DHCP flow for each ONU and trigger the DHCP state machine as soon as it's received
13
14Access bbsimctl
15---------------
16
17When running a test you can check the state of each ONU using :ref:`BBSimCtl`.
18
19The easiest way to use ``bbsimctl`` is to ``exec`` inside the ``bbsim`` container:
20
21.. code:: bash
22
23 kubectl exec -it -n voltha -f $(kubectl get pods -n voltha | grep bbsim | awk '{print $1}') bash
24
25Check the ONU Status
26--------------------
27
28.. code:: bash
29
30 $ bbsimctl onu list
31 PONPORTID ID PORTNO SERIALNUMBER HWADDRESS STAG CTAG OPERSTATE INTERNALSTATE
32 0 1 0 BBSM00000001 2e:60:70:13:00:01 900 900 up dhcp_ack_received
33
34Advanced operations
35-------------------
36
37In certain cases you may want to execute operations on the BBSim ONUs.
38
39Here are the one currently supported, for more usage information use the following commands:
40
41.. code:: bash
42
43 $ bbsimctl onu --help
44 Usage:
45 bbsimctl [OPTIONS] onu <command>
46
47 Commands to query and manipulate ONU devices
48
49 Global Options:
50 -c, --config=FILE Location of client config file [$BBSIMCTL_CONFIG]
51 -s, --server=SERVER:PORT IP/Host and port of XOS
52 -d, --debug Enable debug mode
53
54 Help Options:
55 -h, --help Show this help message
56
57 Available commands:
58 auth_restart
59 dhcp_restart
60 get
61 list
62 poweron
Zack Williams4b0ef4d2019-12-18 14:25:20 -070063 shutdown
64