Changes between Version 7 and Version 8 of GAPI_AM_API_V3


Ignore:
Timestamp:
05/02/12 11:50:22 (12 years ago)
Author:
Aaron Helsinger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GAPI_AM_API_V3

    v7 v8  
    341341}}}
    342342
    343 See the Common Concepts page for details on allocation states, operational states, sliver expiration times, and operations on individual slivers.
     343See the Common Concepts page for details on [wiki:GAPI_AM_API_V3/CommonConcepts#SliverAllocationStates allocation] and [wiki:GAPI_AM_API_V3/CommonConcepts#SliverOperationalStates operational states], [wiki:GAPI_AM_API_V3/CommonConcepts#OperationsonIndividualSlivers operations on individual slivers], [wiki:GAPI_AM_API_V3/CommonConcepts#geni_best_effort `geni_best_effort`], [wiki:GAPI_AM_API_V3/CommonConcepts#datetimedatatype sliver expiration times], [wiki:GAPI_AM_API_V3/CommonConcepts#urns `urns[]`], and [wiki:GAPI_AM_API_V3/CommonConcepts#credentials`credentials[]`].
    344344
    345345{{{
     
    395395The operation is similar to ProtoGENI's [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#RedeemTicket RedeemTicket] method.
    396396
    397 See the Common Concepts page for details on allocation states, `urns[]`, `credentials[]`, and operations on individual slivers.
    398 
    399397Options include:
    400  - {{{geni_best_effort}}}
    401  - {{{geni_end_time}}}
     398 - {{{geni_best_effort}}}: Do all slivers fail if any fail?
     399 - {{{geni_end_time}}}: Requested sliver expiration time
    402400 - `struct geni_users[]`: Resource login information. See [wiki:GAPI_AM_API_V3/CommonConcepts#geni_users the Common Concepts page].
    403 
    404 See the Common Concepts page for details on each option.
    405401
    406402Return struct:
     
    421417The returned manifest covers only newly provisioned slivers. Use `Describe` to get a manifest of all provisioned slivers.
    422418
    423 See the Common concepts page for details on allocation states, operational states, sliver expiration, and operations on individual slivers.
     419See the Common Concepts page for details on [wiki:GAPI_AM_API_V3/CommonConcepts#SliverAllocationStates allocation] and [wiki:GAPI_AM_API_V3/CommonConcepts#SliverOperationalStates operational states], [wiki:GAPI_AM_API_V3/CommonConcepts#OperationsonIndividualSlivers operations on individual slivers], [wiki:GAPI_AM_API_V3/CommonConcepts#geni_best_effort `geni_best_effort`], [wiki:GAPI_AM_API_V3/CommonConcepts#datetimedatatype sliver expiration times], [wiki:GAPI_AM_API_V3/CommonConcepts#urns `urns[]`], and [wiki:GAPI_AM_API_V3/CommonConcepts#credentials`credentials[]`], and [wiki:GAPI_AM_API_V3/CommonConcepts#geni_users `geni_users`].
    424420
    425421{{{
     
    476472
    477473This operation is similar to ProtoGENI's [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#SliverStatus,WaitForStatus SliverStatus] operation. The [http://svn.planet-lab.org/attachment/wiki/WikiStart/sfa.pdf SFA] specification does not include this operation.
    478 
    479 See the common concepts page for details on the `urns[]` and `credentials[]` arguments.
    480474
    481475This method has no required options.
     
    502496}}}
    503497
    504 See the Common Concepts page for details on allocation states, operational states, and sliver expiration times.
    505 
    506 Note that aggregates may provide other information, details on sliver contents, etc.
     498Note that aggregates may return other information, such as details on sliver contents, etc.
     499
     500See the Common Concepts page for details on [wiki:GAPI_AM_API_V3/CommonConcepts#SliverAllocationStates allocation] and [wiki:GAPI_AM_API_V3/CommonConcepts#SliverOperationalStates operational states], [wiki:GAPI_AM_API_V3/CommonConcepts#datetimedatatype sliver expiration times], [wiki:GAPI_AM_API_V3/CommonConcepts#urns `urns[]`], and [wiki:GAPI_AM_API_V3/CommonConcepts#credentials`credentials[]`].
    507501
    508502 == !PerformOperationalAction ==
     
    519513
    520514Options include: {{{geni_best_effort}}}. Default is false (action applies to all slivers equally or none.
    521 
    522 See the Common Concepts page for details on operational states and methods, `geni_best_effort`, operations on individual slivers, and the `urns[]` and `credentials[]` arguments.
    523515
    524516Return value is a list of structs:
     
    536528}}}
    537529
    538 See the Common Concepts page for details on operational states, allocation states, and sliver expiration time formats.
     530See the Common Concepts page for details on [wiki:GAPI_AM_API_V3/CommonConcepts#SliverAllocationStates allocation] and [wiki:GAPI_AM_API_V3/CommonConcepts#SliverOperationalStates operational states], [wiki:GAPI_AM_API_V3/CommonConcepts#SliverOperationalActions operational methods], [wiki:GAPI_AM_API_V3/CommonConcepts#OperationsonIndividualSlivers operations on individual slivers], [wiki:GAPI_AM_API_V3/CommonConcepts#geni_best_effort `geni_best_effort`], [wiki:GAPI_AM_API_V3/CommonConcepts#datetimedatatype sliver expiration times], [wiki:GAPI_AM_API_V3/CommonConcepts#urns `urns[]`], and [wiki:GAPI_AM_API_V3/CommonConcepts#credentials`credentials[]`].
    539531
    540532 == Delete ==
     
    551543Options include: {{{geni_best_effort}}}
    552544
    553 Return list of structs:
     545Return `value` is a list of structs:
    554546{{{
    555547[
     
    563555}}}
    564556
    565 See the Common Concepts page for details on allocation and operational states, operations on individual slivers, `geni_best_effort, sliver expiration times, `urns[]`, and `credentials[]`.
     557See the Common Concepts page for details on [wiki:GAPI_AM_API_V3/CommonConcepts#SliverAllocationStates allocation] and [wiki:GAPI_AM_API_V3/CommonConcepts#SliverOperationalStates operational states], [wiki:GAPI_AM_API_V3/CommonConcepts#OperationsonIndividualSlivers operations on individual slivers], [wiki:GAPI_AM_API_V3/CommonConcepts#geni_best_effort `geni_best_effort`], [wiki:GAPI_AM_API_V3/CommonConcepts#datetimedatatype sliver expiration times], [wiki:GAPI_AM_API_V3/CommonConcepts#urns `urns[]`], and [wiki:GAPI_AM_API_V3/CommonConcepts#credentials`credentials[]`].
    566558
    567559 == Shutdown ==
     
    578570Return: XML-RPC boolean, indicating whether the resources associated with this reservation were successfully shut down to a state suitable for forensics.
    579571
    580 See the Common Concepts page for details on the `credentials[]` argument.
     572See the Common Concepts page for details on the [wiki:GAPI_AM_API_V3/CommonConcepts#credentials `credentials[]` argument].