You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ke...@apache.org on 2013/10/02 16:23:47 UTC
[46/51] [partial] Adding documents from 4.2
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/add-remove-nic-ui.xml
----------------------------------------------------------------------
diff --git a/en-US/add-remove-nic-ui.xml b/en-US/add-remove-nic-ui.xml
new file mode 100644
index 0000000..a671329
--- /dev/null
+++ b/en-US/add-remove-nic-ui.xml
@@ -0,0 +1,152 @@
+<?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-ui">
+ <title>Reconfiguring 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 network and add to a new network. You can also change the
+ default 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, VMware, and KVM hypervisors.</para>
+ <section id="prereq-addnic">
+ <title>Prerequisites</title>
+ <para>Ensure that vm-tools are running on guest VMs for adding or removing networks to work on
+ VMware hypervisor.</para>
+ </section>
+ <section id="add-nic">
+ <title>Adding a Network</title>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as an administrator or end user.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, click Instances.</para>
+ </listitem>
+ <listitem>
+ <para>Choose the VM that you want to work with.</para>
+ </listitem>
+ <listitem>
+ <para>Click the NICs tab.</para>
+ </listitem>
+ <listitem>
+ <para>Click Add network to VM.</para>
+ <para>The Add network to VM dialog is displayed.</para>
+ </listitem>
+ <listitem>
+ <para>In the drop-down list, select the network that you would like to add this VM
+ to.</para>
+ <para> A new NIC is added for this network. You can view the following details in the NICs
+ page:</para>
+ <itemizedlist>
+ <listitem>
+ <para>ID</para>
+ </listitem>
+ <listitem>
+ <para>Network Name</para>
+ </listitem>
+ <listitem>
+ <para>Type</para>
+ </listitem>
+ <listitem>
+ <para>IP Address</para>
+ </listitem>
+ <listitem>
+ <para>Gateway</para>
+ </listitem>
+ <listitem>
+ <para>Netmask</para>
+ </listitem>
+ <listitem>
+ <para>Is default</para>
+ </listitem>
+ <listitem>
+ <para>CIDR (for IPv6)</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section id="remove-nic">
+ <title>Removing a Network</title>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as an administrator or end user.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, click Instances.</para>
+ </listitem>
+ <listitem>
+ <para>Choose the VM that you want to work with.</para>
+ </listitem>
+ <listitem>
+ <para>Click the NICs tab.</para>
+ </listitem>
+ <listitem>
+ <para>Locate the NIC you want to remove.</para>
+ </listitem>
+ <listitem>
+ <para>Click Remove NIC button.<inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/remove-nic.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>remove-nic.png: button to remove a NIC</phrase>
+ </textobject>
+ </inlinemediaobject></para>
+ </listitem>
+ <listitem>
+ <para>Click Yes to confirm.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section id="default-nic">
+ <title>Selecting the Default Network</title>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as an administrator or end user.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, click Instances.</para>
+ </listitem>
+ <listitem>
+ <para>Choose the VM that you want to work with.</para>
+ </listitem>
+ <listitem>
+ <para>Click the NICs tab.</para>
+ </listitem>
+ <listitem>
+ <para>Locate the NIC you want to work with.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Set default NIC button.<inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/set-default-nic.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>set-default-nic.png: button to set a NIC as default one.</phrase>
+ </textobject>
+ </inlinemediaobject></para>
+ </listitem>
+ <listitem>
+ <para>Click Yes to confirm.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/add-remove-nic.xml
----------------------------------------------------------------------
diff --git a/en-US/add-remove-nic.xml b/en-US/add-remove-nic.xml
new file mode 100644
index 0000000..fb23390
--- /dev/null
+++ b/en-US/add-remove-nic.xml
@@ -0,0 +1,133 @@
+<?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 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 network and add to a new network. You can
+ also change the default 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="prereq-addnic">
+ <title>Prerequisites</title>
+ <para>Ensure that vm-tools are running on guest VMs for adding or removing networks to work on VMware hypervisor.</para>
+ </section>
+ <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>
+ <para>The NIC is only updated in the database. You must manually update the default NIC on the
+ VM. You get an alert to manually update the NIC. </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/cloudstack-docs/blob/b23872a5/en-US/add-secondary-storage.xml
----------------------------------------------------------------------
diff --git a/en-US/add-secondary-storage.xml b/en-US/add-secondary-storage.xml
new file mode 100644
index 0000000..318a6ea
--- /dev/null
+++ b/en-US/add-secondary-storage.xml
@@ -0,0 +1,48 @@
+<?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-secondary-storage">
+ <title>Adding Secondary Storage</title>
+ <note>
+ <para>Be sure there is nothing stored on the server. Adding the server to CloudStack will
+ destroy any existing data.</para>
+ </note>
+ <para>When you create a new zone, the first secondary storage is added as part of that procedure.
+ You can add secondary storage servers at any time to add more servers to an existing
+ zone.</para>
+ <orderedlist>
+ <listitem>
+ <para>If you are going to use Swift for cloud-wide secondary storage, you must add the Swift
+ storage to &PRODUCT; before you add the local zone secondary storage servers.</para>
+ </listitem>
+ <listitem>
+ <para>To prepare for local zone secondary storage, you should have created and mounted an NFS
+ share during Management Server installation.</para>
+ </listitem>
+ <listitem>
+ <para>Make sure you prepared the system VM template during Management Server
+ installation.</para>
+ </listitem>
+ <listitem>
+ <para>4. Now that the secondary storage server for per-zone storage is prepared, add it to
+ &PRODUCT;. Secondary storage is added as part of the procedure for adding a new zone.</para>
+ </listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/add-security-group.xml
----------------------------------------------------------------------
diff --git a/en-US/add-security-group.xml b/en-US/add-security-group.xml
new file mode 100644
index 0000000..85a6ba0
--- /dev/null
+++ b/en-US/add-security-group.xml
@@ -0,0 +1,49 @@
+<?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-security-group">
+ <title>Adding a Security Group</title>
+ <para>A user or administrator can define a new security group.</para>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as an administrator or end user. </para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, choose Network</para>
+ </listitem>
+ <listitem>
+ <para>In Select view, choose Security Groups.</para>
+ </listitem>
+ <listitem>
+ <para>Click Add Security Group.</para>
+ </listitem>
+ <listitem>
+ <para>Provide a name and description.</para>
+ </listitem>
+ <listitem>
+ <para>Click OK.</para>
+ <para>The new security group appears in the Security Groups Details tab.</para>
+ </listitem>
+ <listitem>
+ <para>To make the security group useful, continue to Adding Ingress and Egress Rules to a
+ Security Group.</para>
+ </listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/add-tier.xml
----------------------------------------------------------------------
diff --git a/en-US/add-tier.xml b/en-US/add-tier.xml
new file mode 100644
index 0000000..94a8237
--- /dev/null
+++ b/en-US/add-tier.xml
@@ -0,0 +1,102 @@
+<?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-tier">
+ <title>Adding Tiers</title>
+ <para>Tiers are distinct locations within a VPC that act as isolated networks, which do not have
+ access to other tiers by default. Tiers are set up on different VLANs that can communicate with
+ each other by using a virtual router. Tiers provide inexpensive, low latency network
+ connectivity to other tiers within the VPC.</para>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as an administrator or end user.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, choose Network.</para>
+ </listitem>
+ <listitem>
+ <para>In the Select view, select VPC.</para>
+ <para>All the VPC that you have created for the account is listed in the page.</para>
+ <note>
+ <para>The end users can see their own VPCs, while root and domain admin can see any VPC they
+ are authorized to see.</para>
+ </note>
+ </listitem>
+ <listitem>
+ <para>Click the Configure button of the VPC for which you want to set up tiers.</para>
+ </listitem>
+ <listitem>
+ <para>Click Create network.</para>
+ <para>The Add new tier dialog is displayed, as follows:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/add-tier.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>add-tier.png: adding a tier to a vpc.</phrase>
+ </textobject>
+ </mediaobject>
+ <para>If you have already created tiers, the VPC diagram is displayed. Click Create Tier to
+ add a new tier.</para>
+ </listitem>
+ <listitem>
+ <para>Specify the following:</para>
+ <para>All the fields are mandatory.</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Name</emphasis>: A unique name for the tier you create.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Network Offering</emphasis>: The following default network
+ offerings are listed: Internal LB, DefaultIsolatedNetworkOfferingForVpcNetworksNoLB,
+ DefaultIsolatedNetworkOfferingForVpcNetworks</para>
+ <para>In a VPC, only one tier can be created by using LB-enabled network offering.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Gateway</emphasis>: The gateway for the tier you create.
+ Ensure that the gateway is within the Super CIDR range that you specified while creating
+ the VPC, and is not overlapped with the CIDR of any existing tier within the VPC.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">VLAN</emphasis>: The VLAN ID for the tier that the root admin
+ creates. </para>
+ <para>This option is only visible if the network offering you selected is
+ VLAN-enabled.</para>
+ <para condition="install">For more information, see the Assigning VLANs to Isolated
+ Networks section in the &PRODUCT; Administration Guide.</para>
+ <para condition="admin">For more information, see <xref linkend="vlan-assign-isolated-nw"
+ />.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Netmask</emphasis>: The netmask for the tier you create. </para>
+ <para>For example, if the VPC CIDR is 10.0.0.0/16 and the network tier CIDR is
+ 10.0.1.0/24, the gateway of the tier is 10.0.1.1, and the netmask of the tier is
+ 255.255.255.0.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Click OK.</para>
+ </listitem>
+ <listitem>
+ <para>Continue with configuring access control list for the tier.</para>
+ </listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/add-vm-tier-sharednw.xml
----------------------------------------------------------------------
diff --git a/en-US/add-vm-tier-sharednw.xml b/en-US/add-vm-tier-sharednw.xml
new file mode 100644
index 0000000..a688604
--- /dev/null
+++ b/en-US/add-vm-tier-sharednw.xml
@@ -0,0 +1,62 @@
+<?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-vm-tier-sharednw">
+ <title>Deploying VMs to VPC Tier and Shared Networks</title>
+ <para>&PRODUCT; allows you deploy VMs on a VPC tier and one or more shared networks. With this
+ feature, VMs deployed in a multi-tier application can receive monitoring services via a shared
+ network provided by a service provider.</para>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as an administrator.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, choose Instances.</para>
+ </listitem>
+ <listitem>
+ <para>Click Add Instance.</para>
+ </listitem>
+ <listitem>
+ <para>Select a zone.</para>
+ </listitem>
+ <listitem>
+ <para>Select a template or ISO, then follow the steps in the wizard. </para>
+ </listitem>
+ <listitem>
+ <para>Ensure that the hardware you have allows starting the selected service offering.</para>
+ </listitem>
+ <listitem>
+ <para>Under Networks, select the desired networks for the VM you are launching.</para>
+ <para>You can deploy a VM to a VPC tier and multiple shared networks.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/addvm-tier-sharednw.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>addvm-tier-sharednw.png: adding a VM to a VPC tier and shared network.</phrase>
+ </textobject>
+ </mediaobject>
+ </listitem>
+ <listitem>
+ <para>Click Next, review the configuration and click Launch.</para>
+ <para>Your VM will be deployed to the selected VPC tier and shared network.</para>
+ </listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/add-vm-to-tier.xml
----------------------------------------------------------------------
diff --git a/en-US/add-vm-to-tier.xml b/en-US/add-vm-to-tier.xml
new file mode 100644
index 0000000..c7d769d
--- /dev/null
+++ b/en-US/add-vm-to-tier.xml
@@ -0,0 +1,53 @@
+<?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-vm-to-tier">
+ <title>Deploying VMs to the Tier</title>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as an administrator or end user.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, choose Network.</para>
+ </listitem>
+ <listitem>
+ <para>In the Select view, select VPC.</para>
+ <para>All the VPCs that you have created for the account is listed in the page.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Configure button of the VPC to which you want to deploy the VMs.</para>
+ <para>The VPC page is displayed where all the tiers you have created are listed.</para>
+ </listitem>
+ <listitem>
+ <para>Click Virtual Machines tab of the tier to which you want to add a VM.</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/add-vm-vpc.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>add-vm-vpc.png: adding a VM to a vpc.</phrase>
+ </textobject>
+ </mediaobject>
+ <para>The Add Instance page is displayed.</para>
+ <para>Follow the on-screen instruction to add an instance. For information on adding an
+ instance, see the Installation Guide.</para>
+ </listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/add-vpc.xml
----------------------------------------------------------------------
diff --git a/en-US/add-vpc.xml b/en-US/add-vpc.xml
new file mode 100644
index 0000000..b8034c4
--- /dev/null
+++ b/en-US/add-vpc.xml
@@ -0,0 +1,80 @@
+<?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-vpc">
+ <title>Adding a Virtual Private Cloud</title>
+ <para>When creating the VPC, you simply provide the zone and a set of IP addresses for the VPC
+ network address space. You specify this set of addresses in the form of a Classless Inter-Domain
+ Routing (CIDR) block.</para>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as an administrator or end user. </para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, choose Network.</para>
+ </listitem>
+ <listitem>
+ <para>In the Select view, select VPC.</para>
+ </listitem>
+ <listitem>
+ <para>Click Add VPC. The Add VPC page is displayed as follows:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/add-vpc.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>add-vpc.png: adding a vpc.</phrase>
+ </textobject>
+ </mediaobject>
+ <para>Provide the following information:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Name</emphasis>: A short name for the VPC that you are
+ creating.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Description</emphasis>: A brief description of the VPC.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Zone</emphasis>: Choose the zone where you want the VPC to be
+ available.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Super CIDR for Guest Networks</emphasis>: Defines the CIDR
+ range for all the tiers (guest networks) within a VPC. When you create a tier, ensure
+ that its CIDR is within the Super CIDR value you enter. The CIDR must be RFC1918
+ compliant.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">DNS domain for Guest Networks</emphasis>: If you want to
+ assign a special domain name, specify the DNS suffix. This parameter is applied to all
+ the tiers within the VPC. That implies, all the tiers you create in the VPC belong to
+ the same DNS domain. If the parameter is not specified, a DNS domain name is generated
+ automatically.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Public Load Balancer Provider</emphasis>: You have two
+ options: VPC Virtual Router and Netscaler.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>Click OK.</para></listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/added-API-commands-4-0.xml
----------------------------------------------------------------------
diff --git a/en-US/added-API-commands-4-0.xml b/en-US/added-API-commands-4-0.xml
new file mode 100644
index 0000000..2d86ba4
--- /dev/null
+++ b/en-US/added-API-commands-4-0.xml
@@ -0,0 +1,164 @@
+<?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="added-API-commands-4.0">
+ <title>Added API Commands in 4.0.0-incubating</title>
+ <itemizedlist>
+ <listitem>
+ <para>createCounter (Adds metric counter)</para>
+ </listitem>
+ <listitem>
+ <para>deleteCounter (Deletes a counter)</para>
+ </listitem>
+ <listitem>
+ <para>listCounters (List the counters)</para>
+ </listitem>
+ <listitem>
+ <para>createCondition (Creates a condition)</para>
+ </listitem>
+ <listitem>
+ <para>deleteCondition (Removes a condition)</para>
+ </listitem>
+ <listitem>
+ <para>listConditions (List Conditions for the specific user)</para>
+ </listitem>
+ <listitem>
+ <para>createTags. Add tags to one or more resources. Example:
+ <programlisting>command=createTags
+&resourceIds=1,10,12
+&resourceType=userVm
+&tags[0].key=region
+&tags[0].value=canada
+&tags[1].key=city
+&tags[1].value=Toronto </programlisting></para>
+ </listitem>
+ <listitem>
+ <para>deleteTags. Remove tags from one or more resources. Example:
+ <programlisting>command=deleteTags
+&resourceIds=1,12
+&resourceType=Snapshot
+&tags[0].key=city </programlisting></para>
+ </listitem>
+ <listitem>
+ <para>listTags (Show currently defined resource tags)</para>
+ </listitem>
+ <listitem>
+ <para>createVPC (Creates a VPC)</para>
+ </listitem>
+ <listitem>
+ <para>listVPCs (Lists VPCs)</para>
+ </listitem>
+ <listitem>
+ <para>deleteVPC (Deletes a VPC)</para>
+ </listitem>
+ <listitem>
+ <para>updateVPC (Updates a VPC)</para>
+ </listitem>
+ <listitem>
+ <para>restartVPC (Restarts a VPC)</para>
+ </listitem>
+ <listitem>
+ <para>createVPCOffering (Creates VPC offering)</para>
+ </listitem>
+ <listitem>
+ <para>updateVPCOffering (Updates VPC offering)</para>
+ </listitem>
+ <listitem>
+ <para>deleteVPCOffering (Deletes VPC offering)</para>
+ </listitem>
+ <listitem>
+ <para>listVPCOfferings (Lists VPC offerings)</para>
+ </listitem>
+ <listitem>
+ <para>createPrivateGateway (Creates a private gateway)</para>
+ </listitem>
+ <listitem>
+ <para>listPrivateGateways (List private gateways)</para>
+ </listitem>
+ <listitem>
+ <para>deletePrivateGateway (Deletes a Private gateway)</para>
+ </listitem>
+ <listitem>
+ <para>createNetworkACL (Creates a ACL rule the given network (the network has to belong to
+ VPC))</para>
+ </listitem>
+ <listitem>
+ <para>deleteNetworkACL (Deletes a Network ACL)</para>
+ </listitem>
+ <listitem>
+ <para>listNetworkACLs (Lists all network ACLs)</para>
+ </listitem>
+ <listitem>
+ <para>createStaticRoute (Creates a static route)</para>
+ </listitem>
+ <listitem>
+ <para>deleteStaticRoute (Deletes a static route)</para>
+ </listitem>
+ <listitem>
+ <para>listStaticRoutes (Lists all static routes)</para>
+ </listitem>
+ <listitem>
+ <para>createVpnCustomerGateway (Creates site to site vpn customer gateway)</para>
+ </listitem>
+ <listitem>
+ <para>createVpnGateway (Creates site to site vpn local gateway)</para>
+ </listitem>
+ <listitem>
+ <para>createVpnConnection (Create site to site vpn connection)</para>
+ </listitem>
+ <listitem>
+ <para>deleteVpnCustomerGateway (Delete site to site vpn customer gateway)</para>
+ </listitem>
+ <listitem>
+ <para>deleteVpnGateway (Delete site to site vpn gateway)</para>
+ </listitem>
+ <listitem>
+ <para>deleteVpnConnection (Delete site to site vpn connection)</para>
+ </listitem>
+ <listitem>
+ <para>updateVpnCustomerGateway (Update site to site vpn customer gateway)</para>
+ </listitem>
+ <listitem>
+ <para>resetVpnConnection (Reset site to site vpn connection)</para>
+ </listitem>
+ <listitem>
+ <para>listVpnCustomerGateways (Lists site to site vpn customer gateways)</para>
+ </listitem>
+ <listitem>
+ <para>listVpnGateways (Lists site 2 site vpn gateways)</para>
+ </listitem>
+ <listitem>
+ <para>listVpnConnections (Lists site to site vpn connection gateways)</para>
+ </listitem>
+ <listitem>
+ <para>enableCiscoNexusVSM (Enables Nexus 1000v dvSwitch in &PRODUCT;.)</para>
+ </listitem>
+ <listitem>
+ <para>disableCiscoNexusVSM (Disables Nexus 1000v dvSwitch in &PRODUCT;.)</para>
+ </listitem>
+ <listitem>
+ <para>deleteCiscoNexusVSM (Deletes Nexus 1000v dvSwitch in &PRODUCT;.)</para>
+ </listitem>
+ <listitem>
+ <para>listCiscoNexusVSMs (Lists the control VLAN ID, packet VLAN ID, and data VLAN ID, as well
+ as the IP address of the Nexus 1000v dvSwitch.)</para>
+ </listitem>
+ </itemizedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/added-API-commands-4-1.xml
----------------------------------------------------------------------
diff --git a/en-US/added-API-commands-4-1.xml b/en-US/added-API-commands-4-1.xml
new file mode 100644
index 0000000..006c65a
--- /dev/null
+++ b/en-US/added-API-commands-4-1.xml
@@ -0,0 +1,73 @@
+<?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="added-API-commands-4.1">
+ <title>Added API Commands in 4.1</title>
+ <itemizedlist>
+ <listitem>
+ <para>createEgressFirewallRules (creates an egress firewall rule on the guest network.)</para>
+ </listitem>
+ <listitem>
+ <para>deleteEgressFirewallRules (deletes a egress firewall rule on the guest network.)</para>
+ </listitem>
+ <listitem>
+ <para>listEgressFirewallRules (lists the egress firewall rules configured for a guest
+ network.)</para>
+ </listitem>
+ <listitem>
+ <para>resetSSHKeyForVirtualMachine (Resets the SSHkey for virtual machine.)</para>
+ </listitem>
+ <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>
+ <listitem><para>addRegion (Add a region)</para></listitem>
+ <listitem><para>removeRegion (Delete a region)</para></listitem>
+ <listitem><para>updateRegion (Modify attributes of a region)</para></listitem>
+ <listitem><para>listRegions (List regions)</para></listitem>
+ </itemizedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/added-API-commands-4.2.xml
----------------------------------------------------------------------
diff --git a/en-US/added-API-commands-4.2.xml b/en-US/added-API-commands-4.2.xml
new file mode 100644
index 0000000..14a5f64
--- /dev/null
+++ b/en-US/added-API-commands-4.2.xml
@@ -0,0 +1,554 @@
+<?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="added-API-commands-4.2">
+ <title>Added API Commands in 4.2</title>
+ <itemizedlist>
+ <listitem>
+ <para>addImageStore</para>
+ <para>Adds all types of secondary storage providers, S3/Swift/NFS.</para>
+ </listitem>
+ <listitem>
+ <para>createSecondaryStagingStore</para>
+ <para>Adds a staging secondary storage in each zone.</para>
+ </listitem>
+ <listitem>
+ <para>listImageStores</para>
+ <para>Lists all secondary storages, S3/Swift/NFS.</para>
+ </listitem>
+ <listitem>
+ <para>listSecondaryStagingStores</para>
+ <para>Lists all staging secondary storages.</para>
+ </listitem>
+ <listitem>
+ <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</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</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>
+ <listitem>
+ <para>deleteAlerts </para>
+ <para>Deletes the specified alerts. The request parameters are: ids (allowed to pass one or
+ more IDs separated by comma); type (string); olderthan (yyyy-mm-dd format).</para>
+ <para>The response parameters are: true, false </para>
+ </listitem>
+ <listitem>
+ <para>archiveAlerts</para>
+ <para>Archives the specified alerts. The request parameters are: ids (allowed to pass one or
+ more IDs separated by comma); type (string); olderthan (yyyy-mm-dd format).</para>
+ <para>The response parameters are: true, false </para>
+ </listitem>
+ <listitem>
+ <para>deleteEvents </para>
+ <para>Deletes the specified events. The request parameters are: ids (allowed to pass one or
+ more IDs separated by comma); type (string); olderthan (yyyy-mm-dd format).</para>
+ <para>The response parameters are: true, false</para>
+ </listitem>
+ <listitem>
+ <para>archiveEvents</para>
+ <para>Archives the specified events. The request parameters are: ids (allowed to pass one or
+ more IDs separated by comma); type (string); olderthan (yyyy-mm-dd format).</para>
+ <para>The response parameters are: true, false </para>
+ </listitem>
+ <listitem>
+ <para>createGlobalLoadBalancerRule</para>
+ <para>Creates a GSLB rule. The request parameters are name (the name of the global load
+ balancer rule); domain name ( the preferred domain name for the service); lb algorithm (the
+ algorithm used to load balance the traffic across the zones); session persistence (source IP
+ and HTTP cookie); account name; and domain Id.</para>
+ </listitem>
+ <listitem>
+ <para>assignToGlobalLoadBalancerRule</para>
+ <para>Assigns a load balancing rule or list of load balancing rules to GSLB. The request
+ parameters are: id (the UUID of global load balancer rule); loadbalancerrulelist (the list
+ load balancer rules that will be assigned to global load balancer rule. These are second
+ tier load balancing rules created with createLoadBalancerRule API. Weight is optional, the
+ default is 1).</para>
+ </listitem>
+ <listitem>
+ <para>removeFromGlobalLoadBalancerRule</para>
+ <para>Removes a load balancer rule association with global load balancer rule. The request
+ parameters are id (the UUID of global load balancer rule); loadbalancerrulelist (the list
+ load balancer rules that will be assigned to global load balancer rule).</para>
+ </listitem>
+ <listitem>
+ <para>deleteGlobalLoadBalancerRule</para>
+ <para>Deletes a global load balancer rule. The request parameters is: id (the unique ID of the
+ global load balancer rule).</para>
+ </listitem>
+ <listitem>
+ <para>listGlobalLoadBalancerRule</para>
+ <para>Lists load balancer rules.</para>
+ <para>The request parameters are: account (lists resources by account. Use with the domainid
+ parameter); domainid (lists only resources belonging to the domain specified); id (the
+ unique ID of the global load balancer rule); isrecursive (defaults to false; but if true,
+ lists all the resources from the parent specified by the domainid); keyword (lists by
+ keyword); listall (if set to false, lists only resources belonging to the command's caller;
+ if set to true, lists resources that the caller is authorized to see. Default value is
+ false); page; pagesize; projectid (lists objects by project); regionid ; tags (lists
+ resources by tags: key/value pairs). </para>
+ </listitem>
+ <listitem>
+ <para>updateGlobalLoadBalancerRule</para>
+ <para>Updates global load balancer rules.</para>
+ <para>The request parameters are: id (the unique ID of the global load balancer rule); account
+ (lists resources by account. Use with the domainid parameter); description (the description
+ of the load balancer rule); domainid (lists only resources belonging to the domain
+ specified); gslblbmethod (the load balancer algorithm that is used to distributed traffic
+ across the zones participating in global server load balancing, if not specified defaults to
+ round robin); gslbstickysessionmethodname (the session sticky method; if not specified
+ defaults to sourceip); isrecursive (defaults to false, but if true, lists all resources from
+ the parent specified by the domainid till leaves); keyword (lists by keyword); listall (if
+ set to false, list only those resources belonging to the command's caller; if set to true,
+ lists resources that the caller is authorized to see. Default value is false); page;
+ pagesize; projectid (lists objects by project); regionid; tags (lists resources by tags:
+ key/value pairs)</para>
+ </listitem>
+ <listitem>
+ <para>createPortableIpRange</para>
+ <para>Creates portable IP addresses in the portable public IP address pool.</para>
+ <para>The request parameters are region id, start ip, end ip, netmask, gateway, and
+ vlan.</para>
+ </listitem>
+ <listitem>
+ <para>deletePortableIpRange</para>
+ <para>Deletes portable IP addresses from the portable public IP address pool.</para>
+ <para>The request parameters is portable ip address range id.</para>
+ </listitem>
+ <listitem>
+ <para>listPortableIpRange</para>
+ <para>Lists portable IP addresses in the portable public IP address pool associated with a
+ Region.</para>
+ <para>The request parameters are elastic ip id and region id.</para>
+ </listitem>
+ <listitem>
+ <para>createVMSnapshot</para>
+ <para>Creates a virtual machine snapshot.</para>
+ </listitem>
+ <listitem>
+ <para>deleteVMSnapshot </para>
+ <para>Deletes a virtual machine snapshot.</para>
+ </listitem>
+ <listitem>
+ <para>listVMSnapshot</para>
+ <para>Shows a virtual machine snapshot.</para>
+ </listitem>
+ <listitem>
+ <para>revertToVMSnapshot </para>
+ <para>Returns a virtual machine to the state and data saved in a given snapshot.</para>
+ </listitem>
+ <listitem>
+ <para>createLBHealthCheckPolicy </para>
+ <para>Creates a new health check policy for a load balancer rule.</para>
+ </listitem>
+ <listitem>
+ <para>deleteLBHealthCheckPolicy</para>
+ <para>Deletes an existing health check policy from a load balancer rule.</para>
+ </listitem>
+ <listitem>
+ <para>listLBHealthCheckPolicies</para>
+ <para>Displays the health check policy for a load balancer rule.</para>
+ </listitem>
+ <listitem>
+ <para>createEgressFirewallRules </para>
+ <para>Creates an egress firewall rule on the guest network.</para>
+ </listitem>
+ <listitem>
+ <para>deleteEgressFirewallRules </para>
+ <para>Deletes a egress firewall rule on the guest network.</para>
+ </listitem>
+ <listitem>
+ <para>listEgressFirewallRules </para>
+ <para>Lists the egress firewall rules configured for a guest network.</para>
+ </listitem>
+ <listitem>
+ <para>resetSSHKeyForVirtualMachine </para>
+ <para>Resets the SSHkey for virtual machine.</para>
+ </listitem>
+ <listitem>
+ <para>addBaremetalHost </para>
+ <para>Adds a new host. Technically, this API command was present in v3.0.6, but its
+ functionality was disabled.</para>
+ </listitem>
+ <listitem>
+ <para>addBaremetalDhcp </para>
+ <para>Adds a DHCP server for bare metal hosts.</para>
+ </listitem>
+ <listitem>
+ <para> addBaremetalPxePingServer </para>
+ <para>Adds a PXE PING server for bare metal hosts.</para>
+ </listitem>
+ <listitem>
+ <para> addBaremetalPxeKickStartServer (Adds a PXE server for bare metal hosts)</para>
+ </listitem>
+ <listitem>
+ <para> listBaremetalDhcp </para>
+ <para>Shows the DHCP servers currently defined for bare metal hosts.</para>
+ </listitem>
+ <listitem>
+ <para> listBaremetalPxePingServer </para>
+ <para>Shows the PXE PING servers currently defined for bare metal hosts.</para>
+ </listitem>
+ <listitem>
+ <para>addNicToVirtualMachine </para>
+ <para>Adds a new NIC to the specified VM on a selected network.</para>
+ </listitem>
+ <listitem>
+ <para>removeNicFromVirtualMachine </para>
+ <para>Removes the specified NIC from a selected VM.</para>
+ </listitem>
+ <listitem>
+ <para>updateDefaultNicForVirtualMachine </para>
+ <para>Updates the specified NIC to be the default one for a selected VM.</para>
+ </listitem>
+ <listitem>
+ <para>addRegion </para>
+ <para>Registers a Region into another Region.</para>
+ </listitem>
+ <listitem>
+ <para>updateRegion </para>
+ <para>Updates Region details: ID, Name, Endpoint, User API Key, and User Secret Key.</para>
+ </listitem>
+ <listitem>
+ <para>removeRegion </para>
+ <para>Removes a Region from current Region.</para>
+ </listitem>
+ <listitem>
+ <para>listRegions </para>
+ <para>Get all the Regions. They can be filtered by using the ID or Name.</para>
+ </listitem>
+ <listitem>
+ <para>getUser </para>
+ <para>This API can only be used by the Admin. Get user account details by using the API
+ Key.</para>
+ </listitem>
+ <listitem>
+ <para>getApiLimit </para>
+ <para>Shows number of remaining APIs for the invoking user in current window.</para>
+ </listitem>
+ <listitem>
+ <para>resetApiLimit </para>
+ <para>For root admin, if account ID parameter is passed, it will reset count for that
+ particular account, otherwise it will reset all counters.</para>
+ </listitem>
+ <listitem>
+ <para>lockAccount </para>
+ <para>Locks an account.</para>
+ </listitem>
+ <listitem>
+ <para>lockUser </para>
+ <para>Locks a user account.</para>
+ </listitem>
+ <listitem>
+ <para>scaleVirtualMachine </para>
+ <para>Scales the virtual machine to a new service offering.</para>
+ </listitem>
+ <listitem>
+ <para>migrateVirtualMachineWithVolume </para>
+ <para>Attempts migrating VM with its volumes to a different host. </para>
+ </listitem>
+ <listitem>
+ <para>dedicatePublicIpRange </para>
+ <para>Dedicates a Public IP range to an account.</para>
+ </listitem>
+ <listitem>
+ <para>releasePublicIpRange </para>
+ <para>Releases a Public IP range back to the system pool. </para>
+ </listitem>
+ <listitem>
+ <para>dedicateGuestVlanRange </para>
+ <para>Dedicates a guest VLAN range to an account. </para>
+ </listitem>
+ <listitem>
+ <para>releaseDedicatedGuestVlanRange </para>
+ <para>Releases a dedicated guest VLAN range to the system.</para>
+ </listitem>
+ <listitem>
+ <para>listDedicatedGuestVlanRanges </para>
+ <para>Lists dedicated guest VLAN ranges.</para>
+ </listitem>
+ <listitem>
+ <para>updatePortForwardingRule </para>
+ <para>Updates a port forwarding rule. Only the private port and the VM can be updated. </para>
+ </listitem>
+ <listitem>
+ <para>scaleSystemVm </para>
+ <para>Scales the service offering for a systemVM, console proxy, or secondary storage.</para>
+ </listitem>
+ <listitem>
+ <para>listDeploymentPlanners </para>
+ <para>Lists all the deployment planners available.</para>
+ </listitem>
+ <listitem>
+ <para>addS3 </para>
+ <para>Adds a Amazon Simple Storage Service instance.</para>
+ </listitem>
+ <listitem>
+ <para>listS3s </para>
+ <para>Lists all the Amazon Simple Storage Service instances. </para>
+ </listitem>
+ <listitem>
+ <para>findHostsForMigration </para>
+ <para>Finds hosts suitable for migrating a VM to.</para>
+ </listitem>
+ <listitem>
+ <para>releaseHostReservation </para>
+ <para>Releases host reservation.</para>
+ </listitem>
+ <listitem>
+ <para>resizeVolume </para>
+ <para>Resizes a volume.</para>
+ </listitem>
+ <listitem>
+ <para>updateVolume </para>
+ <para>Updates the volume.</para>
+ </listitem>
+ <listitem>
+ <para>listStorageProviders </para>
+ <para>Lists storage providers. </para>
+ </listitem>
+ <listitem>
+ <para>findStoragePoolsForMigration </para>
+ <para>Lists storage pools available for migrating a volume. </para>
+ </listitem>
+ <listitem>
+ <para>createEgressFirewallRule </para>
+ <para>Creates a egress firewall rule for a given network. </para>
+ </listitem>
+ <listitem>
+ <para>deleteEgressFirewallRule </para>
+ <para>Deletes an egress firewall rule.</para>
+ </listitem>
+ <listitem>
+ <para>listEgressFirewallRules </para>
+ <para>Lists all egress firewall rules for network.</para>
+ </listitem>
+ <listitem>
+ <para>updateNetworkACLItem </para>
+ <para>Updates ACL item with specified ID.</para>
+ </listitem>
+ <listitem>
+ <para>createNetworkACLList </para>
+ <para>Creates a Network ACL for the given VPC. </para>
+ </listitem>
+ <listitem>
+ <para>deleteNetworkACLList </para>
+ <para>Deletes a Network ACL. </para>
+ </listitem>
+ <listitem>
+ <para>replaceNetworkACLList </para>
+ <para>Replaces ACL associated with a Network or private gateway.</para>
+ </listitem>
+ <listitem>
+ <para>listNetworkACLLists </para>
+ <para>Lists all network ACLs.</para>
+ </listitem>
+ <listitem>
+ <para>addResourceDetail </para>
+ <para>Adds detail for the Resource. </para>
+ </listitem>
+ <listitem>
+ <para>removeResourceDetail </para>
+ <para>Removes details of the resource.</para>
+ </listitem>
+ <listitem>
+ <para>listResourceDetails </para>
+ <para>Lists resource details. </para>
+ </listitem>
+ <listitem>
+ <para>addNiciraNvpDevice </para>
+ <para>Adds a Nicira NVP device.</para>
+ </listitem>
+ <listitem>
+ <para>deleteNiciraNvpDevice </para>
+ <para>Deletes a Nicira NVP device.</para>
+ </listitem>
+ <listitem>
+ <para>listNiciraNvpDevices </para>
+ <para>Lists Nicira NVP devices.</para>
+ </listitem>
+ <listitem>
+ <para>listNiciraNvpDeviceNetworks </para>
+ <para>Lists network that are using a Nicira NVP device.</para>
+ </listitem>
+ <listitem>
+ <para>addBigSwitchVnsDevice </para>
+ <para>Adds a BigSwitch VNS device.</para>
+ </listitem>
+ <listitem>
+ <para>deleteBigSwitchVnsDevice </para>
+ <para>Deletes a BigSwitch VNS device.</para>
+ </listitem>
+ <listitem>
+ <para>listBigSwitchVnsDevices </para>
+ <para>Lists BigSwitch VNS devices.</para>
+ </listitem>
+ <listitem>
+ <para>configureSimulator </para>
+ <para>Configures a simulator.</para>
+ </listitem>
+ <listitem>
+ <para>listApis </para>
+ <para>Lists all the available APIs on the server, provided by the API Discovery plugin. </para>
+ </listitem>
+ <listitem>
+ <para>getApiLimit </para>
+ <para>Gets the API limit count for the caller. </para>
+ </listitem>
+ <listitem>
+ <para>resetApiLimit </para>
+ <para>Resets the API count.</para>
+ </listitem>
+ <listitem>
+ <para>assignToGlobalLoadBalancerRule </para>
+ <para>Assigns load balancer rule or list of load balancer rules to a global load balancer
+ rules.</para>
+ </listitem>
+ <listitem>
+ <para>removeFromGlobalLoadBalancerRule </para>
+ <para>Removes a load balancer rule association with global load balancer rule.</para>
+ </listitem>
+ <listitem>
+ <para>listVMSnapshot </para>
+ <para>Lists virtual machine snapshot by conditions.</para>
+ </listitem>
+ <listitem>
+ <para>createLoadBalancer </para>
+ <para>Creates a load balancer.</para>
+ </listitem>
+ <listitem>
+ <para>listLoadBalancers </para>
+ <para>Lists load balancers.</para>
+ </listitem>
+ <listitem>
+ <para>deleteLoadBalancer </para>
+ <para>Deletes a load balancer. </para>
+ </listitem>
+ <listitem>
+ <para>configureInternalLoadBalancerElement </para>
+ <para>Configures an Internal Load Balancer element.</para>
+ </listitem>
+ <listitem>
+ <para>createInternalLoadBalancerElement </para>
+ <para>Creates an Internal Load Balancer element.</para>
+ </listitem>
+ <listitem>
+ <para>listInternalLoadBalancerElements </para>
+ <para>Lists all available Internal Load Balancer elements.</para>
+ </listitem>
+ <listitem>
+ <para>createAffinityGroup </para>
+ <para>Creates an affinity or anti-affinity group.</para>
+ </listitem>
+ <listitem>
+ <para>deleteAffinityGroup </para>
+ <para>Deletes an affinity group.</para>
+ </listitem>
+ <listitem>
+ <para>listAffinityGroups </para>
+ <para>Lists all the affinity groups.</para>
+ </listitem>
+ <listitem>
+ <para>updateVMAffinityGroup </para>
+ <para>Updates the affinity or anti-affinity group associations of a VM. The VM has to be
+ stopped and restarted for the new properties to take effect.</para>
+ </listitem>
+ <listitem>
+ <para>listAffinityGroupTypes </para>
+ <para>Lists affinity group types available. </para>
+ </listitem>
+ <listitem>
+ <para>stopInternalLoadBalancerVM </para>
+ <para>Stops an Internal LB VM.</para>
+ </listitem>
+ <listitem>
+ <para>startInternalLoadBalancerVM </para>
+ <para>Starts an existing Internal LB VM.</para>
+ </listitem>
+ <listitem>
+ <para>listInternalLoadBalancerVMs </para>
+ <para>Lists internal LB VMs.</para>
+ </listitem>
+ <listitem>
+ <para>listNetworkIsolationMethods </para>
+ <para>Lists supported methods of network isolation.</para>
+ </listitem>
+ <listitem>
+ <para>dedicateZone </para>
+ <para>Dedicates a zone.</para>
+ </listitem>
+ <listitem>
+ <para>dedicatePod </para>
+ <para>Dedicates a pod. </para>
+ </listitem>
+ <listitem>
+ <para>dedicateCluster </para>
+ <para>Dedicates an existing cluster. </para>
+ </listitem>
+ <listitem>
+ <para>dedicateHost </para>
+ <para>Dedicates a host.</para>
+ </listitem>
+ <listitem>
+ <para>releaseDedicatedZone </para>
+ <para>Releases dedication of zone. </para>
+ </listitem>
+ <listitem>
+ <para>releaseDedicatedPod </para>
+ <para>Releases dedication for the pod. </para>
+ </listitem>
+ <listitem>
+ <para>releaseDedicatedCluster </para>
+ <para>Releases dedication for cluster. </para>
+ </listitem>
+ <listitem>
+ <para>releaseDedicatedHost </para>
+ <para>Releases dedication for host. </para>
+ </listitem>
+ <listitem>
+ <para>listDedicatedZones </para>
+ <para>Lists dedicated zones. </para>
+ </listitem>
+ <listitem>
+ <para>listDedicatedPods </para>
+ <para>Lists dedicated pods.</para>
+ </listitem>
+ <listitem>
+ <para>listDedicatedClusters </para>
+ <para>Lists dedicated clusters.</para>
+ </listitem>
+ <listitem>
+ <para>listDedicatedHosts </para>
+ <para>Lists dedicated hosts. </para>
+ </listitem>
+ </itemizedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/added-API-commands.xml
----------------------------------------------------------------------
diff --git a/en-US/added-API-commands.xml b/en-US/added-API-commands.xml
new file mode 100644
index 0000000..99635de
--- /dev/null
+++ b/en-US/added-API-commands.xml
@@ -0,0 +1,195 @@
+<?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="added-API-commands">
+ <title>Added API commands in 3.0</title>
+ <section id="added-api-commands-3.0.2">
+ <title>Added in 3.0.2</title>
+ <itemizedlist>
+ <listitem>
+ <para>changeServiceForSystemVm</para>
+ <para>Changes the service offering for a system VM (console proxy or secondary storage). The
+ system VM must be in a "Stopped" state for this command to take effect.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="added-api-commands-3.0.1">
+ <title>Added in 3.0.1</title>
+ <itemizedlist>
+ <listitem>
+ <para>changeServiceForSystemVm</para>
+ <para>Changes the service offering for a system VM (console proxy or secondary storage). The
+ system VM must be in a "Stopped" state for this command to take effect.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="added-api-commands-3.0.0">
+ <title>Added in 3.0.0</title>
+ <informaltable frame="all">
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2"/>
+ <colspec colname="c3"/>
+ <tbody>
+ <row>
+ <entry><para>assignVirtualMachine (Move a user VM to another user under same
+ domain.)</para></entry>
+ <entry><para>restoreVirtualMachine (Restore a VM to original template or specific
+ snapshot)</para></entry>
+ <entry><para>createLBStickinessPolicy (Creates a Load Balancer stickiness policy
+ )</para></entry>
+ </row>
+ <row>
+ <entry><para>deleteLBStickinessPolicy (Deletes a LB stickiness policy.)</para></entry>
+ <entry><para>listLBStickinessPolicies (Lists LBStickiness policies.)</para></entry>
+ <entry><para>ldapConfig (Configure the LDAP context for this site.)</para></entry>
+ </row>
+ <row>
+ <entry><para>addSwift (Adds Swift.)</para></entry>
+ <entry><para>listSwifts (List Swift.)</para></entry>
+ <entry><para>migrateVolume (Migrate volume)</para></entry>
+ </row>
+ <row>
+ <entry><para>updateStoragePool (Updates a storage pool.)</para></entry>
+ <entry><para>authorizeSecurityGroupEgress (Authorizes a particular egress rule for this
+ security group)</para></entry>
+ <entry><para>revokeSecurityGroupEgress (Deletes a particular egress rule from this
+ security group)</para></entry>
+ </row>
+ <row>
+ <entry><para>createNetworkOffering (Creates a network offering.)</para></entry>
+ <entry><para>deleteNetworkOffering (Deletes a network offering.)</para></entry>
+ <entry><para>createProject (Creates a project)</para></entry>
+ </row>
+ <row>
+ <entry><para>deleteProject (Deletes a project)</para></entry>
+ <entry><para>updateProject (Updates a project)</para></entry>
+ <entry><para>activateProject (Activates a project)</para></entry>
+ </row>
+ <row>
+ <entry><para>suspendProject (Suspends a project)</para></entry>
+ <entry><para>listProjects (Lists projects and provides detailed information for listed
+ projects)</para></entry>
+ <entry><para>addAccountToProject (Adds account to a project)</para></entry>
+ </row>
+ <row>
+ <entry><para>deleteAccountFromProject (Deletes account from the project)</para></entry>
+ <entry><para>listProjectAccounts (Lists project's accounts)</para></entry>
+ <entry><para>listProjectInvitations (Lists an account's invitations to join
+ projects)</para></entry>
+ </row>
+ <row>
+ <entry><para>updateProjectInvitation (Accepts or declines project
+ invitation)</para></entry>
+ <entry><para>deleteProjectInvitation (Deletes a project invitation)</para></entry>
+ <entry><para>updateHypervisorCapabilities (Updates a hypervisor
+ capabilities.)</para></entry>
+ </row>
+ <row>
+ <entry><para>listHypervisorCapabilities (Lists all hypervisor
+ capabilities.)</para></entry>
+ <entry><para>createPhysicalNetwork (Creates a physical network)</para></entry>
+ <entry><para>deletePhysicalNetwork (Deletes a Physical Network.)</para></entry>
+ </row>
+ <row>
+ <entry><para>listPhysicalNetworks (Lists physical networks)</para></entry>
+ <entry><para>updatePhysicalNetwork (Updates a physical network)</para></entry>
+ <entry><para>listSupportedNetworkServices (Lists all network services provided by
+ &PRODUCT; or for the given Provider.)</para></entry>
+ </row>
+ <row>
+ <entry><para>addNetworkServiceProvider (Adds a network serviceProvider to a physical
+ network)</para></entry>
+ <entry><para>deleteNetworkServiceProvider (Deletes a Network Service
+ Provider.)</para></entry>
+ <entry><para>listNetworkServiceProviders (Lists network serviceproviders for a given
+ physical network.)</para></entry>
+ </row>
+ <row>
+ <entry><para>updateNetworkServiceProvider (Updates a network serviceProvider of a physical
+ network)</para></entry>
+ <entry><para>addTrafficType (Adds traffic type to a physical network)</para></entry>
+ <entry><para>deleteTrafficType (Deletes traffic type of a physical network)</para></entry>
+ </row>
+ <row>
+ <entry><para>listTrafficTypes (Lists traffic types of a given physical
+ network.)</para></entry>
+ <entry><para>updateTrafficType (Updates traffic type of a physical network)</para></entry>
+ <entry><para>listTrafficTypeImplementors (Lists implementors of implementor of a network
+ traffic type or implementors of all network traffic types)</para></entry>
+ </row>
+ <row>
+ <entry><para>createStorageNetworkIpRange (Creates a Storage network IP
+ range.)</para></entry>
+ <entry><para>deleteStorageNetworkIpRange (Deletes a storage network IP
+ Range.)</para></entry>
+ <entry><para>listStorageNetworkIpRange (List a storage network IP range.)</para></entry>
+ </row>
+ <row>
+ <entry><para>updateStorageNetworkIpRange (Update a Storage network IP range, only allowed
+ when no IPs in this range have been allocated.)</para></entry>
+ <entry><para>listUsageTypes (List Usage Types)</para></entry>
+ <entry><para>addF5LoadBalancer (Adds a F5 BigIP load balancer device)</para></entry>
+ </row>
+ <row>
+ <entry><para>configureF5LoadBalancer (configures a F5 load balancer device)</para></entry>
+ <entry><para>deleteF5LoadBalancer ( delete a F5 load balancer device)</para></entry>
+ <entry><para>listF5LoadBalancers (lists F5 load balancer devices)</para></entry>
+ </row>
+ <row>
+ <entry><para>listF5LoadBalancerNetworks (lists network that are using a F5 load balancer
+ device)</para></entry>
+ <entry><para>addSrxFirewall (Adds a SRX firewall device)</para></entry>
+ <entry><para>deleteSrxFirewall ( delete a SRX firewall device)</para></entry>
+ </row>
+ <row>
+ <entry><para>listSrxFirewalls (lists SRX firewall devices in a physical
+ network)</para></entry>
+ <entry><para>listSrxFirewallNetworks (lists network that are using SRX firewall
+ device)</para></entry>
+ <entry><para>addNetscalerLoadBalancer (Adds a netscaler load balancer
+ device)</para></entry>
+ </row>
+ <row>
+ <entry><para>deleteNetscalerLoadBalancer ( delete a netscaler load balancer
+ device)</para></entry>
+ <entry><para>configureNetscalerLoadBalancer (configures a netscaler load balancer
+ device)</para></entry>
+ <entry><para>listNetscalerLoadBalancers (lists netscaler load balancer
+ devices)</para></entry>
+ </row>
+ <row>
+ <entry><para>listNetscalerLoadBalancerNetworks (lists network that are using a netscaler
+ load balancer device)</para></entry>
+ <entry><para>createVirtualRouterElement (Create a virtual router element.)</para></entry>
+ <entry><para>configureVirtualRouterElement (Configures a virtual router
+ element.)</para></entry>
+ </row>
+ <row>
+ <entry><para>listVirtualRouterElements (Lists all available virtual router
+ elements.)</para></entry>
+ <entry><para/></entry>
+ <entry><para/></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/added-error-codes.xml
----------------------------------------------------------------------
diff --git a/en-US/added-error-codes.xml b/en-US/added-error-codes.xml
new file mode 100644
index 0000000..ae73891
--- /dev/null
+++ b/en-US/added-error-codes.xml
@@ -0,0 +1,138 @@
+<?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="added-error-codes">
+ <title>Added &PRODUCT; Error Codes</title>
+ <para>You can now find the &PRODUCT;-specific error code in the exception response for each type of exception. The following list of error codes is added to the new class named CSExceptionErrorCode.</para>
+ <informaltable frame="all">
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1" />
+ <colspec colname="c2" />
+ <colspec colname="c3" />
+ <tbody>
+ <row>
+ <entry><para>4250 : "com.cloud.utils.exception.CloudRuntimeException"</para></entry>
+ <entry><para>4255 : "com.cloud.utils.exception.ExceptionUtil"</para></entry>
+ <entry><para>4260 : "com.cloud.utils.exception.ExecutionException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4265 : "com.cloud.utils.exception.HypervisorVersionChangedException"</para></entry>
+ <entry><para>4270 : "com.cloud.utils.exception.RuntimeCloudException"</para></entry>
+ <entry><para>4275 : "com.cloud.exception.CloudException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4280 : "com.cloud.exception.AccountLimitException"</para></entry>
+ <entry><para>4285 : "com.cloud.exception.AgentUnavailableException"</para></entry>
+ <entry><para>4290 : "com.cloud.exception.CloudAuthenticationException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4295 : "com.cloud.exception.CloudExecutionException"</para></entry>
+ <entry><para>4300 : "com.cloud.exception.ConcurrentOperationException"</para></entry>
+ <entry><para>4305 : "com.cloud.exception.ConflictingNetworkSettingsException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4310 : "com.cloud.exception.DiscoveredWithErrorException"</para></entry>
+ <entry><para>4315 : "com.cloud.exception.HAStateException"</para></entry>
+ <entry><para>4320 : "com.cloud.exception.InsufficientAddressCapacityException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4325 : "com.cloud.exception.InsufficientCapacityException"</para></entry>
+ <entry><para>4330 : "com.cloud.exception.InsufficientNetworkCapacityException"</para></entry>
+ <entry><para>4335 : "com.cloud.exception.InsufficientServerCapacityException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4340 : "com.cloud.exception.InsufficientStorageCapacityException"</para></entry>
+ <entry><para>4345 : "com.cloud.exception.InternalErrorException"</para></entry>
+ <entry><para>4350 : "com.cloud.exception.InvalidParameterValueException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4355 : "com.cloud.exception.ManagementServerException"</para></entry>
+ <entry><para>4360 : "com.cloud.exception.NetworkRuleConflictException"</para></entry>
+ <entry><para>4365 : "com.cloud.exception.PermissionDeniedException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4370 : "com.cloud.exception.ResourceAllocationException"</para></entry>
+ <entry><para>4375 : "com.cloud.exception.ResourceInUseException"</para></entry>
+ <entry><para>4380 : "com.cloud.exception.ResourceUnavailableException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4385 : "com.cloud.exception.StorageUnavailableException"</para></entry>
+ <entry><para>4390 : "com.cloud.exception.UnsupportedServiceException"</para></entry>
+ <entry><para>4395 : "com.cloud.exception.VirtualMachineMigrationException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4400 : "com.cloud.exception.AccountLimitException"</para></entry>
+ <entry><para>4405 : "com.cloud.exception.AgentUnavailableException"</para></entry>
+ <entry><para>4410 : "com.cloud.exception.CloudAuthenticationException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4415 : "com.cloud.exception.CloudException"</para></entry>
+ <entry><para>4420 : "com.cloud.exception.CloudExecutionException"</para></entry>
+ <entry><para>4425 : "com.cloud.exception.ConcurrentOperationException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4430 : "com.cloud.exception.ConflictingNetworkSettingsException"</para></entry>
+ <entry><para>4435 : "com.cloud.exception.ConnectionException"</para></entry>
+ <entry><para>4440 : "com.cloud.exception.DiscoveredWithErrorException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4445 : "com.cloud.exception.DiscoveryException"</para></entry>
+ <entry><para>4450 : "com.cloud.exception.HAStateException"</para></entry>
+ <entry><para>4455 : "com.cloud.exception.InsufficientAddressCapacityException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4460 : "com.cloud.exception.InsufficientCapacityException"</para></entry>
+ <entry><para>4465 : "com.cloud.exception.InsufficientNetworkCapacityException"</para></entry>
+ <entry><para>4470 : "com.cloud.exception.InsufficientServerCapacityException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4475 : "com.cloud.exception.InsufficientStorageCapacityException"</para></entry>
+ <entry><para>4480 : "com.cloud.exception.InsufficientVirtualNetworkCapcityException"</para></entry>
+ <entry><para>4485 : "com.cloud.exception.InternalErrorException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4490 : "com.cloud.exception.InvalidParameterValueException"</para></entry>
+ <entry><para>4495 : "com.cloud.exception.ManagementServerException"</para></entry>
+ <entry><para>4500 : "com.cloud.exception.NetworkRuleConflictException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4505 : "com.cloud.exception.PermissionDeniedException"</para></entry>
+ <entry><para>4510 : "com.cloud.exception.ResourceAllocationException"</para></entry>
+ <entry><para>4515 : "com.cloud.exception.ResourceInUseException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4520 : "com.cloud.exception.ResourceUnavailableException"</para></entry>
+ <entry><para>4525 : "com.cloud.exception.StorageUnavailableException"</para></entry>
+ <entry><para>4530 : "com.cloud.exception.UnsupportedServiceException"</para></entry>
+ </row>
+ <row>
+ <entry><para>4535 : "com.cloud.exception.VirtualMachineMigrationException"</para></entry>
+ <entry><para>9999 : "org.apache.cloudstack.api.ServerApiException"</para></entry>
+ <entry><para></para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </section>
+
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/adding-IP-addresses-for-the-public-network.xml
----------------------------------------------------------------------
diff --git a/en-US/adding-IP-addresses-for-the-public-network.xml b/en-US/adding-IP-addresses-for-the-public-network.xml
new file mode 100644
index 0000000..abf4d02
--- /dev/null
+++ b/en-US/adding-IP-addresses-for-the-public-network.xml
@@ -0,0 +1,45 @@
+<?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="adding-IP-addresses-for-the-public-network">
+ <title>Adding IP Addresses for the Public Network</title>
+ <para>These instructions assume you have already logged in to the &PRODUCT; UI.</para>
+ <orderedlist>
+ <listitem><para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the desired zone .</para></listitem>
+ <listitem><para>Click the Network tab.</para></listitem>
+ <listitem><para>In the Public node of the diagram, click Configure.</para></listitem>
+ <listitem><para>Click the IP Ranges tab.</para></listitem>
+ <listitem><para>Provide the following information:</para>
+ <itemizedlist>
+ <listitem><para>Gateway. The gateway in use for these IP addresses</para></listitem>
+ <listitem><para>Netmask. The netmask associated with this IP range</para></listitem>
+ <listitem><para>VLAN. The VLAN that will be used for public traffic</para></listitem>
+ <listitem><para>Start IP/End IP. A range of IP addresses that are assumed to be accessible from the Internet and will be allocated for access to guest networks.</para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>Click Add.</para></listitem>
+ </orderedlist>
+
+
+ </section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/additional-installation-options.xml
----------------------------------------------------------------------
diff --git a/en-US/additional-installation-options.xml b/en-US/additional-installation-options.xml
new file mode 100644
index 0000000..622ef03
--- /dev/null
+++ b/en-US/additional-installation-options.xml
@@ -0,0 +1,31 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter 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.
+-->
+
+<chapter id="additional-installation-options">
+ <title>Additional Installation Options</title>
+ <para>The next few sections describe &PRODUCT; features above and beyond the basic deployment options.</para>
+ <xi:include href="install-usage-server.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="ssl.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="database-replication.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</chapter>