ovn/ovn-nbctl.8.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <manpage program="ovn-nbctl" section="8" title="ovn-nbctl">
   3     <h1>Name</h1>
   4     <p>ovn-nbctl -- Open Virtual Network northbound db management utility</p>
   5
   6     <h1>Synopsys</h1>
   7     <p><code>ovn-nbctl</code> [<var>options</var>] <var>command</var> [<var>arg</var>...]</p>
   8
   9     <h1>Description</h1>
  10     <p>This utility can be used to manage the OVN northbound database.</p>
  11
  12     <h1>Logical Switch Commands</h1>
  13     <p><code>lswitch-add</code> [<var>name</var>]</p>
  14     <p><code>lswitch-del</code> <var>lswitch</var></p>
  15     <p><code>lswitch-list</code></p>
  16     <p><code>lswitch-set-external-id</code> <var>lswitch</var> <var>key</var> [<var>value</var>]</p>
  17     <p><code>lswitch-get-external-id</code> <var>lswitch</var> [<var>key</var>]</p>
  18
  19     <h1>Logical Port Commands</h1>
  20     <p><code>lport-add</code> <var>name</var> <var>lswitch</var></p>
  21     <p><code>lport-del</code> <var>lport</var></p>
  22     <p><code>lport-list</code> <var>lswitch</var></p>
  23     <p><code>lport-set-external-id</code> <var>lport</var> <var>key</var> [<var>value</var>]</p>
  24     <p><code>lport-get-external-id</code> <var>lport</var> [<var>key</var>]</p>
  25     <p><code>lport-set-macs</code> <var>lport</var> [<var>mac</var>] [<var>mac</var>] [...]</p>
  26     <p><code>lport-get-macs</code> <var>lport</var></p>
  27     <p><code>lport-get-up</code> <var>lport</var></p>
  28
  29     <h1>Options</h1>
  30     <p><code>-d</code> <var>database</var> | <code>--db</code> <var>database</var></p>
  31     <p><code>-h</code> | <code>--help</code></p>
  32     <p><code>-o</code> | <code>--options</code></p>
  33     <p><code>-V</code> | <code>--version</code></p>
  34
  35     <h1>Logging options</h1>
  36     <p><code>-v</code><var>spec</var>, <code>--verbose=</code><var>spec</var></p>
  37     <p><code>-v</code>, <code>--verbose</code></p>
  38     <p><code>--log-file</code>[<code>=</code><var>file</var>]</p>
  39     <p><code>--syslog-target=</code><var>host</var><code>:</code><var>port</var></p>
  40
  41     <h1>PKI configuration (required to use SSL)</h1>
  42     <p><code>-p</code>, <code>--private-key=</code><var>file</var>  file with private key</p>
  43     <p><code>-c</code>, <code>--certificate=</code><var>file</var>  file with certificate for private key</p>
  44     <p><code>-C</code>, <code>--ca-cert=</code><var>file</var>      file with peer CA certificate</p>
  45
  46 </manpage>