|
Open vSwitch CI |
88b1a2 |
diff --git a/Documentation/ref/ovs-appctl.8.rst b/Documentation/ref/ovs-appctl.8.rst
|
|
Open vSwitch CI |
88b1a2 |
index 7054cf559e..e7c8b96d49 100644
|
|
Open vSwitch CI |
88b1a2 |
--- a/Documentation/ref/ovs-appctl.8.rst
|
|
Open vSwitch CI |
88b1a2 |
+++ b/Documentation/ref/ovs-appctl.8.rst
|
|
Open vSwitch CI |
88b1a2 |
@@ -6,11 +6,11 @@ Synopsis
|
|
Open vSwitch CI |
88b1a2 |
========
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
``ovs-appctl``
|
|
Open vSwitch CI |
88b1a2 |
-[``--target=``<target> | ``-t`` <target>]
|
|
Open vSwitch CI |
88b1a2 |
-[``--timeout=``<secs> | ``-T`` <secs>]
|
|
Open vSwitch CI |
88b1a2 |
-[``--format=``<format> | ``-f`` <format>]
|
|
Open vSwitch CI |
88b1a2 |
+[``--target=``\ *target* | ``-t`` *target*]
|
|
Open vSwitch CI |
88b1a2 |
+[``--timeout=``\ *secs* | ``-T`` *secs*]
|
|
Open vSwitch CI |
88b1a2 |
+[``--format=``\ *format* | ``-f`` *format*]
|
|
Open vSwitch CI |
88b1a2 |
[``--pretty``]
|
|
Open vSwitch CI |
88b1a2 |
-<command> [<arg>...]
|
|
Open vSwitch CI |
88b1a2 |
+*command* [*arg* ``...``]
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
``ovs-appctl --help``
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
@@ -33,11 +33,11 @@ command and prints the daemon's response on standard output.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
In normal use only a single option is accepted:
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
-* ``-t`` <target> or ``--target`` <target>
|
|
Open vSwitch CI |
88b1a2 |
+* ``-t`` *target* or ``--target=``\ *target*
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
Tells ``ovs-appctl`` which daemon to contact.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- If <target> begins with ``/`` it must name a Unix domain socket on
|
|
Open vSwitch CI |
88b1a2 |
+ If *target* begins with ``/`` it must name a Unix domain socket on
|
|
Open vSwitch CI |
88b1a2 |
which an Open vSwitch daemon is listening for control channel
|
|
Open vSwitch CI |
88b1a2 |
connections. By default, each daemon listens on a Unix domain socket
|
|
Open vSwitch CI |
88b1a2 |
in the rundir (e.g. ``/run``) named ``<program>.<pid>.ctl``, where
|
|
Open vSwitch CI |
88b1a2 |
@@ -47,33 +47,33 @@ In normal use only a single option is accepted:
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
Otherwise, ``ovs-appctl`` looks in the rundir for a pidfile, that is,
|
|
Open vSwitch CI |
88b1a2 |
a file whose contents are the process ID of a running process as a
|
|
Open vSwitch CI |
88b1a2 |
- decimal number, named ``<target>.pid``. (The ``--pidfile`` option
|
|
Open vSwitch CI |
88b1a2 |
+ decimal number, named *target*\ ``.pid``. (The ``--pidfile`` option
|
|
Open vSwitch CI |
88b1a2 |
makes an Open vSwitch daemon create a pidfile.) ``ovs-appctl`` reads
|
|
Open vSwitch CI |
88b1a2 |
the pidfile, then looks in the rundir for a Unix socket named
|
|
Open vSwitch CI |
88b1a2 |
- ``<target>.<pid>.ctl``, where <pid> is replaced by the process ID read
|
|
Open vSwitch CI |
88b1a2 |
+ *target*\ ``.<pid>.ctl``, where <pid> is replaced by the process ID read
|
|
Open vSwitch CI |
88b1a2 |
from the pidfile, and uses that file as if it had been specified
|
|
Open vSwitch CI |
88b1a2 |
directly as the target.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- On Windows, <target> can be an absolute path to a file that contains a
|
|
Open vSwitch CI |
88b1a2 |
+ On Windows, *target* can be an absolute path to a file that contains a
|
|
Open vSwitch CI |
88b1a2 |
localhost TCP port on which an Open vSwitch daemon is listening for
|
|
Open vSwitch CI |
88b1a2 |
control channel connections. By default, each daemon writes the TCP
|
|
Open vSwitch CI |
88b1a2 |
port on which it is listening for control connection into the file
|
|
Open vSwitch CI |
88b1a2 |
- ``<program>.ctl`` located inside the rundir. If <target> is not an
|
|
Open vSwitch CI |
88b1a2 |
+ ``<program>.ctl`` located inside the rundir. If *target* is not an
|
|
Open vSwitch CI |
88b1a2 |
absolute path, ``ovs-appctl`` looks in the rundir for a file named
|
|
Open vSwitch CI |
88b1a2 |
- ``<target>.ctl``. The default target is ``ovs-vswitchd``.
|
|
Open vSwitch CI |
88b1a2 |
+ *target*\ ``.ctl``. The default *target* is ``ovs-vswitchd``.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
-* ``-T <secs>`` or ``--timeout=<secs>``
|
|
Open vSwitch CI |
88b1a2 |
+* ``-T`` *secs* or ``--timeout=``\ *secs*
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- By default, or with a <secs> of ``0``, ``ovs-appctl`` waits forever to
|
|
Open vSwitch CI |
88b1a2 |
+ By default, or with a *secs* of ``0``, ``ovs-appctl`` waits forever to
|
|
Open vSwitch CI |
88b1a2 |
connect to the daemon and receive a response. This option limits
|
|
Open vSwitch CI |
88b1a2 |
- runtime to approximately <secs> seconds. If the timeout expires,
|
|
Open vSwitch CI |
88b1a2 |
+ runtime to approximately *secs* seconds. If the timeout expires,
|
|
Open vSwitch CI |
88b1a2 |
``ovs-appctl`` exits with a ``SIGALRM`` signal.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
-* ``-f <format>`` or ``--format=<format>``
|
|
Open vSwitch CI |
88b1a2 |
+* ``-f`` *format* or ``--format=``\ *format*
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
Tells ``ovs-appctl`` which output format to use. By default, or with a
|
|
Open vSwitch CI |
88b1a2 |
- <format> of ``text``, ``ovs-appctl`` will print plain-text for humans.
|
|
Open vSwitch CI |
88b1a2 |
- When <format> is ``json``, ``ovs-appctl`` will return a JSON document.
|
|
Open vSwitch CI |
88b1a2 |
+ *format* of ``text``, ``ovs-appctl`` will print plain-text for humans.
|
|
Open vSwitch CI |
88b1a2 |
+ When *format* is ``json``, ``ovs-appctl`` will return a JSON document.
|
|
Open vSwitch CI |
88b1a2 |
When ``json`` is requested, but a command has not implemented JSON
|
|
Open vSwitch CI |
88b1a2 |
output, the plain-text output will be wrapped in a provisional JSON
|
|
Open vSwitch CI |
88b1a2 |
document with the following structure::
|
|
Open vSwitch CI |
88b1a2 |
@@ -158,10 +158,10 @@ and adjusting log levels:
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
Lists logging pattern used for each destination.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
-* ``vlog/set`` [<spec>]
|
|
Open vSwitch CI |
88b1a2 |
+* ``vlog/set`` [*spec*]
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- Sets logging levels. Without any <spec>, sets the log level for
|
|
Open vSwitch CI |
88b1a2 |
- every module and destination to ``dbg``. Otherwise, <spec> is a
|
|
Open vSwitch CI |
88b1a2 |
+ Sets logging levels. Without any *spec*, sets the log level for
|
|
Open vSwitch CI |
88b1a2 |
+ every module and destination to ``dbg``. Otherwise, *spec* is a
|
|
Open vSwitch CI |
88b1a2 |
list of words separated by spaces or commas or colons, up to one from
|
|
Open vSwitch CI |
88b1a2 |
each category below:
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
@@ -173,7 +173,7 @@ and adjusting log levels:
|
|
Open vSwitch CI |
88b1a2 |
change to only to the system log, to the console, or to a file,
|
|
Open vSwitch CI |
88b1a2 |
respectively.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- On Windows platform, ``syslog`` is only useful if <target> was
|
|
Open vSwitch CI |
88b1a2 |
+ On Windows platform, ``syslog`` is only useful if *target* was
|
|
Open vSwitch CI |
88b1a2 |
started with the ``--syslog-target`` option (it has no effect
|
|
Open vSwitch CI |
88b1a2 |
otherwise).
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
@@ -182,20 +182,20 @@ and adjusting log levels:
|
|
Open vSwitch CI |
88b1a2 |
will be logged, and messages of lower severity will be filtered out.
|
|
Open vSwitch CI |
88b1a2 |
``off`` filters out all messages.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- Case is not significant within <spec>.
|
|
Open vSwitch CI |
88b1a2 |
+ Case is not significant within *spec*.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
Regardless of the log levels set for ``file``, logging to a file
|
|
Open vSwitch CI |
88b1a2 |
will not take place unless the target application was invoked with the
|
|
Open vSwitch CI |
88b1a2 |
``--log-file`` option.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
For compatibility with older versions of OVS, ``any`` is accepted
|
|
Open vSwitch CI |
88b1a2 |
- within <spec> but it has no effect.
|
|
Open vSwitch CI |
88b1a2 |
+ within *spec* but it has no effect.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
-* ``vlog/set PATTERN:<destination>:<pattern>``
|
|
Open vSwitch CI |
88b1a2 |
+* ``vlog/set PATTERN:``\ *destination*:*pattern*
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- Sets the log pattern for <destination> to <pattern>. Each time a
|
|
Open vSwitch CI |
88b1a2 |
- message is logged to <destination>, <pattern> determines the
|
|
Open vSwitch CI |
88b1a2 |
- message's formatting. Most characters in <pattern> are copied
|
|
Open vSwitch CI |
88b1a2 |
+ Sets the log pattern for *destination* to *pattern*. Each time a
|
|
Open vSwitch CI |
88b1a2 |
+ message is logged to *destination*, *pattern* determines the
|
|
Open vSwitch CI |
88b1a2 |
+ message's formatting. Most characters in *pattern* are copied
|
|
Open vSwitch CI |
88b1a2 |
literally to the log, but special escapes beginning with ``%`` are
|
|
Open vSwitch CI |
88b1a2 |
expanded as follows:
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
@@ -214,13 +214,13 @@ and adjusting log levels:
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
* ``%d``
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- The current date and time in ISO 8601 format (YYYY-MM-DD HH:MM:SS).
|
|
Open vSwitch CI |
88b1a2 |
+ The current date and time in ISO 8601 format (``YYYY-MM-DD HH:MM:SS``).
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- * ``%d{<format>}``
|
|
Open vSwitch CI |
88b1a2 |
+ * ``%d{``\ *format*\ ``}``
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- The current date and time in the specified <format>, which takes
|
|
Open vSwitch CI |
88b1a2 |
- the same format as the <template> argument to ``strftime(3)``. As
|
|
Open vSwitch CI |
88b1a2 |
- an extension, any ``#`` characters in <format> will be replaced by
|
|
Open vSwitch CI |
88b1a2 |
+ The current date and time in the specified *format*, which takes
|
|
Open vSwitch CI |
88b1a2 |
+ the same format as the ``template`` argument to ``strftime(3)``. As
|
|
Open vSwitch CI |
88b1a2 |
+ an extension, any ``#`` characters in *format* will be replaced by
|
|
Open vSwitch CI |
88b1a2 |
fractional seconds, e.g. use ``%H:%M:%S.###`` for the time to the
|
|
Open vSwitch CI |
88b1a2 |
nearest millisecond. Sub-second times are only approximate and
|
|
Open vSwitch CI |
88b1a2 |
currently decimal places after the third will always be reported
|
|
Open vSwitch CI |
88b1a2 |
@@ -228,14 +228,14 @@ and adjusting log levels:
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
* ``%D``
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- The current UTC date and time in ISO 8601 format (YYYY-MM-DD
|
|
Open vSwitch CI |
88b1a2 |
- HH:MM:SS).
|
|
Open vSwitch CI |
88b1a2 |
+ The current UTC date and time in ISO 8601 format
|
|
Open vSwitch CI |
88b1a2 |
+ (``YYYY-MM-DD HH:MM:SS``).
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- * ``%D{<format>}``
|
|
Open vSwitch CI |
88b1a2 |
+ * ``%D{``\ *format*\ ``}``
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- The current UTC date and time in the specified <format>, which
|
|
Open vSwitch CI |
88b1a2 |
- takes the same format as the <template> argument to
|
|
Open vSwitch CI |
88b1a2 |
- ``strftime``(3). Supports the same extension for sub-second
|
|
Open vSwitch CI |
88b1a2 |
+ The current UTC date and time in the specified *format*, which
|
|
Open vSwitch CI |
88b1a2 |
+ takes the same format as the ``template`` argument to
|
|
Open vSwitch CI |
88b1a2 |
+ ``strftime(3)``. Supports the same extension for sub-second
|
|
Open vSwitch CI |
88b1a2 |
resolution as ``%d{...}``.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
* ``%E``
|
|
Open vSwitch CI |
88b1a2 |
@@ -299,22 +299,23 @@ and adjusting log levels:
|
|
Open vSwitch CI |
88b1a2 |
Pad the field to the field width with ``0`` characters. Padding
|
|
Open vSwitch CI |
88b1a2 |
with spaces is the default.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- * <width>
|
|
Open vSwitch CI |
88b1a2 |
+ * *width*
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
A number specifies the minimum field width. If the escape expands
|
|
Open vSwitch CI |
88b1a2 |
- to fewer characters than <width> then it is padded to fill the
|
|
Open vSwitch CI |
88b1a2 |
- field width. (A field wider than <width> is not truncated to
|
|
Open vSwitch CI |
88b1a2 |
+ to fewer characters than *width* then it is padded to fill the
|
|
Open vSwitch CI |
88b1a2 |
+ field width. (A field wider than *width* is not truncated to
|
|
Open vSwitch CI |
88b1a2 |
fit.)
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- The default pattern for console and file output is ``%D{%Y-%m-%dT
|
|
Open vSwitch CI |
88b1a2 |
- %H:%M:%SZ}|%05N|%c|%p|%m``; for syslog output, ``%05N|%c|%p|%m``.
|
|
Open vSwitch CI |
88b1a2 |
+ The default pattern for console and file output is
|
|
Open vSwitch CI |
88b1a2 |
+ ``%D{%Y-%m-%dT %H:%M:%SZ}|%05N|%c|%p|%m``; for syslog output,
|
|
Open vSwitch CI |
88b1a2 |
+ ``%05N|%c|%p|%m``.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
Daemons written in Python (e.g. ``ovs-monitor-ipsec``) do not allow
|
|
Open vSwitch CI |
88b1a2 |
control over the log pattern.
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
-* ``vlog/set FACILITY:<facility>``
|
|
Open vSwitch CI |
88b1a2 |
+* ``vlog/set FACILITY:``\ *facility*
|
|
Open vSwitch CI |
88b1a2 |
|
|
Open vSwitch CI |
88b1a2 |
- Sets the RFC5424 facility of the log message. <facility> can be one
|
|
Open vSwitch CI |
88b1a2 |
+ Sets the RFC5424 facility of the log message. *facility* can be one
|
|
Open vSwitch CI |
88b1a2 |
of ``kern``, ``user``, ``mail``, ``daemon``, ``auth``, ``syslog``,
|
|
Open vSwitch CI |
88b1a2 |
``lpr``, ``news``, ``uucp``, ``clock``, ``ftp``, ``ntp``, ``audit``,
|
|
Open vSwitch CI |
88b1a2 |
``alert``, ``clock2``, ``local0``, ``local1``, ``local2``,
|