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