summaryrefslogtreecommitdiffhomepage
path: root/doc/source/man/ryu.rst
blob: d6968c36b20e04f857fde58b2f14a5e808779850 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
:orphan:

ryu manual page
===============

Synopsis
--------
**ryu** [-h] [--config-dir DIR] [--config-file PATH] [--version] [subcommand] ...

Description
-----------
:program:`ryu` is the executable for Ryu applications. ryu loads a sub-module
corresponding to the sub-command and run it. 'run' sub-command is an
equivalent to ryu-manager.

Ryu is a component-based software defined networking framework. Ryu
provides software components with well defined API that make it easy for
developers to create new network management and control applications.
Ryu supports various protocols for managing network devices, such as
OpenFlow, Netconf, OF-config, etc. About OpenFlow, Ryu supports fully
1.0, 1.2, 1.3, 1.4 and Nicira Extensions.

Options
-------
subcommand
    [rpc-cli|run|of-config-cli]

subcommand_args
    subcommand specific arguments

-h, --help
    show this help message and exit

--config-dir DIR
    Path to a config directory to pull \*.conf files from.
    This file set is sorted, so as to provide a predictable
    parse order if individual options are over-ridden. The
    set is parsed after the file(s) specified via previous
    --config-file, arguments hence over-ridden options in
    the directory take precedence.

--config-file PATH
    Path to a config file to use. Multiple config files can
    be specified, with values in later files taking
    precedence. The default files used are: None

--version
    show program's version number and exit