You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by hu...@apache.org on 2012/10/06 00:32:46 UTC
[38/49] git commit: Changed and new API commands documentation
Changed and new API commands documentation
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/3643fc94
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/3643fc94
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/3643fc94
Branch: refs/heads/maven-to-rpm
Commit: 3643fc94762ffa043200b300de403933d401aa9f
Parents: 298409b
Author: Radhika PC <ra...@citrix.com>
Authored: Thu Oct 4 11:51:03 2012 +0530
Committer: Hugo Trippaers <ht...@schubergphilis.com>
Committed: Sat Oct 6 00:30:26 2012 +0200
----------------------------------------------------------------------
docs/en-US/added-API-commands.xml | 487 ++++++++++-----
docs/en-US/change-to-behavior-of-list-commands.xml | 184 +++---
docs/en-US/changed-apicommands-4.0.xml | 268 ++++++++
3 files changed, 697 insertions(+), 242 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/3643fc94/docs/en-US/added-API-commands.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/added-API-commands.xml b/docs/en-US/added-API-commands.xml
index b63895e..237c524 100644
--- a/docs/en-US/added-API-commands.xml
+++ b/docs/en-US/added-API-commands.xml
@@ -3,165 +3,332 @@
<!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.
+ 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</title>
- <para>Added in 3.0.3:</para>
- <itemizedlist>
- <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>
- <para>Added in 3.0.2:</para>
- <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>
- <para>Added in 3.0.1:</para>
- <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>
- <para>Added in 3.0.0:</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>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 acoount 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></para></entry>
- <entry><para></para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
+<section id="added-API-commands">
+ <title>Added API commands</title>
+ <para>Added in 4.0</para>
+ <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>
+ </itemizedlist>
+ <para>Added in 3.0.3:</para>
+ <itemizedlist>
+ <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>
+ <para>Added in 3.0.2:</para>
+ <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>
+ <para>Added in 3.0.1:</para>
+ <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>
+ <para>Added in 3.0.0:</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>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 acoount 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>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/3643fc94/docs/en-US/change-to-behavior-of-list-commands.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/change-to-behavior-of-list-commands.xml b/docs/en-US/change-to-behavior-of-list-commands.xml
index 4e53590..9065398 100644
--- a/docs/en-US/change-to-behavior-of-list-commands.xml
+++ b/docs/en-US/change-to-behavior-of-list-commands.xml
@@ -1,89 +1,109 @@
<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!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.
+ 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="change-to-behavior-of-list-commands">
- <title>Change to Behavior of List Commands</title>
- <para>There was a major change in how our List* API commands work in CloudStack 3.0 compared to 2.2.x. The rules below apply only for managed resources – those that belong to an account, domain, or project. They are irrelevant for the List* commands displaying unmanaged (system) resources, such as hosts, clusters, and external network resources.</para>
- <para>When no parameters are passed in to the call, the caller sees only resources owned by the caller (even when the caller is the administrator). Previously, the administrator saw everyone else's resources by default.</para>
- <para>When accountName and domainId are passed in:</para>
- <itemizedlist>
- <listitem><para>The caller sees the resources dedicated to the account specified.</para></listitem>
- <listitem><para>If the call is executed by a regular user, the user is authorized to specify only the user's own account and domainId.</para></listitem>
- <listitem><para>If the caller is a domain administrator, CloudStack performs an authorization check to see whether the caller is permitted to view resources for the given account and domainId.</para></listitem>
- </itemizedlist>
- <para>When projectId is passed in, only resources belonging to that project are listed.</para>
- <para>When domainId is passed in, the call returns only resources belonging to the domain specified. To see the resources of subdomains, use the parameter isRecursive=true. Again, the regular user can see only resources owned by that user, the root administrator can list anything, and a domain administrator is authorized to see only resources of the administrator's own domain and subdomains.</para>
- <para>To see all resources the caller is authorized to see, except for Project resources, use the parameter listAll=true.</para>
- <para>To see all Project resources the caller is authorized to see, use the parameter projectId=-1.</para>
- <para>There is one API command that doesn't fall under the rules above completely: the listTemplates command. This command has its own flags defining the list rules:</para>
- <informaltable frame="all">
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" />
- <colspec colname="c2" />
- <thead>
- <row>
- <entry><para>listTemplates Flag</para></entry>
- <entry><para>Description</para></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>featured</para></entry>
- <entry><para>Returns templates that have been marked as featured and public.</para></entry>
- </row>
-
- <row>
- <entry><para>self</para></entry>
- <entry><para>Returns templates that have been registered or created by the calling user.</para></entry>
- </row>
-
- <row>
- <entry><para>selfexecutable</para></entry>
- <entry><para>Same as self, but only returns templates that are ready to be deployed with.</para></entry>
- </row>
-
- <row>
- <entry><para>sharedexecutable</para></entry>
- <entry><para>Ready templates that have been granted to the calling user by another user.</para></entry>
- </row>
-
- <row>
- <entry><para>executable</para></entry>
- <entry><para>Templates that are owned by the calling user, or public templates, that can be used to deploy a new VM.</para></entry>
- </row>
-
- <row>
- <entry><para>community</para></entry>
- <entry><para>Returns templates that have been marked as public but not featured.</para></entry>
- </row>
-
- <row>
- <entry><para>all</para></entry>
- <entry><para>Returns all templates (only usable by admins).</para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- <para>The &PRODUCT; UI on a general view will display all resources that the logged-in user is authorized to see, except for project resources. To see the project resources, select the project view.</para>
- </section>
+ <title>Change to Behavior of List Commands</title>
+ <para>There was a major change in how our List* API commands work in CloudStack 3.0 compared to
+ 2.2.x. The rules below apply only for managed resources – those that belong to an account,
+ domain, or project. They are irrelevant for the List* commands displaying unmanaged (system)
+ resources, such as hosts, clusters, and external network resources.</para>
+ <para>When no parameters are passed in to the call, the caller sees only resources owned by the
+ caller (even when the caller is the administrator). Previously, the administrator saw everyone
+ else's resources by default.</para>
+ <para>When accountName and domainId are passed in:</para>
+ <itemizedlist>
+ <listitem>
+ <para>The caller sees the resources dedicated to the account specified.</para>
+ </listitem>
+ <listitem>
+ <para>If the call is executed by a regular user, the user is authorized to specify only the
+ user's own account and domainId.</para>
+ </listitem>
+ <listitem>
+ <para>If the caller is a domain administrator, CloudStack performs an authorization check to
+ see whether the caller is permitted to view resources for the given account and
+ domainId.</para>
+ </listitem>
+ </itemizedlist>
+ <para>When projectId is passed in, only resources belonging to that project are listed.</para>
+ <para>When domainId is passed in, the call returns only resources belonging to the domain
+ specified. To see the resources of subdomains, use the parameter isRecursive=true. Again, the
+ regular user can see only resources owned by that user, the root administrator can list
+ anything, and a domain administrator is authorized to see only resources of the administrator's
+ own domain and subdomains.</para>
+ <para>To see all resources the caller is authorized to see, except for Project resources, use the
+ parameter listAll=true.</para>
+ <para>To see all Project resources the caller is authorized to see, use the parameter
+ projectId=-1.</para>
+ <para>There is one API command that doesn't fall under the rules above completely: the
+ listTemplates command. This command has its own flags defining the list rules:</para>
+ <informaltable frame="all">
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2"/>
+ <thead>
+ <row>
+ <entry><para>listTemplates Flag</para></entry>
+ <entry><para>Description</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>featured</para></entry>
+ <entry><para>Returns templates that have been marked as featured and
+ public.</para></entry>
+ </row>
+ <row>
+ <entry><para>self</para></entry>
+ <entry><para>Returns templates that have been registered or created by the calling
+ user.</para></entry>
+ </row>
+ <row>
+ <entry><para>selfexecutable</para></entry>
+ <entry><para>Same as self, but only returns templates that are ready to be deployed
+ with.</para></entry>
+ </row>
+ <row>
+ <entry><para>sharedexecutable</para></entry>
+ <entry><para>Ready templates that have been granted to the calling user by another
+ user.</para></entry>
+ </row>
+ <row>
+ <entry><para>executable</para></entry>
+ <entry><para>Templates that are owned by the calling user, or public templates, that can
+ be used to deploy a new VM.</para></entry>
+ </row>
+ <row>
+ <entry><para>community</para></entry>
+ <entry><para>Returns templates that have been marked as public but not
+ featured.</para></entry>
+ </row>
+ <row>
+ <entry><para>all</para></entry>
+ <entry><para>Returns all templates (only usable by admins).</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>The &PRODUCT; UI on a general view will display all resources that the logged-in user is
+ authorized to see, except for project resources. To see the project resources, select the
+ project view.</para>
+ <xi:include href="changed-apicommands-4.0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/3643fc94/docs/en-US/changed-apicommands-4.0.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/changed-apicommands-4.0.xml b/docs/en-US/changed-apicommands-4.0.xml
new file mode 100644
index 0000000..f851bf7
--- /dev/null
+++ b/docs/en-US/changed-apicommands-4.0.xml
@@ -0,0 +1,268 @@
+<?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="changed-apicommands-4.0">
+ <title>Changed API Commands in 4.0</title>
+ <informaltable>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colwidth="1" colname="1" colnum="1"/>
+ <colspec colwidth="2*" colname="2" colnum="2"/>
+ <thead>
+ <row>
+ <entry><para>API Commands</para></entry>
+ <entry><para>Description</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>copyTemplate</para>
+ <para>prepareTemplate</para>
+ <para>registerTemplate</para>
+ <para>updateTemplate</para>
+ <para>createProject</para>
+ <para>activateProject</para>
+ <para>suspendProject</para>
+ <para>updateProject</para>
+ <para>listProjectAccounts</para>
+ <para>createVolume</para>
+ <para>migrateVolume</para>
+ <para>attachVolume</para>
+ <para>detachVolume</para>
+ <para>uploadVolume</para>
+ <para>createSecurityGroup</para>
+ <para>registerIso</para>
+ <para>copyIso</para>
+ <para>updateIso</para>
+ <para>createIpForwardingRule</para>
+ <para>listIpForwardingRules</para>
+ <para>createLoadBalancerRule</para>
+ <para>updateLoadBalancerRule</para>
+ <para>createSnapshot</para>
+ </entry>
+ <entry>
+ <para>The commands in this list have a single new response parameter, and no other
+ changes.</para>
+ <para>New response parameter: tags(*)</para>
+ <note>
+ <para>Many other commands also have the new tags(*) parameter in addition to other
+ changes; those commands are listed separately.</para>
+ </note></entry>
+ </row>
+ <row>
+ <entry>
+ <para>rebootVirtualMachine</para>
+ <para>attachIso</para>
+ <para>detachIso</para>
+ <para>listLoadBalancerRuleInstances</para>
+ <para>resetPasswordForVirtualMachine</para>
+ <para>changeServiceForVirtualMachine</para>
+ <para>recoverVirtualMachine</para>
+ <para>startVirtualMachine</para>
+ <para>migrateVirtualMachine</para>
+ <para>deployVirtualMachine</para>
+ <para>assignVirtualMachine</para>
+ <para>updateVirtualMachine</para>
+ <para>restoreVirtualMachine</para>
+ <para>stopVirtualMachine</para>
+ <para>destroyVirtualMachine</para>
+ </entry>
+ <entry>
+ <para>The commands in this list have two new response parameters, and no other
+ changes.</para>
+ <para>New response parameters: keypair, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>listSecurityGroups</para>
+ <para>listFirewallRules</para>
+ <para>listPortForwardingRules</para>
+ <para>listSnapshots</para>
+ <para>listIsos</para>
+ <para>listProjects</para>
+ <para>listTemplates</para>
+ <para>listLoadBalancerRules</para>
+ </entry>
+ <entry><para>The commands in this list have the following new parameters, and no other
+ changes.</para>
+ <para>New request parameter: tags (optional)</para>
+ <para>New response parameter: tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>listF5LoadBalancerNetworks</para>
+ <para>listNetscalerLoadBalancerNetworks</para>
+ <para>listSrxFirewallNetworks</para>
+ <para>updateNetwork</para>
+ </entry>
+ <entry>
+ <para>The commands in this list have three new response parameters, and no other
+ changes.</para>
+ <para>New response parameters: canusefordeploy, vpcid, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>createZone</para>
+ <para>updateZone</para>
+ </entry>
+ <entry><para>The commands in this list have the following new parameters, and no other
+ changes.</para>
+ <para>New request parameter: localstorageenabled (optional)</para>
+ <para>New response parameter: localstorageenabled</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listZones</para></entry>
+ <entry><para>New response parameter: localstorageenabled</para></entry>
+ </row>
+ <row>
+ <entry>
+ <para>rebootRouter</para>
+ <para>changeServiceForRouter</para>
+ <para>startRouter</para>
+ <para>destroyRouter</para>
+ <para>stopRouter</para>
+ </entry>
+ <entry><para>The commands in this list have two new response parameters, and no other
+ changes.</para>
+ <para>New response parameters: vpcid, nic(*)</para></entry>
+ </row>
+ <row>
+ <entry>
+ <para>updateAccount</para>
+ <para>disableAccount</para>
+ <para>listAccounts</para>
+ <para>markDefaultZoneForAccount</para>
+ <para>enableAccount</para>
+ </entry>
+ <entry><para>The commands in this list have three new response parameters, and no other
+ changes.</para>
+ <para>New response parameters: vpcavailable, vpclimit, vpctotal</para></entry>
+ </row>
+ <row>
+ <entry><para>listRouters</para></entry>
+ <entry>
+ <para>New request parameters: forvpc (optional), vpcid (optional)</para>
+ <para>New response parameters: vpcid, nic(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listNetworkOfferings</para></entry>
+ <entry>
+ <para>New request parameters: forvpc (optional)</para>
+ <para>New response parameters: forvpc </para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listVolumes</para></entry>
+ <entry>
+ <para>New request parameters: details (optional), tags (optional)</para>
+ <para>New response parameters: tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>addTrafficMonitor</para></entry>
+ <entry>
+ <para>New request parameters: excludezones (optional), includezones (optional)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>createNetwork</para></entry>
+ <entry>
+ <para>New request parameters: vpcid (optional)</para>
+ <para>New response parameters: canusefordeploy, vpcid, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listPublicIpAddresses</para></entry>
+ <entry>
+ <para>New request parameters: tags (optional), vpcid (optional)</para>
+ <para>New response parameters: vpcid, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listNetworks</para></entry>
+ <entry>
+ <para>New request parameters: canusefordeploy (optional), forvpc (optional), tags
+ (optional), vpcid (optional)</para>
+ <para>New response parameters: canusefordeploy, vpcid, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>restartNetwork</para></entry>
+ <entry>
+ <para>New response parameters: vpcid, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>enableStaticNat</para></entry>
+ <entry>
+ <para>New request parameter: networkid (optional)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>createDiskOffering</para></entry>
+ <entry>
+ <para>New request parameter: storagetype (optional)</para>
+ <para>New response parameter: storagetype</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listDiskOfferings</para></entry>
+ <entry>
+ <para>New response parameter: storagetype</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>updateDiskOffering</para></entry>
+ <entry>
+ <para>New response parameter: storagetype</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>createFirewallRule</para></entry>
+ <entry>
+ <para>Changed request parameters: ipaddressid (old version - optional, new version -
+ required)</para>
+ <para>New response parameter: tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>listVirtualMachines</para></entry>
+ <entry>
+ <para>New request parameters: isoid (optional), tags (optional), templateid
+ (optional)</para>
+ <para>New response parameters: keypair, tags(*)</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>updateStorageNetworkIpRange</para></entry>
+ <entry>
+ <para>New response parameters: id, endip, gateway, netmask, networkid, podid, startip,
+ vlan, zoneid</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</section>