vtep-ctl

package: openvswitch-vtep

title: vtep-ctl(8)

text:
# vtep-ctl(8)

## NAME
vtep-ctl - utility for querying and configuring a VTEP database

## SYNOPSIS
vtep-ctl [options] -- [options] command [args] [-- [options] command [args]]...

## DESCRIPTION
The vtep-ctl program configures a VTEP database. See vtep(5) for comprehensive documentation of the database schema.

vtep-ctl connects to an ovsdb-server process that maintains a VTEP configuration database. Using this connection, it queries and possibly applies changes to the database, depending on the supplied commands.

vtep-ctl can perform any number of commands in a single run, implemented as a single atomic transaction against the database.

The vtep-ctl command line begins with global options (see OPTIONS below for details). The global options are followed by one or more commands. Each command should begin with -- by itself as a command-line argument, to separate it from the following commands. (The -- before the first command is optional.) The command itself starts with command-specific options, if any, followed by the command name and any arguments. See EXAMPLES below for syntax examples.

## OPTIONS
The following options affect the behavior vtep-ctl as a whole. Some individual commands also accept their own options, which are given just before the command name. If the first command on the command line has options, then those options must be separated from the global options by --.

--db=server

Sets server as the database server that vtep-ctl contacts to query or modify configuration. server may be an OVSDB active or passive connection method, as described in ovsdb(7). The default is unix:/run/openvswitch/db.sock.

--no-syslog

By default, vtep-ctl logs its arguments and the details of any changes that it makes to the system log. This option disables this logging.

This option is equivalent to --verbose=vtep_ctl:syslog:warn.

--oneline

Modifies the output format so that the output for each command is printed on a single line. New-line characters that would otherwise separate lines are printed as \n, and any instances of \ that would otherwise appear in the output are doubled. Prints a blank line for each command that has no output. This option does not affect the formatting of output from the list or find commands; see Table Formatting Options below.

--dry-run

Prevents vtep-ctl from actually modifying the database.

-t secs

--timeout=secs

By default, or with a secs of 0, vtep-ctl waits forever for a response from the database. This option limits runtime to approximately secs seconds. If the timeout expires, vtep-ctl will exit with a SIGALRM signal. (A timeout would normally happen only if the database cannot be contacted, or if the system is overloaded.)

### Table Formatting Options
These options control the format of output from the list and find commands.

-f format

--format=format

Sets the type of table formatting. The following types of format are available:

table

2-D text tables with aligned columns.

list (default)

A list with one column per line and rows separated by a blank line.

html

HTML tables.

csv

Comma-separated values as defined in RFC 4180.

json

JSON format as defined in RFC 4627. The output is a sequence of JSON objects, each of which corresponds to one table. Each JSON object has the following members with the noted values:

caption

The table's caption. This member is omitted if the table has no caption.

headings

An array with one element per table column. Each array element is a string giving the corresponding column's heading.

data

An array with one element per table row. Each element is also an array with one element per table column. The elements of this second-level array are the cells that constitute the table. Cells that represent OVSDB data or data types are expressed in the format described in the OVSDB specification; other cells are simply expressed as text strings.

-d format

--data=format

Sets the formatting for cells within output tables unless the table format is set to json, in which case json formatting is always used when formatting cells. The following types of format are available:

string (default)

The simple format described in the Database Values section of ovs-vsctl(8).

bare

The simple format with punctuation stripped off: [] and {} are omitted around sets, maps, and empty columns, items within sets and maps are space-separated, and strings are never quoted. This format may be easier for scripts to parse.

json

The RFC 4627 JSON format as described above.

--no-headings

This option suppresses the heading row that otherwise appears in the first row of table output.

--pretty

By default, JSON in output is printed as compactly as possible. This option causes JSON in output to be printed in a more readable fashion. Members of objects and elements of arrays are printed one per line, with indentation.

This option does not affect JSON in tables, which is always printed compactly.

--bare

Equivalent to --format=list --data=bare --no-headings.

--max-column-width=n

For table output only, limits the width of any column in the output to n columns. Longer cell data is truncated to fit, as necessary. Columns are always wide enough to display the column names, if the heading row is printed.

### Public Key Infrastructure Options
-p privkey.pem

--private-key=privkey.pem

Specifies a PEM file containing the private key used as vtep-ctl's identity for outgoing SSL connections.

-c cert.pem

--certificate=cert.pem

Specifies a PEM file containing a certificate that certifies the private key specified on -p or --private-key to be trustworthy. The certificate must be signed by the certificate authority (CA) that the peer in SSL connections will use to verify it.

-C cacert.pem

--ca-cert=cacert.pem

Specifies a PEM file containing the CA certificate that vtep-ctl should use to verify certificates presented to it by SSL peers. (This may be the same certificate that SSL peers use to verify the certificate specified on -c or --certificate, or it may be a different one, depending on the PKI design in use.)

-C none

--ca-cert=none

Disables verification of certificates presented by SSL peers. This introduces a security risk, because it means that certificates cannot be verified to be those of known trusted hosts.

--bootstrap-ca-cert=cacert.pem

When cacert.pem exists, this option has the same effect as -C or --ca-cert. If it does not exist, then vtep-ctl will attempt to obtain the CA certificate from the SSL peer on its first SSL connection and save it to the named PEM file. If it is successful, it will immediately drop the connection and reconnect, and from then on all SSL connections must be authenticated by a certificate signed by the CA certificate thus obtained.

This option exposes the SSL connection to a man-in-the-middle attack obtaining the initial CA certificate, but it may be useful for bootstrapping.

This option is only useful if the SSL peer sends its CA certificate as part of the SSL certificate chain. The SSL protocol does not require the server to send the CA certificate.

This option is mutually exclusive with -C and --ca-cert.

--peer-ca-cert=peer-cacert.pem

Specifies a PEM file that contains one or more additional certificates to send to SSL peers. peer-cacert.pem should be the CA certificate used to sign vtep-ctl's own certificate, that is, the certificate specified on -c or --certificate. If vtep-ctl's certificate is self-signed, then --certificate and --peer-ca-cert should specify the same file.

This option is not useful in normal operation, because the SSL peer must already have the CA certificate for the peer to have any confidence in vtep-ctl's identity. However, this offers a way for a new installation to bootstrap the CA certificate on its first SSL connection.

-v[spec]

--verbose=[spec]

Sets logging levels. Without any spec, sets the log level for every module and destination to dbg. Otherwise, spec is a list of words separated by spaces or commas or colons, up to one from each category below:

- A valid module name, as displayed by the vlog/list command on ovs-appctl(8), limits the log level change to the specified module.

- syslog, console, or file, to limit the log level change to only to the system log, to the console, or to a file, respectively. (If --detach is specified, vtep-ctl closes its standard file descriptors, so logging to the console will have no effect.)

On Windows platform, syslog is accepted as a word and is only useful along with the --syslog-target option (the word has no effect otherwise).

•

off, emer, err, warn, info, or dbg, to control the log level. Messages of the given severity or higher will be logged, and messages of lower severity will be filtered out. off filters out all messages. See ovs-appctl(8) for a definition of each log level.

Case is not significant within spec.

Regardless of the log levels set for file, logging to a file will not take place unless --log-file is also specified (see below).

For compatibility with older versions of OVS, any is accepted as a word but has no effect.

-v

--verbose

Sets the maximum logging verbosity level, equivalent to --verbose=dbg.

-vPATTERN:destination:pattern

--verbose=PATTERN:destination:pattern

Sets the log pattern for destination to pattern. Refer to ovs-appctl(8) for a description of the valid syntax for pattern.

-vFACILITY:facility

--verbose=FACILITY:facility

Sets the RFC5424 facility of the log message. facility can be one of kern, user, mail, daemon, auth, syslog, lpr, news, uucp, clock, ftp, ntp, audit, alert, clock2, local0, local1, local2, local3, local4, local5, local6 or local7. If this option is not specified, daemon is used as the default for the local system syslog and local0 is used while sending a message to the target provided via the --syslog-target option.

--log-file[=file]

Enables logging to a file. If file is specified, then it is used as the exact name for the log file. The default log file name used if file is omitted is /var/log/openvswitch/vtep-ctl.log.

--syslog-target=host:port

Send syslog messages to UDP port on host, in addition to the system syslog. The host must be a numerical IP address, not a hostname.

--syslog-method=method

Specify method how syslog messages should be sent to syslog daemon. Following forms are supported:

- libc, use libc syslog() function. Downside of using this options is that libc adds fixed prefix to every message before it is actually sent to the syslog daemon over /dev/log UNIX domain socket.

- unix:file, use UNIX domain socket directly. It is possible to specify arbitrary message format with this option. However, rsyslogd 8.9 and older versions use hard coded parser function anyway that limits UNIX domain socket use. If you want to use arbitrary message format with older rsyslogd versions, then use UDP socket to localhost IP address instead.

- udp:ip:port, use UDP socket. With this method it is possible to use arbitrary message format also with older rsyslogd. When sending syslog messages over UDP socket extra precaution needs to be taken into account, for example, syslog daemon needs to be configured to listen on the specified UDP port, accidental iptables rules could be interfering with local syslog traffic and there are some security considerations that apply to UDP sockets, but do not apply to UNIX domain sockets.

- null, discards all messages logged to syslog.

The default is taken from the OVS_SYSLOG_METHOD environment variable; if it is unset, the default is libc.

-h

--help

Prints a brief help message to the console.

-V

--version

Prints version information to the console.

## COMMANDS
The commands implemented by vtep-ctl are described in the sections below.

### Physical Switch Commands
These commands examine and manipulate physical switches.

[--may-exist] add-ps pswitch

Creates a new physical switch named pswitch. Initially the switch will have no ports.

Without --may-exist, attempting to create a switch that exists is an error. With --may-exist, this command does nothing if pswitch already exists.

[--if-exists] del-ps pswitch

Deletes pswitch and all of its ports.

Without --if-exists, attempting to delete a switch that does not exist is an error. With --if-exists, attempting to delete a switch that does not exist has no effect.

list-ps

Lists all existing physical switches on standard output, one per line.

ps-exists pswitch

Tests whether pswitch exists. If so, vtep-ctl exits successfully with exit code 0. If not, vtep-ctl exits unsuccessfully with exit code 2.

### Port Commands
These commands examine and manipulate VTEP physical ports.

list-ports pswitch

Lists all of the ports within pswitch on standard output, one per line.

[--may-exist] add-port pswitch port

Creates on pswitch a new port named port from the network device of the same name.

Without --may-exist, attempting to create a port that exists is an error. With --may-exist, this command does nothing if port already exists on pswitch.

[--if-exists] del-port [pswitch] port

Deletes port. If pswitch is omitted, port is removed from whatever switch contains it; if pswitch is specified, it must be the switch that contains port.

Without --if-exists, attempting to delete a port that does not exist is an error. With --if-exists, attempting to delete a port that does not exist has no effect.

### Logical Switch Commands
These commands examine and manipulate logical switches.

[--may-exist] add-ls lswitch

Creates a new logical switch named lswitch. Initially the switch will have no locator bindings.

Without --may-exist, attempting to create a switch that exists is an error. With --may-exist, this command does nothing if lswitch already exists.

[--if-exists] del-ls lswitch

Deletes lswitch.

Without --if-exists, attempting to delete a switch that does not exist is an error. With --if-exists, attempting to delete a switch that does not exist has no effect.

list-ls

Lists all existing logical switches on standard output, one per line.

ls-exists lswitch

Tests whether lswitch exists. If so, vtep-ctl exits successfully with exit code 0. If not, vtep-ctl exits unsuccessfully with exit code 2.

bind-ls pswitch port vlan lswitch

Bind logical switch lswitch to the port/vlan combination on the physical switch pswitch.

unbind-ls pswitch port vlan

Remove the logical switch binding from the port/vlan combination on the physical switch pswitch.

list-bindings pswitch port

List the logical switch bindings for port on the physical switch pswitch.

set-replication-mode lswitch replication-mode

Set logical switch lswitch replication mode to replication-mode; the only valid values for replication mode are "service_node" and "source_node". For handling L2 broadcast, multicast and unknown unicast traffic, packets can be sent to all members of a logical switch referenced by a physical switch. There are different modes to replicate the packets. The default mode of replication is to send the traffic to a service node, which can be a hypervisor, server or appliance, and let the service node handle replication to other transport nodes (hypervisors or other VTEP physical switches). This mode is called service node replication. An alternate mode of replication, called source node replication involves the source node sending to all other transport nodes. Hypervisors are always responsible for doing their own replication for locally attached VMs in both modes. Service node mode is the default, if the replication mode is not explicitly set. Service node replication mode is considered a basic requirement because it only requires sending the packet to a single transport node.

get-replication-mode lswitch

Get logical switch lswitch replication mode. The only valid values for replication mode are "service_node" and "source_node". An empty reply for replication mode implies a default of "service_node".

### Logical Router Commands
These commands examine and manipulate logical routers.

[--may-exist] add-lr lrouter

Creates a new logical router named lrouter.

Without --may-exist, attempting to create a router that exists is an error. With --may-exist, this command does nothing if lrouter already exists.

[--if-exists] del-lr lrouter

Deletes lrouter.

Without --if-exists, attempting to delete a router that does not exist is an error. With --if-exists, attempting to delete a router that does not exist has no effect.

list-lr

Lists all existing logical routers on standard output, one per line.

lr-exists lrouter

Tests whether lrouter exists. If so, vtep-ctl exits successfully with exit code 0. If not, vtep-ctl exits unsuccessfully with exit code 2.

### Local MAC Binding Commands
These commands examine and manipulate local MAC bindings for the logical switch. The local maps are written by the VTEP to refer to MACs it has learned on its physical ports.

add-ucast-local lswitch mac [encap] ip

Map the unicast Ethernet address mac to the physical location ip using encapsulation encap on lswitch. If encap is not specified, the default is "vxlan_over_ipv4". The local mappings are used by the VTEP to refer to MACs learned on its physical ports.

del-ucast-local lswitch mac

Remove the local unicast Ethernet address mac map from lswitch. The local mappings are used by the VTEP to refer to MACs learned on its physical ports.

add-mcast-local lswitch mac [encap] ip

Add physical location ip using encapsulation encap to the local mac binding table for multicast Ethernet address mac on lswitch. If encap is not specified, the default is "vxlan_over_ipv4". The local mappings are used by the VTEP to refer to MACs learned on its physical ports.

del-mcast-local lswitch mac [encap] ip

Remove physical location ip using encapsulation encap from the local mac binding table for multicast Ethernet address mac on lswitch. If encap is not specified, the default is "vxlan_over_ipv4". The local mappings are used by the VTEP to refer to MACs learned on its physical ports.

clear-local-macs lswitch

Clear the local MAC bindings for lswitch.

list-local-macs lswitch

List the local MAC bindings for lswitch, one per line.

### Remote MAC Binding Commands
These commands examine and manipulate local and remote MAC bindings for the logical switch. The remote maps are written by the network virtualization controller to refer to MACs that it has learned.

add-ucast-remote lswitch mac [encap] ip

Map the unicast Ethernet address mac to the physical location ip using encapsulation encap on lswitch. If encap is not specified, the default is "vxlan_over_ipv4". The remote mappings are used by the network virtualization platform to refer to MACs that it has learned.

del-ucast-remote lswitch mac

Remove the remote unicast Ethernet address mac map from lswitch. The remote mappings are used by the network virtualization platform to refer to MACs that it has learned.

add-mcast-remote lswitch mac [encap] ip

Add physical location ip using encapsulation encap to the remote mac binding table for multicast Ethernet address mac on lswitch. If encap is not specified, the default is "vxlan_over_ipv4". The remote mappings are used by the network virtualization platform to refer to MACs that it has learned.

del-mcast-remote lswitch mac [encap] ip

Remove physical location ip using encapsulation encap from the remote mac binding table for multicast Ethernet address mac on lswitch. If encap is not specified, the default is "vxlan_over_ipv4". The remote mappings are used by the network virtualization platform to refer to MACs that it has learned.

clear-remote-macs lswitch

Clear the remote MAC bindings for lswitch.

list-remote-macs lswitch

List the remote MAC bindings for lswitch, one per line.

### Manager Connectivity
These commands manipulate the managers column in the Global table and rows in the Managers table. When ovsdb-server is configured to use the managers column for OVSDB connections (as described in the startup scripts provided with Open vSwitch), this allows the administrator to use vtep-ctl to configure database connections.

get-manager

Prints the configured manager(s).

del-manager

Deletes the configured manager(s).

set-manager target...

Sets the configured manager target or targets. Each target may be an OVSDB active or passive connection method, e.g. pssl:6640, as described in ovsdb(7).

### Database Commands
These commands query and modify the contents of ovsdb tables. They are a slight abstraction of the ovsdb interface and as such they operate at a lower level than other vtep-ctl commands.

Identifying Tables, Records, and Columns

Each of these commands has a table parameter to identify a table within the database. Many of them also take a record parameter that identifies a particular record within a table. The record parameter may be the UUID for a record, and many tables offer additional ways to identify records. Some commands also take column parameters that identify a particular field within the records in a table.

The following tables are currently defined:

Global

Top-level configuration for a hardware VTEP. This table contains exactly one record, identified by specifying . as the record name.

Manager

Configuration for an OVSDB connection. Records may be identified by target (e.g. tcp:1.2.3.4).

Physical_Switch

A physical switch that implements a VTEP. Records may be identified by physical switch name.

Physical_Port

A port within a physical switch.

Logical_Binding_Stats

Reports statistics for the logical switch with which a VLAN on a physical port is associated.

Logical_Switch

A logical Ethernet switch. Records may be identified by logical switch name.

Ucast_Macs_Local

Mapping of locally discovered unicast MAC addresses to tunnels.

Ucast_Macs_Remote

Mapping of remotely programmed unicast MAC addresses to tunnels.

Mcast_Macs_Local

Mapping of locally discovered multicast MAC addresses to tunnels.

Mcast_Macs_Remote

Mapping of remotely programmed multicast MAC addresses to tunnels.

Physical_Locator_Set

A set of one or more physical locators.

Physical_Locator

Identifies an endpoint to which logical switch traffic may be encapsulated and forwarded. Records may be identified by physical locator name.

Record names must be specified in full and with correct capitalization, except that UUIDs may be abbreviated to their first 4 (or more) hex digits, as long as that is unique within the table. Names of tables and columns are not case-sensitive, and - and _ are treated interchangeably. Unique abbreviations of table and column names are acceptable, e.g. man or m is sufficient to identify the Manager table.

Database Values

Each column in the database accepts a fixed type of data. The currently defined basic types, and their representations, are:

integer

A decimal integer in the range -2**63 to 2**63-1, inclusive.

real

A floating-point number.

Boolean

True or false, written true or false, respectively.

string

An arbitrary Unicode string, except that null bytes are not allowed. Quotes are optional for most strings that begin with an English letter or underscore and consist only of letters, underscores, hyphens, and periods. However, true and false and strings that match the syntax of UUIDs (see below) must be enclosed in double quotes to distinguish them from other basic types. When double quotes are used, the syntax is that of strings in JSON, e.g. backslashes may be used to escape special characters. The empty string must be represented as a pair of double quotes ("").

UUID

Either a universally unique identifier in the style of RFC 4122, e.g. f81d4fae-7dec-11d0-a765-00a0c91e6bf6, or an @name defined by a get or create command within the same vtep-ctl invocation.

Multiple values in a single column may be separated by spaces or a single comma. When multiple values are present, duplicates are not allowed, and order is not important. Conversely, some database columns can have an empty set of values, represented as [], and square brackets may optionally enclose other non-empty sets or single values as well. For a column accepting a set of integers, database commands accept a range. A range is represented by two integers separated by -. A range is inclusive. A range has a maximum size of 4096 elements. If more elements are needed, they can be specified in separate ranges.

A few database columns are ``maps'' of key-value pairs, where the key and the value are each some fixed database type. These are specified in the form key=value, where key and value follow the syntax for the column's key type and value type, respectively. When multiple pairs are present (separated by spaces or a comma), duplicate keys are not allowed, and again the order is not important. Duplicate values are allowed. An empty map is represented as {}. Curly braces may optionally enclose non-empty maps as well (but use quotes to prevent the shell from expanding other-config={0=x,1=y} into other-config=0=x other-config=1=y, which may not have the desired effect).

Database Command Syntax

[--if-exists] [--columns=column[,column]...] list table [record]...

Lists the data in each specified record. If no records are specified, lists all the records in table.

If --columns is specified, only the requested columns are listed, in the specified order. Otherwise, all columns are listed, in alphabetical order by column name.

Without --if-exists, it is an error if any specified record does not exist. With --if-exists, the command ignores any record that does not exist, without producing any output.

[--columns=column[,column]...] find table [column[:key]=value]...

Lists the data in each record in table whose column equals value or, if key is specified, whose column contains a key with the specified value. The following operators may be used where = is written in the syntax summary:

= != < > <= >=

Selects records in which column[:key] equals, does not equal, is less than, is greater than, is less than or equal to, or is greater than or equal to value, respectively.

Consider column[:key] and value as sets of elements. Identical sets are considered equal. Otherwise, if the sets have different numbers of elements, then the set with more elements is considered to be larger. Otherwise, consider a element from each set pairwise, in increasing order within each set. The first pair that differs determines the result. (For a column that contains key-value pairs, first all the keys are compared, and values are considered only if the two sets contain identical keys.)

{=} {!=}

Test for set equality or inequality, respectively.

{<=}

Selects records in which column[:key] is a subset of value. For example, flood-vlans{<=}1,2 selects records in which the flood-vlans column is the empty set or contains 1 or 2 or both.

{<}

Selects records in which column[:key] is a proper subset of value. For example, flood-vlans{<}1,2 selects records in which the flood-vlans column is the empty set or contains 1 or 2 but not both.

{>=} {>}

Same as {<=} and {<}, respectively, except that the relationship is reversed. For example, flood-vlans{>=}1,2 selects records in which the flood-vlans column contains both 1 and 2.

The following operators are available only in Open vSwitch 2.16 and later:

{in}

Selects records in which every element in column[:key] is also in value. (This is the same as {<=}.)

{not-in}

Selects records in which every element in column[:key] is not in value.

For arithmetic operators (= != < > <= >=), when key is specified but a particular record's column does not contain key, the record is always omitted from the results. Thus, the condition other-config:mtu!=1500 matches records that have a mtu key whose value is not 1500, but not those that lack an mtu key.

For the set operators, when key is specified but a particular record's column does not contain key, the comparison is done against an empty set. Thus, the condition other-config:mtu{!=}1500 matches records that have a mtu key whose value is not 1500 and those that lack an mtu key.

Don't forget to escape < or > from interpretation by the shell.

If --columns is specified, only the requested columns are listed, in the specified order. Otherwise all columns are listed, in alphabetical order by column name.

The UUIDs shown for rows created in the same vtep-ctl invocation will be wrong.

[--if-exists] [--id=@name] get table record [column[:key]]...

Prints the value of each specified column in the given record in table. For map columns, a key may optionally be specified, in which case the value associated with key in the column is printed, instead of the entire map.

Without --if-exists, it is an error if record does not exist or key is specified, if key does not exist in record. With --if-exists, a missing record yields no output and a missing key prints a blank line.

If @name is specified, then the UUID for record may be referred to by that name later in the same vtep-ctl invocation in contexts where a UUID is expected.

Both --id and the column arguments are optional, but usually at least one or the other should be specified. If both are omitted, then get has no effect except to verify that record exists in table.

--id and --if-exists cannot be used together.

[--if-exists] set table record column[:key]=value...

Sets the value of each specified column in the given record in table to value. For map columns, a key may optionally be specified, in which case the value associated with key in that column is changed (or added, if none exists), instead of the entire map.

Without --if-exists, it is an error if record does not exist. With --if-exists, this command does nothing if record does not exist.

[--if-exists] add table record column [key=]value...

Adds the specified value or key-value pair to column in record in table. If column is a map, then key is required, otherwise it is prohibited. If key already exists in a map column, then the current value is not replaced (use the set command to replace an existing value).

Without --if-exists, it is an error if record does not exist. With --if-exists, this command does nothing if record does not exist.

[--if-exists] remove table record column value...

[--if-exists] remove table record column key...

[--if-exists] remove table record column key=value...

Removes the specified values or key-value pairs from column in record in table. The first form applies to columns that are not maps: each specified value is removed from the column. The second and third forms apply to map columns: if only a key is specified, then any key-value pair with the given key is removed, regardless of its value; if a value is given then a pair is removed only if both key and value match.

It is not an error if the column does not contain the specified key or value or pair.

Without --if-exists, it is an error if record does not exist. With --if-exists, this command does nothing if record does not exist.

[--if-exists] clear table record column...

Sets each column in record in table to the empty set or empty map, as appropriate. This command applies only to columns that are allowed to be empty.

Without --if-exists, it is an error if record does not exist. With --if-exists, this command does nothing if record does not exist.

[--id=(@name | uuid] create table column[:key]=value...

Creates a new record in table and sets the initial values of each column. Columns not explicitly set will receive their default values. Outputs the UUID of the new row.

If @name is specified, then the UUID for the new row may be referred to by that name elsewhere in the same vtep-ctl invocation in contexts where a UUID is expected. Such references may precede or follow the create command.

If a valid uuid is specified, then it is used as the UUID of the new row.

Caution (ovs-vsctl as example)

Records in the Open vSwitch database are significant only when they can be reached directly or indirectly from the Open_vSwitch table. Except for records in the QoS or Queue tables, records that are not reachable from the Open_vSwitch table are automatically deleted from the database. This deletion happens immediately, without waiting for additional ovs-vsctl commands or other database activity. Thus, a create command must generally be accompanied by additional commands within the same ovs-vsctl invocation to add a chain of references to the newly created record from the top-level Open_vSwitch record. The EXAMPLES section gives some examples that show how to do this.

[--if-exists] destroy table record...

Deletes each specified record from table. Unless --if-exists is specified, each records must exist.

--all destroy table

Deletes all records from the table.

Caution (ovs-vsctl as example)

The destroy command is only useful for records in the QoS or Queue tables. Records in other tables are automatically deleted from the database when they become unreachable from the Open_vSwitch table. This means that deleting the last reference to a record is sufficient for deleting the record itself. For records in these tables, destroy is silently ignored. See the EXAMPLES section below for more information.

wait-until table record [column[:key]=value]...

Waits until table contains a record named record whose column equals value or, if key is specified, whose column contains a key with the specified value. This command supports the same operators and semantics described for the find command above.

If no column[:key]=value arguments are given, this command waits only until record exists. If more than one such argument is given, the command waits until all of them are satisfied.

Caution (ovs-vsctl as example)

Usually wait-until should be placed at the beginning of a set of ovs-vsctl commands. For example, wait-until bridge br0 -- get bridge br0 datapath_id waits until a bridge named br0 is created, then prints its datapath_id column, whereas get bridge br0 datapath_id -- wait-until bridge br0 will abort if no bridge named br0 exists when ovs-vsctl initially connects to the database.

Consider specifying --timeout=0 along with --wait-until, to prevent vtep-ctl from terminating after waiting only at most 5 seconds.

comment [arg]...

This command has no effect on behavior, but any database log record created by the command will include the command and its arguments.

## EXIT STATUS
0

Successful program execution.

1

Usage, syntax, or configuration file error.

2

The switch argument to ps-exists specified the name of a physical switch that does not exist.

## SEE ALSO
ovsdb-server(1), vtep(5).


oping

package: oping

title: oping(8)

summary: send ICMP ECHO_REQUEST to network hosts

text:
# oping(8)

## NAME
oping - send ICMP ECHO_REQUEST to network hosts

## SYNOPSIS
oping [-4 | -6] [-c count] [-i interval] host [host [host ...]]

oping [-4 | -6] [-c count] [-i interval] -f filename

noping [-4 | -6] [-c count] [-i interval] host [host [host ...]]

noping [-4 | -6] [-c count] [-i interval] -f filename

## DESCRIPTION
oping uses ICMPv4 or ICMPv6 ECHO_REQUEST packets to measure a hosts reachability and the network latency. In contrast to the original ping(8) utility oping can send ICMP packets to multiple hosts in parallel and wait for all ECHO_RESPONSE packets to arrive. In contrast to the fping utility (URL is listed in "SEE ALSO") oping can use both, IPv4 and IPv6 transparently and side by side.

noping is an ncurses-based front-end to liboping which displays ping statistics online and highlights aberrant round-trip times if the terminal supports colors.

## OPTIONS
-4

Force the use of IPv4.

-6

Force the use of IPv6.

-c count

Send (and receive) count ICMP packets, then stop and exit.

-i interval

Send one ICMP packet (per host) each interval seconds. This can be a floating-point number to specify sub-second precision.

-w timeout

Specifies the time to wait for an "ECHO REPLY" packet before giving up, in seconds. This can be a floating point number for sub-second precision. Defaults to 1.0 seconds.

-t ttl

Set the IP Time to Live to ttl. This must be a number between (and including) 1 and 255. If omitted, the value 64 is used.

-I address

Set the source address to use. You may either specify an IP number or a hostname. You cannot pass the interface name, as you can with GNU's ping(8) - use the -D option for that purpose.

-D interface name

Set the outgoing network device to use.

-f filename

Instead of specifying hostnames on the command line, read them from filename. If filename is -, read from "STDIN". If oping is installed with the SetUID-bit, it will set the effective UID to the real UID before opening the file. In the special (but common) case that oping is owned by the super-user (UID 0), this means that privileges are temporarily dropped before opening the file, in order to prevent users from reading arbitrary files on the system.

If your system doesn't provide saved set-user IDs (this was an optional feature before POSIX 2001), the behavior is different because it is not possible to temporarily drop privileges. The alternative behavior is: If the real user ID (as returned by getuid(2)) and the effective user ID (as returned by geteuid(2)) differ, the only argument allowed for this option is "-" (i.e. standard input).

-O filename

Write measurements in Comma Separated Values (CSV) format to filename. This option writes three columns per row: wall clock time in (fractional) seconds since epoch, hostname and the round trip time in milliseconds.

-Q qos

Specify the Quality of Service (QoS) for outgoing packets. This is a somewhat tricky option, since the meaning of the bits in the IPv4 header has been revised several times. The currently recommended method is Differentiated Services which is used in IPv6 headers as well. There are shortcuts for various predefined per-hop behaviors (PHBs):

be

Selects the Best Effort behavior. This is the default behavior.

ef

Selects the Expedited Forwarding (EF) per-hop behavior, as defined in RFC 3246. This PHB is characterised by low delay, low loss and low jitter, i.e. high priority traffic.

va

Selects the Voice Admitted (VA) per-hop behavior, as defined in RFC 5865. This traffic class is meant for Voice over IP (VoIP) traffic which uses Call Admission Control (CAC) for reserving network capacity.

afcp

Selects one of 12 differentiated services code points (DSCPs), which are organized in four classes with three priorities each. Therefore, c must be a number between 1 through 4 and p must be a number between 1 through 3, for example "af13", "af22" and "af41". In each class, the lower priority number takes precedence over the higher priority number.

csn

Selects one of the eight Class Selector PHBs. n is a number between 0 through 7. The class selectors have been defined to be compatible to the Precedence field in the IPv4 header as defined in RFC 791. Please note that "cs0" is synonymous to "be".

The old definition of the same bits in the IPv4 header was as Type of Service (ToS) field, specified in RFC 1349. It defined four possible values which have appropriate aliases. Please note that this use of the bits is deprecated and the meaning is limited to IPv4!

lowdelay

Minimize delay

throughput

Maximize throughput

reliability

Maximize reliability

mincost

Minimize monetary cost

Alternatively, you can also specify the byte manually. You can use either a decimal number (0-255), a hexadecimal number (0x00-0xff) or an octal number (00-0377) using the usual "0x" and "0" prefixes for hexadecimal and octal respectively.

The printed lines will contain information about the QoS field of received packets if either a non-standard QoS setting was used on outgoing packets or if the QoS byte of incoming packets is not zero. In other words, the QoS information is omitted if both, the outgoing and the incoming QoS bytes are zero. The received byte is always interpreted as Differentiated Services Code Point (DSCP) and Explicit Congestion Notification (ECN), even if the deprecated Type of Service (ToS) aliases were used to specify the bits of outgoing packets.

-m mark

Linux only Sets the mark (an integer number) on outgoing packets. This can be used by iptables(8) and other networking infrastructure for filtering and routing.

-u|-U

noping only -u forces UTF-8 output, -U disables UTF-8 output. If neither is given, the codeset is automatically determined from the locale.

-g none|prettyping|boxplot|histogram

noping only Selects the graph to display.

none

Do not show a graph.

prettyping

Show a graph with time on the x-axis, the y-axis shows the round-trip time. This is the default graph. If your terminal supports unicode and colors, they are used to improve the precision of the data shown: a green box is drawn for round-trip times up to one third of the configured timeout, the height representing the RTT. Longer RTTs will start to fill the box yellow (with a green background) and then red (with a yellow background). Lost packages are drawn as a bold red explamation mark.

boxplot

Show a box plot where the x-axis, i.e. the width of the window, is the round-trip time. The entire width of the window it the ping interval, set with the -i option. The box is sized so it contains 50% of the replies. The vertical line shows the median. The whiskers are sized to contain 95% of the replies -- 2.5% below the whiskers and 2.5% above.

```
  |----------[#####|##########]--------------------------------------------|
  ^          ^     ^          ^                                            ^
 2.5%       25%   50%        75%                                         97.5%

```

histogram

Show a histrogram of the round-trip times. The width of the window is taken as round-trip time from 0ms on the left to the interval (the -i option, default 1000ms) on the right. The height of the graph is scaled so that the most-used buckets vertically fills the line. The buckets are colored green up to and including the 80th percentile, yellow up to and including the 95th percentile and red for the remainder.

-b

Audible bell. Print a ASCII BEL character (\a or 0x07) when a packet is received before the timeout occurs. This can be useful in order to monitory hosts' connectivity without looking physically at the console, for example to trace network cables (start audible beep, disconnect cable N: if beep stops, the cable was in use) or to tell when a host returns from a reboot. This relies on the terminal bell to be functional. To enable the terminal bell, use the following instructions.

- the visual bell is disabled in your terminal emulator, with the +vb commandline flag or the following in your .Xresources:

```
 XTerm*visualBell: false

```

- the PC speaker module is loaded in your kernel:

```
 modprobe pcspkr

```

- X11 has the terminal bell enabled:

```
 xset b on; xset b 100

```

- and finally, if you are using PulseAudio, that the module-x11-bell module is loaded with a pre-loaded sample defined in your pulseaudio configuration:

```
 load-sample-lazy x11-bell /usr/share/sounds/freedesktop/stereo/complete.oga
 load-module module-x11-bell sample=x11-bell

```

-P percent

Configures the latency percentile to report. percent must be a number between zero and 100, exclusively in both cases. In general, defaults to 95. If -c is given and a number less than 20, this would be the same as the maximum. In this case the default is chosen so that it excludes the maximum, e.g. if -c 5 is given, the default is 80. The calculated percentile is based on the last 900 packets (15 minutes with the default interval).

-Z percent

If any hosts have a drop rate higher than percent, where percent is a number between zero and 100 inclusively, exit with a non-zero exit status. Since it is not possible to have a higher drop rate than 100%, passing this limit will effectively disable the feature (the default). Setting the option to zero means that the exit status will only be zero if all replies for all hosts have been received. The exit status will indicate the number of hosts with more than percent packets lost, up to a number of 255 failing hosts.

## COLORS
If supported by the terminal, noping will highlight the round-trip times (RTT) using the colors green, yellow and red. Green signals RTTs that are in the "expected" range, yellow marks moderately unusual times and times that differ a lot from the expected value are printed in red.

The information used to categorize round-trip times is the percentile. RTTs in the 80th percentile are considered to be "normal" and are printed in green. RTTs within the 95th percentile are considered "moderately unusual" and are printed in yellow. RTTs above that are considered to be "unusual" and are printed in red.

## INTERACTIVE KEYBOARD CONTROLS
When running noping, the type of graph being displayed can be changed by using the g key. A new host can be added at any time with the a key.

## SEE ALSO
ping(8), <http://fping.org/>, liboping(3)

## LICENSE
oping and noping are licensed under the GPL 2. No other version of the license is applicable.

## AUTHOR
liboping is written by Florian "octo" Forster <ff at octo.it>. Its homepage can be found at <http://noping.cc/>.

Copyright (c) 2006-2017 by Florian "octo" Forster.

branch: sisyphus


ostree-state-overlay@.service

package: ostree

title: ostree-state-overlay@.service(8)

summary: Set up state overlays

text:
# ostree-state-overlay@.service(8)

## NAME
ostree-state-overlay@.service - Set up state overlays

## SYNOPSIS
ostree-state-overlay@.service

## EXPERIMENTAL
Note this feature is currently considered experimental. It may not work correctly and some of its semantics may be subject to change. Positive or negative feedback are both welcome and may be provided at https://github.com/ostreedev/ostree/discussions. If using the feature via rpm-ostree, feedback may also be provided at https://github.com/coreos/rpm-ostree/issues/233.

## DESCRIPTION
In some cases, it's useful to be able to have a directory as part of the OSTree commit yet still have this directory be writable client-side. One example is software that ships in /opt. /opt is its own vendor-namespaced alternate file hierarchy which may contain both code and state. With state overlays, it's possible to have the code part baked in the OSTree, but still allowing the directory to be writable so that state can be kept there.

Since it's writable, nothing prevents sufficiently privileged code to modify or delete content that comes from the OSTree commit. This is in sharp contrast with content in /usr, and more closely matches a package manager-based distro.

Crucially, this state is automatically rebased during upgrades (or more generally, anytime a different OSTree commit is booted). The semantics of the rebase are as follows: any state file or directory that modified OSTree content is deleted, otherwise it is kept and merged onto the new base content (using overlayfs). This mostly matches the semantics of a package manager.

To enable this feature, simply instantiate the unit template, using the target path (in escaped systemd path notation) as the instance name. For example, to enable it on /opt:

```
    $ systemctl enable --now ostree-state-overlay@opt.service

```


ovn-appctl

package: ovn

title: ovn-appctl(8)

text:
# ovn-appctl(8)

## NAME
ovn-appctl - utility for configuring running OVN daemons

## SYNOPSIS
ovn-appctl [-target=target | -t target] [-T secs | -timeout=secs] command [arg...]

ovn-appctl -help

ovn-appctl -version

## DESCRIPTION
OVN daemons accept certain commands at runtime to control their behavior and query their settings. Every daemon accepts a common set of commands documented under COMMON COMMANDS below. Some daemons support additional commands documented in their own manpages.

The ovn-appctl program provides a simple way to invoke these commands. The command to be sent is specified on ovn-appctl’s command line as non-option arguments. ovn-appctl sends the command and prints the daemon’s response on standard output.

ovn-ctl is exactly similar to Open vSwitch ovs-appctl utility.

## COMMAND COMMANDS
Every OVN daemon supports a common set of commands, which are documented in this section.

### General Commands
These commands display daemon-specific commands and the running version. Note that these commands are different from the -help and -version options that return information about the ovn-appctl utility itself.

list-commands

Lists the commands supported by the target.

version

Displays the version and compilation date of the target.

### Logging Commands
OVN has several log levels. The highest-severity log level is:

off

No message is ever logged at this level, so setting a logging destination’s log level to off disables logging to that destination.

The following log levels, in order of descending severity, are available:

emer

A major failure forced a process to abort.

err

A high-level operation or a subsystem failed. Attention is warranted.

warn

A low-level operation failed, but higher-level subsystems may be able to recover.

info

Information that may be useful in retrospect when investigating a problem.

dbg

Information useful only to someone with intricate knowledge of the system, or that would commonly cause too-voluminous log output. Log messages at this level are not logged by default.

Every OVN daemon supports the following commands for examining and adjusting log levels.

vlog/list

Lists the known logging modules and their current levels.

vlog/list-pattern

Lists logging pattern used for each destination.

vlog/set [spec]

Sets logging levels. Without any spec, sets the log level for every module and destination to dbg. Otherwise, spec is a list of words separated by spaces or commas or colons, up to one from each category below:

- A valid module name, as displayed by the vlog/list command on ovn-appctl(8), limits the log level change to the specified module.

- syslog, console, or file, to limit the log level change to only to the system log, to the console, or to a file, respectively.

On Windows platform, syslog is accepted as a word and is only useful if the target was started with the --syslog-target option (the word has no effect otherwise).

•

off, emer, err, warn, info, or dbg, to control the log level. Messages of the given severity or higher will be logged, and messages of lower severity will be filtered out. off filters out all messages.

Case is not significant within spec.

vlog/set PATTERN:destination: pattern

Sets the log pattern for destination to pattern. Each time a message is logged to destination, pattern determines the message’s formatting. Most characters in pattern are copied literally to the log, but special escapes beginning with % are expanded as follows:

- %A : The name of the application logging the message, e.g. ovn-controller.

- %B : The RFC5424 syslog PRI of the message.

- %c : The name of the module (as shown by ovn-appctl -list) logging the message.

- %d : The current date and time in ISO 8601 format (YYYY-MM-DD HH:MM:SS).

- %d{format} : The current date and time in the specified format, which takes the same format as the template argument to strftime(3). As an extension, any # characters in format will be replaced by fractional seconds, e.g. use %H:%M:%S.### for the time to the nearest millisecond. Sub-second times are only approximate and currently decimal places after the third will always be reported as zero.

- %D : The current UTC date and time in ISO 8601 format (YYYY-MM-DD HH:MM:SS).

- %D{format} : The current UTC date and time in the specified format, which takes the same format as the template argument to strftime(3). Supports the same extension for sub-second resolution as %d{...}.

- %E : The hostname of the node running the application.

- %m : The message being logged.

- %N : A serial number for this message within this run of the program, as a decimal number. The first message a program logs has serial number 1, the second one has serial number 2, and so on.

- %n : A new-line.

- %p : The level at which the message is logged, e.g. DBG.

- %P : The program’s process ID (pid), as a decimal number.

- %r : The number of milliseconds elapsed from the start of the application to the time the message was logged.

- %t : The subprogram name, that is, an identifying name for the process or thread that emitted the log message, such as monitor for the process used for -monitor or main for the primary process or thread in a program.

- %T : The subprogram name enclosed in parentheses, e.g. (monitor), or the empty string for the primary process or thread in a program.

- %% : A literal %.

A few options may appear between the % and the format specifier character, in this order:

- - : Left justify the escape’s expansion within its field width. Right justification is the default.

- - : Pad the field to the field width with 0s. Padding with spaces is the default.

width A number specifies the minimum field width. If the escape expands to fewer characters than width then it is padded to fill the field width. (A field wider than width is not truncated to fit.)

The default pattern for console and file output is %D{%Y-%m-%dT %H:%M:%SZ}|%05N|%c|%p|%m; for syslog output, %05N|%c|%p|%m.

vlog/set FACILITY:facility

Sets the RFC5424 facility of the log message. facility can be one of kern, user, mail, daemon, auth, syslog, lpr, news, uucp, clock, ftp, ntp, audit, alert, clock2, local0, local1, local2, local3, local4, local5, local6 or local7.

vlog/close

Causes the daemon to close its log file, if it is open. (Use vlog/reopen to reopen it later.)

vlog/reopen

Causes the daemon to close its log file, if it is open, and then reopen it. (This is useful after rotating log files, to cause a new log file to be used.)

This has no effect if the target application was not invoked with the --log-file option.

## OPTIONS
-h

--help

Prints a brief help message to the console.

-V

--version

Prints version information to the console.


ovn-ctl

title: ovn-ctl(8)

text:
# ovn-ctl(8)

## NAME
ovn-ctl - Open Virtual Network northbound daemon lifecycle utility

## SYNOPSIS
ovn-ctl [options] command [-- extra_args]

## DESCRIPTION
This program is intended to be invoked internally by Open Virtual Network startup scripts. System administrators should not normally invoke it directly.

## COMMANDS
start_northd

start_controller

start_controller_vtep

start_ic

stop_northd

stop_controller

stop_controller_vtep

stop_ic

restart_northd

restart_controller

restart_controller_vtep

restart_ic

promote_ovnnb

promote_ovnsb

demote_ovnnb

demote_ovnsb

status_ovnnb

status_ovnsb

start_ovsdb

start_nb_ovsdb

start_sb_ovsdb

stop_ovsdb

stop_nb_ovsdb

stop_sb_ovsdb

restart_ovsdb

run_nb_ovsdb

run_sb_ovsdb

promote_ic_nb

promote_ic_sb

demote_ic_nb

demote_ic_sb

status_ic_nb

status_ic_sb

start_ic_ovsdb

start_ic_nb_ovsdb

start_ic_sb_ovsdb

stop_ic_ovsdb

stop_ic_nb_ovsdb

stop_ic_sb_ovsdb

restart_ic_ovsdb

run_ic_nb_ovsdb

run_ic_sb_ovsdb

## OPTIONS
--ovn-northd-priority=NICE

--ovn-northd-wrapper=WRAPPER

--ovn-controller-priority=NICE

--ovn-controller-wrapper=WRAPPER

--ovn-ic-priority=NICE

--ovn-ic-wrapper=WRAPPER

--ovsdb-nb-wrapper=WRAPPER

--ovsdb-sb-wrapper=WRAPPER

--ovn-user=USER:GROUP

-h | --help

## FILE LOCATION OPTIONS
--db-sock=SOCKET

--db-nb-file=FILE

--db-sb-file=FILE

--db-nb-schema=FILE

--db-sb-schema=FILE

--db-sb-create-insecure-remote=yes|no

--db-nb-create-insecure-remote=yes|no

--db-ic-nb-file=FILE

--db-ic-sb-file=FILE

--db-ic-nb-schema=FILE

--db-ic-sb-schema=FILE

--db-ic-sb-create-insecure-remote=yes|no

--db-ic-nb-create-insecure-remote=yes|no

--ovn-controller-ssl-key=KEY

--ovn-controller-ssl-cert=CERT

--ovn-controller-ssl-ca-cert=CERT

--ovn-controller-ssl-bootstrap-ca-cert=CERT

## ADDRESS AND PORT OPTIONS
--db-nb-sync-from-addr=IP ADDRESS

--db-nb-sync-from-port=PORT NUMBER

--db-nb-sync-from-proto=PROTO

--db-sb-sync-from-addr=IP ADDRESS

--db-sb-sync-from-port=PORT NUMBER

--db-sb-sync-from-proto=PROTO

--db-ic-nb-sync-from-addr=IP ADDRESS

--db-ic-nb-sync-from-port=PORT NUMBER

--db-ic-nb-sync-from-proto=PROTO

--db-ic-sb-sync-from-addr=IP ADDRESS

--db-ic-sb-sync-from-port=PORT NUMBER

--db-ic-sb-sync-from-proto=PROTO

--ovn-northd-nb-db=PROTO:IP ADDRESS: PORT..

--ovn-northd-sb-db=PROTO:IP ADDRESS: PORT..

--ovn-ic-nb-db=PROTO:IP ADDRESS: PORT..

--ovn-ic-sb-db=PROTO:IP ADDRESS: PORT..

## CLUSTERING OPTIONS
--db-nb-cluster-local-addr=IP ADDRESS

--db-nb-cluster-local-port=PORT NUMBER

--db-nb-cluster-local-proto=PROTO (tcp/ssl)

--db-nb-cluster-remote-addr=IP ADDRESS

--db-nb-cluster-remote-port=PORT NUMBER

--db-nb-cluster-remote-proto=PROTO (tcp/ssl)

--db-nb-election-timer=Timeout in milliseconds

--db-sb-cluster-local-addr=IP ADDRESS

--db-sb-cluster-local-port=PORT NUMBER

--db-sb-cluster-local-proto=PROTO (tcp/ssl)

--db-sb-cluster-remote-addr=IP ADDRESS

--db-sb-cluster-remote-port=PORT NUMBER

--db-sb-cluster-remote-proto=PROTO (tcp/ssl)

--db-sb-election-timer=Timeout in milliseconds

--db-ic-nb-cluster-local-addr=IP ADDRESS

--db-ic-nb-cluster-local-port=PORT NUMBER

--db-ic-nb-cluster-local-proto=PROTO (tcp/ssl)

--db-ic-nb-cluster-remote-addr=IP ADDRESS

--db-ic-nb-cluster-remote-port=PORT NUMBER

--db-ic-nb-cluster-remote-proto=PROTO (tcp/ssl)

--db-ic-sb-cluster-local-addr=IP ADDRESS

--db-ic-sb-cluster-local-port=PORT NUMBER

--db-ic-sb-cluster-local-proto=PROTO (tcp/ssl)

--db-ic-sb-cluster-remote-addr=IP ADDRESS

--db-ic-sb-cluster-remote-port=PORT NUMBER

--db-ic-sb-cluster-remote-proto=PROTO (tcp/ssl)

--db-cluster-schema-upgrade=yes|no

## PROBE INTERVAL OPTIONS
--db-nb-probe-interval-to-active=Time in milliseconds

--db-sb-probe-interval-to-active=Time in milliseconds

## EXTRA OPTIONS
Any options after ’-’ will be passed on to the binary run by command with the exception of start_northd, which can have options specified in ovn-northd-db-params.conf. Any extra_args passed to start_northd will be passed to the ovsdb-servers if --ovn-manage-ovsdb=yes

## CONFIGURATION FILES
Following are the optional configuration files. If present, it should be located in the etc dir

### ovnnb-active.conf
If present, this file should hold the url to connect to the active Northbound DB server

tcp:x.x.x.x:6641

### ovnsb-active.conf
If present, this file should hold the url to connect to the active Southbound DB server

tcp:x.x.x.x:6642

### ovn-northd-db-params.conf
If present, start_northd will not start the DB server even if --ovn-manage-ovsdb=yes. This file should hold the database url parameters to be passed to ovn-northd.

--ovnnb-db=tcp:x.x.x.x:6641 --ovnsb-db=tcp:x.x.x.x:6642

### ic-nb-active.conf
If present, this file should hold the url to connect to the active Interconnection Northbound DB server

tcp:x.x.x.x:6645

### ic-sb-active.conf
If present, this file should hold the url to connect to the active Interconnection Southbound DB server

tcp:x.x.x.x:6646

### ovn-ic-db-params.conf
If present, this file should hold the database url parameters to be passed to ovn-ic.

--ic-nb-db=tcp:x.x.x.x:6645 --ic-sb-db=tcp:x.x.x.x:6646

## RUNNING OVN DB SERVERS WITHOUT DETACHING
\# ovn-ctl run_nb_ovsdb

This command runs the OVN nb ovsdb-server without passing the detach option, making it to block until ovsdb-server exits. This command will be useful for starting the OVN nb ovsdb-server in a container.

\# ovn-ctl run_sb_ovsdb

This command runs the OVN sb ovsdb-server without passing the detach option, making it to block until ovsdb-server exits. This command will be useful for starting the OVN sb ovsdb-server in a container.

\# ovn-ctl run_ic_nb_ovsdb

This command runs the OVN IC-NB ovsdb-server without passing the detach option, making it to block until ovsdb-server exits. This command will be useful for starting the OVN IC-NB ovsdb-server in a container.

\# ovn-ctl run_ic_sb_ovsdb

This command runs the OVN IC-SB ovsdb-server without passing the detach option, making it to block until ovsdb-server exits. This command will be useful for starting the OVN IC-SB ovsdb-server in a container.

## EXAMPLE USAGE

### Run ovn-controller on a host already running OVS
\# ovn-ctl start_controller

### Run ovn-northd on a host already running OVS
\# ovn-ctl start_northd

### All-in-one OVS+OVN for testing
\# ovs-ctl start --system-id="random"

\# ovn-ctl start_northd

\# ovn-ctl start_controller

### Promote and demote ovsdb servers
\# ovn-ctl promote_ovnnb

\# ovn-ctl promote_ovnsb

\# ovn-ctl --db-nb-sync-from-addr=x.x.x.x --db-nb-sync-from-port=6641 --db-nb-probe-interval-to-active=60000 demote_ovnnb

\# ovn-ctl --db-sb-sync-from-addr=x.x.x.x --db-sb-sync-from-port=6642 --db-sb-probe-interval-to-active=60000 demote_ovnsb

### Creating a clustered db on 3 nodes with IPs x.x.x.x, y.y.y.y and z.z.z.z
Starting OVN ovsdb servers and ovn-northd on the node with IP x.x.x.x

\# ovn-ctl --db-nb-addr=x.x.x.x --db-nb-create-insecure-remote=yes --db-sb-addr=x.x.x.x --db-sb-create-insecure-remote=yes --db-nb-cluster-local-addr=x.x.x.x --db-sb-cluster-local-addr=x.x.x.x --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641 --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642 start_northd

Starting OVN ovsdb-servers and ovn-northd on the node with IP y.y.y.y and joining the cluster started at x.x.x.x

\# ovn-ctl --db-nb-addr=y.y.y.y --db-nb-create-insecure-remote=yes --db-sb-addr=y.y.y.y --db-sb-create-insecure-remote=yes --db-nb-cluster-local-addr=y.y.y.y --db-sb-cluster-local-addr=y.y.y.y --db-nb-cluster-remote-addr=x.x.x.x --db-sb-cluster-remote-addr=x.x.x.x --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641 --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642 start_northd

Starting OVN ovsdb-servers and ovn-northd on the node with IP z.z.z.z and joining the cluster started at x.x.x.x

\# ovn-ctl --db-nb-addr=z.z.z.z --db-nb-create-insecure-remote=yes --db-nb-cluster-local-addr=z.z.z.z --db-sb-addr=z.z.z.z --db-sb-create-insecure-remote=yes --db-sb-cluster-local-addr=z.z.z.z --db-nb-cluster-remote-addr=x.x.x.x --db-sb-cluster-remote-addr=x.x.x.x --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641 --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642 start_northd

### Passing ssl keys when starting OVN dbs will supersede the default ssl values in db
Starting standalone ovn db server passing SSL certificates

\# ovn-ctl --ovn-nb-db-ssl-key=/etc/ovn/ovnnb-privkey.pem --ovn-nb-db-ssl-cert=/etc/ovn/ovnnb-cert.pem --ovn-nb-db-ssl-ca-cert=/etc/ovn/cacert.pem --ovn-sb-db-ssl-key=/etc/ovn/ovnsb-privkey.pem --ovn-sb-db-ssl-cert=/etc/ovn/ovnsb-cert.pem --ovn-sb-db-ssl-ca-cert=/etc/ovn/cacert.pem start_northd

### Avoiding automatic clustered OVN database schema upgrade
If you desire more control over clustered DB schema upgrade, you can opt-out of automatic on-start upgrade attempts with --no-db-cluster-schema-upgrade.

Start OVN NB and SB clustered databases on host with IP x.x.x.x without schema upgrade

\# ovn-ctl start_nb_ovsdb --db-nb-cluster-local-addr=x.x.x.x --no-db-cluster-schema-upgrade # ovn-ctl start_sb_ovsdb --db-sb-cluster-local-addr=x.x.x.x --no-db-cluster-schema-upgrade

Trigger clustered DB schema upgrade manually

\# ovsdb-client convert unix:/var/run/ovn/ovnnb_db.sock /usr/local/share/ovn/ovn-nb.ovsschema # ovsdb-client convert unix:/var/run/ovn/ovnsb_db.sock /usr/local/share/ovn/ovn-sb.ovsschema


ovn-debug

title: ovn-debug(8)

summary: Open Virtual Network debug tool

text:
# ovn-debug(8)

## NAME
ovn-debug - Open Virtual Network debug tool

## SYNOPSIS
ovn-debug COMMAND [ARG...]

## DESCRIPTION
ovn-debug, OVN debug tool, is a tool to help with debugging of OVN setup.

## COMMANDS
lflow-stage-to-ltable STAGE_NAME

Convert the logical flow stage name e.g. ls_in_lb into the logical flow table number e.g. 13.

lflow-stage-to-oftable STAGE_NAME

Convert the logical flow stage name e.g. ls_in_lb into the OpenFlow table number e.g. 21.


ovn-ic-nbctl

title: ovn-ic-nbctl(8)

text:
# ovn-ic-nbctl(8)

## NAME
ovn-ic-nbctl - Open Virtual Network interconnection northbound db management utility

## SYNOPSIS
ovn-ic-nbctl [options] command [arg...]

## DESCRIPTION
This utility can be used to manage the OVN interconnection northbound database.

## GENERAL COMMANDS
init

Initializes the database, if it is empty. If the database has already been initialized, this command has no effect.

show

Prints a brief overview of the database contents.

## TRANSIT SWITCH COMMANDS
[--may-exist] ts-add switch

Creates a new transit switch named switch.

Transit switch names must be unique. Adding a duplicated name results in error. With --may-exist, adding a duplicate name succeeds but does not create a new transit switch.

[--if-exists] ts-del switch

Deletes switch. It is an error if switch does not exist, unless --if-exists is specified.

ts-list

Lists all existing switches on standard output, one per line.

## DATABASE COMMANDS
These commands query and modify the contents of ovsdb tables. They are a slight abstraction of the ovsdb interface and as such they operate at a lower level than other ovn-ic-nbctl commands.

Identifying Tables, Records, and Columns

Each of these commands has a table parameter to identify a table within the database. Many of them also take a record parameter that identifies a particular record within a table. The record parameter may be the UUID for a record, which may be abbreviated to its first 4 (or more) hex digits, as long as that is unique. Many tables offer additional ways to identify records. Some commands also take column parameters that identify a particular field within the records in a table.

For a list of tables and their columns, see ovn-ic-nb(5) or see the table listing from the --help option.

Record names must be specified in full and with correct capitalization, except that UUIDs may be abbreviated to their first 4 (or more) hex digits, as long as that is unique within the table. Names of tables and columns are not case-sensitive, and - and _ are treated interchangeably. Unique abbreviations of table and column names are acceptable, e.g. t or transit is sufficient to identify the Transit_Switch table.

Database Values

Each column in the database accepts a fixed type of data. The currently defined basic types, and their representations, are:

integer

A decimal integer in the range -2**63 to 2**63-1, inclusive.

real

A floating-point number.

Boolean

True or false, written true or false, respectively.

string

An arbitrary Unicode string, except that null bytes are not allowed. Quotes are optional for most strings that begin with an English letter or underscore and consist only of letters, underscores, hyphens, and periods. However, true and false and strings that match the syntax of UUIDs (see below) must be enclosed in double quotes to distinguish them from other basic types. When double quotes are used, the syntax is that of strings in JSON, e.g. backslashes may be used to escape special characters. The empty string must be represented as a pair of double quotes ("").

UUID

Either a universally unique identifier in the style of RFC 4122, e.g. f81d4fae-7dec-11d0-a765-00a0c91e6bf6, or an @name defined by a get or create command within the same ovs-vsctl invocation.

Multiple values in a single column may be separated by spaces or a single comma. When multiple values are present, duplicates are not allowed, and order is not important. Conversely, some database columns can have an empty set of values, represented as [], and square brackets may optionally enclose other non-empty sets or single values as well.

A few database columns are ``maps’’ of key-value pairs, where the key and the value are each some fixed database type. These are specified in the form key=value, where key and value follow the syntax for the column’s key type and value type, respectively. When multiple pairs are present (separated by spaces or a comma), duplicate keys are not allowed, and again the order is not important. Duplicate values are allowed. An empty map is represented as {}. Curly braces may optionally enclose non-empty maps as well (but use quotes to prevent the shell from expanding other-config={0=x,1=y} into other-config=0=x other-config=1=y, which may not have the desired effect).

Database Command Syntax

[--if-exists] [--columns=column[,column]...] list table [record]...

Lists the data in each specified record. If no records are specified, lists all the records in table.

If --columns is specified, only the requested columns are listed, in the specified order. Otherwise, all columns are listed, in alphabetical order by column name.

Without --if-exists, it is an error if any specified record does not exist. With --if-exists, the command ignores any record that does not exist, without producing any output.

[--columns=column[,column]...] find table [column[:key]=value]...

Lists the data in each record in table whose column equals value or, if key is specified, whose column contains a key with the specified value. The following operators may be used where = is written in the syntax summary:

= != < > <= >=

Selects records in which column[:key] equals, does not equal, is less than, is greater than, is less than or equal to, or is greater than or equal to value, respectively.

Consider column[:key] and value as sets of elements. Identical sets are considered equal. Otherwise, if the sets have different numbers of elements, then the set with more elements is considered to be larger. Otherwise, consider a element from each set pairwise, in increasing order within each set. The first pair that differs determines the result. (For a column that contains key-value pairs, first all the keys are compared, and values are considered only if the two sets contain identical keys.)

{=} {!=}

Test for set equality or inequality, respectively.

{<=}

Selects records in which column[:key] is a subset of value. For example, flood-vlans{<=}1,2 selects records in which the flood-vlans column is the empty set or contains 1 or 2 or both.

{<}

Selects records in which column[:key] is a proper subset of value. For example, flood-vlans{<}1,2 selects records in which the flood-vlans column is the empty set or contains 1 or 2 but not both.

{>=} {>}

Same as {<=} and {<}, respectively, except that the relationship is reversed. For example, flood-vlans{>=}1,2 selects records in which the flood-vlans column contains both 1 and 2.

The following operators are available only in Open vSwitch 2.16 and later:

{in}

Selects records in which every element in column[:key] is also in value. (This is the same as {<=}.)

{not-in}

Selects records in which every element in column[:key] is not in value.

For arithmetic operators (= != < > <= >=), when key is specified but a particular record’s column does not contain key, the record is always omitted from the results. Thus, the condition other-config:mtu!=1500 matches records that have a mtu key whose value is not 1500, but not those that lack an mtu key.

For the set operators, when key is specified but a particular record’s column does not contain key, the comparison is done against an empty set. Thus, the condition other-config:mtu{!=}1500 matches records that have a mtu key whose value is not 1500 and those that lack an mtu key.

Don’t forget to escape < or > from interpretation by the shell.

If --columns is specified, only the requested columns are listed, in the specified order. Otherwise all columns are listed, in alphabetical order by column name.

The UUIDs shown for rows created in the same ovs-vsctl invocation will be wrong.

[--if-exists] [--id=@name] get table record [column[:key]]...

Prints the value of each specified column in the given record in table. For map columns, a key may optionally be specified, in which case the value associated with key in the column is printed, instead of the entire map.

Without --if-exists, it is an error if record does not exist or key is specified, if key does not exist in record. With --if-exists, a missing record yields no output and a missing key prints a blank line.

If @name is specified, then the UUID for record may be referred to by that name later in the same ovs-vsctl invocation in contexts where a UUID is expected.

Both --id and the column arguments are optional, but usually at least one or the other should be specified. If both are omitted, then get has no effect except to verify that record exists in table.

--id and --if-exists cannot be used together.

[--if-exists] set table record column[:key]=value...

Sets the value of each specified column in the given record in table to value. For map columns, a key may optionally be specified, in which case the value associated with key in that column is changed (or added, if none exists), instead of the entire map.

Without --if-exists, it is an error if record does not exist. With --if-exists, this command does nothing if record does not exist.

[--if-exists] add table record column [key=]value...

Adds the specified value or key-value pair to column in record in table. If column is a map, then key is required, otherwise it is prohibited. If key already exists in a map column, then the current value is not replaced (use the set command to replace an existing value).

Without --if-exists, it is an error if record does not exist. With --if-exists, this command does nothing if record does not exist.

[--if-exists] remove table record column value...

[--if-exists] remove table record column key...

[--if-exists] remove table record column key=value... Removes the specified values or key-value pairs from column in record in table. The first form applies to columns that are not maps: each specified value is removed from the column. The second and third forms apply to map columns: if only a key is specified, then any key-value pair with the given key is removed, regardless of its value; if a value is given then a pair is removed only if both key and value match.

It is not an error if the column does not contain the specified key or value or pair.

Without --if-exists, it is an error if record does not exist. With --if-exists, this command does nothing if record does not exist.

[--if-exists] clear table record column...

Sets each column in record in table to the empty set or empty map, as appropriate. This command applies only to columns that are allowed to be empty.

Without --if-exists, it is an error if record does not exist. With --if-exists, this command does nothing if record does not exist.

[--id=(@name|uuid)] create table column[:key]=value...

Creates a new record in table and sets the initial values of each column. Columns not explicitly set will receive their default values. Outputs the UUID of the new row.

If @name is specified, then the UUID for the new row may be referred to by that name elsewhere in the same \*(PN invocation in contexts where a UUID is expected. Such references may precede or follow the create command.

If a valid uuid is specified, then it is used as the UUID of the new row.

Caution (ovs-vsctl as example)

Records in the Open vSwitch database are significant only when they can be reached directly or indirectly from the Open_vSwitch table. Except for records in the QoS or Queue tables, records that are not reachable from the Open_vSwitch table are automatically deleted from the database. This deletion happens immediately, without waiting for additional ovs-vsctl commands or other database activity. Thus, a create command must generally be accompanied by additional commands within the same ovs-vsctl invocation to add a chain of references to the newly created record from the top-level Open_vSwitch record. The EXAMPLES section gives some examples that show how to do this.

[--if-exists] destroy table record...

Deletes each specified record from table. Unless --if-exists is specified, each records must exist.

--all destroy table

Deletes all records from the table.

Caution (ovs-vsctl as example)

The destroy command is only useful for records in the QoS or Queue tables. Records in other tables are automatically deleted from the database when they become unreachable from the Open_vSwitch table. This means that deleting the last reference to a record is sufficient for deleting the record itself. For records in these tables, destroy is silently ignored. See the EXAMPLES section below for more information.

wait-until table record [column[:key]=value]...

Waits until table contains a record named record whose column equals value or, if key is specified, whose column contains a key with the specified value. This command supports the same operators and semantics described for the find command above.

If no column[:key]=value arguments are given, this command waits only until record exists. If more than one such argument is given, the command waits until all of them are satisfied.

Caution (ovs-vsctl as example)

Usually wait-until should be placed at the beginning of a set of ovs-vsctl commands. For example, wait-until bridge br0 -- get bridge br0 datapath_id waits until a bridge named br0 is created, then prints its datapath_id column, whereas get bridge br0 datapath_id -- wait-until bridge br0 will abort if no bridge named br0 exists when ovs-vsctl initially connects to the database.

Consider specifying --timeout=0 along with --wait-until, to prevent ovs-vsctl from terminating after waiting only at most 5 seconds.

comment [arg]...

This command has no effect on behavior, but any database log record created by the command will include the command and its arguments.

## REMOTE CONNECTIVITY COMMANDS
get-connection

Prints the configured connection(s).

del-connection

Deletes the configured connection(s).

[--inactivity-probe=msecs] set-connection target...

Sets the configured manager target or targets. Use --inactivity-probe=msecs to override the default idle connection inactivity probe time. Use 0 to disable inactivity probes.

## SSL CONFIGURATION COMMANDS
get-ssl

Prints the SSL configuration.

del-ssl

Deletes the current SSL configuration.

[--bootstrap] set-ssl private-key certificate ca-cert [ssl-protocol-list [ssl-cipher-list]]

Sets the SSL configuration.

## SYNCHRONIZATION COMMANDS
sync

Ordinarily, --wait=sb only waits for changes by the current ovn-ic-nbctl invocation to take effect. This means that, if none of the commands supplied to ovn-ic-nbctl change the database, then the command does not wait at all. With the sync command, however, ovn-ic-nbctl waits even for earlier changes to the database to propagate down to the southbound database, according to the argument of --wait.

## OPTIONS
--no-wait | --wait=none

--wait=sb

These options control whether and how ovn-ic-nbctl waits for the OVN system to become up-to-date with changes made in an ovn-ic-nbctl invocation.

By default, or if --no-wait or --wait=none, ovn-ic-nbctl exits immediately after confirming that changes have been committed to the Interconnect northbound database, without waiting.

With --wait=sb, before ovn-ic-nbctl exits, it waits for ovn-ics to bring the Interconnect southbound database up-to-date with the Interconnect northbound database updates.

Ordinarily, --wait=sb only waits for changes by the current ovn-ic-nbctl invocation to take effect. This means that, if none of the commands supplied to ovn-ic-nbctl change the database, then the command does not wait at all. Use the sync command to override this behavior.

--db database

The OVSDB database remote to contact. If the OVN_IC_NB_DB environment variable is set, its value is used as the default. Otherwise, the default is unix:/ovn_ic_nb_db.sock, but this default is unlikely to be useful outside of single-machine OVN test environments.

--leader-only

--no-leader-only

By default, or with --leader-only, when the database server is a clustered database, ovn-ic-nbctl will avoid servers other than the cluster leader. This ensures that any data that ovn-ic-nbctl reads and reports is up-to-date. With --no-leader-only, ovn-ic-nbctl will use any server in the cluster, which means that for read-only transactions it can report and act on stale data (transactions that modify the database are always serialized even with --no-leader-only). Refer to Understanding Cluster Consistency in ovsdb(7) for more information.

## LOGGING OPTIONS
-v[spec]

--verbose=[spec]

Sets logging levels. Without any spec, sets the log level for every module and destination to dbg. Otherwise, spec is a list of words separated by spaces or commas or colons, up to one from each category below:

- A valid module name, as displayed by the vlog/list command on ovs-appctl(8), limits the log level change to the specified module.

- syslog, console, or file, to limit the log level change to only to the system log, to the console, or to a file, respectively. (If --detach is specified, the daemon closes its standard file descriptors, so logging to the console will have no effect.)

On Windows platform, syslog is accepted as a word and is only useful along with the --syslog-target option (the word has no effect otherwise).

•

off, emer, err, warn, info, or dbg, to control the log level. Messages of the given severity or higher will be logged, and messages of lower severity will be filtered out. off filters out all messages. See ovs-appctl(8) for a definition of each log level.

Case is not significant within spec.

Regardless of the log levels set for file, logging to a file will not take place unless --log-file is also specified (see below).

For compatibility with older versions of OVS, any is accepted as a word but has no effect.

-v

--verbose

Sets the maximum logging verbosity level, equivalent to --verbose=dbg.

-vPATTERN:destination:pattern

--verbose=PATTERN:destination:pattern

Sets the log pattern for destination to pattern. Refer to ovs-appctl(8) for a description of the valid syntax for pattern.

-vFACILITY:facility

--verbose=FACILITY:facility

Sets the RFC5424 facility of the log message. facility can be one of kern, user, mail, daemon, auth, syslog, lpr, news, uucp, clock, ftp, ntp, audit, alert, clock2, local0, local1, local2, local3, local4, local5, local6 or local7. If this option is not specified, daemon is used as the default for the local system syslog and local0 is used while sending a message to the target provided via the --syslog-target option.

--log-file[=file]

Enables logging to a file. If file is specified, then it is used as the exact name for the log file. The default log file name used if file is omitted is /var/log/ovn/program.log.

--syslog-target=host:port

Send syslog messages to UDP port on host, in addition to the system syslog. The host must be a numerical IP address, not a hostname.

--syslog-method=method

Specify method as how syslog messages should be sent to syslog daemon. The following forms are supported:

- libc, to use the libc syslog() function. Downside of using this options is that libc adds fixed prefix to every message before it is actually sent to the syslog daemon over /dev/log UNIX domain socket.

- unix:file, to use a UNIX domain socket directly. It is possible to specify arbitrary message format with this option. However, rsyslogd 8.9 and older versions use hard coded parser function anyway that limits UNIX domain socket use. If you want to use arbitrary message format with older rsyslogd versions, then use UDP socket to localhost IP address instead.

- udp:ip:port, to use a UDP socket. With this method it is possible to use arbitrary message format also with older rsyslogd. When sending syslog messages over UDP socket extra precaution needs to be taken into account, for example, syslog daemon needs to be configured to listen on the specified UDP port, accidental iptables rules could be interfering with local syslog traffic and there are some security considerations that apply to UDP sockets, but do not apply to UNIX domain sockets.

- null, to discard all messages logged to syslog.

The default is taken from the OVS_SYSLOG_METHOD environment variable; if it is unset, the default is libc.

## TABLE FORMATTING OPTIONS
These options control the format of output from the list and find commands.

-f format

--format=format

Sets the type of table formatting. The following types of format are available:

table

2-D text tables with aligned columns.

list (default)

A list with one column per line and rows separated by a blank line.

html

HTML tables.

csv

Comma-separated values as defined in RFC 4180.

json

JSON format as defined in RFC 4627. The output is a sequence of JSON objects, each of which corresponds to one table. Each JSON object has the following members with the noted values:

caption

The table’s caption. This member is omitted if the table has no caption.

headings

An array with one element per table column. Each array element is a string giving the corresponding column’s heading.

data

An array with one element per table row. Each element is also an array with one element per table column. The elements of this second-level array are the cells that constitute the table. Cells that represent OVSDB data or data types are expressed in the format described in the OVSDB specification; other cells are simply expressed as text strings.

-d format

--data=format

Sets the formatting for cells within output tables unless the table format is set to json, in which case json formatting is always used when formatting cells. The following types of format are available:

string (default)

The simple format described in the Database Values section of ovs-vsctl(8).

bare

The simple format with punctuation stripped off: [] and {} are omitted around sets, maps, and empty columns, items within sets and maps are space-separated, and strings are never quoted. This format may be easier for scripts to parse.

json

The RFC 4627 JSON format as described above.

--no-headings

This option suppresses the heading row that otherwise appears in the first row of table output.

--pretty

By default, JSON in output is printed as compactly as possible. This option causes JSON in output to be printed in a more readable fashion. Members of objects and elements of arrays are printed one per line, with indentation.

This option does not affect JSON in tables, which is always printed compactly.

--bare

Equivalent to --format=list --data=bare --no-headings.

### PKI Options
PKI configuration is required to use SSL for the connection to the database.

-p privkey.pem

--private-key=privkey.pem

Specifies a PEM file containing the private key used as identity for outgoing SSL connections.

-c cert.pem

--certificate=cert.pem

Specifies a PEM file containing a certificate that certifies the private key specified on -p or --private-key to be trustworthy. The certificate must be signed by the certificate authority (CA) that the peer in SSL connections will use to verify it.

-C cacert.pem

--ca-cert=cacert.pem

Specifies a PEM file containing the CA certificate for verifying certificates presented to this program by SSL peers. (This may be the same certificate that SSL peers use to verify the certificate specified on -c or --certificate, or it may be a different one, depending on the PKI design in use.)

-C none

--ca-cert=none

Disables verification of certificates presented by SSL peers. This introduces a security risk, because it means that certificates cannot be verified to be those of known trusted hosts.

--bootstrap-ca-cert=cacert.pem

When cacert.pem exists, this option has the same effect as -C or --ca-cert. If it does not exist, then the executable will attempt to obtain the CA certificate from the SSL peer on its first SSL connection and save it to the named PEM file. If it is successful, it will immediately drop the connection and reconnect, and from then on all SSL connections must be authenticated by a certificate signed by the CA certificate thus obtained.

This option exposes the SSL connection to a man-in-the-middle attack obtaining the initial CA certificate, but it may be useful for bootstrapping.

This option is only useful if the SSL peer sends its CA certificate as part of the SSL certificate chain. The SSL protocol does not require the server to send the CA certificate.

This option is mutually exclusive with -C and --ca-cert.

### Other Options
-h

--help

Prints a brief help message to the console.

-V

--version

Prints version information to the console.