summaryrefslogtreecommitdiff
path: root/utilities/ovs-vsctl.8.in
Commit message (Collapse)AuthorAgeFilesLines
* doc: Populate 'install', 'howto' sectionsStephen Finucane2016-12-121-3/+3
| | | | | | | | | This is a dumb move of all 'INSTALL*' docs, with very little refactoring (mostly updating links and making the titles a little more consistent. Additional refactoring will be done in subsequent changes. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org>
* ovs-vsctl: Add another Flow_Table example.Ben Pfaff2016-07-181-1/+8
| | | | | Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Ryan Moats <rmoats@us.ibm.com>
* treewide: Fix doubled "the".Ben Pfaff2015-08-031-1/+1
| | | | | Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Russell Bryant <rbryant@redhat.com>
* db-ctl-base: Librarize database command manual.Alex Wang2015-06-231-258/+1
| | | | | | | | This commit extracts the database command manual and puts it into db-ctl-base.man. Signed-off-by: Alex Wang <alexw@nicira.com> Acked-by: Ben Pfaff <blp@nicira.com>
* docs: Clarify creation & bonding of DPDK enabled interfaces.Billy O'Mahony2015-05-071-1/+3
| | | | | | | | | | Unlike system interfaces, DPDK enabled interfaces must have their interface type explicitly set when used to create ports. Mention this in relevant parts of the documentation and add references to INTALL.DPDK.md, where there are many examples. Signed-off-by: Billy O'Mahony <billy.o.mahony@intel.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* auto-attach: Add auto-attach support to bridge layer and command setDennis Flynn2015-03-031-2/+25
| | | | | | | | | | | | | This is the final commit in the series of commits that deliver initial support for Auto-Attach. Specifically this commit delivers auto-attach support to the OVS bridge layer as well as the new auto-attach commands. The OVSDB schema is modified to define the new auto-attach entries. The man pages, unit tests, and news and license notice files are also updated. A unit test is provided to validate the construction of auto-attach packets. Signed-off-by: Ludovic Beliveau <ludovic.beliveau@windriver.com> Signed-off-by: Dennis Flynn <drflynn@avaya.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* mcast-snoop: Add support to control Reports forwardingFlavio Leitner2015-02-041-1/+5
| | | | | | | | | The RFC4541 section 2.1.1 item 1 allows the snooping switch to provide an administrative control to allow Report messages to be flooded to ports not connected to multicast routers. Signed-off-by: Flavio Leitner <fbl@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-vsctl: Prevent creating duplicate VLAN bridges.Ben Pfaff2014-11-251-1/+2
| | | | | | | | | | | | | ovs-vsctl has the concept of a VLAN (or "fake") bridge, which is a sort of a sub-bridge that receives only packets on a particular VLAN. There is no way to distinguish two VLAN bridges with the same parent on the same VLAN, but until now ovs-vsctl did not prevent creating duplicates or report them. This commit fixes the problem. Reported-by: rwxybh Reported-at: https://github.com/openvswitch/ovs/issues/21 Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Thomas Graf <tgraf@noironetworks.com>
* ovs-vsctl: Update RSTP documentation.Daniele Venturino2014-11-201-3/+5
| | | | | | | Mention that the AUTO detection of admin point to point MAC parameter is not implemented. Signed-off-by: Martino Fornasa <mf@fornasa.it> Acked-by: Jarno Rajahalme <jrajahalme@nicira.com>
* rstp: Add 'rstp-admin-p2p-mac' and 'rstp-admin-port-state' setters.Jarno Rajahalme2014-11-141-5/+16
| | | | | | | | | | | | | | | | 'rstp-admin-port-state' is the Administrative Bridge Port state variable defined in the 802.1D-2004 standard. It can be set to include or exclude a port from the active topology by management (section 7.4). operPointToPointMAC and 'rstp-admin-p2p-mac' are a pair of parameters that permit inspection of, and control over, the administrative and operational state of the point-to-point status of the MAC entity by the MAC Relay Entity. adminPointToPointMAC can be set by management and its value is reflected on operPointToPointMAC. Signed-off-by: Daniele Venturino <daniele.venturino@m3s.it> Acked-by: Jarno Rajahalme <jrajahalme@nicira.com>
* Rapid Spanning Tree Protocol (IEEE 802.1D).Daniele Venturino2014-09-091-0/+79
| | | | | | | | | This is the v5 from June 12th, 2014, rebased to OVS master, further changes in following patches. Signed-off by: Daniele Venturino <daniele.venturino@m3s.it> Signed-off by: Martino Fornasa <mf@fornasa.it> Signed-off-by: Jarno Rajahalme <jrajahalme@nicira.com> Acked-by: Daniele Venturino <daniele.venturino@m3s.it>
* Extend OVS IPFIX exporter to export tunnel headersWenyu Zhang2014-08-181-2/+6
| | | | | | | | | | | | | | | | | | | | | | Extend IPFIX exporter to export tunnel headers when both input and output of the port. Add three other_config options in IPFIX table: enable-input-sampling, enable-output-sampling and enable-tunnel-sampling, to control whether sampling tunnel info, on which direction (input or output). Insert sampling action before output action and the output tunnel port is sent to datapath in the sampling action. Make datapath collect output tunnel info and send it back to userpace in upcall message with a new additional optional attribute. Add a tunnel ports map to make the tunnel port lookup faster in sampling upcalls in IPFIX exporter. Make the IPFIX exporter generate IPFIX template sets with enterprise elements for the tunnel info, save the tunnel info in IPFIX cache entries, and send IPFIX DATA with tunnel info. Add flowDirection element in IPFIX templates. Signed-off-by: Wenyu Zhang <wenyuz@vmware.com> Acked-by: Romain Lenglet <rlenglet@vmware.com> Acked-by: Ben Pfaff <blp@nicira.com> Acked-by: Pravin B Shelar <pshelar@nicira.com>
* bridge: Enable multicast support on the bridgeFlavio Leitner2014-06-241-0/+30
| | | | | Signed-off-by: Flavio Leitner <fbl@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-vsctl: Fix OF protocol name capitalization in manual pageThomas Graf2014-06-171-1/+1
| | | | | Signed-off-by: Thomas Graf <tgraf@noironetworks.com> Signed-off-by: Justin Pettit <jpettit@nicira.com>
* ovs-vsctl: Add an example of how to limit the flows in a flow table.Ben Pfaff2014-05-211-0/+4
| | | | | Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Gurucharan Shetty <gshetty@nicira.com>
* man: Document common options in ovs-vsctl and vtep-ctl.Justin Pettit2014-02-281-0/+1
| | | | | Signed-off-by: Justin Pettit <jpettit@nicira.com> Acked-by: Ben Pfaff <blp@nicira.com>
* utilities: Wrong command syntax in ovs-vsctl manpage.Daniele Venturino2014-01-081-1/+1
| | | | | | | | | | | | | | | | | | | The command shown in the man page to disable the STP protocol on a bridge is: ovs-vsctl clear Bridge br0 stp_enable Calling that, the following warning message is returned: ovs-vsctl: "clear" operation cannot be applied to column stp_enable of table Bridge, which is not allowed to be empty It seems correct to use the command: ovs-vsctl set Bridge br0 stp_enable=false Signed-off-by: Daniele Venturino <daniele.venturino@m3s.it> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-controller: Rename test-controller and do not install or package.Ben Pfaff2013-11-021-5/+1
| | | | | | | | | Too many users have incorrectly assumed that ovs-controller is a necessary or desirable part of an Open vSwitch deployment. This commit should fix the problem by renaming it test-controller and removing it from the default install and from packaging. Signed-off-by: Ben Pfaff <blp@nicira.com>
* ipfix: implement flow caching and aggregation in exporterRomain Lenglet2013-08-221-2/+3
| | | | | | | | | | | | | | | Implement a per-exporter flow cache with active timeout expiration. Add columns "cache_active_timeout" and "cache_max_flows" into table "IPFIX" to configure each cache. Add per-flow elements "octetDeltaSumOfSquares", "minimumIpTotalLength", and "maximumIpTotalLength" to replace "ethernetTotalLength". Add per-flow element "flowEndReason" to indicate whether a flow has expired because of an active timeout, the cache size limit being reached, or the exporter being stopped. Signed-off-by: Romain Lenglet <rlenglet@vmware.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* Implement IPFIX exportRomain Lenglet2013-04-221-5/+26
| | | | | | | | | | | | | | | | | | | | | | | | Define a new NXAST_SAMPLE OpenFlow vendor action and the corresponding OFPACT_SAMPLE OVS action, to do per-flow packet sampling, translated into a new SAMPLE "flow_sample" dp action. Make the userspace action's userdata size vary depending on the union member used. Add a new "flow_sample" upcall to do per-flow packet sampling. Add a new "ipfix" upcall to do per-bridge packet sampling to IPFIX collectors. Extend the OVSDB schema to support configuring IPFIX collector sets. Add support for configuring multiple IPFIX collectors for per-flow packet sampling. Add support for configuring per-bridge IPFIX sampling. Automatically generate standard IPFIX entity definitions from the IANA specs. Send one IPFIX data record message for every packet sampled by an OpenFlow sample action or received by a bridge configured with IPFIX sampling, and periodically send IPFIX template set messages. Signed-off-by: Romain Lenglet <rlenglet@vmware.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-vsctl: Try connecting only once for active connections by default.Ben Pfaff2013-03-151-0/+14
| | | | | | | | | | | | | | | | | | | | | | | Until now, ovs-vsctl has kept trying to the database server until it succeeded or the timeout expired (if one was specified with --timeout). This meant that if ovsdb-server wasn't running, then ovs-vsctl would hang. The result was that almost every ovs-vsctl invocation in scripts specified a timeout on the off-chance that the database server might not be running. But it's difficult to choose a good timeout. A timeout that is too short can cause spurious failures. A timeout that is too long causes long delays if the server really isn't running. This commit should alleviate this problem. It changes ovs-vsctl's behavior so that, if it fails to connect to the server, it exits unsuccessfully. This makes --timeout obsolete for the purpose of avoiding a hang if the database server isn't running. (--timeout is still useful to avoid a hang if ovsdb-server is running but ovs-vswitchd is not, for ovs-vsctl commands that modify the database. --no-wait also avoids that issue.) Bug #2393. Bug #15594. Reported-by: Jeff Merrick <jmerrick@vmware.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-vsctl: Add --if-exists option to many database commands.Ben Pfaff2013-01-161-12/+36
| | | | | | | | | | | | | | | | | | | A few ovs-vsctl commands have accepted --if-exists options for some time, to make it possible to execute them in cases where it doesn't really matter if the records they touch exist. This commit adds this option to other commands. This is intended for initial use with "ovs-vsctl set interface <iface> ofport_request=<number>" commands in ovs-ctl for upgrades from OVS 1.9 to later versions. This makes a very small incompatible change to the ovs-vsctl "get" command: previously with --if-exists, only keys in map columns were allowed to be missing; now with --if-eixsts, also records are allowed to be missing. CC: Gurucharan Shetty <gshetty@nicira.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-vsctl.8: Add an example to configure openflow version.Isaku Yamahata2013-01-061-0/+7
| | | | | Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp> Signed-off-by: Ben Pfaff <blp@nicira.com>
* manpages: Put version number instead of date at bottom of page.Ben Pfaff2013-01-041-1/+1
| | | | | | | | | | | | | | | | | We're really good about keeping manpages up to date, but terrible at updating the dates at the bottom of the manpages. So, instead of using manually updated dates, this commit switches to using automatically updated version numbers. We can only use automatically updated version numbers for manpages that we preprocess, that is, the manpages whose sources end with ".in". This excludes a couple of manpages that don't actually get installed with OVS, such as the manpages for ovs-ctl and ovsdb-idlc. This commit doesn't change those manpages. It does change the ovs-bugtool manpage to one that is preprocessed so that we can use the version there. Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Ethan Jackson <ethan@nicira.com>
* ovs-vsctl: Allow command-specific options to mingle with global options.Ben Pfaff2012-12-101-6/+5
| | | | | | | | | | | | | | | | Until now, a command like "ovs-vsctl --may-exist add-br br0" yielded a confusing error message. Users had to realize that the correct form was "ovs-vsctl -- --may-exist add-br br0", but instead they often reported a bug or gave up in frustration. Even though the behavior was documented, it was counterintuitive. This commit allows command-specific options to be mixed with global options, making both forms of the command listed above equally acceptable. CC: 691508@bugs.debian.org Reported-by: Adam Heath <doogie@brainfood.com> Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Kyle Mestery <kmestery@cisco.com>
* ovs-vsctl: Add "--real" and "--fake" options to "list-br".Justin Pettit2012-12-011-2/+3
| | | | | | | | | By default, "ovs-vsctl list-br" returns all bridges, real or fake. This commit adds "--real" and "--fake" options that limit the output to only bridges of that type. This will be useful in a future commit that needs to perform actions only on bridges of a particular type. Signed-off-by: Justin Pettit <jpettit@nicira.com>
* ovs-vsctl: Correct example for removing a mirror.Ben Pfaff2012-07-121-1/+7
| | | | | Reported-by: Kris zhang <zhang.kris@gmail.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* docs: Add references to the database schema documentation.Ben Pfaff2012-06-201-14/+13
| | | | | | | | | | | I field lots of questions about "where's the documentation?" Perhaps this will help. The changes to ovs-vsctl(8) add a couple of references to ovs-vswitchd.conf.db(5) but they also rephrase a couple of paragraphs in what seems to me an easier to understand style. Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-vsctl: Add "--all" option for "destroy" command in ovs-vsctl.Arun Sharma2012-05-161-1/+4
| | | | | | | | | | | Adds the ability to delete all records from table. This will help users to destroy all records from Qos or Queue table using single command rather then current method. Feature #11306 Suggested-by: Kevin Mancuso <kevin.mancuso@rackspace.com> Signed-off-by: Arun Sharma <arun.sharma@calsoftinc.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-vsctl: Allow "fake bridges" to be created for VLAN 0.Ben Pfaff2012-03-201-2/+3
| | | | | | | | | A fake bridge for VLAN 0 is useful, because it provides a way to create access ports for VLAN 0. There is no good reason to prevent it. NIC-464. Reported-by: Rob Hoes <Rob.Hoes@citrix.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* Add support for limiting the number of flows in an OpenFlow flow table.Ben Pfaff2012-02-011-0/+3
| | | | Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-vsctl: Add example of creating a GRE tunnel to manpage.Ben Pfaff2012-01-161-0/+6
| | | | | | We've had questions about this a few times. Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-vsctl: Document a pitfall of the syntax for maps.Ben Pfaff2012-01-131-2/+4
| | | | Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-vsctl: Add set relational operators to "find" command.Ben Pfaff2012-01-111-5/+50
| | | | | Requested-by: Shih-Hao Li <shli@nicira.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* ovs-vswitchd: Add support for 802.1D STP.Justin Pettit2011-10-221-0/+18
| | | | | Still alpha quality, since only tested for interoperability with Linux bridge's STP implementation.
* ovs-vsctl: Fix small formatting error in man page.Justin Pettit2011-10-221-1/+1
|
* ovs-vsctl: Update man page description of controller support.Justin Pettit2011-10-121-2/+8
| | | | | | | ovs-vswitchd supports passive OpenFlow connections, but that was not indicated in the documentation. Add that information as well as a description of Primary (active) and Service (passive) control connections.
* ovs-vsctl: Remove "cfm_remote_mpid" from man page.Justin Pettit2011-09-291-2/+2
| | | | | The "cfm_remote_mpid" column is no longer used by the CFM module, so remove the reference from the ovs-vsctl man page.
* ovs-vsctl: Fix typo in documentation.Ben Pfaff2011-09-201-1/+1
| | | | | | | I don't know what was really supposed to go here. Documentation #7371. Reported-by: Reid Price <reid@nicira.com>
* ovs-vsctl: New "comment" command.Ben Pfaff2011-06-071-0/+3
| | | | | This allows processes that call ovs-vsctl to add remarks that explain their intentions.
* ovs-vsctl: Clarify meaning of --may-exist options.Ben Pfaff2011-05-261-10/+10
| | | | CC: Jeremy Stribling <strib@nicira.com>
* ovs-vsctl: Add "show" command for printing an overview of configuration.Ben Pfaff2011-05-241-0/+3
|
* cfm: Remove Maintenance_Point and Monitor tables.Ethan Jackson2011-05-201-15/+4
| | | | | | | | | | In an effort to make CFM easier to understand and configure, this patch removes the Maintenance_Point and Monitor tables from the database. As a consequence, users will only be able to configure one remote maintenance point. Furthermore, before this patch each remote maintenance point maintained its own separate fault flag in the database. This flag is no longer reported, users will need to infer the fault status from the global CFM fault flag.
* ovs-vsctl: Issue warning for likely erroneous "get" commands.Ben Pfaff2011-05-101-0/+5
| | | | | Suggested-by: Reid Price <reid@nicira.com> Feature #5527.
* ovsdb-idl: Suppress "delete" operations for garbage-collected tables.Ben Pfaff2011-04-121-6/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Deciding what delete operations to issue on garbage-collected tables has been a bit of a difficult issue for ovs-vsctl. When garbage collection was introduced in commit c5f341a "ovsdb: Implement garbage collection", ovs-vsctl did not issue any deletions for these tables at all. As a side effect, ovs-vsctl did not notice that records were going to be deleted. That meant that when multiple commands were issued in one ovs-vsctl run, ovs-vsctl could get confused by apparent duplicate records that did not in fact exist. Commit 28a14bf "ovs-vsctl: Back out garbage collection changes" fixed the problem by putting all of the explicit deletions back into ovs-vsctl. However, adding these explicit deletions had the price that it then became (again) impossible to use ovs-vsctl commands to delete duplicates, for example to use "ovs-vsctl del-br" to delete a bridge that points to the same Port records that some other Bridge record also does. This commit makes that possible again, by implementing a compromise: * Internally, ovs-vsctl deletes the records that it believes should be deleted. * ovsdb-idl suppresses the deletions when it makes the RPC call into the database server. Bug #5358. Reported-by: Henrik Amren <henrik@nicira.com>
* ovsdb: Implement garbage collection.Ben Pfaff2011-03-101-12/+35
|
* ovs-vsctl: Remove stray \ from end of manpage.Ben Pfaff2011-03-101-1/+0
|
* ovs-vsctl: Update list of tables in manpage.Ben Pfaff2011-03-101-5/+9
| | | | | | The QoS and Queue tables weren't mentioned at all, and some of the tables were in a different order from that in vswitch.xml. This fixes both.
* ovs-vsctl: --bootstrap only has an effect if the ca cert is missing.Ben Pfaff2011-02-221-1/+2
| | | | | Someone (I can't remember who) asked me about this a while ago. I hope this clarifies.
* ovsdb: Remove 'managers' column from 'Open vSwitch' table.Andrew Evans2011-02-181-5/+5
| | | | | | | | We had retained but deprecated the use of the older 'managers' column in the 'Open vSwitch' table for compatibility with applications that might still use it, but that created more problems than it solved. This commit removes the 'managers' column from the schema, and removes all references to it from the code, init scripts, documentation, and tests.
View Lorry Controller Status