incubator-cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bfede...@apache.org
Subject [16/29] git commit: refs/heads/ui-multiple-nics - cloudstack-890 and cloudstack 815
Date Wed, 06 Mar 2013 18:00:03 GMT
cloudstack-890 and cloudstack 815


Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/00cd9d5d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/00cd9d5d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/00cd9d5d

Branch: refs/heads/ui-multiple-nics
Commit: 00cd9d5d6fd0901dc00b9f685897ef8e8736453e
Parents: cdae53a
Author: Radhika PC <radhika.puthiyetath@citrix.com>
Authored: Tue Mar 5 16:00:13 2013 +0530
Committer: Radhika PC <radhika.puthiyetath@citrix.com>
Committed: Wed Mar 6 10:48:19 2013 +0530

----------------------------------------------------------------------
 docs/en-US/add-remove-nic.xml         |  127 ++++++++++++++++++++++++++++
 docs/en-US/added-API-commands-4-1.xml |   28 ++++++
 docs/en-US/whats-new.xml              |    1 +
 3 files changed, 156 insertions(+), 0 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/00cd9d5d/docs/en-US/add-remove-nic.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/add-remove-nic.xml b/docs/en-US/add-remove-nic.xml
new file mode 100644
index 0000000..15dc66c
--- /dev/null
+++ b/docs/en-US/add-remove-nic.xml
@@ -0,0 +1,127 @@
+<?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="add-remove-nic">
+  <title>Reconfiguring Physical Networks in VMs</title>
+  <para>&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. </para>
+  <para>This feature is supported on XenServer and KVM hypervisors.</para>
+  <para>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.</para>
+  <section id="addnic">
+    <title>addNicToVirtualMachine</title>
+    <para>The addNicToVirtualMachine API adds a new NIC to the specified VM on a selected
+      network.</para>
+    <informaltable>
+      <tgroup cols="3" align="left" colsep="1" rowsep="1">
+        <thead>
+          <row>
+            <entry><para>parameter</para></entry>
+            <entry><para>description</para></entry>
+            <entry><para>Value</para></entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry><para>virtualmachineid</para></entry>
+            <entry><para>The unique ID of the VM to which the NIC is to be added.
</para></entry>
+            <entry><para>true</para></entry>
+          </row>
+          <row>
+            <entry><para>networkid</para></entry>
+            <entry><para>The unique ID of the network the NIC that you add should
apply
+              to.</para></entry>
+            <entry><para>true</para></entry>
+          </row>
+          <row>
+            <entry><para>ipaddress</para></entry>
+            <entry><para>The IP address of the VM on the network.</para></entry>
+            <entry><para>false</para></entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </informaltable>
+    <para>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.</para>
+  </section>
+  <section id="removenic">
+    <title>removeNicFromVirtualMachine</title>
+    <para>The removeNicFromVirtualMachine API removes a NIC from the specified VM on
a selected
+      network.</para>
+    <informaltable>
+      <tgroup cols="3" align="left" colsep="1" rowsep="1">
+        <thead>
+          <row>
+            <entry><para>parameter</para></entry>
+            <entry><para>description</para></entry>
+            <entry><para>Value</para></entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry><para>virtualmachineid</para></entry>
+            <entry><para>The unique ID of the VM from which the NIC is to be
removed.
+              </para></entry>
+            <entry><para>true</para></entry>
+          </row>
+          <row>
+            <entry><para>nicid</para></entry>
+            <entry><para>The unique ID of the NIC that you want to remove.</para></entry>
+            <entry><para>true</para></entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </informaltable>
+    <para>Removing the default NIC is not allowed.</para>
+  </section>
+  <section id="defaultnic">
+    <title>updateDefaultNicForVirtualMachine</title>
+    <para>The updateDefaultNicForVirtualMachine API updates the specified NIC to be
the default one
+      for a selected VM.</para>
+    <informaltable>
+      <tgroup cols="3" align="left" colsep="1" rowsep="1">
+        <thead>
+          <row>
+            <entry><para>parameter</para></entry>
+            <entry><para>description</para></entry>
+            <entry><para>Value</para></entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry><para>virtualmachineid</para></entry>
+            <entry><para>The unique ID of the VM for which you want to specify
the default NIC.
+              </para></entry>
+            <entry><para>true</para></entry>
+          </row>
+          <row>
+            <entry><para>nicid</para></entry>
+            <entry><para>The unique ID of the NIC that you want to set as the
default
+              one.</para></entry>
+            <entry><para>true</para></entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </informaltable>
+  </section>
+</section>

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/00cd9d5d/docs/en-US/added-API-commands-4-1.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/added-API-commands-4-1.xml b/docs/en-US/added-API-commands-4-1.xml
index f635e9d..aa5529e 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 @@
     <listitem>
       <para>addBaremetalHost (Adds a new host.)</para>
     </listitem>
+    <listitem>
+      <para>addNicToVirtualMachine (Adds a new NIC to the specified VM on a selected
+        network.)</para>
+    </listitem>
+    <listitem>
+      <para>removeNicFromVirtualMachine (Removes the specified NIC from a selected
VM.)</para>
+    </listitem>
+    <listitem>
+      <para>updateDefaultNicForVirtualMachine (Updates the specified NIC to be the
default one for a
+        selected VM.)</para>
+    </listitem>
+    <listitem>
+      <para>addRegion (Registers a Region into another Region.)</para>
+    </listitem>
+    <listitem>
+      <para>updateRegion (Updates Region details: ID, Name, Endpoint, User API Key,
and User Secret
+        Key.)</para>
+    </listitem>
+    <listitem>
+      <para>removeRegion (Removes a Region from current Region.)</para>
+    </listitem>
+    <listitem>
+      <para>listRegions (Get all the Regions. They can be filtered by using the ID
or Name.)</para>
+    </listitem>
+    <listitem>
+      <para>getUser (This API can only be used by the Admin. Get user details by using
the API Key.)
+      </para>
+    </listitem>
   </itemizedlist>
 </section>

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/00cd9d5d/docs/en-US/whats-new.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/whats-new.xml b/docs/en-US/whats-new.xml
index 29ae1f6..761d7a2 100644
--- a/docs/en-US/whats-new.xml
+++ b/docs/en-US/whats-new.xml
@@ -24,6 +24,7 @@
     API usage.</para>
   <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"/>
     <xi:include href="vmx-settings-dev.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
     <xi:include href="reset-ssh-key-dev.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
     <xi:include href="changed-apicommands-4.1.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>


Mime
View raw message