netdev-port: Fix invalid memory access in netdev_vport_poll_add().
[openvswitch] / xenserver / README
1 This directory contains files for seamless integration of Open vSwitch on
2 Citrix XenServer hosts managed by the Citrix management tools.
3
4 Files in this directory are licensed on a file-by-file basis.  Please
5 refer to each file for details.
6
7 Most of the files in this directory is installed on a XenServer system
8 under the same name, if underscores are replaced by slashes.  The
9 files are:
10
11     etc_init.d_openvswitch
12
13         Initializes Open vSwitch at boot and shuts it down at shutdown.
14
15     etc_init.d_openvswitch-xapi-update
16
17         Init script to ensure openvswitch-cfg-update is called for the
18         current host at boot.
19
20     etc_logrotate.d_openvswitch
21
22         Ensures that logs in /var/log/openvswitch are rotated
23         periodically and that appropriate daemons reopen their log
24         files at that point.
25
26     etc_profile.d_openvswitch.sh
27
28         Open vSwitch-related shell functions for the administrator's
29         convenience.
30
31     etc_xapi.d_plugins_openvswitch-cfg-update
32
33         xapi plugin script to update the cache of configuration items
34         in the ovs-vswitchd configuration that are managed in the
35         xapi database when integrated with Citrix management tools.
36
37     etc_xensource_bugtool_network-status_openvswitch.xml
38
39         xen-bugtool extension to collect networking information relevant to
40         Open vSwitch. Runs
41         usr_share_openvswitch_scripts_xen-bugtool-tc-class-show.
42
43     etc_xensource_scripts_vif
44
45         Open vSwitch-aware replacement for Citrix script of the same name.
46
47     openvswitch-xen.spec
48
49         spec file for building RPMs to install on a XenServer host.
50
51     opt_xensource_libexec_interface-reconfigure
52
53         Open vSwitch-aware replacement for Citrix script of the same name.
54
55     usr_share_openvswitch_scripts_ovs-xapi-sync
56
57         Daemon to monitor the external_ids columns of the Bridge and
58         Interface OVSDB tables for changes that require interrogating
59         XAPI.
60
61     usr_share_openvswitch_scripts_sysconfig.template
62
63         Template for Open vSwitch's /etc/sysconfig/openvswitch 
64         configuration file.
65
66     usr_share_openvswitch_scripts_xen-bugtool-tc-class-show
67
68         Script to dump tc class configuration for all network
69         interfaces. Intended to be run by xen-bugtool via
70         etc_xensource_bugtool_network-status_openvswitch.xml.
71
72     usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
73
74         xsconsole plugin to configure the pool-wide configuration keys
75         used to control Open vSwitch when integrated with Citrix 
76         management tools.
77
78     uuid.py
79
80         This is uuid.py from Python 2.5.  It is installed into the
81         Open vSwitch RPM because XenServer uses Python 2.4, which does
82         not have uuid.py.
83
84 To install, build the Open vSwitch RPM with a command like this:
85
86         rpmbuild -D "openvswitch_version $full_version" \
87                 -D "xen_version $XENKERNEL" \
88                 -D "build_number --with-build-number=$buildnr" \
89                 -bb openvswitch-xen.spec
90
91 Then, "rpm -U" the resulting Open vSwitch package on the XenServer hosts in
92 question and reboot them.  (The openvswitch-dbg package that is also
93 produced need not be installed, but it is harmless to do so.)
94
95 ----------------------------------------------------------------------
96 Copyright (C) 2009, 2010, 2011 Nicira Networks, Inc.
97
98 Copying and distribution of this file, with or without modification,
99 are permitted in any medium without royalty provided the copyright
100 notice and this notice are preserved.  This file is offered as-is,
101 without warranty of any kind.