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-bfd-show
  85             * ovs-bugtool-cfm-show
  86             * ovs-bugtool-fdb-show
  87             * ovs-bugtool-lacp-show
  88             * ovs-bugtool-list-dbs
  89             * ovs-bugtool-ovsdb-dump
  90             * ovs-bugtool-tc-class-show
  91             * ovs-bugtool-bond-show
  92             * ovs-bugtool-ovs-ofctl-show
  93             * ovs-bugtool-ovs-ofctl-dump-flows
  94             * ovs-bugtool-ovs-appctl-dpif
  95             * ovs-bugtool-coverage-show
  96             * ovs-bugtool-memory-show
  97             * ovs-bugtool-vsctl-show
  98             * ovs-bugtool-conntrack-dump
  99
 100     system-configuration/openvswitch.xml
 101
 102         Collect system configuration information relevant to Open vSwitch,
 103         including timezone. Runs the following script which is described
 104         below:
 105
 106             * ovs-bugtool-daemons-ver
 107
 108     system-configuration.xml
 109
 110         Collect system configuration data.  This category is configured
 111         to collect up to 1Mb of data, take up to 60 seconds to collect
 112         data, run every time and is hidden from display in XenCenter.
 113
 114 A number of scripts are installed in /usr/share/openvswitch/scripts to
 115 assist Open vSwitch's xen-bugtool extensions.  The sources for the
 116 scripts are located in ../utilities/bugtool:
 117
 118     ovs-bugtool-bfd-show
 119
 120         Script to dump detailed BFD information for all enabled interfaces.
 121
 122     ovs-bugtool-cfm-show
 123
 124         Script to dump detailed CFM information for all enabled interfaces.
 125
 126     ovs-bugtool-fdb-show
 127
 128         Script to collect a summary of learned MACs for each bridge.
 129
 130     ovs-bugtool-lacp-show
 131
 132         Script to dump detailed LACP information for all enabled ports.
 133
 134     ovs-bugtool-list-dbs
 135
 136         Script to list the databases controlled by ovsdb-server.
 137
 138     ovs-bugtool-ovsdb-dump
 139
 140         Script to dump contents of Open vSwitch configuration database
 141         in comma-separated value format.
 142
 143     ovs-bugtool-tc-class-show
 144
 145         Script to dump tc class configuration for all network interfaces.
 146
 147     ovs-bugtool-ovs-ofctl-show
 148
 149         Script to dump information about flow tables and ports of each bridge.
 150
 151     ovs-bugtool-ovs-ofctl-dump-flows
 152
 153         Script to dump openflow flows of each bridge.
 154
 155     ovs-bugtool-ovs-appctl-dpif
 156
 157         Script to collect a summary of configured datapaths and datapath flows.
 158
 159     ovs-bugtool-coverage-show
 160
 161         Script to count the number of times particular events occur during
 162         ovs-vswitchd's runtime.
 163
 164     ovs-bugtool-memory-show
 165
 166         Script to show some basic statistics about ovs-vswitchd's memory usage.
 167
 168     ovs-bugtool-vsctl-show
 169
 170         Script to show a brief overview of the database contents.
 171
 172     ovs-bugtool-conntrack-dump
 173
 174         Script to show all the connection entries in the tracker.
 175
 176     ovs-bugtool-daemons-ver
 177
 178         Script to dump version information for all Open vSwitch daemons.
 179
 180 ----------------------------------------------------------------------
 181 Copyright (C) 2009, 2010, 2011 Nicira, Inc.
 182
 183 Copying and distribution of this file, with or without modification,
 184 are permitted in any medium without royalty provided the copyright
 185 notice and this notice are preserved.  This file is offered as-is,
 186 without warranty of any kind.