Difference between revisions of "ONE/Command-line Interface CLI Guide"

From fd.io
< ONE
Jump to: navigation, search
(Created page with "TBD")
 
Line 1: Line 1:
 
TBD
 
TBD
 +
 +
 +
== Introduction ==
 +
The vpp contain a set of commands to set and debug LISP.
 +
One way to access the CLI (with proper permissions) is to use the <tt>vpp_api_test</tt> command:
 +
 +
<pre>
 +
sudo vpp_api_test
 +
</pre>
 +
 +
 +
== LISP commands ==
 +
 +
 +
=== Locator_set ===
 +
To add new locator_set, use "lisp_add_del_locator_set". This command also "reset" exist locator_set in vpp:
 +
<pre>
 +
vat# lisp_add_del_locator_set locator-set ls1
 +
</pre>
 +
 +
To delete a specific locator_set, use "lisp_add_del_locator_set locator-set <name> del":
 +
<pre>
 +
vat# lisp_add_del_locator_set locator-set ls1 del
 +
</pre>
 +
When delete locator_set, then also delete all locator which are assigned to locator_set
 +
 +
To add new locator to locator_set, use "lisp_add_del_locator":
 +
<pre>
 +
vat# lisp_add_del_locator locator-set  ls1 iface GigabitEthernet0/a/0 p 1 w 2
 +
</pre>
 +
Where <tt>p</tt> is <tt>priority</tt> and <tt>w</tt> is <tt>weight</tt>.
 +
 +
Locator API also support sw_if_index instead of interface name:
 +
<pre>
 +
lisp_add_del_locator locator-set  ls1 sw_if_index 6 p 1 w 2
 +
</pre>
 +
 +
To delete specific locator, use "lisp_add_del_locator locator-set  <name> iface <interface> p <priority> w <weight> del"
 +
<pre>
 +
vat# lisp_add_del_locator locator-set  ls1 iface GigabitEthernet0/a/0 p 1 w 2 del
 +
</pre>
 +
 +
To display locator_set and locator:
 +
<pre>
 +
vat# lisp_locator_set_dump                                                                                                                                                                                                                                                                 
 +
    Locator-set        Locator        Priority        Weight                                                                                                                                                                                                                             
 +
        ls1                6              1              2
 +
</pre>
 +
 +
 +
=== Eid ===
 +
To add new Eid address, use "lisp_add_del_local_eid"
 +
<pre>
 +
vat# lisp_add_del_local_eid eid 6:0:1::0/64 locator-set ls1
 +
</pre>
 +
There must exist locator_set, before add new eid address.
 +
 +
To delete specific eid address, use "isp_add_del_local_eid eid <address>/<prefix> locator-set <name>"
 +
<pre>
 +
vat# lisp_add_del_local_eid eid 6:0:1::0/64 locator-set ls1 del
 +
</pre>
 +
 +
To display Eid table:
 +
<pre>
 +
vat# lisp_local_eid_table_dump
 +
    Locator-set                  Eid           
 +
        ls1                  6.0.1.0/24         
 +
        ls1                  6:0:1::/64
 +
</pre>
 +
 +
 +
=== Map resolver ===
 +
To add new map resolver, use "lisp_add_del_map_resolver"
 +
<pre>
 +
vat# lisp_add_del_map_resolver 6:0:3::100
 +
</pre>
 +
 +
To delete specific map resolver, use "lisp_add_del_map_resolver <ip address> del"
 +
<pre>
 +
vat# lisp_add_del_map_resolver 6:0:3::100 del
 +
</pre>
 +
 +
To display map resolver:
 +
<pre>
 +
vat# lisp_map_resolver_dump
 +
    Map resolver   
 +
    6:0:3::100
 +
</pre>

Revision as of 08:38, 10 May 2016

TBD


Introduction

The vpp contain a set of commands to set and debug LISP. One way to access the CLI (with proper permissions) is to use the vpp_api_test command: 

sudo vpp_api_test


LISP commands

Locator_set

To add new locator_set, use "lisp_add_del_locator_set". This command also "reset" exist locator_set in vpp: 

vat# lisp_add_del_locator_set locator-set ls1

To delete a specific locator_set, use "lisp_add_del_locator_set locator-set <name> del": 

vat# lisp_add_del_locator_set locator-set ls1 del

When delete locator_set, then also delete all locator which are assigned to locator_set

To add new locator to locator_set, use "lisp_add_del_locator": 

vat# lisp_add_del_locator locator-set  ls1 iface GigabitEthernet0/a/0 p 1 w 2

Where p is priority and w is weight.

Locator API also support sw_if_index instead of interface name: 

lisp_add_del_locator locator-set  ls1 sw_if_index 6 p 1 w 2

To delete specific locator, use "lisp_add_del_locator locator-set <name> iface <interface> p <priority> w <weight> del" 

vat# lisp_add_del_locator locator-set  ls1 iface GigabitEthernet0/a/0 p 1 w 2 del

To display locator_set and locator: 

vat# lisp_locator_set_dump                                                                                                                                                                                                                                                                   
     Locator-set         Locator        Priority         Weight                                                                                                                                                                                                                              
         ls1                6               1               2


Eid

To add new Eid address, use "lisp_add_del_local_eid" 

vat# lisp_add_del_local_eid eid 6:0:1::0/64 locator-set ls1

There must exist locator_set, before add new eid address.

To delete specific eid address, use "isp_add_del_local_eid eid <address>/<prefix> locator-set <name>" 

vat# lisp_add_del_local_eid eid 6:0:1::0/64 locator-set ls1 del

To display Eid table: 

vat# lisp_local_eid_table_dump
     Locator-set                  Eid             
         ls1                  6.0.1.0/24          
         ls1                  6:0:1::/64


Map resolver

To add new map resolver, use "lisp_add_del_map_resolver" 

vat# lisp_add_del_map_resolver 6:0:3::100

To delete specific map resolver, use "lisp_add_del_map_resolver <ip address> del" 

vat# lisp_add_del_map_resolver 6:0:3::100 del

To display map resolver: 

vat# lisp_map_resolver_dump
    Map resolver    
     6:0:3::100
Retrieved from "https://wiki.fd.io/index.php?title=ONE/Command-line_Interface_CLI_Guide&oldid=1289"