cloudstack/docs/en-US/added-API-commands-4.2.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-4.2">
  <title>Added API Commands in 4.2</title>
  <itemizedlist>
    <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>createPortableIpAddressRange</para>
      <para>Creates portable IP addresses from 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>deletePortableIpAddressRange</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>createPortableIpAddressRange</para>
      <para>Lists portable IP addresses in the portable public IP address pool.</para>
      <para>The request parameters are elastic ip id and region id.</para>
    </listitem>
  </itemizedlist>
</section>