NSX CLI Guide

Associated Commands:

CLI Description Command

Display logical switch information


Display information about the specified logical switch.
get logical-switch <dpd-uuid-lswitch-arg> (Deprecated)

Display mcast offload tunnel


Display mcast offload tunnel.
get logical-switch <dpd-uuid-lswitch-arg> mcast-offload-tunnel source <ip-address> group <multicast-ip-address>

Display information about a logical switch


Display information about the specified logical switch.
get logical-switch <ls-id-arg-kvm> (Deprecated)

Display information about a logical switch


Display information about the specified logical switch.
get logical-switch <ls_id_arg_esx> (Deprecated)

Display all the counters for the specified logical switch.


Display all the counters for the specified logical switch.
get logical-switch <ls_id_arg_esx> datapath-stats all

Display all drop counters of all modules for the specified logical switch.


Display all drop counters of all modules for the specified logical switch.
get logical-switch <ls_id_arg_esx> datapath-stats drops

Display new drop counters for the specified logical switch.


Display new drop counters of all modules for the specified logical switch.
get logical-switch <ls_id_arg_esx> datapath-stats drops new

Display all the counters for the specified logical switch and module.


Display all the counters for the specified logical switch and module.
get logical-switch <ls_id_arg_esx> datapath-stats module <mod_name_arg_esx> all

Display all new counters for the specified logical switch and module.


Display all new counters for the specified logical switch and module.
get logical-switch <ls_id_arg_esx> datapath-stats module <mod_name_arg_esx> all new

Display drop counters for the specified logical switch and module.


Display drop counters for the specified logical switch and module.
get logical-switch <ls_id_arg_esx> datapath-stats module <mod_name_arg_esx> drops

Display new drop counters for the specified logical switch and module.


Display new drop counters for the specified logical switch and module.
get logical-switch <ls_id_arg_esx> datapath-stats module <mod_name_arg_esx> drops new

Display information about a logical switch


Display information about the specified logical switch. Use the get logical-switches command to get a list of all logical switches. You can use the VNI or UUID to specify the logical switch.
get logical-switch <vni-or-uuid-arg> (Deprecated)

Display statistics information about the specified logical switch


Display statistics information about the specified logical switch.
get logical-switch <vni-or-uuid-arg> stats (Deprecated)

Display information about a logical switch


Display information about the specified logical switch and logical switch ports associated with it. Use the get logical-switches command to get a list of all logical switches. You can use the VNI or UUID to specify the logical switch.
get logical-switch <vni-or-uuid-arg> verbose (Deprecated)

Display logical switches


Display all logical switches on this host.
get logical-switches (Deprecated)

Display logical switches


Display information about all logical switches.
get logical-switches (Deprecated)

Display all logical switches associated with the VIF on this host


Display all logical switches associated with the VIF on this host.
get logical-switches (Deprecated)

Display specified counter's detailed description.


Display specified counter's detailed description.
get logical-switches datapath-stats module <mod_name_arg_esx> counter <ctr_name_arg_esx> description verbose

List all the counters with brief description for the specified module.


List all the counters with brief description for the specified module.
get logical-switches datapath-stats module <mod_name_arg_esx> counters list

Display specified kernel module's detailed description.


Display specified kernel module's detailed description.
get logical-switches datapath-stats module <mod_name_arg_esx> description verbose

List all the observability enabled kernel modules.


List all the observability enabled kernel modules with.
get logical-switches datapath-stats modules list

Display a summary of all logical switch statistics


Display a summary of all logical switch statistics.
get logical-switches stats (Deprecated)

Display segment information


Display information about the specified segment.
get segment <dpd-uuid-lswitch-arg>

Display information about a segment


Display information about the specified segment.
get segment <segment-id-arg-kvm>

Display information about a segment


Display information about the specified segment.
get segment <segment_id_arg_esx>

Display all the counters for the specified segment.


Display all the counters for the specified segment.
get segment <segment_id_arg_esx> datapath-stats all

Display all drop counters of all modules for the specified segment.


Display all drop counters of all modules for the specified segment.
get segment <segment_id_arg_esx> datapath-stats drops

Display new drop counters for the specified segment.


Display new drop counters of all modules for the specified segment.
get segment <segment_id_arg_esx> datapath-stats drops new

Display all the counters for the specified segment and module.


Display all the counters for the specified segment and module.
get segment <segment_id_arg_esx> datapath-stats module <mod_name_arg_esx> all

Display all new counters for the specified segment and module.


Display all new counters for the specified segment and module.
get segment <segment_id_arg_esx> datapath-stats module <mod_name_arg_esx> all new

Display drop counters for the specified segment and module.


Display drop counters for the specified segment and module.
get segment <segment_id_arg_esx> datapath-stats module <mod_name_arg_esx> drops

Display new drop counters for the specified segment and module.


Display new drop counters for the specified segment and module.
get segment <segment_id_arg_esx> datapath-stats module <mod_name_arg_esx> drops new

Display information about a Segment


Display information about the specified segment. Use the get segmentss command to get a list of all segments. You can use the VNI or UUID to specify the logical switch.
get segment <vni-or-uuid-arg>

Display information about a segment


Display information about the specified Segment and segment ports associated with it. Use the get segments command to get a list of all segmentss. You can use the VNI or UUID to specify the segment.
get segment <vni-or-uuid-arg> verbose

Display all segment associated with the VIF on this host


Display all segment associated with the VIF on this host.
get segments

Display segments


Display information about all segments.
get segments

Display segments


Display all segments on this host.
get segments

Display statistics information about the specified segment


Display statistics information about the specified Segment.
get segments <vni-or-uuid-arg> stats

Display specified counter's detailed description.


Display specified counter's detailed description.
get segments datapath-stats module <mod_name_arg_esx> counter <ctr_name_arg_esx> description verbose

List all the counters with brief description for the specified module.


List all the counters with brief description for the specified module.
get segments datapath-stats module <mod_name_arg_esx> counters list

Display specified kernel module's detailed description.


Display specified kernel module's detailed description.
get segments datapath-stats module <mod_name_arg_esx> description verbose

List all the observability enabled kernel modules.


List all the observability enabled kernel modules.
get segments datapath-stats modules list

Display a summary of all segment statistics


Display a summary of all segment statistics.
get segments stats

Total commands: 43