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 00000000000..3b765f259c9 --- /dev/null +++ b/docs/en-US/added-API-commands-4.2.xml @@ -0,0 +1,38 @@ + + +%BOOK_ENTITIES; +]> + +
+ Added API Commands in 4.2 + + + addIpToNic (Adds an IP address to the NIC from the guest subnet. The request parameters + are: nicid, ipaddress) + + + removeIpFromNic (Removes the reserved IP for the NIC. The request parameters is: + id) + + + 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) + + +
diff --git a/docs/en-US/multiple-ip-nic.xml b/docs/en-US/multiple-ip-nic.xml new file mode 100644 index 00000000000..fb9a331141c --- /dev/null +++ b/docs/en-US/multiple-ip-nic.xml @@ -0,0 +1,134 @@ + + +%BOOK_ENTITIES; +]> + + +
+ Configuring Multiple IP Addresses on a Single NIC + &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. + 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. + This feature is supported on XenServer, KVM, and VMware hypervisors. + Some of the use cases are described below: + + + 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. + + + Moving private IP addresses between interfaces or instances. Applications that are + bound to specific IP addresses can be moved between instances. + + + 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. + + +
+ Assigning Additional IPs to a VM + + + Log in to the &PRODUCT; UI. + + + In the left navigation bar, click Instances. + + + Click the name of the instance you want to work with. + + + In the Details tab, click NICs. + + + Click View All. + + + Click Acquire New IP, and click Yes in the confirmation dialog. + 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. + + +
+
+ API Changes + The following APIs have been added: + + + + + Parameter Name + Description + Request Parameter + Response Parameter + + + + + addIpToNic + Adds an IP address to the NIC from the guest subnet. + + nicid + (optional) ipaddress + + nicid + ipaddress + networkid + + + removeIpFromNic + Removes the reserved IP for the NIC. + + id + + true + false + + + listNics + Lists the NIC details of the user VM; the API response also contains + the Secondary IP addresses of the NIC. + + virtualmachineid + (optional) nicid + + Lists the NIC details including secondary IP address + + + + +
+
+ Port Forwarding and StaticNAT Services Changes + 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. +
+
diff --git a/docs/en-US/networks.xml b/docs/en-US/networks.xml index f877aa55584..cb7493cc945 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"/> + diff --git a/docs/en-US/whats-new.xml b/docs/en-US/whats-new.xml index 252f87d0543..295b53220e1 100644 --- a/docs/en-US/whats-new.xml +++ b/docs/en-US/whats-new.xml @@ -21,7 +21,11 @@ What's New in the API? The following describes any new major features of each &PRODUCT; version as it applies to - API usage. + API usage. +
+ What's New in the API for 4.2 + +
What's New in the API for 4.1