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 are installed on a XenServer system
   8 under the same name; underscores are replaced by slashes.  The files are:
   9
  10     etc_init.d_openvswitch
  11
  12         Initializes Open vSwitch at boot and shuts it down at shutdown.
  13
  14     etc_init.d_openvswitch-xapi-update
  15
  16         Init script to ensure openvswitch-cfg-update is called for the
  17         current host at boot.
  18
  19     etc_logrotate.d_openvswitch
  20
  21         Ensures that logs in /var/log/openvswitch are rotated
  22         periodically and that appropriate daemons reopen their log
  23         files at that point.
  24
  25     etc_profile.d_openvswitch.sh
  26
  27         Open vSwitch-related shell functions for the administrator's
  28         convenience.
  29
  30     etc_xapi.d_plugins_openvswitch-cfg-update
  31
  32         xapi plugin script to update the cache of configuration items
  33         in the ovs-vswitchd configuration that are managed in the
  34         xapi database when integrated with Citrix management tools.
  35
  36     etc_xensource_scripts_vif
  37
  38         Open vSwitch-aware replacement for Citrix script of the same name.
  39
  40     openvswitch-xen.spec
  41
  42         spec file for building RPMs to install on a XenServer host.
  43
  44     opt_xensource_libexec_interface-reconfigure
  45     opt_xensource_libexec_InterfaceReconfigureBridge.py
  46     opt_xensource_libexec_InterfaceReconfigure.py
  47     opt_xensource_libexec_InterfaceReconfigureVswitch.py
  48
  49         Open vSwitch-aware replacements for Citrix script of the same
  50         names.
  51
  52     usr_lib_xsconsole_plugins-base_XSFeatureVSwitch.py
  53
  54         xsconsole plugin to configure the pool-wide configuration keys
  55         used to control Open vSwitch when integrated with Citrix
  56         management tools.
  57
  58     usr_share_openvswitch_scripts_ovs-xapi-sync
  59
  60         Daemon to monitor the external_ids columns of the Bridge and
  61         Interface OVSDB tables for changes that require interrogating
  62         XAPI.
  63
  64     usr_share_openvswitch_scripts_sysconfig.template
  65
  66         Template for Open vSwitch's /etc/sysconfig/openvswitch
  67         configuration file.
  68
  69 Open vSwitch installs a number of xen-bugtool extensions in
  70 /etc/xensource/bugtool to gather additional information useful for
  71 debugging.  The sources for the extensions are in
  72 ../utilities/bugtool/plugins:
  73
  74     kernel-info/openvswitch.xml
  75
  76         Collect kernel information relevant to Open vSwitch, such as
  77         slabinfo.
  78
  79     network-status/openvswitch.xml
  80
  81         Collect networking information relevant to Open vSwitch.  Runs
  82         the following scripts, which are described below:
  83
  84             * ovs-bugtool-cfm-show
  85             * ovs-bugtool-lacp-show
  86             * ovs-bugtool-ovsdb-dump
  87             * ovs-bugtool-tc-class-show
  88             * ovs-bugtool-bond-show
  89             * ovs-bugtool-ovs-ofctl-show
  90             * ovs-bugtool-ovs-ofctl-dump-flows
  91             * ovs-bugtool-ovs-appctl-dpif
  92             * ovs-bugtool-coverage-show
  93             * ovs-bugtool-memory-show
  94             * ovs-bugtool-vsctl-show
  95
  96     system-configuration/openvswitch.xml
  97
  98         Collect system configuration information relevant to Open vSwitch,
  99         including timezone. Runs the following script which is described
 100         below:
 101
 102             * ovs-bugtool-daemons-ver
 103
 104     system-configuration.xml
 105
 106         Collect system configuration data.  This category is configured
 107         to collect up to 1Mb of data, take up to 60 seconds to collect
 108         data, run every time and is hidden from display in XenCenter.
 109
 110 A number of scripts are installed in /usr/share/openvswitch/scripts to
 111 assist Open vSwitch's xen-bugtool extensions.  The sources for the
 112 scripts are located in ../utilities/bugtool:
 113
 114     ovs-bugtool-cfm-show
 115
 116         Script to dump detailed CFM information for all enabled interfaces.
 117
 118     ovs-bugtool-lacp-show
 119
 120         Script to dump detailed LACP information for all enabled ports.
 121
 122     ovs-bugtool-ovsdb-dump
 123
 124         Script to dump contents of Open vSwitch configuration database
 125         in comma-separated value format.
 126
 127     ovs-bugtool-tc-class-show
 128
 129         Script to dump tc class configuration for all network interfaces.
 130
 131     ovs-bugtool-ovs-ofctl-show
 132
 133         Script to dump information about flow tables and ports of each bridge.
 134
 135     ovs-bugtool-ovs-ofctl-dump-flows
 136
 137         Script to dump openflow flows of each bridge.
 138
 139     ovs-bugtool-ovs-appctl-dpif
 140
 141         Script to collect a summary of configured datapaths and datapath flows.
 142
 143     ovs-bugtool-coverage-show
 144
 145         Script to count the number of times particular events occur during
 146         ovs-vswitchd's runtime.
 147
 148     ovs-bugtool-memory-show
 149
 150         Script to show some basic statistics about ovs-vswitchd's memory usage.
 151
 152     ovs-bugtool-vsctl-show
 153
 154         Script to show a brief overview of the database contents.
 155
 156     ovs-bugtool-daemons-ver
 157
 158         Script to dump version information for all Open vSwitch daemons.
 159
 160 ----------------------------------------------------------------------
 161 Copyright (C) 2009, 2010, 2011 Nicira, Inc.
 162
 163 Copying and distribution of this file, with or without modification,
 164 are permitted in any medium without royalty provided the copyright
 165 notice and this notice are preserved.  This file is offered as-is,
 166 without warranty of any kind.