python: Backport argparse to older platforms.
[sliver-openvswitch.git] / xenserver / README
index db2bd29..0e2affa 100644 (file)
@@ -1,11 +1,8 @@
 This directory contains files for seamless integration of Open vSwitch on
 Citrix XenServer hosts managed by the Citrix management tools.
 
-Some of these files are modifications of Citrix's proprietary code.
-Citrix has given permission to distribute these modified files.
-Citrix has not specified a particular license for them.  There is no
-guarantee that, should Citrix specify a license, that it would be
-DFSG-compliant or GPL-compatible.
+Files in this directory are licensed on a file-by-file basis.  Please
+refer to each file for details.
 
 Most of the files in this directory is installed on a XenServer system
 under the same name, if underscores are replaced by slashes.  The
@@ -37,6 +34,29 @@ files are:
         in the ovs-vswitchd configuration that are managed in the
         xapi database when integrated with Citrix management tools.
 
+    etc_xensource_bugtool_network-status_openvswitch.xml
+
+        xen-bugtool extension to collect networking information relevant to
+        Open vSwitch. Runs
+        usr_share_openvswitch_scripts_xen-bugtool-tc-class-show.
+
+    etc_xensource_bugtool_kernel-info_openvswitch.xml
+
+        xen-bugtool extension to collect kernel information relevant to
+        Open vSwitch.
+
+    etc_xensource_bugtool_system-configuration.xml
+
+        Custom xen-bugtool category to collect system configuration data.
+        This category is configured to collect up to 1Mb of data, take
+        up to 60 seconds to collect data, run every time and is hidden from
+        display in xencenter.
+
+    etc_xensource_bugtool_system-configuration_openvswitch.xml
+
+        xen-bugtool extension to collect system configuration information
+        relevant to Open vSwitch, including timezone.
+
     etc_xensource_scripts_vif
 
         Open vSwitch-aware replacement for Citrix script of the same name.
@@ -49,37 +69,29 @@ files are:
 
         Open vSwitch-aware replacement for Citrix script of the same name.
 
-    usr_share_openvswitch_scripts_refresh-xs-network-uuids
+    usr_share_openvswitch_scripts_ovs-xapi-sync
 
-        Script to refresh Bridge table external-ids:xs-network-uuids
-        values, which can get out-of-sync following a pool join.
+        Daemon to monitor the external_ids columns of the Bridge and
+        Interface OVSDB tables for changes that require interrogating
+        XAPI.
 
     usr_share_openvswitch_scripts_sysconfig.template
 
-        Template for Open vSwitch's /etc/sysconfig/openvswitch 
+        Template for Open vSwitch's /etc/sysconfig/openvswitch
         configuration file.
 
+    usr_share_openvswitch_scripts_xen-bugtool-tc-class-show
+
+        Script to dump tc class configuration for all network
+        interfaces. Intended to be run by xen-bugtool via
+        etc_xensource_bugtool_network-status_openvswitch.xml.
+
     usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
 
         xsconsole plugin to configure the pool-wide configuration keys
-        used to control Open vSwitch when integrated with Citrix 
+        used to control Open vSwitch when integrated with Citrix
         management tools.
 
-    usr_sbin_brctl
-
-        wrapper for /usr/sbin/brctl that provides some additional
-        bridge compatibility
-
-    usr_sbin_xen-bugtool
-
-        Open vSwitch-aware replacement for Citrix script of the same name.
-
-    uuid.py
-
-        This is uuid.py from Python 2.5.  It is installed into the
-        Open vSwitch RPM because XenServer 5.5 and 5.6 use Python 2.4,
-        which do not have uuid.py.
-
 To install, build the Open vSwitch RPM with a command like this:
 
         rpmbuild -D "openvswitch_version $full_version" \
@@ -92,7 +104,7 @@ question and reboot them.  (The openvswitch-dbg package that is also
 produced need not be installed, but it is harmless to do so.)
 
 ----------------------------------------------------------------------
-Copyright (C) 2009, 2010 Nicira Networks, Inc.
+Copyright (C) 2009, 2010, 2011 Nicira Networks, Inc.
 
 Copying and distribution of this file, with or without modification,
 are permitted in any medium without royalty provided the copyright