.\" Man page generated from reStructuredText.
.
.TH "RYU-MANAGER" "8" "March 26, 2019" "4.30" "Ryu"
.SH NAME
ryu-manager \- management for Ryu application
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBryu\-manager\fP [\-h]
[\-\-app\-lists APP_LISTS] [\-\-ca\-certs CA_CERTS]
[\-\-config\-dir DIR] [\-\-config\-file PATH]
[\-\-ctl\-cert CTL_CERT] [\-\-ctl\-privkey CTL_PRIVKEY]
[\-\-default\-log\-level DEFAULT_LOG_LEVEL] [\-\-explicit\-drop]
[\-\-install\-lldp\-flow] [\-\-log\-config\-file LOG_CONFIG_FILE]
[\-\-log\-dir LOG_DIR] [\-\-log\-file LOG_FILE]
[\-\-log\-file\-mode LOG_FILE_MODE]
[\-\-neutron\-admin\-auth\-url NEUTRON_ADMIN_AUTH_URL]
[\-\-neutron\-admin\-password NEUTRON_ADMIN_PASSWORD]
[\-\-neutron\-admin\-tenant\-name NEUTRON_ADMIN_TENANT_NAME]
[\-\-neutron\-admin\-username NEUTRON_ADMIN_USERNAME]
[\-\-neutron\-auth\-strategy NEUTRON_AUTH_STRATEGY]
[\-\-neutron\-controller\-addr NEUTRON_CONTROLLER_ADDR]
[\-\-neutron\-url NEUTRON_URL]
[\-\-neutron\-url\-timeout NEUTRON_URL_TIMEOUT]
[\-\-noexplicit\-drop] [\-\-noinstall\-lldp\-flow]
[\-\-noobserve\-links] [\-\-nouse\-stderr] [\-\-nouse\-syslog]
[\-\-noverbose] [\-\-observe\-links]
[\-\-ofp\-listen\-host OFP_LISTEN_HOST]
[\-\-ofp\-ssl\-listen\-port OFP_SSL_LISTEN_PORT]
[\-\-ofp\-tcp\-listen\-port OFP_TCP_LISTEN_PORT] [\-\-use\-stderr]
[\-\-use\-syslog] [\-\-verbose] [\-\-version]
[\-\-wsapi\-host WSAPI_HOST] [\-\-wsapi\-port WSAPI_PORT]
[\-\-test\-switch\-dir TEST\-SWITCH_DIR]
[\-\-test\-switch\-target TEST\-SWITCH_TARGET]
[\-\-test\-switch\-tester TEST\-SWITCH_TESTER]
[app [app ...]]
.SH DESCRIPTION
.sp
\fBryu\-manager\fP is the executable for Ryu applications. ryu\-manager
loads Ryu applications and run it.
.sp
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.
.SH OPTIONS
.INDENT 0.0
.TP
.B app
application module name to run
.UNINDENT
.INDENT 0.0
.TP
.B \-h\fP,\fB  \-\-help
show this help message and exit
.TP
.BI \-\-app\-lists \ APP_LISTS
application module name to run
.TP
.BI \-\-ca\-certs \ CA_CERTS
CA certificates
.TP
.BI \-\-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.
.TP
.BI \-\-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
.TP
.BI \-\-ctl\-cert \ CTL_CERT
controller certificate
.TP
.BI \-\-ctl\-privkey \ CTL_PRIVKEY
controller private key
.TP
.BI \-\-default\-log\-level \ DEFAULT_LOG_LEVEL
default log level
.TP
.B \-\-explicit\-drop
link discovery: explicitly drop lldp packet in
.TP
.B \-\-install\-lldp\-flow
link discovery: explicitly install flow entry to send
lldp packet to controller
.TP
.BI \-\-log\-config\-file \ LOG_CONFIG_FILE
Path to a logging config file to use
.TP
.BI \-\-log\-dir \ LOG_DIR
log file directory
.TP
.BI \-\-log\-file \ LOG_FILE
log file name
.TP
.BI \-\-log\-file\-mode \ LOG_FILE_MODE
default log file permission
.TP
.BI \-\-neutron\-admin\-auth\-url \ NEUTRON_ADMIN_AUTH_URL
auth url for connecting to neutron in admin context
.TP
.BI \-\-neutron\-admin\-password \ NEUTRON_ADMIN_PASSWORD
password for connecting to neutron in admin context
.TP
.BI \-\-neutron\-admin\-tenant\-name \ NEUTRON_ADMIN_TENANT_NAME
tenant name for connecting to neutron in admin context
.TP
.BI \-\-neutron\-admin\-username \ NEUTRON_ADMIN_USERNAME
username for connecting to neutron in admin context
.TP
.BI \-\-neutron\-auth\-strategy \ NEUTRON_AUTH_STRATEGY
auth strategy for connecting to neutron in admincontext
.TP
.BI \-\-neutron\-controller\-addr \ NEUTRON_CONTROLLER_ADDR
openflow method:address:port to set controller ofovs bridge
.TP
.BI \-\-neutron\-url \ NEUTRON_URL
URL for connecting to neutron
.TP
.BI \-\-neutron\-url\-timeout \ NEUTRON_URL_TIMEOUT
timeout value for connecting to neutron in seconds
.TP
.B \-\-noexplicit\-drop
The inverse of \-\-explicit\-drop
.TP
.B \-\-noinstall\-lldp\-flow
The inverse of \-\-install\-lldp\-flow
.TP
.B \-\-noobserve\-links
The inverse of \-\-observe\-links
.TP
.B \-\-nouse\-stderr
The inverse of \-\-use\-stderr
.TP
.B \-\-nouse\-syslog
The inverse of \-\-use\-syslog
.TP
.B \-\-noverbose
The inverse of \-\-verbose
.TP
.B \-\-observe\-links
observe link discovery events.
.TP
.BI \-\-ofp\-listen\-host \ OFP_LISTEN_HOST
openflow listen host
.TP
.BI \-\-ofp\-ssl\-listen\-port \ OFP_SSL_LISTEN_PORT
openflow ssl listen port
.TP
.BI \-\-ofp\-tcp\-listen\-port \ OFP_TCP_LISTEN_PORT
openflow tcp listen port
.TP
.B \-\-use\-stderr
log to standard error
.TP
.B \-\-use\-syslog
output to syslog
.TP
.B \-\-verbose
show debug output
.TP
.B \-\-version
show program\(aqs version number and exit
.TP
.BI \-\-wsapi\-host \ WSAPI_HOST
webapp listen host
.TP
.BI \-\-wsapi\-port \ WSAPI_PORT
webapp listen port
.TP
.BI \-\-test\-switch\-dir \ TEST\-SWITCH_DIR
test files directory
.TP
.BI \-\-test\-switch\-target \ TEST\-SWITCH_TARGET
target sw dp\-id
.TP
.BI \-\-test\-switch\-tester \ TEST\-SWITCH_TESTER
tester sw dp\-id
.UNINDENT
.SH AUTHOR
Ryu development team
.SH COPYRIGHT
2011-2019 Nippon Telegraph and Telephone Corporation
.\" Generated by docutils manpage writer.
.