1ovn-appctl(8)                     OVN Manual                     ovn-appctl(8)
2
3
4
5build/.PP
6

NAME

8       ovn-appctl - utility for configuring running OVN daemons
9

SYNOPSIS

11        ovn-appctl [-target=target | -t target] [-T secs | -timeout=secs] com‐
12       mand [arg...]
13
14       ovn-appctl -help
15
16       ovn-appctl -version
17

DESCRIPTION

19       OVN daemons accept certain commands at runtime to control their  behav‐
20       ior and query their settings. Every daemon accepts a common set of com‐
21       mands documented under COMMON  COMMANDS  below.  Some  daemons  support
22       additional commands documented in their own manpages.
23
24       The  ovn-appctl program provides a simple way to invoke these commands.
25       The command to be sent is specified on  ovn-appctl’s  command  line  as
26       non-option  arguments. ovn-appctl sends the command and prints the dae‐
27       mon’s response on standard output.
28
29       ovn-ctl is exactly similar to Open vSwitch ovs-appctl utility.
30

COMMAND COMMANDS

32       Every OVN daemon supports a common set of  commands,  which  are  docu‐
33       mented in this section.
34
35   General Commands
36       These  commands  display  daemon-specific commands and the running ver‐
37       sion. Note that these commands are different from the -help  and  -ver‐
38       sion  options  that  return  information  about  the ovn-appctl utility
39       itself.
40
41              list-commands
42                     Lists the commands supported by the target.
43
44              version
45                     Displays the version and compilation date of the target.
46
47   Logging Commands
48       OVN has several log levels. The highest-severity log level is:
49
50              off    No message is ever logged at this  level,  so  setting  a
51                     logging  destination’s  log level to off disables logging
52                     to that destination.
53
54       The following log levels, in order of descending severity,  are  avail‐
55       able:
56
57              emer   A major failure forced a process to abort.
58
59              err    A  high-level  operation or a subsystem failed. Attention
60                     is warranted.
61
62              warn   A low-level operation failed, but higher-level subsystems
63                     may be able to recover.
64
65              info   Information  that may be useful in retrospect when inves‐
66                     tigating a problem.
67
68              dbg    Information useful only to someone with intricate  knowl‐
69                     edge  of  the  system,  or that would commonly cause too-
70                     voluminous log output. Log messages at this level are not
71                     logged by default.
72
73       Every  OVN  daemon  supports  the  following commands for examining and
74       adjusting log levels.
75
76              vlog/list
77                     Lists the known logging modules and their current levels.
78
79              vlog/list-pattern
80                     Lists logging pattern used for each destination.
81
82              vlog/set [spec]
83                     Sets logging levels. Without any spec, sets the log level
84                     for  every module and destination to dbg. Otherwise, spec
85                     is a list of words  separated  by  spaces  or  commas  or
86                     colons, up to one from each category below:
87
88                     ·      A valid module name, as displayed by the vlog/list
89                            command on ovn-appctl(8),  limits  the  log  level
90                            change to the specified module.
91
92                     ·      syslog,  console,  or file, to limit the log level
93                            change to only to the system log, to the  console,
94                            or to a file, respectively.
95
96                            On  Windows platform, syslog is accepted as a word
97                            and is only useful if the target was started  with
98                            the --syslog-target option (the word has no effect
99                            otherwise).
100
101                     ·      off, emer, err, warn, info, or dbg, to control the
102                            log  level.  Messages  of  the  given  severity or
103                            higher will  be  logged,  and  messages  of  lower
104                            severity will be filtered out. off filters out all
105                            messages.
106
107                     Case is not significant within spec.
108
109              vlog/set PATTERN:destination: pattern
110                     Sets the log pattern for  destination  to  pattern.  Each
111                     time  a  message is logged to destination, pattern deter‐
112                     mines the message’s formatting. Most characters  in  pat‐
113                     tern are copied literally to the log, but special escapes
114                     beginning with % are expanded as follows:
115
116                     ·      %A : The name of the application logging the  mes‐
117                            sage, e.g. ovn-controller.
118
119                     ·      %B : The RFC5424 syslog PRI of the message.
120
121                     ·      %c  :  The  name  of  the module (as shown by ovn-
122                            appctl -list) logging the message.
123
124                     ·      %d : The current date and time in ISO 8601  format
125                            (YYYY-MM-DD HH:MM:SS).
126
127                     ·      %d{format}  :  The  current  date  and time in the
128                            specified format, which takes the same  format  as
129                            the template argument to strftime(3). As an exten‐
130                            sion, any # characters in format will be  replaced
131                            by  fractional  seconds, e.g. use %H:%M:%S.### for
132                            the time to the  nearest  millisecond.  Sub-second
133                            times  are  only approximate and currently decimal
134                            places after the third will always be reported  as
135                            zero.
136
137                     ·      %D  :  The  current  UTC date and time in ISO 8601
138                            format (YYYY-MM-DD HH:MM:SS).
139
140                     ·      %D{format} : The current UTC date and time in  the
141                            specified  format,  which takes the same format as
142                            the template argument to strftime(3). Supports the
143                            same   extension   for  sub-second  resolution  as
144                            %d{...}.
145
146                     ·      %E : The hostname of the node running the applica‐
147                            tion.
148
149                     ·      %m : The message being logged.
150
151                     ·      %N  : A serial number for this message within this
152                            run of the program, as a decimal number. The first
153                            message  a  program  logs has serial number 1, the
154                            second one has serial number 2, and so on.
155
156                     ·      %n : A new-line.
157
158                     ·      %p : The level at which  the  message  is  logged,
159                            e.g. DBG.
160
161                     ·      %P  : The program’s process ID (pid), as a decimal
162                            number.
163
164                     ·      %r : The number of milliseconds elapsed  from  the
165                            start  of  the application to the time the message
166                            was logged.
167
168                     ·      %t : The subprogram name, that is, an  identifying
169                            name  for  the  process or thread that emitted the
170                            log message, such as monitor for the process  used
171                            for  -monitor  or  main for the primary process or
172                            thread in a program.
173
174                     ·      %T : The subprogram name enclosed in  parentheses,
175                            e.g.  (monitor),  or the empty string for the pri‐
176                            mary process or thread in a program.
177
178                     ·      %% : A literal %.
179
180                     A few options may appear between the  %  and  the  format
181                     specifier character, in this order:
182
183                     ·      - : Left justify the escape’s expansion within its
184                            field width. Right justification is the default.
185
186                     ·      - : Pad the field to the field width with 0s. Pad‐
187                            ding with spaces is the default.
188
189                     width  A number specifies the minimum field width. If the
190                     escape expands to fewer characters than width then it  is
191                     padded to fill the field width. (A field wider than width
192                     is not truncated to fit.)
193
194                     The default  pattern  for  console  and  file  output  is
195                     %D{%Y-%m-%dT %H:%M:%SZ}|%05N|%c|%p|%m; for syslog output,
196                     %05N|%c|%p|%m.
197
198              vlog/set FACILITY:facility
199                     Sets the RFC5424 facility of the  log  message.  facility
200                     can  be  one  of  kern, user, mail, daemon, auth, syslog,
201                     lpr, news, uucp, clock, ftp, ntp, audit,  alert,  clock2,
202                     local0, local1, local2, local3, local4, local5, local6 or
203                     local7.
204
205              vlog/close
206                     Causes the daemon to close its log file, if it  is  open.
207                     (Use vlog/reopen to reopen it later.)
208
209              vlog/reopen
210                     Causes  the  daemon to close its log file, if it is open,
211                     and then reopen it. (This is useful  after  rotating  log
212                     files, to cause a new log file to be used.)
213
214                     This  has  no  effect  if  the target application was not
215                     invoked with the --log-file option.
216

OPTIONS

218       -h
219       --help
220            Prints a brief help message to the console.
221
222       -V
223       --version
224            Prints version information to the console.
225
226
227
228OVN 20.03.0                       ovn-appctl                     ovn-appctl(8)
Impressum