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

From fd.io
< ONE
Jump to: navigation, search
Line 4: Line 4:
 
== Introduction ==
 
== Introduction ==
 
The vpp contain a set of commands to set and debug LISP.
 
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:
+
One way to access the CLI (with proper permissions) is to use the <tt>vpp_api_test</tt> command or use telnet CLI:
  
 
<pre>
 
<pre>
Line 11: Line 11:
  
  
−
== LISP commands ==
+
== Telnet LISP CLI ==
  
 +
=== Lisp GPE enable ===
 +
To enable lisp, use "lisp gpe":
 +
<pre>
 +
vpp# lisp gpe enable
 +
</pre>
 +
 +
To disable lisp
 +
<pre>
 +
vpp# lisp gpe disable
 +
</pre>
 +
 +
=== Locator_set ===
 +
To add new locator_set and locator, use "lisp locator-set add":
 +
<pre>
 +
vpp# lisp locator-set add ls1 iface host-intervpp1 p 1 w 1
 +
</pre>
 +
Where <tt>p</tt> is <tt>priority</tt> and <tt>w</tt> is <tt>weight</tt>.
 +
 +
To delete a specific locator_set, use "lisp locator-set del"
 +
<pre>
 +
vpp# lisp locator-set del ls1
 +
</pre>
 +
 +
To display locator_set and locator:
 +
<pre>
 +
vpp# show lisp locator-set
 +
    Locator-set        Locator        Priority        Weight   
 +
    ls1                      6              1              1
 +
</pre>
 +
 +
=== Eid ===
 +
To add new Eid address, use "lisp eid-table":
 +
<pre>
 +
vpp# lisp eid-table add eid 6.0.1.0/24 locator-set ls1
 +
</pre>
 +
 +
To delete a specific eid address, use "lisp eid-table del"
 +
<pre>
 +
vpp# lisp eid-table del eid 6.0.1.0/24 locator-set ls1
 +
</pre>
 +
 +
To display eid table:
 +
<pre>
 +
vpp# show lisp eid-table
 +
        EID            Locator   
 +
6.0.2.0/24                  ls1
 +
</pre>
 +
 +
=== Map resolver ===
 +
To add new map resolver, use "lisp map-resolver":
 +
<pre>
 +
vpp# lisp map-resolver add 6.0.3.100
 +
</pre>
 +
 +
To delete a specific map resolver address, use "lisp map-resolver del":
 +
<pre>
 +
vpp# lisp map-resolver del 6.0.3.100
 +
</pre>
 +
 +
== LISP VAT commands ==
 +
 +
=== Lisp GPE enable ===
 +
To enable lisp, use "lisp_gpe_enable_disable":
 +
<pre>
 +
vat# lisp_gpe_enable_disable enable
 +
</pre>
 +
 +
To disable lisp.
 +
<pre>
 +
vat# lisp_gpe_enable_disable disable
 +
</pre>
 +
 +
To display lisp status
 +
<pre>
 +
vat# lisp_gpe_enable_disable_status_dump
 +
    lisp gpe
 +
    enable
 +
</pre>
  
 
=== Locator_set ===
 
=== Locator_set ===
Line 48: Line 126:
 
         ls1                6              1              2  
 
         ls1                6              1              2  
 
</pre>
 
</pre>
−
 
  
 
=== Eid ===
 
=== Eid ===
Line 69: Line 146:
 
         ls1                  6:0:1::/64
 
         ls1                  6:0:1::/64
 
</pre>
 
</pre>
−
 
  
 
=== Map resolver ===
 
=== Map resolver ===

Revision as of 07:42, 11 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 or use telnet CLI: 

sudo vpp_api_test


Telnet LISP CLI

Lisp GPE enable

To enable lisp, use "lisp gpe": 

vpp# lisp gpe enable

To disable lisp 

vpp# lisp gpe disable

Locator_set

To add new locator_set and locator, use "lisp locator-set add": 

vpp# lisp locator-set add ls1 iface host-intervpp1 p 1 w 1

Where p is priority and w is weight.

To delete a specific locator_set, use "lisp locator-set del" 

vpp# lisp locator-set del ls1

To display locator_set and locator: 

vpp# show lisp locator-set
     Locator-set         Locator        Priority         Weight     
     ls1                      6               1               1

Eid

To add new Eid address, use "lisp eid-table": 

vpp# lisp eid-table add eid 6.0.1.0/24 locator-set ls1

To delete a specific eid address, use "lisp eid-table del" 

vpp# lisp eid-table del eid 6.0.1.0/24 locator-set ls1

To display eid table: 

vpp# show lisp eid-table
         EID             Locator    
6.0.2.0/24                   ls1

Map resolver

To add new map resolver, use "lisp map-resolver": 

vpp# lisp map-resolver add 6.0.3.100

To delete a specific map resolver address, use "lisp map-resolver del": 

vpp# lisp map-resolver del 6.0.3.100

LISP VAT commands

Lisp GPE enable

To enable lisp, use "lisp_gpe_enable_disable": 

vat# lisp_gpe_enable_disable enable

To disable lisp. 

vat# lisp_gpe_enable_disable disable

To display lisp status 

vat# lisp_gpe_enable_disable_status_dump
    lisp gpe
    enable

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=1311"