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/ui-vm-affinity Commit: 5e445f9dd71233638fedeb91ba36aecaae769e8e Parents: 38a8db9 Author: radhikap <radhika.puthiyet...@citrix.com> Authored: Wed Apr 10 17:24:50 2013 +0530 Committer: radhikap <radhika.puthiyet...@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
