You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ra...@apache.org on 2013/04/10 13:57:49 UTC
[1/3] git commit: updated refs/heads/master to 5e445f9
Updated Branches:
refs/heads/master bdc82627f -> 5e445f9dd
CLOUDSTACK-772
Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/c2fb870f
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/c2fb870f
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/c2fb870f
Branch: refs/heads/master
Commit: c2fb870f7cab75443b9cd6283acc7b0f2f14067a
Parents: bdc8262
Author: radhikap <ra...@citrix.com>
Authored: Tue Apr 9 12:32:19 2013 +0530
Committer: radhikap <ra...@citrix.com>
Committed: Wed Apr 10 17:26:32 2013 +0530
----------------------------------------------------------------------
docs/en-US/Book_Info.xml | 2 +-
docs/en-US/add-clusters-vsphere.xml | 104 ++++-
docs/en-US/images/add-cluster.png | Bin 46302 -> 35697 bytes
docs/en-US/images/dvswitch-config.png | Bin 0 -> 41955 bytes
docs/en-US/images/dvswitchconfig.png | Bin 0 -> 38642 bytes
docs/en-US/vmware-cluster-config-dvswitch.xml | 193 ++++++++
docs/en-US/vmware-install.xml | 511 +++++++++++++-------
7 files changed, 614 insertions(+), 196 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/c2fb870f/docs/en-US/Book_Info.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/Book_Info.xml b/docs/en-US/Book_Info.xml
index c125ab8..0ab84c4 100644
--- a/docs/en-US/Book_Info.xml
+++ b/docs/en-US/Book_Info.xml
@@ -27,7 +27,7 @@
<title>&PRODUCT; Guide</title>
<subtitle>Revised August 9, 2012 10:48 pm Pacific</subtitle>
<productname>Apache CloudStack</productname>
- <productnumber>4.0.0-incubating</productnumber>
+ <productnumber>4.0.0</productnumber>
<edition>1</edition>
<pubsnumber></pubsnumber>
<abstract>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/c2fb870f/docs/en-US/add-clusters-vsphere.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/add-clusters-vsphere.xml b/docs/en-US/add-clusters-vsphere.xml
index 6b2dff2..c3a0902 100644
--- a/docs/en-US/add-clusters-vsphere.xml
+++ b/docs/en-US/add-clusters-vsphere.xml
@@ -71,38 +71,106 @@
<para>In Hypervisor, choose VMware.</para>
</listitem>
<listitem>
- <para>Provide the following information in the dialog. The fields below make reference to
+ <para>Provide the following information in the dialog. The fields below make reference to the
values from vCenter.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/add-cluster.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>addcluster.png: add a cluster</phrase>
+ </textobject>
+ </mediaobject>
<itemizedlist>
<listitem>
- <para>Cluster Name. Enter the name of the cluster you created in vCenter. For example,
- "cloud.cluster.2.2.1"</para>
+ <para><emphasis role="bold">Cluster Name</emphasis>: Enter the name of the cluster you
+ created in vCenter. For example, "cloud.cluster.2.2.1"</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">vCenter Username</emphasis>: Enter the username that &PRODUCT;
+ should use to connect to vCenter. This user must have all the administrative
+ privileges.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">CPU overcommit ratio</emphasis>: Enter the CPU overcommit
+ ratio for the cluster. The value you enter determines the CPU consumption of each VM in
+ the selected cluster. By increasing the over-provisioning ratio, more resource capacity
+ will be used. If no value is specified, the value is defaulted to 1, which implies no
+ over-provisioning is done.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">RAM overcommit ratio</emphasis>: Enter the RAM overcommit
+ ratio for the cluster. The value you enter determines the memory consumption of each VM
+ in the selected cluster. By increasing the over-provisioning ratio, more resource
+ capacity will be used. If no value is specified, the value is defaulted to 1, which
+ implies no over-provisioning is done.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">vCenter Host</emphasis>: Enter the hostname or IP address of
+ the vCenter server.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">vCenter Password</emphasis>: Enter the password for the user
+ named above.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">vCenter Datacenter</emphasis>: Enter the vCenter datacenter
+ that the cluster is in. For example, "cloud.dc.VM".</para>
</listitem>
<listitem>
- <para>vCenter Host. Enter the hostname or IP address of the vCenter server. </para>
+ <para><emphasis role="bold">Override Public Traffic</emphasis>: Enable this option to
+ override the zone-wide public traffic for the cluster you are creating.</para>
</listitem>
<listitem>
- <para>vCenter Username. Enter the username that &PRODUCT; should use to connect to
- vCenter. This user must have all administrative privileges.</para>
+ <para><emphasis role="bold">Public Traffic vSwitch Type</emphasis>: This option is
+ displayed only if you enable the Override Public Traffic option. Select a desirable
+ switch. If the vmware.use.dvswitch global parameter is true, the default option will be
+ VMware vNetwork Distributed Virtual Switch.</para>
+ <para>If you have enabled Nexus dvSwitch in the environment, the following parameters for
+ dvSwitch configuration are displayed:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Nexus dvSwitch IP Address: The IP address of the Nexus VSM appliance.</para>
+ </listitem>
+ <listitem>
+ <para>Nexus dvSwitch Username: The username required to access the Nexus VSM
+ appliance.</para>
+ </listitem>
+ <listitem>
+ <para>Nexus dvSwitch Password: The password associated with the username specified
+ above.</para>
+ </listitem>
+ </itemizedlist>
</listitem>
<listitem>
- <para>vCenter Password. Enter the password for the user named above</para>
+ <para><emphasis role="bold">Override Guest Traffic</emphasis>: Enable this option to
+ override the zone-wide guest traffic for the cluster you are creating.</para>
</listitem>
<listitem>
- <para>vCenter Datacenter. Enter the vCenter datacenter that the cluster is in. For
- example, "cloud.dc.VM".</para>
+ <para><emphasis role="bold">Guest Traffic vSwitch Type</emphasis>: This option is
+ displayed only if you enable the Override Guest Traffic option. Select a desirable
+ switch. </para>
+ <para>If the vmware.use.dvswitch global parameter is true, the default option will be
+ VMware vNetwork Distributed Virtual Switch.</para>
+ <para>If you have enabled Nexus dvSwitch in the environment, the following parameters for
+ dvSwitch configuration are displayed:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Nexus dvSwitch IP Address: The IP address of the Nexus VSM appliance.</para>
+ </listitem>
+ <listitem>
+ <para>Nexus dvSwitch Username: The username required to access the Nexus VSM
+ appliance.</para>
+ </listitem>
+ <listitem>
+ <para>Nexus dvSwitch Password: The password associated with the username specified
+ above.</para>
+ </listitem>
+ </itemizedlist>
</listitem>
<listitem>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/add-cluster.png"/>
- </imageobject>
- <textobject>
- <phrase>addcluster.png: add cluster</phrase>
- </textobject>
- </mediaobject>
<para>There might be a slight delay while the cluster is provisioned. It will
- automatically display in the UI</para>
+ automatically display in the UI.</para>
</listitem>
</itemizedlist>
</listitem>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/c2fb870f/docs/en-US/images/add-cluster.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/add-cluster.png b/docs/en-US/images/add-cluster.png
index 383f375..4b24ec7 100644
Binary files a/docs/en-US/images/add-cluster.png and b/docs/en-US/images/add-cluster.png differ
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/c2fb870f/docs/en-US/images/dvswitch-config.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/dvswitch-config.png b/docs/en-US/images/dvswitch-config.png
new file mode 100644
index 0000000..edce6e8
Binary files /dev/null and b/docs/en-US/images/dvswitch-config.png differ
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/c2fb870f/docs/en-US/images/dvswitchconfig.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/dvswitchconfig.png b/docs/en-US/images/dvswitchconfig.png
new file mode 100644
index 0000000..55b1ef7
Binary files /dev/null and b/docs/en-US/images/dvswitchconfig.png differ
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/c2fb870f/docs/en-US/vmware-cluster-config-dvswitch.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vmware-cluster-config-dvswitch.xml b/docs/en-US/vmware-cluster-config-dvswitch.xml
new file mode 100644
index 0000000..dfbaca1
--- /dev/null
+++ b/docs/en-US/vmware-cluster-config-dvswitch.xml
@@ -0,0 +1,193 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="vmware-cluster-config-dvswitch">
+ <title>Configuring a vSphere Cluster with VMware Distributed Virtual Switch</title>
+ <para>&PRODUCT;supports VMware vNetwork Distributed Switch (VDS) for virtual network configuration
+ in a VMware vSphere environment. This section helps you configure VMware VDS in a &PRODUCT;
+ deployment. Each vCenter server instance can support up to 128 VDS instances and each VDS
+ instance can manage up to 500 VMware hosts.</para>
+ <section id="about-dvswitch">
+ <title>About VMware Distributed Virtual Switch</title>
+ <para>VMware VDS is an aggregation of host-level virtual switches on a VMware vCenter server.
+ VDS abstracts the configuration of individual virtual switches that span across a large number
+ of hosts, and enables centralized provisioning, administration, and monitoring for your entire
+ datacenter from a centralized interface. In effect, a VDS acts as a single virtual switch at
+ the datacenter level and manages networking for a number of hosts in a datacenter from a
+ centralized VMware vCenter server. Each VDS maintains network runtime state for VMs as they
+ move across multiple hosts, enabling inline monitoring and centralized firewall services. A
+ VDS can be deployed with or without Virtual Standard Switch and a Nexus 1000V virtual
+ switch.</para>
+ </section>
+ <section id="prereq-dvswitch">
+ <title>Prerequisites and Guidelines</title>
+ <itemizedlist>
+ <listitem>
+ <para>Do not attempt to configure VDS by altering VMware traffic label when configuring
+ physical networks. This will only work for Standard Virtual Switch and should not be
+ distributed.</para>
+ </listitem>
+ <listitem>
+ <para>VMware VDS does not support multiple VDS per traffic type. If a user has many VDS
+ switches, only one can be used for Guest traffic and another one for Public
+ traffic.</para>
+ </listitem>
+ <listitem>
+ <para>Management and Storage network does not support VDS. Therefore, use Standard Switch
+ for these networks.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="enable-dvswitch">
+ <title>Enabling Virtual Distributed Switch in &PRODUCT;</title>
+ <para>To make a &PRODUCT; deployment VDS enabled, set the vmware.use.dvswitch parameter to true
+ by using the Global Settings page in the &PRODUCT; UI and restart the Management Server.
+ Unless you enable the vmware.use.dvswitch parameter, you cannot see any UI options specific to
+ VDS, and &PRODUCT; ignores the VDS-specific parameters given in the AddClusterCmd API call.
+ Additionally, &PRODUCT; uses VDS for virtual network infrastructure if the value of
+ vmware.use.dvswitch parameter is true and the value of vmware.use.nexus.dvswitch parameter is
+ false.</para>
+ <para>&PRODUCT; supports configuring virtual networks in a deployment with a mix of Virtual
+ Distributed Switch, Standard Virtual Switch and Nexus 1000v Virtual Switch. </para>
+ </section>
+ <section id="config-dvswitch">
+ <title>Configuring Distributed Virtual Switch in &PRODUCT;</title>
+ <para>You can configure VDS by adding the necessary resources while a zone is created.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/dvSwitch-config.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>dvSwitchConfig.png: Configuring dvSwitch</phrase>
+ </textobject>
+ </mediaobject>
+ <para>Alternatively, you can create an additional cluster with VDS enabled in the existing zone.
+ Use the Add Cluster option. For information as given in <xref linkend="add-clusters-vsphere"
+ />.</para>
+ <para>In both these cases, you must specify the following parameters to configure VDS:</para>
+ <informaltable frame="all">
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2"/>
+ <thead>
+ <row>
+ <entry><para>Parameters</para></entry>
+ <entry><para>Description</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>Cluster Name</para></entry>
+ <entry><para>Enter the name of the cluster you created in vCenter. For example,
+ "cloud.cluster".</para></entry>
+ </row>
+ <row>
+ <entry><para>vCenter Host</para></entry>
+ <entry><para>Enter the host name or the IP address of the vCenter host where you have
+ deployed the Nexus virtual switch.</para></entry>
+ </row>
+ <row>
+ <entry><para>vCenter User name</para></entry>
+ <entry><para>Enter the username that &PRODUCT; should use to connect to vCenter. This
+ user must have all administrative privileges.</para></entry>
+ </row>
+ <row>
+ <entry><para>vCenter Password</para></entry>
+ <entry><para>Enter the password for the user named above.</para></entry>
+ </row>
+ <row>
+ <entry><para>vCenter Datacenter</para></entry>
+ <entry><para>Enter the vCenter datacenter that the cluster is in. For example,
+ "cloud.dc.VM".</para></entry>
+ </row>
+ <row>
+ <entry><para>Override Public Traffic</para></entry>
+ <entry><para>Enable this option to override the zone-wide public traffic for the cluster
+ you are creating. </para></entry>
+ </row>
+ <row>
+ <entry><para>Public Traffic vSwitch Type</para></entry>
+ <entry><para>This option is displayed only if you enable the Override Public Traffic
+ option. Select VMware vNetwork Distributed Virtual Switch. </para>
+ <para>If the vmware.use.dvswitch global parameter is true, the default option will be
+ VMware vNetwork Distributed Virtual Switch.</para></entry>
+ </row>
+ <row>
+ <entry><para>Public Traffic vSwitch Name</para></entry>
+ <entry><para>Specify a name to identify the switch.</para></entry>
+ </row>
+ <row>
+ <entry><para>Override Guest Traffic</para></entry>
+ <entry><para>Enable the option to override the zone-wide guest traffic for the cluster
+ you are creating.</para></entry>
+ </row>
+ <row>
+ <entry><para>Guest Traffic vSwitch Type</para></entry>
+ <entry><para>This option is displayed only if you enable the Override Guest Traffic
+ option. Select VMware vNetwork Distributed Virtual Switch. </para>
+ <para>If the vmware.use.dvswitch global parameter is true, the default option will be
+ VMware vNetwork Distributed Virtual Switch.</para></entry>
+ </row>
+ <row>
+ <entry><para>Guest Traffic vSwitch Name</para></entry>
+ <entry><para>Specify a name to identify the switch.</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+ <section id="vmware-dvswitch-remove">
+ <title>Removing Nexus Virtual Switch</title>
+ <orderedlist>
+ <listitem>
+ <para>In the vCenter datacenter that is served by the VMware dvSwitch, ensure that you
+ delete all the hosts in the corresponding cluster.</para>
+ </listitem>
+ <listitem>
+ <para>Log in with Admin permissions to the &PRODUCT; administrator UI.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation bar, select Infrastructure.</para>
+ </listitem>
+ <listitem>
+ <para>In the Infrastructure page, click View all under Clusters.</para>
+ </listitem>
+ <listitem>
+ <para>Select the cluster where you want to remove the virtual switch.</para>
+ </listitem>
+ <listitem>
+ <para>In the VMware dvSwitch tab, click the name of the virtual switch.</para>
+ </listitem>
+ <listitem>
+ <para> In the Details page, click Delete VMware dvSwitch icon. <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/delete-button.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>DeleteButton.png: button to delete dvSwitch</phrase>
+ </textobject>
+ </inlinemediaobject>
+ </para>
+ <para>Click Yes in the confirmation dialog box.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/c2fb870f/docs/en-US/vmware-install.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vmware-install.xml b/docs/en-US/vmware-install.xml
index 467e135..fd88fc7 100644
--- a/docs/en-US/vmware-install.xml
+++ b/docs/en-US/vmware-install.xml
@@ -327,282 +327,439 @@ esxcfg-firewall -o 59000-60000,tcp,out,vncextras
guide.</para>
</section>
</section>
- <!-- <section id="vmware-vsphere-cluster-config-nexus-vswitch">
+ <section id="vmware-vsphere-cluster-config-nexus-vswitch">
<title>Configuring a vSphere Cluster with Nexus 1000v Virtual Switch</title>
- <para>&PRODUCT; supports Cisco Nexus 1000v dvSwitch (Distributed Virtual Switch) for virtual network configuration in a VMware vSphere environment. This section helps you configure a vSphere cluster with Nexus 1000v virtual switch in a VMware vCenter environment. For information on creating a vSphere cluster, see <xref linkend="vmware-install" /></para>
+ <para>&PRODUCT; supports Cisco Nexus 1000v dvSwitch (Distributed Virtual Switch) for virtual
+ network configuration in a VMware vSphere environment. This section helps you configure a
+ vSphere cluster with Nexus 1000v virtual switch in a VMware vCenter environment. For
+ information on creating a vSphere cluster, see <xref linkend="vmware-install"/></para>
<section id="vmware-vsphere-cluster-config-nexus-vswitch-about">
- <title>About Cisco Nexus 1000v Distributed Virtual Switch</title>
- <para>The Cisco Nexus 1000V virtual switch is a software-based virtual machine access switch for VMware vSphere environments. It can span multiple hosts running VMware ESXi 4.0 and later. A Nexus virtual switch consists of two components: the Virtual Supervisor Module (VSM) and the Virtual Ethernet Module (VEM). The VSM is a virtual appliance that acts as the switch's supervisor. It controls multiple VEMs as a single network device. The VSM is installed independent of the VEM and is deployed in redundancy mode as pairs or as a standalone appliance. The VEM is installed on each VMware ESXi server to provide packet-forwarding capability. It provides each virtual machine with dedicated switch ports. This VSM-VEM architecture is analogous to a physical Cisco switch's supervisor (standalone or configured in high-availability mode) and multiple linecards architecture.</para>
- <para>Nexus 1000v switch uses vEthernet port profiles to simplify network provisioning for virtual machines. There are two types of port profiles: Ethernet port profile and vEthernet port profile. The Ethernet port profile is applied to the physical uplink ports-the NIC ports of the physical NIC adapter on an ESXi server. The vEthernet port profile is associated with the virtual NIC (vNIC) that is plumbed on a guest VM on the ESXi server. The port profiles help the network administrators define network policies which can be reused for new virtual machines. The Ethernet port profiles are created on the VSM and are represented as port groups on the vCenter server.</para>
+ <title>About Cisco Nexus 1000v Distributed Virtual Switch</title>
+ <para>The Cisco Nexus 1000V virtual switch is a software-based virtual machine access switch
+ for VMware vSphere environments. It can span multiple hosts running VMware ESXi 4.0 and
+ later. A Nexus virtual switch consists of two components: the Virtual Supervisor Module
+ (VSM) and the Virtual Ethernet Module (VEM). The VSM is a virtual appliance that acts as the
+ switch's supervisor. It controls multiple VEMs as a single network device. The VSM is
+ installed independent of the VEM and is deployed in redundancy mode as pairs or as a
+ standalone appliance. The VEM is installed on each VMware ESXi server to provide
+ packet-forwarding capability. It provides each virtual machine with dedicated switch ports.
+ This VSM-VEM architecture is analogous to a physical Cisco switch's supervisor
+ (standalone or configured in high-availability mode) and multiple linecards
+ architecture.</para>
+ <para>Nexus 1000v switch uses vEthernet port profiles to simplify network provisioning for
+ virtual machines. There are two types of port profiles: Ethernet port profile and vEthernet
+ port profile. The Ethernet port profile is applied to the physical uplink ports-the NIC
+ ports of the physical NIC adapter on an ESXi server. The vEthernet port profile is
+ associated with the virtual NIC (vNIC) that is plumbed on a guest VM on the ESXi server. The
+ port profiles help the network administrators define network policies which can be reused
+ for new virtual machines. The Ethernet port profiles are created on the VSM and are
+ represented as port groups on the vCenter server.</para>
</section>
<section id="vmware-vsphere-cluster-config-nexus-vswitch-prerequisite-guide">
- <title>Prerequisites and Guidelines</title>
- <para>This section discusses prerequisites and guidelines for using Nexus virtual switch in &PRODUCT;. Before configuring Nexus virtual switch, ensure that your system meets the following requirements:</para>
- <itemizedlist>
- <listitem><para>A cluster of servers (ESXi 4.1 or later) is configured in the vCenter.</para></listitem>
- <listitem><para>Each cluster managed by &PRODUCT; is the only cluster in its vCenter datacenter.</para></listitem>
- <listitem><para>A Cisco Nexus 1000v virtual switch is installed to serve the datacenter that contains the vCenter cluster. This ensures that &PRODUCT; doesn't have to deal with dynamic migration of virtual adapters or networks across other existing virtual switches. See <ulink url="http://www.cisco.com/en/US/docs/switches/datacenter/nexus1000/sw/4_2_1_s_v_1_5_1/install_upgrade/vsm_vem/guide/n1000v_installupgrade.html">Cisco Nexus 1000V Installation and Upgrade Guide</ulink> for guidelines on how to install the Nexus 1000v VSM and VEM modules.</para></listitem>
- <listitem><para>The Nexus 1000v VSM is not deployed on a vSphere host that is managed by &PRODUCT;.</para></listitem>
- <listitem><para>When the maximum number of VEM modules per VSM instance is reached, an additional VSM instance is created before introducing any more ESXi hosts. The limit is 64 VEM modules for each VSM instance.</para></listitem>
- <listitem><para>&PRODUCT; expects that the Management Network of the ESXi host is configured on the standard vSwitch and searches for it in the standard vSwitch. Therefore, ensure that you do not migrate the management network to Nexus 1000v virtual switch during configuration.</para></listitem>
- <listitem><para>All information given in <xref linkend="vmware-vsphere-cluster-config-nexus-vswitch-preconfig" /></para></listitem>
- </itemizedlist>
+ <title>Prerequisites and Guidelines</title>
+ <para>This section discusses prerequisites and guidelines for using Nexus virtual switch in
+ &PRODUCT;. Before configuring Nexus virtual switch, ensure that your system meets the
+ following requirements:</para>
+ <itemizedlist>
+ <listitem>
+ <para>A cluster of servers (ESXi 4.1 or later) is configured in the vCenter.</para>
+ </listitem>
+ <listitem>
+ <para>Each cluster managed by &PRODUCT; is the only cluster in its vCenter
+ datacenter.</para>
+ </listitem>
+ <listitem>
+ <para>A Cisco Nexus 1000v virtual switch is installed to serve the datacenter that
+ contains the vCenter cluster. This ensures that &PRODUCT; doesn't have to deal with
+ dynamic migration of virtual adapters or networks across other existing virtual
+ switches. See <ulink
+ url="http://www.cisco.com/en/US/docs/switches/datacenter/nexus1000/sw/4_2_1_s_v_1_5_1/install_upgrade/vsm_vem/guide/n1000v_installupgrade.html"
+ >Cisco Nexus 1000V Installation and Upgrade Guide</ulink> for guidelines on how to
+ install the Nexus 1000v VSM and VEM modules.</para>
+ </listitem>
+ <listitem>
+ <para>The Nexus 1000v VSM is not deployed on a vSphere host that is managed by
+ &PRODUCT;.</para>
+ </listitem>
+ <listitem>
+ <para>When the maximum number of VEM modules per VSM instance is reached, an additional
+ VSM instance is created before introducing any more ESXi hosts. The limit is 64 VEM
+ modules for each VSM instance.</para>
+ </listitem>
+ <listitem>
+ <para>&PRODUCT; expects that the Management Network of the ESXi host is configured on the
+ standard vSwitch and searches for it in the standard vSwitch. Therefore, ensure that you
+ do not migrate the management network to Nexus 1000v virtual switch during
+ configuration.</para>
+ </listitem>
+ <listitem>
+ <para>All information given in <xref
+ linkend="vmware-vsphere-cluster-config-nexus-vswitch-preconfig"/></para>
+ </listitem>
+ </itemizedlist>
</section>
<section id="vmware-vsphere-cluster-config-nexus-vswitch-preconfig">
- <title>Nexus 1000v Virtual Switch Preconfiguration</title>
- <section id="vmware-vsphere-cluster-config-nexus-vswitch-preconfig-checklist">
+ <title>Nexus 1000v Virtual Switch Preconfiguration</title>
+ <section id="vmware-vsphere-cluster-config-nexus-vswitch-preconfig-checklist">
<title>Preparation Checklist</title>
- <para>For a smoother configuration of Nexus 1000v switch, gather the following information before you start:</para>
+ <para>For a smoother configuration of Nexus 1000v switch, gather the following information
+ before you start:</para>
<itemizedlist>
- <listitem><para>vCenter Credentials</para></listitem>
- <listitem><para>Nexus 1000v VSM IP address</para></listitem>
- <listitem><para>Nexus 1000v VSM Credentials</para></listitem>
- <listitem><para>Ethernet port profile names</para></listitem>
+ <listitem>
+ <para>vCenter Credentials</para>
+ </listitem>
+ <listitem>
+ <para>Nexus 1000v VSM IP address</para>
+ </listitem>
+ <listitem>
+ <para>Nexus 1000v VSM Credentials</para>
+ </listitem>
+ <listitem>
+ <para>Ethernet port profile names</para>
+ </listitem>
</itemizedlist>
<section id="vmware-vsphere-cluster-config-nexus-vswitch-vcenter-credential-checklist">
- <title>vCenter Credentials Checklist</title>
- <para>You will need the following information about vCenter:</para>
- <informaltable frame="all">
+ <title>vCenter Credentials Checklist</title>
+ <para>You will need the following information about vCenter:</para>
+ <informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" />
- <colspec colname="c2" />
- <colspec colname="c3" />
- <thead>
+ <colspec colname="c1"/>
+ <colspec colname="c2"/>
+ <colspec colname="c3"/>
+ <thead>
<row>
- <entry><para>Nexus vSwitch Requirements</para></entry>
- <entry><para>Value</para></entry>
- <entry><para>Notes</para></entry>
+ <entry><para>Nexus vSwitch Requirements</para></entry>
+ <entry><para>Value</para></entry>
+ <entry><para>Notes</para></entry>
</row>
- </thead>
- <tbody>
+ </thead>
+ <tbody>
<row>
- <entry><para>vCenter IP</para></entry>
- <entry><para></para></entry>
- <entry><para>The IP address of the vCenter.</para></entry>
+ <entry><para>vCenter IP</para></entry>
+ <entry><para/></entry>
+ <entry><para>The IP address of the vCenter.</para></entry>
</row>
<row>
- <entry><para>Secure HTTP Port Number</para></entry>
- <entry><para>443</para></entry>
- <entry><para>Port 443 is configured by default; however, you can change the port if needed.</para></entry>
+ <entry><para>Secure HTTP Port Number</para></entry>
+ <entry><para>443</para></entry>
+ <entry><para>Port 443 is configured by default; however, you can change the port
+ if needed.</para></entry>
</row>
<row>
- <entry><para>vCenter User ID</para></entry>
- <entry><para></para></entry>
- <entry><para>The vCenter user with administrator-level privileges. The vCenter User ID is required when you configure the virtual switch in &PRODUCT;.</para></entry>
+ <entry><para>vCenter User ID</para></entry>
+ <entry><para/></entry>
+ <entry><para>The vCenter user with administrator-level privileges. The vCenter
+ User ID is required when you configure the virtual switch in
+ &PRODUCT;.</para></entry>
</row>
<row>
- <entry><para>vCenter Password</para></entry>
- <entry><para></para></entry>
- <entry><para>The password for the vCenter user specified above. The password for this vCenter user is required when you configure the switch in &PRODUCT;.</para></entry>
+ <entry><para>vCenter Password</para></entry>
+ <entry><para/></entry>
+ <entry><para>The password for the vCenter user specified above. The password for
+ this vCenter user is required when you configure the switch in
+ &PRODUCT;.</para></entry>
</row>
- </tbody>
+ </tbody>
</tgroup>
- </informaltable>
+ </informaltable>
</section>
<section id="vmware-vsphere-cluster-config-nexus-vswitch-net-config-checklist">
- <title>Network Configuration Checklist</title>
- <para>The following information specified in the Nexus Configure Networking screen is displayed in the Details tab of the Nexus dvSwitch in the &PRODUCT; UI:</para>
- <informaltable frame="all">
+ <title>Network Configuration Checklist</title>
+ <para>The following information specified in the Nexus Configure Networking screen is
+ displayed in the Details tab of the Nexus dvSwitch in the &PRODUCT; UI:</para>
+ <informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" />
- <colspec colname="c2" />
- <colspec colname="c3" />
- <thead>
+ <colspec colname="c1"/>
+ <colspec colname="c2"/>
+ <colspec colname="c3"/>
+ <thead>
<row>
- <entry><para>Network Requirements</para></entry>
- <entry><para>Value</para></entry>
- <entry><para>Notes</para></entry>
+ <entry><para>Network Requirements</para></entry>
+ <entry><para>Value</para></entry>
+ <entry><para>Notes</para></entry>
</row>
- </thead>
- <tbody>
+ </thead>
+ <tbody>
<row>
- <entry><para>Control Port Group VLAN ID</para></entry>
- <entry><para></para></entry>
- <entry><para>The VLAN ID of the Control Port Group. The control VLAN is used for communication between the VSM and the VEMs.</para></entry>
+ <entry><para>Control Port Group VLAN ID</para></entry>
+ <entry><para/></entry>
+ <entry><para>The VLAN ID of the Control Port Group. The control VLAN is used for
+ communication between the VSM and the VEMs.</para></entry>
</row>
<row>
- <entry><para>Management Port Group VLAN ID</para></entry>
- <entry><para></para></entry>
- <entry><para>The VLAN ID of the Management Port Group. The management VLAN corresponds to the mgmt0 interface that is used to establish and maintain the connection between the VSM and VMware vCenter Server.</para></entry>
+ <entry><para>Management Port Group VLAN ID</para></entry>
+ <entry><para/></entry>
+ <entry><para>The VLAN ID of the Management Port Group. The management VLAN
+ corresponds to the mgmt0 interface that is used to establish and maintain the
+ connection between the VSM and VMware vCenter Server.</para></entry>
</row>
<row>
- <entry><para>Packet Port Group VLAN ID</para></entry>
- <entry><para></para></entry>
- <entry><para>The VLAN ID of the Packet Port Group. The packet VLAN forwards relevant data packets from the VEMs to the VSM.</para></entry>
+ <entry><para>Packet Port Group VLAN ID</para></entry>
+ <entry><para/></entry>
+ <entry><para>The VLAN ID of the Packet Port Group. The packet VLAN forwards
+ relevant data packets from the VEMs to the VSM.</para></entry>
</row>
- </tbody>
+ </tbody>
</tgroup>
- </informaltable>
- <note><para>The VLANs used for control, packet, and management port groups can be the same.</para></note>
- <para>For more information, see <ulink url="http://www.cisco.com/en/US/docs/switches/datacenter/nexus1000/sw/4_2_1_s_v_1_4_b/getting_started/configuration/guide/n1000v_gsg.pdf">Cisco Nexus 1000V Getting Started Guide</ulink>.</para>
+ </informaltable>
+ <note>
+ <para>The VLANs used for control, packet, and management port groups can be the
+ same.</para>
+ </note>
+ <para>For more information, see <ulink
+ url="http://www.cisco.com/en/US/docs/switches/datacenter/nexus1000/sw/4_2_1_s_v_1_4_b/getting_started/configuration/guide/n1000v_gsg.pdf"
+ >Cisco Nexus 1000V Getting Started Guide</ulink>.</para>
</section>
<section id="vmware-vsphere-cluster-config-nexus-vswitch-vsm-config-checklist">
- <title>VSM Configuration Checklist</title>
- <para>You will need the following information about network configuration:</para>
- <informaltable frame="all">
+ <title>VSM Configuration Checklist</title>
+ <para>You will need the following information about network configuration:</para>
+ <informaltable frame="all">
<tgroup cols="3" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" />
- <colspec colname="c2" />
- <colspec colname="c3" />
- <thead>
+ <colspec colname="c1"/>
+ <colspec colname="c2"/>
+ <colspec colname="c3"/>
+ <thead>
<row>
- <entry><para>VSM Configuration Parameters Value Notes</para></entry>
- <entry><para>Value</para></entry>
- <entry><para>Notes</para></entry>
+ <entry><para>VSM Configuration Parameters Value Notes</para></entry>
+ <entry><para>Value</para></entry>
+ <entry><para>Notes</para></entry>
</row>
- </thead>
- <tbody>
+ </thead>
+ <tbody>
<row>
- <entry><para>Admin Name and Password</para></entry>
- <entry><para></para></entry>
- <entry><para>The admin name and password to connect to the VSM appliance. You must specify these credentials while configuring Nexus virtual switch.</para></entry>
+ <entry><para>Admin Name and Password</para></entry>
+ <entry><para/></entry>
+ <entry><para>The admin name and password to connect to the VSM appliance. You must
+ specify these credentials while configuring Nexus virtual
+ switch.</para></entry>
</row>
<row>
- <entry><para>Management IP Address</para></entry>
- <entry><para></para></entry>
- <entry><para>This is the IP address of the VSM appliance. This is the IP address you specify in the virtual switch IP Address field while configuting Nexus virtual switch.</para></entry>
+ <entry><para>Management IP Address</para></entry>
+ <entry><para/></entry>
+ <entry><para>This is the IP address of the VSM appliance. This is the IP address
+ you specify in the virtual switch IP Address field while configuting Nexus
+ virtual switch.</para></entry>
</row>
<row>
- <entry><para>SSL</para></entry>
- <entry><para>Enable</para></entry>
- <entry><para>Always enable SSL. SSH is usually enabled by default during the VSM installation. However, check whether the SSH connection to the VSM is working, without which &PRODUCT; failes to connect to the VSM.</para></entry>
+ <entry><para>SSL</para></entry>
+ <entry><para>Enable</para></entry>
+ <entry><para>Always enable SSL. SSH is usually enabled by default during the VSM
+ installation. However, check whether the SSH connection to the VSM is working,
+ without which &PRODUCT; failes to connect to the VSM.</para></entry>
</row>
- </tbody>
+ </tbody>
</tgroup>
- </informaltable>
- </section>
+ </informaltable>
</section>
- <section id="vmware-vsphere-cluster-config-nexus-vswitch-create-port-profile">
+ </section>
+ <section id="vmware-vsphere-cluster-config-nexus-vswitch-create-port-profile">
<title>Creating a Port Profile</title>
<itemizedlist>
- <listitem>
- <para>Whether you create a Basic or Advanced zone configuration, ensure that you always create an Ethernet port profile on the VSM after you install it and before you create the zone.</para>
+ <listitem>
+ <para>Whether you create a Basic or Advanced zone configuration, ensure that you always
+ create an Ethernet port profile on the VSM after you install it and before you create
+ the zone.</para>
<itemizedlist>
- <listitem><para>The Ethernet port profile created to represent the physical network or networks used by an Advanced zone configuration trunk all the VLANs including guest VLANs, the VLANs that serve the native VLAN, and the packet/control/data/management VLANs of the VSM.</para></listitem>
- <listitem><para>The Ethernet port profile created for a Basic zone configuration does not trunk the guest VLANs because the guest VMs do not get their own VLANs provisioned on their network interfaces in a Basic zone.</para></listitem>
+ <listitem>
+ <para>The Ethernet port profile created to represent the physical network or
+ networks used by an Advanced zone configuration trunk all the VLANs including
+ guest VLANs, the VLANs that serve the native VLAN, and the
+ packet/control/data/management VLANs of the VSM.</para>
+ </listitem>
+ <listitem>
+ <para>The Ethernet port profile created for a Basic zone configuration does not
+ trunk the guest VLANs because the guest VMs do not get their own VLANs provisioned
+ on their network interfaces in a Basic zone.</para>
+ </listitem>
</itemizedlist>
- </listitem>
- <listitem><para>An Ethernet port profile configured on the Nexus 1000v virtual switch should not use in its set of system VLANs, or any of the VLANs configured or intended to be configured for use towards VMs or VM resources in the &PRODUCT; environment.</para></listitem>
- <listitem><para>You do not have to create any vEthernet port profiles – &PRODUCT; does that during VM deployment.</para></listitem>
- <listitem><para>Ensure that you create required port profiles to be used by &PRODUCT; for different traffic types of &PRODUCT;, such as Management traffic, Guest traffic, Storage traffic, and Public traffic. The physical networks configured during zone creation should have a one-to-one relation with the Ethernet port profiles.</para></listitem>
+ </listitem>
+ <listitem>
+ <para>An Ethernet port profile configured on the Nexus 1000v virtual switch should not
+ use in its set of system VLANs, or any of the VLANs configured or intended to be
+ configured for use towards VMs or VM resources in the &PRODUCT; environment.</para>
+ </listitem>
+ <listitem>
+ <para>You do not have to create any vEthernet port profiles – &PRODUCT; does that during
+ VM deployment.</para>
+ </listitem>
+ <listitem>
+ <para>Ensure that you create required port profiles to be used by &PRODUCT; for
+ different traffic types of &PRODUCT;, such as Management traffic, Guest traffic,
+ Storage traffic, and Public traffic. The physical networks configured during zone
+ creation should have a one-to-one relation with the Ethernet port profiles.</para>
+ </listitem>
</itemizedlist>
<mediaobject>
- <imageobject>
+ <imageobject>
<imagedata fileref="./images/vmware-nexus-port-profile.png"/>
- </imageobject>
- <textobject>
+ </imageobject>
+ <textobject>
<phrase>vsphereclient.png: vSphere client</phrase>
- </textobject>
+ </textobject>
</mediaobject>
- <para>For information on creating a port profile, see <ulink url="http://www.cisco.com/en/US/docs/switches/datacenter/nexus1000/sw/4_2_1_s_v_1_4_a/port_profile/configuration/guide/n1000v_port_profile.html">Cisco Nexus 1000V Port Profile Configuration Guide</ulink>.</para>
- </section>
- <section id="vmware-vsphere-cluster-config-nexus-vswitch-assign-nic-adapters">
+ <para>For information on creating a port profile, see <ulink
+ url="http://www.cisco.com/en/US/docs/switches/datacenter/nexus1000/sw/4_2_1_s_v_1_4_a/port_profile/configuration/guide/n1000v_port_profile.html"
+ >Cisco Nexus 1000V Port Profile Configuration Guide</ulink>.</para>
+ </section>
+ <section id="vmware-vsphere-cluster-config-nexus-vswitch-assign-nic-adapters">
<title>Assigning Physical NIC Adapters</title>
- <para>Assign ESXi host's physical NIC adapters, which correspond to each physical network, to the port profiles. In each ESXi host that is part of the vCenter cluster, observe the physical networks assigned to each port profile and note down the names of the port profile for future use. This mapping information helps you when configuring physical networks during the zone configuration on &PRODUCT;. These Ethernet port profile names are later specified as VMware Traffic Labels for different traffic types when configuring physical networks during the zone configuration. For more information on configuring physical networks, see <xref linkend="vmware-vsphere-cluster-config-nexus-vswitch" />.</para>
- </section>
- <section id="vmware-vsphere-cluster-config-nexus-vswitch-add-vlan-range">
+ <para>Assign ESXi host's physical NIC adapters, which correspond to each physical
+ network, to the port profiles. In each ESXi host that is part of the vCenter cluster,
+ observe the physical networks assigned to each port profile and note down the names of the
+ port profile for future use. This mapping information helps you when configuring physical
+ networks during the zone configuration on &PRODUCT;. These Ethernet port profile names are
+ later specified as VMware Traffic Labels for different traffic types when configuring
+ physical networks during the zone configuration. For more information on configuring
+ physical networks, see <xref linkend="vmware-vsphere-cluster-config-nexus-vswitch"
+ />.</para>
+ </section>
+ <section id="vmware-vsphere-cluster-config-nexus-vswitch-add-vlan-range">
<title>Adding VLAN Ranges</title>
- <para>Determine the public VLAN, System VLAN, and Guest VLANs to be used by the &PRODUCT;. Ensure that you add them to the port profile database. Corresponding to each physical network, add the VLAN range to port profiles. In the VSM command prompt, run the switchport trunk allowed vlan<range> command to add the VLAN ranges to the port profile.</para>
+ <para>Determine the public VLAN, System VLAN, and Guest VLANs to be used by the &PRODUCT;.
+ Ensure that you add them to the port profile database. Corresponding to each physical
+ network, add the VLAN range to port profiles. In the VSM command prompt, run the
+ switchport trunk allowed vlan<range> command to add the VLAN ranges to the port
+ profile.</para>
<para>For example:</para>
<programlisting>switchport trunk allowed vlan 1,140-147,196-203</programlisting>
<para>In this example, the allowed VLANs added are 1, 140-147, and 196-203</para>
- <para>You must also add all the public and private VLANs or VLAN ranges to the switch. This range is the VLAN range you specify in your zone.</para>
- <note><para>Before you run the vlan command, ensure that the configuration mode is enabled in Nexus 1000v virtual switch.</para></note>
+ <para>You must also add all the public and private VLANs or VLAN ranges to the switch. This
+ range is the VLAN range you specify in your zone.</para>
+ <note>
+ <para>Before you run the vlan command, ensure that the configuration mode is enabled in
+ Nexus 1000v virtual switch.</para>
+ </note>
<para>For example:</para>
<para>If you want the VLAN 200 to be used on the switch, run the following command:</para>
<programlisting>vlan 200</programlisting>
- <para>If you want the VLAN range 1350-1750 to be used on the switch, run the following command:</para>
+ <para>If you want the VLAN range 1350-1750 to be used on the switch, run the following
+ command:</para>
<programlisting>vlan 1350-1750</programlisting>
<para>Refer to Cisco Nexus 1000V Command Reference of specific product version.</para>
- </section>
+ </section>
</section>
<section id="vmware-vsphere-cluster-config-nexus-vswitch-enable">
- <title>Enabling Nexus Virtual Switch in &PRODUCT;</title>
- <para>To make a &PRODUCT; deployment Nexus enabled, you must set the vmware.use.nexus.vswitch parameter true by using the Global Settings page in the &PRODUCT; UI. Unless this parameter is set to "true" and restart the management server, you cannot see any UI options specific to Nexus virtual switch, and &PRODUCT; ignores the Nexus virtual switch specific parameters specified in the AddTrafficTypeCmd, UpdateTrafficTypeCmd, and AddClusterCmd API calls.</para>
- <para>Unless the &PRODUCT; global parameter "vmware.use.nexus.vswitch" is set to "true", &PRODUCT; by default uses VMware standard vSwitch for virtual network infrastructure. In this release, &PRODUCT; doesn’t support configuring virtual networks in a deployment with a mix of standard vSwitch and Nexus 1000v virtual switch. The deployment can have either standard vSwitch or Nexus 1000v virtual switch.</para>
+ <title>Enabling Nexus Virtual Switch in &PRODUCT;</title>
+ <para>To make a &PRODUCT; deployment Nexus enabled, you must set the vmware.use.nexus.vswitch
+ parameter true by using the Global Settings page in the &PRODUCT; UI. Unless this parameter
+ is set to "true" and restart the management server, you cannot see any UI options
+ specific to Nexus virtual switch, and &PRODUCT; ignores the Nexus virtual switch specific
+ parameters specified in the AddTrafficTypeCmd, UpdateTrafficTypeCmd, and AddClusterCmd API
+ calls.</para>
+ <para>Unless the &PRODUCT; global parameter "vmware.use.nexus.vswitch" is set to
+ "true", &PRODUCT; by default uses VMware standard vSwitch for virtual network
+ infrastructure. In this release, &PRODUCT; doesn’t support configuring virtual networks in a
+ deployment with a mix of standard vSwitch and Nexus 1000v virtual switch. The deployment can
+ have either standard vSwitch or Nexus 1000v virtual switch.</para>
</section>
<section id="vmware-vsphere-cluster-config-nexus-vswitch-config">
- <title>Configuring Nexus 1000v Virtual Switch in &PRODUCT;</title>
- <para>You can configure Nexus dvSwitch by adding the necessary resources while the zone is being created.</para>
- <mediaobject>
+ <title>Configuring Nexus 1000v Virtual Switch in &PRODUCT;</title>
+ <para>You can configure Nexus dvSwitch by adding the necessary resources while the zone is
+ being created.</para>
+ <mediaobject>
<imageobject>
- <imagedata fileref="./images/vmware-nexus-add-cluster.png"/>
+ <imagedata fileref="./images/vmware-nexus-add-cluster.png"/>
</imageobject>
<textobject>
- <phrase>vsphereclient.png: vSphere client</phrase>
+ <phrase>vsphereclient.png: vSphere client</phrase>
</textobject>
- </mediaobject>
- <para>After the zone is created, if you want to create an additional cluster along with Nexus 1000v virtual switch in the existing zone, use the Add Cluster option. For information on creating a cluster, see <xref linkend="add-clusters-vsphere" />.</para>
- <para>In both these cases, you must specify the following parameters to configure Nexus virtual switch:</para>
- <informaltable frame="all">
+ </mediaobject>
+ <para>After the zone is created, if you want to create an additional cluster along with Nexus
+ 1000v virtual switch in the existing zone, use the Add Cluster option. For information on
+ creating a cluster, see <xref linkend="add-clusters-vsphere"/>.</para>
+ <para>In both these cases, you must specify the following parameters to configure Nexus
+ virtual switch:</para>
+ <informaltable frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" />
- <colspec colname="c2" />
- <thead>
+ <colspec colname="c1"/>
+ <colspec colname="c2"/>
+ <thead>
<row>
- <entry><para>Parameters</para></entry>
- <entry><para>Description</para></entry>
+ <entry><para>Parameters</para></entry>
+ <entry><para>Description</para></entry>
</row>
- </thead>
- <tbody>
+ </thead>
+ <tbody>
<row>
- <entry><para>Cluster Name</para></entry>
- <entry><para>Enter the name of the cluster you created in vCenter. For example, "cloud.cluster".</para></entry>
+ <entry><para>Cluster Name</para></entry>
+ <entry><para>Enter the name of the cluster you created in vCenter. For example,
+ "cloud.cluster".</para></entry>
</row>
<row>
- <entry><para>vCenter Host</para></entry>
- <entry><para>Enter the host name or the IP address of the vCenter host where you have deployed the Nexus virtual switch.</para></entry>
+ <entry><para>vCenter Host</para></entry>
+ <entry><para>Enter the host name or the IP address of the vCenter host where you have
+ deployed the Nexus virtual switch.</para></entry>
</row>
<row>
- <entry><para>vCenter User name</para></entry>
- <entry><para>Enter the username that &PRODUCT; should use to connect to vCenter. This user must have all administrative privileges.</para></entry>
+ <entry><para>vCenter User name</para></entry>
+ <entry><para>Enter the username that &PRODUCT; should use to connect to vCenter. This
+ user must have all administrative privileges.</para></entry>
</row>
<row>
- <entry><para>vCenter Password</para></entry>
- <entry><para>Enter the password for the user named above.</para></entry>
+ <entry><para>vCenter Password</para></entry>
+ <entry><para>Enter the password for the user named above.</para></entry>
</row>
<row>
- <entry><para>vCenter Datacenter</para></entry>
- <entry><para>Enter the vCenter datacenter that the cluster is in. For example, "cloud.dc.VM".</para></entry>
+ <entry><para>vCenter Datacenter</para></entry>
+ <entry><para>Enter the vCenter datacenter that the cluster is in. For example,
+ "cloud.dc.VM".</para></entry>
</row>
<row>
- <entry><para>Nexus dvSwitch IP Address</para></entry>
- <entry><para>The IP address of the VSM component of the Nexus 1000v virtual switch.</para></entry>
+ <entry><para>Nexus dvSwitch IP Address</para></entry>
+ <entry><para>The IP address of the VSM component of the Nexus 1000v virtual
+ switch.</para></entry>
</row>
<row>
- <entry><para>Nexus dvSwitch Username</para></entry>
- <entry><para>The admin name to connect to the VSM appliance.</para></entry>
+ <entry><para>Nexus dvSwitch Username</para></entry>
+ <entry><para>The admin name to connect to the VSM appliance.</para></entry>
</row>
<row>
- <entry><para>Nexus dvSwitch Password</para></entry>
- <entry><para>The corresponding password for the admin user specified above.</para></entry>
+ <entry><para>Nexus dvSwitch Password</para></entry>
+ <entry><para>The corresponding password for the admin user specified
+ above.</para></entry>
</row>
- </tbody>
+ </tbody>
</tgroup>
- </informaltable>
+ </informaltable>
</section>
<section id="vmware-vsphere-cluster-config-nexus-vswitch-remove">
- <title>Removing Nexus Virtual Switch</title>
- <orderedlist>
- <listitem><para>In the vCenter datacenter that is served by the Nexus virtual switch, ensure that you delete all the hosts in the corresponding cluster.</para></listitem>
- <listitem><para>Log in with Admin permissions to the &PRODUCT; administrator UI.</para></listitem>
- <listitem><para>In the left navigation bar, select Infrastructure.</para></listitem>
- <listitem><para>In the Infrastructure page, click View all under Clusters.</para></listitem>
- <listitem><para>Select the cluster where you want to remove the virtual switch.</para></listitem>
- <listitem><para>In the dvSwitch tab, click the name of the virtual switch.</para></listitem>
+ <title>Removing Nexus Virtual Switch</title>
+ <orderedlist>
+ <listitem>
+ <para>In the vCenter datacenter that is served by the Nexus virtual switch, ensure that
+ you delete all the hosts in the corresponding cluster.</para>
+ </listitem>
+ <listitem>
+ <para>Log in with Admin permissions to the &PRODUCT; administrator UI.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation bar, select Infrastructure.</para>
+ </listitem>
<listitem>
- <para>
- In the Details page, click Delete Nexus dvSwitch icon.
- <inlinemediaobject>
- <imageobject><imagedata fileref="./images/delete-button.png" /></imageobject>
- <textobject><phrase>DeleteButton.png: button to delete dvSwitch</phrase></textobject>
+ <para>In the Infrastructure page, click View all under Clusters.</para>
+ </listitem>
+ <listitem>
+ <para>Select the cluster where you want to remove the virtual switch.</para>
+ </listitem>
+ <listitem>
+ <para>In the dvSwitch tab, click the name of the virtual switch.</para>
+ </listitem>
+ <listitem>
+ <para> In the Details page, click Delete Nexus dvSwitch icon. <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/delete-button.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>DeleteButton.png: button to delete dvSwitch</phrase>
+ </textobject>
</inlinemediaobject>
- </para>
- <para>Click Yes in the confirmation dialog box.</para>
+ </para>
+ <para>Click Yes in the confirmation dialog box.</para>
</listitem>
- </orderedlist>
- </section>
-</section> -->
+ </orderedlist>
+ </section>
+ </section>
+ <xi:include href="vmware-cluster-config-dvswitch.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<section id="vmware-vsphere-iscsi-storage-preparation">
<title>Storage Preparation for vSphere (iSCSI only)</title>
<para>Use of iSCSI requires preparatory work in vCenter. You must add an iSCSI target and create
[3/3] git commit: updated refs/heads/master to 5e445f9
Posted by ra...@apache.org.
CLOUDSTACK-809
Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/5e445f9d
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/5e445f9d
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/5e445f9d
Branch: refs/heads/master
Commit: 5e445f9dd71233638fedeb91ba36aecaae769e8e
Parents: 38a8db9
Author: radhikap <ra...@citrix.com>
Authored: Wed Apr 10 17:24:50 2013 +0530
Committer: radhikap <ra...@citrix.com>
Committed: Wed Apr 10 17:26:38 2013 +0530
----------------------------------------------------------------------
docs/en-US/added-API-commands-4.2.xml | 19 ++++---
docs/en-US/multiple-ip-nic.xml | 79 ++++++---------------------
2 files changed, 30 insertions(+), 68 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5e445f9d/docs/en-US/added-API-commands-4.2.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/added-API-commands-4.2.xml b/docs/en-US/added-API-commands-4.2.xml
index 3b765f2..4bec148 100644
--- a/docs/en-US/added-API-commands-4.2.xml
+++ b/docs/en-US/added-API-commands-4.2.xml
@@ -22,17 +22,22 @@
<title>Added API Commands in 4.2</title>
<itemizedlist>
<listitem>
- <para>addIpToNic (Adds an IP address to the NIC from the guest subnet. The request parameters
- are: nicid, ipaddress)</para>
+ <para>addIpToNic </para>
+ <para>Adds an IP address to the NIC from the guest subnet. The request parameters are: nicid,
+ ipaddress.</para>
+ <para>The response parameters are: nicid, ipaddress, networkid </para>
</listitem>
<listitem>
- <para>removeIpFromNic (Removes the reserved IP for the NIC. The request parameters is:
- id)</para>
+ <para>removeIpFromNic</para>
+ <para> Removes the reserved IP for the NIC. The request parameters is: id.</para>
+ <para>The response parameters are: true, false</para>
</listitem>
<listitem>
- <para>listNics (Lists the NIC details of the user VM; the API response also contains the
- Secondary IP addresses of the NIC. The request parameters are: nicid,
- virtualmachineid)</para>
+ <para>listNics</para>
+ <para>Lists the NIC details of the user VM; the API response also contains the Secondary IP
+ addresses of the NIC. The request parameters are: nicid, virtualmachineid.</para>
+ <para>The response parameters are: id, ipaddress, secondaryips, gateway, netmask, macaddr,
+ broadcasturi, isolationuri, isdefault,</para>
</listitem>
</itemizedlist>
</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/5e445f9d/docs/en-US/multiple-ip-nic.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/multiple-ip-nic.xml b/docs/en-US/multiple-ip-nic.xml
index fb9a331..561ba07 100644
--- a/docs/en-US/multiple-ip-nic.xml
+++ b/docs/en-US/multiple-ip-nic.xml
@@ -21,27 +21,32 @@
-->
<section id="multiple-ip-nic">
<title>Configuring Multiple IP Addresses on a Single NIC</title>
- <para>&PRODUCT; now provides you the ability to associate multiple private IP addresses per NIC.
- This feature is supported on all the network configurations—Basic, Advanced, and VPC.
- Security Groups, Static NAT and Port forwarding services are supported on these additional IPs.
- In addition to the primary IP, you can assign additional IPs to the guest VM NIC. Up to 256 IP
- addresses are allowed per NIC.</para>
+ <para>&PRODUCT; now provides you the ability to associate multiple private IP addresses per guest
+ VM NIC. This feature is supported on all the network configurations—Basic, Advanced, and
+ VPC. Security Groups, Static NAT and Port forwarding services are supported on these additional
+ IPs. In addition to the primary IP, you can assign additional IPs to the guest VM NIC. Up to 256
+ IP addresses are allowed per NIC.</para>
<para>As always, you can specify an IP from the guest subnet; if not specified, an IP is
- automatically picked up from the guest subnet. You can view the IPs and associated NICs
- for each VMs on the UI. You can apply NAT on these additional guest IPs by using firewall
+ automatically picked up from the guest VM subnet. You can view the IPs associated with for each
+ guest VM NICs on the UI. You can apply NAT on these additional guest IPs by using firewall
configuration in the &PRODUCT; UI. You must specify the NIC to which the IP should be
associated.</para>
<para>This feature is supported on XenServer, KVM, and VMware hypervisors.</para>
+ <note>
+ <para>You need to configure the secondary IP address on the guest VM. &PRODUCT; will
+ not configure the acquired IP address on the VM. Ensure that you assign IPs to NIC each
+ time the VM reboots.</para>
+ </note>
<para>Some of the use cases are described below:</para>
<itemizedlist>
<listitem>
- <para>Building network appliances: Network appliances, such as firewalls and load
- balancers, generally work best when they have access to multiple IP addresses on the
- network interface.</para>
+ <para>Building network appliances: Network appliances, such as firewalls and load balancers,
+ generally work best when they have access to multiple IP addresses on the network
+ interface.</para>
</listitem>
<listitem>
- <para>Moving private IP addresses between interfaces or instances. Applications that are
- bound to specific IP addresses can be moved between instances. </para>
+ <para>Moving private IP addresses between interfaces or instances. Applications that are bound
+ to specific IP addresses can be moved between instances. </para>
</listitem>
<listitem>
<para>Hosting multiple SSL Websites on a single instance. You can install multiple SSL
@@ -74,55 +79,7 @@
</listitem>
</orderedlist>
</section>
- <section id="api-nic">
- <title>API Changes</title>
- <para>The following APIs have been added:</para>
- <informaltable>
- <tgroup cols="4" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry><para>Parameter Name</para></entry>
- <entry><para>Description</para></entry>
- <entry><para>Request Parameter</para></entry>
- <entry><para>Response Parameter</para></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>addIpToNic</para></entry>
- <entry><para>Adds an IP address to the NIC from the guest subnet.</para></entry>
- <entry>
- <para>nicid</para>
- <para>(optional) ipaddress </para>
- </entry>
- <entry><para>nicid</para>
- <para>ipaddress</para>
- <para>networkid </para></entry>
- </row>
- <row>
- <entry><para>removeIpFromNic</para></entry>
- <entry><para>Removes the reserved IP for the NIC.</para></entry>
- <entry>
- <para>id</para>
- </entry>
- <entry><para>true</para>
- <para>false</para></entry>
- </row>
- <row>
- <entry><para>listNics</para></entry>
- <entry><para>Lists the NIC details of the user VM; the API response also contains
- the Secondary IP addresses of the NIC.</para></entry>
- <entry>
- <para>virtualmachineid</para>
- <para>(optional) nicid</para>
- </entry>
- <entry><para>Lists the NIC details including secondary IP address </para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section id="caveats-rn">
+ <section id="caveats">
<title>Port Forwarding and StaticNAT Services Changes</title>
<para>Because multiple IPs can be associated per NIC, you are allowed to select a desired IP for
the Port Forwarding and StaticNAT services. The default is the primary IP. To enable this
[2/3] git commit: updated refs/heads/master to 5e445f9
Posted by ra...@apache.org.
CLOUDSTACK-809
Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/38a8db90
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/38a8db90
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/38a8db90
Branch: refs/heads/master
Commit: 38a8db9046eb680f368335634be838499d7b2aa5
Parents: c2fb870
Author: radhikap <ra...@citrix.com>
Authored: Tue Apr 9 13:32:08 2013 +0530
Committer: radhikap <ra...@citrix.com>
Committed: Wed Apr 10 17:26:35 2013 +0530
----------------------------------------------------------------------
docs/en-US/added-API-commands-4.2.xml | 38 ++++++++
docs/en-US/multiple-ip-nic.xml | 134 ++++++++++++++++++++++++++++
docs/en-US/networks.xml | 1 +
docs/en-US/whats-new.xml | 6 +-
4 files changed, 178 insertions(+), 1 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/38a8db90/docs/en-US/added-API-commands-4.2.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/added-API-commands-4.2.xml b/docs/en-US/added-API-commands-4.2.xml
new file mode 100644
index 0000000..3b765f2
--- /dev/null
+++ b/docs/en-US/added-API-commands-4.2.xml
@@ -0,0 +1,38 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="added-API-commands-4.2">
+ <title>Added API Commands in 4.2</title>
+ <itemizedlist>
+ <listitem>
+ <para>addIpToNic (Adds an IP address to the NIC from the guest subnet. The request parameters
+ are: nicid, ipaddress)</para>
+ </listitem>
+ <listitem>
+ <para>removeIpFromNic (Removes the reserved IP for the NIC. The request parameters is:
+ id)</para>
+ </listitem>
+ <listitem>
+ <para>listNics (Lists the NIC details of the user VM; the API response also contains the
+ Secondary IP addresses of the NIC. The request parameters are: nicid,
+ virtualmachineid)</para>
+ </listitem>
+ </itemizedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/38a8db90/docs/en-US/multiple-ip-nic.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/multiple-ip-nic.xml b/docs/en-US/multiple-ip-nic.xml
new file mode 100644
index 0000000..fb9a331
--- /dev/null
+++ b/docs/en-US/multiple-ip-nic.xml
@@ -0,0 +1,134 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="multiple-ip-nic">
+ <title>Configuring Multiple IP Addresses on a Single NIC</title>
+ <para>&PRODUCT; now provides you the ability to associate multiple private IP addresses per NIC.
+ This feature is supported on all the network configurations—Basic, Advanced, and VPC.
+ Security Groups, Static NAT and Port forwarding services are supported on these additional IPs.
+ In addition to the primary IP, you can assign additional IPs to the guest VM NIC. Up to 256 IP
+ addresses are allowed per NIC.</para>
+ <para>As always, you can specify an IP from the guest subnet; if not specified, an IP is
+ automatically picked up from the guest subnet. You can view the IPs and associated NICs
+ for each VMs on the UI. You can apply NAT on these additional guest IPs by using firewall
+ configuration in the &PRODUCT; UI. You must specify the NIC to which the IP should be
+ associated.</para>
+ <para>This feature is supported on XenServer, KVM, and VMware hypervisors.</para>
+ <para>Some of the use cases are described below:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Building network appliances: Network appliances, such as firewalls and load
+ balancers, generally work best when they have access to multiple IP addresses on the
+ network interface.</para>
+ </listitem>
+ <listitem>
+ <para>Moving private IP addresses between interfaces or instances. Applications that are
+ bound to specific IP addresses can be moved between instances. </para>
+ </listitem>
+ <listitem>
+ <para>Hosting multiple SSL Websites on a single instance. You can install multiple SSL
+ certificates on a single instance, each associated with a distinct IP address.</para>
+ </listitem>
+ </itemizedlist>
+ <section id="workflow-rn">
+ <title>Assigning Additional IPs to a VM</title>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation bar, click Instances.</para>
+ </listitem>
+ <listitem>
+ <para>Click the name of the instance you want to work with.</para>
+ </listitem>
+ <listitem>
+ <para>In the Details tab, click NICs.</para>
+ </listitem>
+ <listitem>
+ <para>Click View All.</para>
+ </listitem>
+ <listitem>
+ <para>Click Acquire New IP, and click Yes in the confirmation dialog.</para>
+ <para>You are prompted for confirmation because, typically, IP addresses are a limited
+ resource. Within a few moments, the new IP address should appear with the state Allocated.
+ You can now use the IP address in Port Forwarding or StaticNAT rules.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section id="api-nic">
+ <title>API Changes</title>
+ <para>The following APIs have been added:</para>
+ <informaltable>
+ <tgroup cols="4" align="left" colsep="1" rowsep="1">
+ <thead>
+ <row>
+ <entry><para>Parameter Name</para></entry>
+ <entry><para>Description</para></entry>
+ <entry><para>Request Parameter</para></entry>
+ <entry><para>Response Parameter</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>addIpToNic</para></entry>
+ <entry><para>Adds an IP address to the NIC from the guest subnet.</para></entry>
+ <entry>
+ <para>nicid</para>
+ <para>(optional) ipaddress </para>
+ </entry>
+ <entry><para>nicid</para>
+ <para>ipaddress</para>
+ <para>networkid </para></entry>
+ </row>
+ <row>
+ <entry><para>removeIpFromNic</para></entry>
+ <entry><para>Removes the reserved IP for the NIC.</para></entry>
+ <entry>
+ <para>id</para>
+ </entry>
+ <entry><para>true</para>
+ <para>false</para></entry>
+ </row>
+ <row>
+ <entry><para>listNics</para></entry>
+ <entry><para>Lists the NIC details of the user VM; the API response also contains
+ the Secondary IP addresses of the NIC.</para></entry>
+ <entry>
+ <para>virtualmachineid</para>
+ <para>(optional) nicid</para>
+ </entry>
+ <entry><para>Lists the NIC details including secondary IP address </para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+ <section id="caveats-rn">
+ <title>Port Forwarding and StaticNAT Services Changes</title>
+ <para>Because multiple IPs can be associated per NIC, you are allowed to select a desired IP for
+ the Port Forwarding and StaticNAT services. The default is the primary IP. To enable this
+ functionality, an extra optional parameter 'vmguestip' is added to the Port forwarding and
+ StaticNAT APIs (enableStaticNat, createIpForwardingRule) to indicate on what IP address NAT
+ need to be configured. If vmguestip is passed, NAT is configured on the specified private IP
+ of the VM. if not passed, NAT is configured on the primary IP of the VM.</para>
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/38a8db90/docs/en-US/networks.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/networks.xml b/docs/en-US/networks.xml
index f877aa5..cb7493c 100644
--- a/docs/en-US/networks.xml
+++ b/docs/en-US/networks.xml
@@ -32,6 +32,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="using-multiple-guest-networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="reserved-ip-addresses-non-csvms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="multiple-ip-nic.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="security-groups.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="external-firewalls-and-load-balancers.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"/>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/38a8db90/docs/en-US/whats-new.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/whats-new.xml b/docs/en-US/whats-new.xml
index 252f87d..295b532 100644
--- a/docs/en-US/whats-new.xml
+++ b/docs/en-US/whats-new.xml
@@ -21,7 +21,11 @@
<chapter id="whats-new">
<title>What's New in the API?</title>
<para>The following describes any new major features of each &PRODUCT; version as it applies to
- API usage.</para>
+ API usage.</para>
+ <section id="whats-new-in-api-4.2">
+ <title>What's New in the API for 4.2</title>
+ <xi:include href="added-API-commands-4.2.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ </section>
<section id="whats-new-in-api-4.1">
<title>What's New in the API for 4.1</title>
<xi:include href="add-remove-nic.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>