diff --git a/docs/en-US/add-remove-nic.xml b/docs/en-US/add-remove-nic.xml new file mode 100644 index 00000000000..15dc66c2b83 --- /dev/null +++ b/docs/en-US/add-remove-nic.xml @@ -0,0 +1,127 @@ + + +%BOOK_ENTITIES; +]> + +
+ Reconfiguring Physical Networks in VMs + &PRODUCT; provides you the ability to move VMs between networks and reconfigure a VM's + network. You can remove a VM from a physical network and add to a new physical network. You can + also change the default physical network of a virtual machine. With this functionality, hybrid + or traditional server loads can be accommodated with ease. + This feature is supported on XenServer and KVM hypervisors. + The following APIs have been added to support this feature. These API calls can function + only while the VM is in running or stopped state. +
+ addNicToVirtualMachine + The addNicToVirtualMachine API adds a new NIC to the specified VM on a selected + network. + + + + + parameter + description + Value + + + + + virtualmachineid + The unique ID of the VM to which the NIC is to be added. + true + + + networkid + The unique ID of the network the NIC that you add should apply + to. + true + + + ipaddress + The IP address of the VM on the network. + false + + + + + The network and VM must reside in the same zone. Two VMs with the same name cannot reside + in the same network. Therefore, adding a second VM that duplicates a name on a network will + fail. +
+
+ removeNicFromVirtualMachine + The removeNicFromVirtualMachine API removes a NIC from the specified VM on a selected + network. + + + + + parameter + description + Value + + + + + virtualmachineid + The unique ID of the VM from which the NIC is to be removed. + + true + + + nicid + The unique ID of the NIC that you want to remove. + true + + + + + Removing the default NIC is not allowed. +
+
+ updateDefaultNicForVirtualMachine + The updateDefaultNicForVirtualMachine API updates the specified NIC to be the default one + for a selected VM. + + + + + parameter + description + Value + + + + + virtualmachineid + The unique ID of the VM for which you want to specify the default NIC. + + true + + + nicid + The unique ID of the NIC that you want to set as the default + one. + true + + + + +
+
diff --git a/docs/en-US/added-API-commands-4-1.xml b/docs/en-US/added-API-commands-4-1.xml index f635e9dfdd8..aa5529e41ff 100644 --- a/docs/en-US/added-API-commands-4-1.xml +++ b/docs/en-US/added-API-commands-4-1.xml @@ -37,5 +37,33 @@ addBaremetalHost (Adds a new host.) + + addNicToVirtualMachine (Adds a new NIC to the specified VM on a selected + network.) + + + removeNicFromVirtualMachine (Removes the specified NIC from a selected VM.) + + + updateDefaultNicForVirtualMachine (Updates the specified NIC to be the default one for a + selected VM.) + + + addRegion (Registers a Region into another Region.) + + + updateRegion (Updates Region details: ID, Name, Endpoint, User API Key, and User Secret + Key.) + + + removeRegion (Removes a Region from current Region.) + + + listRegions (Get all the Regions. They can be filtered by using the ID or Name.) + + + getUser (This API can only be used by the Admin. Get user details by using the API Key.) + + diff --git a/docs/en-US/whats-new.xml b/docs/en-US/whats-new.xml index 29ae1f68903..761d7a2eb37 100644 --- a/docs/en-US/whats-new.xml +++ b/docs/en-US/whats-new.xml @@ -24,6 +24,7 @@ API usage.
What's New in the API for 4.1 +