Merge "citrix" into "master".
[openvswitch] / xenserver / README
1 This directory contains files for seamless integration of vswitch on
2 Citrix XenServer hosts managed by the Citrix management tools.
3
4 Some of these files are modifications of Citrix's proprietary code.
5 Citrix has given permission to distribute these modified files.
6 Citrix has not specified a particular license for them.  There is no
7 guarantee that, should Citrix specify a license, that it would be
8 DFSG-compliant or GPL-compatible.
9
10 Most of the files in this directory is installed on a XenServer system
11 under the same name, if underscores are replaced by slashes.  The
12 files are:
13
14     etc_init.d_vswitch
15
16         Initializes the vswitch at boot and shuts it down at shutdown.
17
18     etc_init.d_vswitch-xapi-update
19
20         Init script to ensure vswitch-cfg-update is called for the
21         current host at boot.
22
23     etc_logrotate.d_vswitch
24
25         Ensures that /var/log/ovs-vswitchd.log is rotated periodically
26         and that ovs-vswitchd reopens its log file at that point.
27
28     etc_profile.d_vswitch.sh
29
30         vswitch-related shell functions for the administrator's
31         convenience.
32
33     etc_xapi.d_plugins_vswitch-cfg-update
34
35         xapi plugin script to update the cache of configuration items
36         in the ovs-vswitchd configuration file that are managed in the
37         xapi database when integrated with Citrix management tools.
38
39     etc_xensource_scripts_vif
40
41         vswitch-aware replacement for Citrix script of the same name.
42
43     opt_xensource_libexec_interface-reconfigure
44
45         vswitch-aware replacement for Citrix script of the same name.
46
47     root_vswitch_scripts_dump-vif-details
48
49         Script to retrieve extended information about VIFs that are
50         needed by the controller.  This is called by the "vif" script,
51         which is run when virtual interfaces are added and removed.
52
53     usr_share_vswitch_scripts_refresh-xs-network-uuids
54
55         Script to refresh bridge.<bridge>.xs-network-uuids keys, which
56         can get out-of-sync following a pool join.  Running this script
57         is an alternative to rebooting the host.
58
59     root_vswitch_scripts_sysconfig.template
60
61         Template for vswitch's /etc/sysconfig/vswitch configuration
62         file.
63
64     usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
65
66         xsconsole plugin to configure the pool-wide configuration keys
67         used to control vswitch when integrated with Citrix management
68         tools.
69
70     usr_sbin_brctl
71
72         wrapper for /usr/sbin/brctl that provides some additional
73         bridge compatibility
74
75     usr_sbin_xen-bugtool
76
77         vswitch-aware replacement for Citrix script of the same name.
78
79     vswitch-xen.spec
80
81         spec file for building RPMs to install on a XenServer host.
82
83 To install, build the vswitch RPM with a command like this:
84
85         rpmbuild -D "vswitch_version $full_version" \
86                 -D "xen_version $XENKERNEL" \
87                 -D "build_number --with-build-number=$buildnr" \
88                 -bb vswitch-xen.spec
89
90 Then, "rpm -U" the resulting vswitch package on the XenServer hosts in
91 question and reboot them.  (The vswitch-dbg package that is also
92 produced need not be installed, but it is harmless to do so.)
93
94 ----------------------------------------------------------------------
95 Copyright (C) 2009 Nicira Networks, Inc.
96
97 Copying and distribution of this file, with or without modification,
98 are permitted in any medium without royalty provided the copyright
99 notice and this notice are preserved.  This file is offered as-is,
100 without warranty of any kind.