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_udev_xen-backend.rules
  34
  35         udev rules for invoking the XenServer "vif" and "tap" scripts.
  36
  37     etc_xapi.d_plugins_vswitch-cfg-update
  38
  39         xapi plugin script to update the cache of configuration items
  40         in the ovs-vswitchd configuration file that are managed in the
  41         xapi database when integrated with Citrix management tools.
  42
  43     etc_xensource_scripts_vif
  44
  45         vswitch-aware replacement for Citrix script of the same name.
  46
  47     opt_xensource_libexec_interface-reconfigure
  48
  49         vswitch-aware replacement for Citrix script of the same name.
  50
  51     root_vswitch_scripts_sysconfig.template
  52
  53         Template for vswitch's /etc/sysconfig/vswitch configuration
  54         file.
  55
  56     usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
  57
  58         xsconsole plugin to configure the pool-wide configuration keys
  59         used to control vswitch when integrated with Citrix management
  60         tools.
  61
  62     usr_sbin_brctl
  63
  64         wrapper for /usr/sbin/brctl that provides some additional
  65         bridge compatibility
  66
  67     usr_sbin_xen-bugtool
  68
  69         vswitch-aware replacement for Citrix script of the same name.
  70
  71     vswitch-xen.spec
  72
  73         spec file for building RPMs to install on a XenServer host.
  74
  75 To install, build the vswitch RPM with a command like this:
  76
  77         rpmbuild -D "vswitch_version $full_version" \
  78                 -D "xen_version $XENKERNEL" \
  79                 -D "build_number --with-build-number=$buildnr" \
  80                 -bb vswitch-xen.spec
  81
  82 Then, "rpm -U" the resulting vswitch package on the XenServer hosts in
  83 question and reboot them.  (The vswitch-dbg package that is also
  84 produced need not be installed, but it is harmless to do so.)
  85
  86 ----------------------------------------------------------------------
  87 Copyright (C) 2009 Nicira Networks, Inc.
  88
  89 Copying and distribution of this file, with or without modification,
  90 are permitted in any medium without royalty provided the copyright
  91 notice and this notice are preserved.  This file is offered as-is,
  92 without warranty of any kind.