Skip to content

Commit 6200b63

Browse files
author
David Scott
committed
Split out networking into its own xen-api section
Signed-off-by: David Scott <[email protected]>
1 parent 08efcbc commit 6200b63

File tree

3 files changed

+102
-97
lines changed

3 files changed

+102
-97
lines changed

‎_data/navbar.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
- xen-api/snapshots.md
2525
- xen-api/consoles.md
2626
- xen-api/install-vms.md
27+
- xen-api/networking.md
2728
- xen-api/udhcp.md
2829
- xen-api/index.html
2930
- title: Xapi

‎xen-api/extensions.md‎

Lines changed: 0 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -45,103 +45,6 @@ The control domain privileged user-space interfaces can now be restricted to onl
4545

4646
- The VNC guest consoles are bound only to the `localhost` interface, so that they are not exposed externally even if the control domain packet filter is disabled by user intervention.
4747

48-
Advanced settings for network interfaces
49-
----------------------------------------
50-
51-
Virtual and physical network interfaces have some advanced settings that can be configured using the `other-config` map parameter. There is a set of custom ethtool settings and some miscellaneous settings.
52-
53-
### ethtool settings
54-
55-
Developers might wish to configure custom ethtool settings for physical and virtual network interfaces. This is accomplished with `ethtool-<option>` keys in the `other-config` map parameter.
56-
57-
<table>
58-
<col width="20%" />
59-
<col width="49%" />
60-
<col width="28%" />
61-
<thead>
62-
<tr class="header">
63-
<th align="left">Key</th>
64-
<th align="left">Description</th>
65-
<th align="left">Valid settings</th>
66-
</tr>
67-
</thead>
68-
<tbody>
69-
<tr class="odd">
70-
<td align="left">ethtool-rx</td>
71-
<td align="left">Specify if RX checksumming is enabled</td>
72-
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
73-
</tr>
74-
<tr class="even">
75-
<td align="left">ethtool-tx</td>
76-
<td align="left">Specify if TX checksumming is enabled</td>
77-
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
78-
</tr>
79-
<tr class="odd">
80-
<td align="left">ethtool-sg</td>
81-
<td align="left">Specify if scatter-gather is enabled</td>
82-
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
83-
</tr>
84-
<tr class="even">
85-
<td align="left">ethtool-tso</td>
86-
<td align="left">Specify if tcp segmentation offload is enabled</td>
87-
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
88-
</tr>
89-
<tr class="odd">
90-
<td align="left">ethtool-ufo</td>
91-
<td align="left">Specify if UDP fragmentation offload is enabled</td>
92-
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
93-
</tr>
94-
<tr class="even">
95-
<td align="left">ethtool-gso</td>
96-
<td align="left">Specify if generic segmentation offload is enabled</td>
97-
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
98-
</tr>
99-
<tr class="odd">
100-
<td align="left">ethtool-autone g</td>
101-
<td align="left">Specify if autonegotiation is enabled</td>
102-
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
103-
</tr>
104-
<tr class="even">
105-
<td align="left">ethtool-speed</td>
106-
<td align="left">Set the device speed in Mb/s</td>
107-
<td align="left">10, 100, or 1000</td>
108-
</tr>
109-
<tr class="odd">
110-
<td align="left">ethtool-duplex</td>
111-
<td align="left">Set full or half duplex mode</td>
112-
<td align="left">half or full</td>
113-
</tr>
114-
</tbody>
115-
</table>
116-
117-
For example, to enable TX checksumming on a virtual NIC using the xe CLI:
118-
119-
xe vif-param-set uuid=<VIF UUID> other-config:ethtool-tx="on"
120-
121-
or:
122-
123-
xe vif-param-set uuid=<VIF UUID> other-config:ethtool-tx="true"
124-
125-
To set the duplex setting on a physical NIC to half duplex using the xe CLI:
126-
127-
xe vif-param-set uuid=<VIF UUID> other-config:ethtool-duplex="half"
128-
129-
### Miscellaneous settings
130-
131-
You can also set a promiscuous mode on a VIF or PIF by setting the `promiscuous` key to `on`. For example, to enable promiscuous mode on a physical NIC using the xe CLI:
132-
133-
xe pif-param-set uuid=<PIF UUID> other-config:promiscuous="on"
134-
135-
or:
136-
137-
xe pif-param-set uuid=<PIF UUID> other-config:promiscuous="true"
138-
139-
The VIF and PIF objects have a `MTU` parameter that is read-only and provide the current setting of the maximum transmission unit for the interface. You can override the default maximum transmission unit of a physical or virtual NIC with the `mtu` key in the `other-config` map parameter. For example, to reset the MTU on a virtual NIC to use jumbo frames using the xe CLI:
140-
141-
xe vif-param-set uuid=<VIF UUID> other-config:mtu=9000
142-
143-
Note that changing the MTU of underlying interfaces is an advanced and experimental feature, and may lead to unexpected side-effects if you have varying MTUs across NICs in a single resource pool.
144-
14548
Internationalization for SR names
14649
---------------------------------
14750

‎xen-api/networking.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
title: Networking
3+
layout: default
4+
---
5+
6+
Advanced settings for network interfaces
7+
----------------------------------------
8+
9+
Virtual and physical network interfaces have some advanced settings that can be configured using the `other-config` map parameter. There is a set of custom ethtool settings and some miscellaneous settings.
10+
11+
### ethtool settings
12+
13+
Developers might wish to configure custom ethtool settings for physical and virtual network interfaces. This is accomplished with `ethtool-<option>` keys in the `other-config` map parameter.
14+
15+
<table>
16+
<col width="20%" />
17+
<col width="49%" />
18+
<col width="28%" />
19+
<thead>
20+
<tr class="header">
21+
<th align="left">Key</th>
22+
<th align="left">Description</th>
23+
<th align="left">Valid settings</th>
24+
</tr>
25+
</thead>
26+
<tbody>
27+
<tr class="odd">
28+
<td align="left">ethtool-rx</td>
29+
<td align="left">Specify if RX checksumming is enabled</td>
30+
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
31+
</tr>
32+
<tr class="even">
33+
<td align="left">ethtool-tx</td>
34+
<td align="left">Specify if TX checksumming is enabled</td>
35+
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
36+
</tr>
37+
<tr class="odd">
38+
<td align="left">ethtool-sg</td>
39+
<td align="left">Specify if scatter-gather is enabled</td>
40+
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
41+
</tr>
42+
<tr class="even">
43+
<td align="left">ethtool-tso</td>
44+
<td align="left">Specify if tcp segmentation offload is enabled</td>
45+
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
46+
</tr>
47+
<tr class="odd">
48+
<td align="left">ethtool-ufo</td>
49+
<td align="left">Specify if UDP fragmentation offload is enabled</td>
50+
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
51+
</tr>
52+
<tr class="even">
53+
<td align="left">ethtool-gso</td>
54+
<td align="left">Specify if generic segmentation offload is enabled</td>
55+
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
56+
</tr>
57+
<tr class="odd">
58+
<td align="left">ethtool-autone g</td>
59+
<td align="left">Specify if autonegotiation is enabled</td>
60+
<td align="left"><code>on</code> or <code>true</code> to enable the setting, <code>off</code> or <code>false</code> to disable it</td>
61+
</tr>
62+
<tr class="even">
63+
<td align="left">ethtool-speed</td>
64+
<td align="left">Set the device speed in Mb/s</td>
65+
<td align="left">10, 100, or 1000</td>
66+
</tr>
67+
<tr class="odd">
68+
<td align="left">ethtool-duplex</td>
69+
<td align="left">Set full or half duplex mode</td>
70+
<td align="left">half or full</td>
71+
</tr>
72+
</tbody>
73+
</table>
74+
75+
For example, to enable TX checksumming on a virtual NIC using the xe CLI:
76+
77+
xe vif-param-set uuid=<VIF UUID> other-config:ethtool-tx="on"
78+
79+
or:
80+
81+
xe vif-param-set uuid=<VIF UUID> other-config:ethtool-tx="true"
82+
83+
To set the duplex setting on a physical NIC to half duplex using the xe CLI:
84+
85+
xe vif-param-set uuid=<VIF UUID> other-config:ethtool-duplex="half"
86+
87+
### Miscellaneous settings
88+
89+
You can also set a promiscuous mode on a VIF or PIF by setting the `promiscuous` key to `on`. For example, to enable promiscuous mode on a physical NIC using the xe CLI:
90+
91+
xe pif-param-set uuid=<PIF UUID> other-config:promiscuous="on"
92+
93+
or:
94+
95+
xe pif-param-set uuid=<PIF UUID> other-config:promiscuous="true"
96+
97+
The VIF and PIF objects have a `MTU` parameter that is read-only and provide the current setting of the maximum transmission unit for the interface. You can override the default maximum transmission unit of a physical or virtual NIC with the `mtu` key in the `other-config` map parameter. For example, to reset the MTU on a virtual NIC to use jumbo frames using the xe CLI:
98+
99+
xe vif-param-set uuid=<VIF UUID> other-config:mtu=9000
100+
101+
Note that changing the MTU of underlying interfaces is an advanced and experimental feature, and may lead to unexpected side-effects if you have varying MTUs across NICs in a single resource pool.

0 commit comments

Comments
 (0)