NSX Command Line Interface Reference - VMware

1 NSX Command line InterfaceReferenceVMware NSX for vSphere 4 Modified on 16 FEB 2018 This document supports the version of each product listed andsupports all subsequent versions until the document is replacedby a new edition. To check for more recent editions of thisdocument, see , Hillview Alto, CA , Command line Interface Reference You can find the most up-to-date technical documentation on the VMware Web site at: VMware Web site also provides the latest product you have comments about this documentation, submit your feedback Copyright 2012 - 2018 VMware , Inc. All rights reserved. This product is protected by and international copyright and intellectual property laws. VMware products are covered by one or more patents listed at is a registered trademark or trademark of VMware , Inc. in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies. VMware , The NSX Command line Interface Reference describes how to use the NSX for vSphere Command line Interface (CLI) and includes examples and Command AudienceThis guide is intended for anyone who wants to install or use NSX in a VMware vCenter environment.

2 The information in this guide is written for experienced system administrators who are familiar with virtual machine technology and virtual datacenter operations. This guide assumes familiarity with VMware Infrastructure, including VMware ESX, vCenter Server, and the vSphere Technical Publications GlossaryVMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitions of terms as they are used in VMware technical documentation go to FeedbackVMware welcomes your suggestions for improving our documentation. If you have comments, send your feedback to DocumentationThe following documents comprise the NSX documentation set: NSX Installation Guide NSX Cross-vCenter Installation Guide NSX Upgrade Guide NSX Administration Guide NSX Troubleshooting Guide NSX Command line Interface Reference NSX API GuideAbout This BookNSX Command line Interface Reference4 VMware , Inc. VMware , ContentsAbout This Book111 Introduction to the NSX CLI13 Logging In and Out of the CLI13 Syntax Notation Used in this Document14 NSX Manager and NSX Edge CLI Command Modes14 NSX Manager and NSX Edge CLI Passwords14 Moving Around in the NSX Manager and NSX Edge CLI 15 Getting Help within the NSX Manager and NSX Edge CLI152 NSX Manager Commands17cli password17configure terminal17copy running-config startup-config 17disable18debug show files18enable18enable password19exit19export tech-support scp19hostname20interface20ip address21ip route21list21ping 22quit22reset22reboot22set clock 23setup23show arp 24show clock24show ethernet24show filesystem25show log25show running-config25show startup-config26show slots26show tech-support27shutdown 27ssh27terminal length28terminal no length 28traceroute28user29user userName privilege web- Interface 29web-manager 30 NSX Command line Interface Reference2 VMware , Inc.

3 Write memory 303 NSX Central Commands31 Central Commands Overview31 Central Common Commands32show cluster32show host hostID 32show host hostID health-status 33show vm vmID 33show vnic vnicID 33 Central Controller Commands 34show controller list all34 Central Logical Router Commands34show logical-router controller controllerID dlr dlrID bridge (all | bridgeID) 34show logical-router controller controllerID dlr dlrID bridge (all | bridgeID) mac-address-table34show logical-router controller controllerID dlr dlrID brief 35show logical-router controller controllerID dlr dlrID Interface 35show logical-router controller controllerID dlr dlrID route 36show logical-router controller controllerID dlr dlrID statistics 36show logical-router controller controllerID host hostIP connection 37show logical-router controller controllerID statistics37show logical-router host hostID connection 37show logical-router host hostID dlr dlrID 38show logical-router host hostID dlr dlrID arp38show logical-router host hostID dlr dlrID bridge bridgeName mac-address-table 39show logical-router host hostID dlr dlrID bridge bridgeName statistics40show logical-router host hostID dlr dlrID bridge bridgeName verbose41show logical-router host hostID dlr dlrID control-plane-statistics42show logical-router host hostID dlr dlrID Interface intName brief 43show logical-router host hostID dlr dlrID

4 Interface intName statistics43show logical-router host hostID dlr dlrID Interface intName verbose 44show logical-router host hostID dlr dlrID route45show logical-router host hostID dlr dlrID tunable45show logical-router list all46show logical-router list dlr dlrID host 46show logical-router resolve46 Central Logical Switch Commands47show logical-switch controller controllerID host hostIP arp47show logical-switch controller controllerID host hostIP joined-vnis47show logical-switch controller controllerID host hostIP mac48show logical-switch controller controllerID host hostIP vtep48show logical-switch controller controllerID vni vni arp 48show logical-switch controller controllerID vni vni brief 48show logical-switch controller controllerID vni vni connection 49show logical-switch controller controllerID vni vni mac 49show logical-switch controller controllerID vni vni statistics 49show logical-switch controller controllerID vni vni vtep 50show logical-switch host hostID config-by-vsm50show logical-switch host hostID statistics51show logical-switch host hostID verbose 52show logical-switch host hostID vni vni arp53show logical-switch host hostID vni vni mac53show logical-switch host hostID vni vni port portID statistics 53show logical-switch host hostID vni vni statistics54show logical-switch host hostID vni vni verbose54show logical-switch host hostID vni vni vtep55 VMware .

5 Show logical-switch list all55show logical-switch list host hostID vni 56show logical-switch list vni vni host56 Central Distributed Firewall Commands56show dfw cluster56show dfw host hostID 57show dfw host hostID filter filterID addrsets57show dfw host hostID filter filterID discoveredips 58show dfw host hostID filter filterID discoveredips stats 58show dfw host hostID filter filterID flows58show dfw host hostID filter filterID rule ruleID 59show dfw host hostID filter filterID rules59show dfw host hostID filter filterID spoofguard59show dfw host hostID filter filterID stats60show dfw host hostID summarize-dvfilter 60show dfw vm vmID61show dfw vnic vnicID 62 Central NSX Edge Commands62show edge (all | edgeID )62show edge edgeID arp 63show edge edgeID configuration application-set 63show edge edgeID configuration bgp 64show edge edgeID configuration certificatestore 64show edge edgeID configuration dhcp 64show edge edgeID configuration dns 64show edge edgeID configuration firewall 64show edge edgeID configuration global 65show edge edgeID configuration gslb 65show edge edgeID configuration highavailability 65show edge edgeID configuration Interface 65show edge edgeID configuration Interface -set 66show edge edgeID configuration ipsec 66show edge edgeID configuration ipset 66show edge edgeID configuration l2vpn 66show edge edgeID configuration loadbalancer 67show edge edgeID configuration nat 67show edge edgeID configuration osfp 67show edge edgeID configuration provider-appset 67show edge edgeID configuration provider-ipset 67show edge edgeID configuration routing-global 68show edge edgeID

6 Configuration snmp 68show edge edgeID configuration sslvpn-plus 68show edge edgeID configuration static-routing 68show edge edgeID configuration syslog 69show edge edgeID eventmgr 69show edge edgeID firewall 69show edge edgeID firewall flows topN n69show edge edgeID flowtable 70show edge edgeID interface70show edge edgeID ip bgp 70show edge edgeID ip bgp neighbors 70show edge edgeID ip forwarding71show edge edgeID ip ospf 71show edge edgeID ip ospf database 71show edge edgeID ip ospf Interface 71show edge edgeID ip ospf neighbor 72show edge edgeID ip route 72 NSX Command line Interface Reference4 VMware , Inc. show edge edgeID ipset 72show edge edgeID log72show edge edgeID messagebus 73show edge edgeID nat 73show edge edgeID process list 73show edge edgeID process snapshot 73show edge edgeID service dhcp74show edge edgeID service dns 74show edge edgeID service highavailability 75show edge edgeID service ipsec 75show edge edgeID service ipsec site 75show edge edgeID service loadbalancer 75show edge edgeID service loadbalancer error 76show edge edgeID service monitor 76show edge edgeID service monitor service 76show edge edgeID system cpu 76show edge edgeID system memory 77show edge edgeID system network-stats 77show edge edgeID system storage 77 Central NSX Packet Capture Commands78 Capture vNic78 Capture pNic 78 Capture vdrPort79 Capture VMKNic79 Delete packet capture session80 Show all packet capture sessions80 Show packet capture session80 Show packet capture file content81 Stop packet capture session81

7 Stop packet capture session and discard82 Transfer packet capture file824 NSX Edge Commands85clear nat counters85clear arp ipAddress85clear service dhcp lease85clear service ipsec sa 85debug packet capture86debug packet display interface86disable86dnslookup serverName 87dnslookup serverName (hostname | ipAddress)87enable87export tech-support scp87ping 88ping Interface addr88ping (ip | ipv6) ipAddress 88show arp 89show clock89show configuration application-set90show configuration bgp91show configuration certificatestore 93show configuration dhcp93show configuration dns94show configuration firewall95show configuration global96 VMware , show configuration gslb 97show configuration highavailability98show configuration interface99show configuration Interface -set100show configuration ipsec102show configuration ipset 103show configuration l2vpn103show configuration loadbalancer 104show configuration loadbalancer monitor 106show configuration loadbalancer pool107show configuration loadbalancer rule108show configuration loadbalancer virtual108show configuration nat109show configuration ospf110show configuration routing-global112show configuration snmp112show configuration sslvpn-plus112show configuration static-routing112show configuration syslog113show eventmgr113show firewall 114show firewall flows115show firewall flows top n 115show firewall flows top n sort-by bytes 115show firewall flows top n sort-by pkts 115show firewall rule-id id115show firewall rule-id id flows 115show firewall rule-id id flows top n 116show firewall rule-id id flows top n sort-by

8 Bytes 116show firewall rule-id id flows top n sort-by pkts 116show flowstats116show flowtable118show flowtable expect 118show flowtable rule-id id118show flowtable rule-id id top n 118show flowtable rule-id id top n sort-by bytes 118show flowtable rule-id id top n sort-by pkts 119show flowtable top n 119show flowtable top n sort-by bytes 119show flowtable top n sort-by pkts 119show flowtimeouts119show hostname120show interface120show ip bgp 121show ip bgp neighbors121show ip forwarding122show ip ospf123show ip ospf database123show ip ospf database adv-router 124show ip ospf database asbr-summary 125show ip ospf database external125show ip ospf database network 125show ip ospf database nssa-external125show ip ospf database opaque-area126show ip ospf database router 126show ip ospf database summary126show ip ospf interface127 NSX Command line Interface Reference6 VMware , Inc. show ip ospf neighbor127show ip ospf statistics 127show ip route128show ip route bgp128show ip route ospf129show ipset129show ipv6 forwarding130show log130show log routing 131show messagebus131show nat133show netdevice133show process134show rpfilter134show rpfstats135show service all 135show service dhcp136show service dns136show service highavailability136show service highavailability connection-sync136show service highavailability internal137show service highavailability link137show service ipsec138show service ipsec cacerts 138show service ipsec certs138show service ipsec crls138show service ipsec pubkeys139show service ipsec sa139show service ipsec site139show service ipsec stats139show service ipsec sp139show service l2vpn (on client)140show service l2vpn (on server)

9 140show service l2vpn bridge140show service l2vpn conversion table141show service l2vpn trunk-table141show service loadbalancer 142show service loadbalancer error142show service loadbalancer monitor 142show service loadbalancer pool142show service loadbalancer session 143show service loadbalancer table143show service loadbalancer virtual143show service monitor 143show service monitor service144show service network-connections145show service sslvpn-plus146show service sslvpn-plus sessions146show service sslvpn-plus stats146show service sslvpn-plus tunnels146show system cpu147show system interrupt147show system memory 148show system network-stats148show system storage149show system uptime150show tech-support150 VMware , show version150traceroute1525 Standalone NSX Edge Commands153 Standalone NSX Edge Overview 153 Standalone NSX Edge Commands153ciphers153commit153configure terminal154dns name-server154egress-optimize 154exit155fips enable155fips disable156interface intName156ip address156ip route157l2vpn157mtu157no proxy setup157no proxy user 158password158proxy address158proxy username159quit159rpfilter 159server ipAddress [port]160show configuration 160show log161show service dns161show service l2vpn161show sub-interface162ssh (start | stop)

10 162sub- Interface pairs162sub- Interface range163trustca163user1646 NSX Host Commands165 ESXi CLI Commands165esxcli network vswitch dvs VMware vxlan config stats get165esxcli network vswitch dvs VMware vxlan config stats set165esxcli network vswitch dvs VMware vxlan get165esxcli network vswitch dvs VMware vxlan list --vds-name value166esxcli network vswitch dvs VMware vxlan network list --vds-name value --vxlan-id value166esxcli network vswitch dvs VMware vxlan network arp list --vds-name value --vxlan-id value 166esxcli network vswitch dvs VMware vxlan network arp reset --vds-name value --vxlan-id value 166esxcli network vswitch dvs vmwar