From patchwork Mon Jul 24 14:14:49 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Olaf Hering X-Patchwork-Id: 9859577 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 47D72601A1 for ; Mon, 24 Jul 2017 14:17:40 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 3963A27FA3 for ; Mon, 24 Jul 2017 14:17:40 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 2E51F281B7; Mon, 24 Jul 2017 14:17:40 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.1 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_MED,T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id ED7542823D for ; Mon, 24 Jul 2017 14:17:38 +0000 (UTC) Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dZe8s-0004l5-M4; Mon, 24 Jul 2017 14:15:26 +0000 Received: from mail6.bemta6.messagelabs.com ([193.109.254.103]) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dZe8r-0004il-Ht for xen-devel@lists.xen.org; Mon, 24 Jul 2017 14:15:25 +0000 Received: from [193.109.254.147] by server-7.bemta-6.messagelabs.com id EF/65-03557-CF006795; Mon, 24 Jul 2017 14:15:24 +0000 X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFvrJLMWRWlGSWpSXmKPExsUSuHLSbd3fDGW RBvsajS2WfFzM4sDocXT3b6YAxijWzLyk/IoE1ozHv1qYCuabVnQ9mM3UwHhDu4uRi4NF4BeT xLXuYyxdjJwcEgK5Es/nPmbrYuQAskUknvxPA6kREjjEJLFn1WtmkBo2ASWJvQePM4LYIgKpE jOmdoP1MgsoSLx4vpUJxBYWCJB4dWkCG4jNIqAqcbfvEiuIzStgLDH77QR2iF3yEu/6n4LVcw qYSGx9+hksLgRU03j1D9MERt4FjAyrGNWLU4vKUot0zfWSijLTM0pyEzNzdA0NzPRyU4uLE9N TcxKTivWS83M3MQKDgQEIdjDOvOx/iFGSg0lJlHf5uqJIIb6k/JTKjMTijPii0pzU4kOMMhwc ShK8W/6XRgoJFqWmp1akZeYAwxImLcHBoyTCew8kzVtckJhbnJkOkTrFqMvxasL/b0xCLHn5e alS4ryrQYoEQIoySvPgRsBi5BKjrJQwLyPQUUI8BalFuZklqPKvGMU5GJWEeQ+CTOHJzCuB2/ QK6AgmoCPmzAA7oiQRISXVwFgivyDRg2PPzD8/9j85/Dwg5JYq77kGJ5ONgqePpSnsX8/xY/v 8OV/mPbM5rrVP8erUDccv1jL6+ogxu1l+N31xwcJrgYjVpSed06yfPPwdphdqkrJq1xenWtuF XxoUZZtORc1su9mfOutV9NfdLcuCT4U3Pz5jEHr3bfcJ06zkDUn2fmd8XeYrsRRnJBpqMRcVJ wIADwB3p4wCAAA= X-Env-Sender: olaf@aepfle.de X-Msg-Ref: server-9.tower-27.messagelabs.com!1500905723!108702175!1 X-Originating-IP: [81.169.146.219] X-SpamReason: No, hits=0.5 required=7.0 tests=BODY_RANDOM_LONG X-StarScan-Received: X-StarScan-Version: 9.4.25; banners=-,-,- X-VirusChecked: Checked Received: (qmail 52326 invoked from network); 24 Jul 2017 14:15:23 -0000 Received: from mo4-p00-ob.smtp.rzone.de (HELO mo4-p00-ob.smtp.rzone.de) (81.169.146.219) by server-9.tower-27.messagelabs.com with DHE-RSA-AES256-GCM-SHA384 encrypted SMTP; 24 Jul 2017 14:15:23 -0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; t=1500905723; l=6864; s=domk; d=aepfle.de; h=References:In-Reply-To:Date:Subject:Cc:To:From; bh=p0ptr6GcLXqK1h/f37Hr7HNRrDUNKqi+IptzehY05GQ=; b=U0hOdxBuceCiLoI19OGudG7h/k7klwNNdBqbny9ybhWWikATc+KBfO1Rf0cQLv34cN G23uYwAo9VpuhMjjSEHt/bfF8lRyWQXynS/ZQedWgmcMgt/t5rxIGreU/yOvn/CL2DmK 8Z54i9FoOKSS2KNNd4jSnvlS0ja7BeBESUVj0= X-RZG-AUTH: :P2EQZWCpfu+qG7CngxMFH1J+yackYocTD1iAi8x+OWi/zfN1cLnAYQz4nWZeYaUqZmDcaKDKWuInYjY1AKYxM/KZ8U5sbA== X-RZG-CLASS-ID: mo00 Received: from sender ([2001:a61:345b:acff:1864:5839:ae0e:f6b6]) by smtp.strato.de (RZmta 41.1 AUTH) with ESMTPSA id 50583et6OEFGLL8 (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA (curve secp521r1 with 521 ECDH bits, eq. 15360 bits RSA)) (Client did not present a certificate); Mon, 24 Jul 2017 16:15:16 +0200 (CEST) From: Olaf Hering To: xen-devel@lists.xen.org, Ian Jackson , Wei Liu Date: Mon, 24 Jul 2017 16:14:49 +0200 Message-Id: <20170724141450.22971-6-olaf@aepfle.de> X-Mailer: git-send-email 2.13.2 In-Reply-To: <20170724141450.22971-1-olaf@aepfle.de> References: <20170724141450.22971-1-olaf@aepfle.de> Cc: Olaf Hering Subject: [Xen-devel] [PATCH 5/6] docs: remove markdown variant of xl-network-configuration.5 X-BeenThere: xen-devel@lists.xen.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: xen-devel-bounces@lists.xen.org Sender: "Xen-devel" X-Virus-Scanned: ClamAV using ClamSMTP A variant in pod format exists now. Signed-off-by: Olaf Hering --- docs/man/xl-network-configuration.markdown.5 | 173 --------------------------- 1 file changed, 173 deletions(-) delete mode 100644 docs/man/xl-network-configuration.markdown.5 diff --git a/docs/man/xl-network-configuration.markdown.5 b/docs/man/xl-network-configuration.markdown.5 deleted file mode 100644 index 84c2645ad8..0000000000 --- a/docs/man/xl-network-configuration.markdown.5 +++ /dev/null @@ -1,173 +0,0 @@ -# XL Network Configuration - -## Syntax Overview - -This document specifies the xl config file format vif configuration -option. It has the following form: - - vif = [ '', '', ... ] - -where each vifspec is in this form: - - [=|,] - -For example: - - 'mac=00:16:3E:74:3d:76,model=rtl8139,bridge=xenbr0' - 'mac=00:16:3E:74:34:32' - '' # The empty string - -These might be specified in the domain config file like this: - - vif = [ 'mac=00:16:3E:74:34:32', 'mac=00:16:3e:5f:48:e4,bridge=xenbr1' ] - -More formally, the string is a series of comma-separated keyword/value -pairs. All keywords are optional. - -Each device has a `DEVID` which is its index within the vif list, starting from 0. - -## Keywords - -### mac - -If specified then this option specifies the MAC address inside the -guest of this VIF device. The value is a 48-bit number represented as -six groups of two hexadecimal digits, separated by colons (:). - -The default if this keyword is not specified is to be automatically -generate a MAC address inside the space assigned to Xen's -[Organizationally Unique Identifier][oui] (00:16:3e). - -If you are choosing a MAC address then it is strongly recommend to -follow one of the following strategies: - - * Generate a random sequence of 6 byte, set the locally administered - bit (bit 2 of the first byte) and clear the multicast bit (bit 1 - of the first byte). In other words the first byte should have the - bit pattern xxxxxx10 (where x is a randomly generated bit) and the - remaining 5 bytes are randomly generated See - [http://en.wikipedia.org/wiki/MAC_address] for more details the - structure of a MAC address. - * Allocate an address from within the space defined by your - organization's OUI (if you have one) following your organization's - procedures for doing so. - * Allocate an address from within the space defined by Xen's OUI - (00:16:3e). Taking care not to clash with other users of the - physical network segment where this VIF will reside. - -If you have an OUI for your own use then that is the preferred -strategy. Otherwise in general you should prefer to generate a random -MAC and set the locally administered bit since this allows for more -bits of randomness than using the Xen OUI. - -### bridge - -Specifies the name of the network bridge which this VIF should be -added to. The default is `xenbr0`. The bridge must be configured using -your distribution's network configuration tools. See the [wiki][net] -for guidance and examples. - -### gatewaydev - -Specifies the name of the network interface which has an IP and which -is in the network the VIF should communicate with. This is used in the host -by the vif-route hotplug script. See [wiki][vifroute] for guidance and -examples. - -NOTE: netdev is a deprecated alias of this option. - -### type - -This keyword is valid for HVM guests only. - -Specifies the type of device to valid values are: - - * `ioemu` (default) -- this device will be provided as an emulate - device to the guest and also as a paravirtualised device which the - guest may choose to use instead if it has suitable drivers - available. - * `vif` -- this device will be provided as a paravirtualised device - only. - -### model - -This keyword is valid for HVM guest devices with `type=ioemu` only. - -Specifies the type device to emulated for this guest. Valid values -are: - - * `rtl8139` (default) -- Realtek RTL8139 - * `e1000` -- Intel E1000 - * in principle any device supported by your device model - -### vifname - -Specifies the backend device name for the virtual device. - -If the domain is an HVM domain then the associated emulated (tap) -device will have a "-emu" suffice added. - -The default name for the virtual device is `vifDOMID.DEVID` where -`DOMID` is the guest domain ID and `DEVID` is the device -number. Likewise the default tap name is `vifDOMID.DEVID-emu`. - -### script - -Specifies the hotplug script to run to configure this device (e.g. to -add it to the relevant bridge). Defaults to -`XEN_SCRIPT_DIR/vif-bridge` but can be set to any script. Some example -scripts are installed in `XEN_SCRIPT_DIR`. - -### ip - -Specifies the IP address for the device, the default is not to -specify an IP address. - -What, if any, effect this has depends on the hotplug script which is -configured. A typically behaviour (exhibited by the example hotplug -scripts) if set might be to configure firewall rules to allow only the -specified IP address to be used by the guest (blocking all others). - -### backend - -Specifies the backend domain which this device should attach to. This -defaults to domain 0. Specifying another domain requires setting up a -driver domain which is outside the scope of this document. - -### rate - -Specifies the rate at which the outgoing traffic will be limited to. -The default if this keyword is not specified is unlimited. - -The rate may be specified as "/s" or optionally "/s@". - - * `RATE` is in bytes and can accept suffixes: - * GB, MB, KB, B for bytes. - * Gb, Mb, Kb, b for bits. - * `INTERVAL` is in microseconds and can accept suffixes: ms, us, s. - It determines the frequency at which the vif transmission credit - is replenished. The default is 50ms. - -Vif rate limiting is credit-based. It means that for "1MB/s@20ms", the -available credit will be equivalent of the traffic you would have done -at "1MB/s" during 20ms. This will results in a credit of 20,000 bytes -replenished every 20,000 us. - -For example: - - 'rate=10Mb/s' -- meaning up to 10 megabits every second - 'rate=250KB/s' -- meaning up to 250 kilobytes every second - 'rate=1MB/s@20ms' -- meaning 20,000 bytes in every 20 millisecond period - -NOTE: The actual underlying limits of rate limiting are dependent -on the underlying netback implementation. - -### devid - -Specifies the devid manually instead of letting xl choose the lowest index available. - -NOTE: This should not be set unless you have a reason to. - -[oui]: http://en.wikipedia.org/wiki/Organizationally_Unique_Identifier -[net]: http://wiki.xen.org/wiki/HostConfiguration/Networking -[vifroute]: http://wiki.xen.org/wiki/Vif-route