Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
Usage: opflow-cli.pl act=operation [option=A...] [param=X...]
opflow-cli.pl act=setup-db [drop=true] [usepercent=NN]
opflow-cli.pl act=setup-iana [url=...|file=...]
opflow-cli.pl act=(purge|purge-raw|purge-endpoints|purge-indices)
opflow-cli.pl act=load-flows file=...
opflow-cli.pl act=list-endpoints [searchprop=value...]
value can be regex:...

opflow-cli.pl act=create-endpoint property=value...
opflow-cli.pl act=show-endpoint ip=address
opflow-cli.pl act=update-endpoint ip=address entry.propname=value...
opflow-cli.pl act=delete-endpoint ip=address

opflow-cli.pl act=list-apps [searchprop=value...]
opflow-cli.pl act=(create-app|update-app) number=N protocol=M name=X description=Y
opflow-cli.pl act=delete-app number=N protocol=M

opflow-cli.pl act=list-agents
opflow-cli.pl act=update-agent agent=X [in_if=Y out_if=Z] admin_status=(active|inactive)

opflow-cli.pl act=list-filters [include_inactive=0/1]
opflow-cli.pl act=show-filter name=F
opflow-cli.pl act=disable-filter name=F
opflow-cli.pl act=create-filter name=F [description=D] propA=X,Y,Z [propB=...]
properties: agent application endpoint proto src_ip dst_ip src_port dst_port
filter expressions: A,B,C for list of choices, regex:string supported
for all properties except agent and proto.
proto must be number or list of numbers. agent must be agent_ip
(for all interfaces), or agent_ip:in_ifidx:out_ifidx.

opflow-cli.pl act=create-report [param=...]

options:
quiet=1: suppress output, only set exit code
debug=1: more verbose debugging output

Manage Agents

Agents are a list of the IP addresses from which flows are received.  The System -> Manage Agents function enables you to associate the agent IP with an actual node in NMIS.  Associating to an NMIS node enables opFlow to look up the interface indexes which the traffic is flowing to and from.  You MUST tell opFlow which IP address is which Node Name for this process to work.  You can also tell opFlow to query a remote server for those Node Details refer to: opCharts/NMIS integration.

opFlow allows to select which flow agents (and in/out interfaces) your opFlow instance should accept data from. The agent list is updated automatically based on the flows that are received.

...