This page is for EdgeView client side command descriptions. For information on EdgeView design and architecture, please see Design Proposal.

To run EdgeView client script, the docker is required on user's laptop. The EdgeView client program is started in a script with 'docker run'. For an example of the client script, see EdgeView Client Script.

Command Help

EdgeView script (e.g. edgeview.sh) with the '-h' or '-help', it will display the output like:

edgeview.sh -h

eve-edgeview [ -token <session-token> ] [ -inst <instance-id> ] [ -debug ] <query command>
query options:

[acl app arp connectivity flow if mdns nslookup ping route socket speed tcp tcpdump trace url wireless]
[app configitem cat cp datastore dmesg download du hw lastreboot ls model newlog pci ps cipher usb techsupport top volume]
log/search-pattern [ -time <start_time>-<end_time> -json -type <app|dev> -line <num> ]
pub/ [baseosmgr domainmgr downloader edgeview global loguploader newlogd nim nodeagent tpmmgr vaultmgr volumemgr watcher zedagent zedclient zedmanager zedrouter zfsmanager]

For more detail help on EdgeView commands, see https://wiki.lfedge.org/display/EVE/EdgeView+Commands

For help on a specific command, for example on 'flow' (assume it's a multiple instance, need to specify '-inst 1'):

edgeview.sh -inst 1 flow -h

flow[/<some pattern>] - display ip flow information in the kernel search pattern
e.g. flow/sport=53 -- display all the ip flow matches source port of 53
flow/10.1.0.2 -- display all the ip flow matches ip address of 10.1.0.2

The rest of this document will have more detail information on each of the EdgeView command.