Skip to content

Commit 00cd9d5

Browse files
author
Radhika PC
committed
cloudstack-890 and cloudstack 815
1 parent cdae53a commit 00cd9d5

3 files changed

Lines changed: 156 additions & 0 deletions

File tree

‎docs/en-US/add-remove-nic.xml‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<!-- Licensed to the Apache Software Foundation (ASF) under one
7+
or more contributor license agreements. See the NOTICE file
8+
distributed with this work for additional information
9+
regarding copyright ownership. The ASF licenses this file
10+
to you under the Apache License, Version 2.0 (the
11+
"License"); you may not use this file except in compliance
12+
with the License. You may obtain a copy of the License at
13+
http://www.apache.org/licenses/LICENSE-2.0
14+
Unless required by applicable law or agreed to in writing,
15+
software distributed under the License is distributed on an
16+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17+
KIND, either express or implied. See the License for the
18+
specific language governing permissions and limitations
19+
under the License.
20+
-->
21+
<section id="add-remove-nic">
22+
<title>Reconfiguring Physical Networks in VMs</title>
23+
<para>&PRODUCT; provides you the ability to move VMs between networks and reconfigure a VM's
24+
network. You can remove a VM from a physical network and add to a new physical network. You can
25+
also change the default physical network of a virtual machine. With this functionality, hybrid
26+
or traditional server loads can be accommodated with ease. </para>
27+
<para>This feature is supported on XenServer and KVM hypervisors.</para>
28+
<para>The following APIs have been added to support this feature. These API calls can function
29+
only while the VM is in running or stopped state.</para>
30+
<section id="addnic">
31+
<title>addNicToVirtualMachine</title>
32+
<para>The addNicToVirtualMachine API adds a new NIC to the specified VM on a selected
33+
network.</para>
34+
<informaltable>
35+
<tgroup cols="3" align="left" colsep="1" rowsep="1">
36+
<thead>
37+
<row>
38+
<entry><para>parameter</para></entry>
39+
<entry><para>description</para></entry>
40+
<entry><para>Value</para></entry>
41+
</row>
42+
</thead>
43+
<tbody>
44+
<row>
45+
<entry><para>virtualmachineid</para></entry>
46+
<entry><para>The unique ID of the VM to which the NIC is to be added. </para></entry>
47+
<entry><para>true</para></entry>
48+
</row>
49+
<row>
50+
<entry><para>networkid</para></entry>
51+
<entry><para>The unique ID of the network the NIC that you add should apply
52+
to.</para></entry>
53+
<entry><para>true</para></entry>
54+
</row>
55+
<row>
56+
<entry><para>ipaddress</para></entry>
57+
<entry><para>The IP address of the VM on the network.</para></entry>
58+
<entry><para>false</para></entry>
59+
</row>
60+
</tbody>
61+
</tgroup>
62+
</informaltable>
63+
<para>The network and VM must reside in the same zone. Two VMs with the same name cannot reside
64+
in the same network. Therefore, adding a second VM that duplicates a name on a network will
65+
fail.</para>
66+
</section>
67+
<section id="removenic">
68+
<title>removeNicFromVirtualMachine</title>
69+
<para>The removeNicFromVirtualMachine API removes a NIC from the specified VM on a selected
70+
network.</para>
71+
<informaltable>
72+
<tgroup cols="3" align="left" colsep="1" rowsep="1">
73+
<thead>
74+
<row>
75+
<entry><para>parameter</para></entry>
76+
<entry><para>description</para></entry>
77+
<entry><para>Value</para></entry>
78+
</row>
79+
</thead>
80+
<tbody>
81+
<row>
82+
<entry><para>virtualmachineid</para></entry>
83+
<entry><para>The unique ID of the VM from which the NIC is to be removed.
84+
</para></entry>
85+
<entry><para>true</para></entry>
86+
</row>
87+
<row>
88+
<entry><para>nicid</para></entry>
89+
<entry><para>The unique ID of the NIC that you want to remove.</para></entry>
90+
<entry><para>true</para></entry>
91+
</row>
92+
</tbody>
93+
</tgroup>
94+
</informaltable>
95+
<para>Removing the default NIC is not allowed.</para>
96+
</section>
97+
<section id="defaultnic">
98+
<title>updateDefaultNicForVirtualMachine</title>
99+
<para>The updateDefaultNicForVirtualMachine API updates the specified NIC to be the default one
100+
for a selected VM.</para>
101+
<informaltable>
102+
<tgroup cols="3" align="left" colsep="1" rowsep="1">
103+
<thead>
104+
<row>
105+
<entry><para>parameter</para></entry>
106+
<entry><para>description</para></entry>
107+
<entry><para>Value</para></entry>
108+
</row>
109+
</thead>
110+
<tbody>
111+
<row>
112+
<entry><para>virtualmachineid</para></entry>
113+
<entry><para>The unique ID of the VM for which you want to specify the default NIC.
114+
</para></entry>
115+
<entry><para>true</para></entry>
116+
</row>
117+
<row>
118+
<entry><para>nicid</para></entry>
119+
<entry><para>The unique ID of the NIC that you want to set as the default
120+
one.</para></entry>
121+
<entry><para>true</para></entry>
122+
</row>
123+
</tbody>
124+
</tgroup>
125+
</informaltable>
126+
</section>
127+
</section>

‎docs/en-US/added-API-commands-4-1.xml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,33 @@
3737
<listitem>
3838
<para>addBaremetalHost (Adds a new host.)</para>
3939
</listitem>
40+
<listitem>
41+
<para>addNicToVirtualMachine (Adds a new NIC to the specified VM on a selected
42+
network.)</para>
43+
</listitem>
44+
<listitem>
45+
<para>removeNicFromVirtualMachine (Removes the specified NIC from a selected VM.)</para>
46+
</listitem>
47+
<listitem>
48+
<para>updateDefaultNicForVirtualMachine (Updates the specified NIC to be the default one for a
49+
selected VM.)</para>
50+
</listitem>
51+
<listitem>
52+
<para>addRegion (Registers a Region into another Region.)</para>
53+
</listitem>
54+
<listitem>
55+
<para>updateRegion (Updates Region details: ID, Name, Endpoint, User API Key, and User Secret
56+
Key.)</para>
57+
</listitem>
58+
<listitem>
59+
<para>removeRegion (Removes a Region from current Region.)</para>
60+
</listitem>
61+
<listitem>
62+
<para>listRegions (Get all the Regions. They can be filtered by using the ID or Name.)</para>
63+
</listitem>
64+
<listitem>
65+
<para>getUser (This API can only be used by the Admin. Get user details by using the API Key.)
66+
</para>
67+
</listitem>
4068
</itemizedlist>
4169
</section>

‎docs/en-US/whats-new.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
API usage.</para>
2525
<section id="whats-new-in-api-4.1">
2626
<title>What's New in the API for 4.1</title>
27+
<xi:include href="add-remove-nic.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
2728
<xi:include href="vmx-settings-dev.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
2829
<xi:include href="reset-ssh-key-dev.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
2930
<xi:include href="changed-apicommands-4.1.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

0 commit comments

Comments
 (0)