mirror of
https://github.com/apache/cloudstack.git
synced 2025-10-26 08:42:29 +01:00
340 lines
14 KiB
XML
340 lines
14 KiB
XML
<?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</title>
|
|
<section id="added-API-commands-4.0">
|
|
<title>Added in 4.0</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>
|
|
<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 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>
|
|
</section>
|