Changes between Version 22 and Version 23 of GAPI_AM_API_V3_DETAILS


Ignore:
Timestamp:
07/19/12 13:20:30 (9 years ago)
Author:
Aaron Helsinger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GAPI_AM_API_V3_DETAILS

    v22 v23  
    2020`GetVersion` is intended to provide information about the configuration of this aggregate, helping experimenter tools determine how to communicate with this aggregate.
    2121
    22 Sample output:
     22'''Sample output''':
    2323
    2424{{{
     
    159159For details on options to `Describe`, see `ListResources` above, and the Common Concepts page.
    160160
    161 Sample Return `value`:
     161'''Sample Return `value`''':
    162162{{{
    163163{
     
    186186}}}
    187187
    188 Error codes:
     188'''Error codes''':
    189189|| '''''Error''''' || '''''Condition''''' ||
    190190|| `BADARGS`       || One of the required arguments is badly formed or missing ||
     
    201201`Allocate` is used to request a reservation of resources. If the request can be completely satisfied, the manifest RSpec is returned. Otherwise, an error is returned.
    202202
     203'''Arguments''':
     204Most arguments are described on the main page. Here a few additional details are provided.
    203205 `rspec`::
    204206    An RSpec matching the [http://www.protogeni.net/trac/protogeni/wiki/RSpec GENI standard] request RSpec [http://www.geni.net/resources/rspec/3/request.xsd schema] containing the resources that the caller is requesting for allocation to the slice specified in {{{slice_urn}}}. These are expected to be consistent with the resources returned by a previous invocation of [wiki:GAPI_AM_API_V3#ListResources ListResources]. If this RSpec is in a format not listed as supported by `GetVersion`, then the aggregate will return an error of {{{BADVERSION}}} ({{{4}}}).
     
    206208If `geni_end_time` is supplied, the experimenter is requesting a particular sliver reservation expiration date. Local policy may however dictate the expiration date. The AM therefore may ignore this argument; the `Allocate` call should still succeed, even if the date argument cannot be satisfied.
    207209
    208 At some aggregates, experimenter tools may call `Allocate` multiple times, to add resources to the existing reservation for the same slice. Other aggregates may limit such requests or forbid them entirely. See the Common Concepts page for details on Operations on Individual Slivers.
    209 
    210 Error codes:
     210At some aggregates, experimenter tools may call `Allocate` multiple times, to add resources to the existing reservation for the same slice. Other aggregates may limit such requests or forbid them entirely. See the Common Concepts page for details on [wiki:GAPI_AM_API_V3/CommonConcepts#OperationsonIndividualSlivers Operations on Individual Slivers].
     211
     212'''Error codes''':
    211213|| '''''Error''''' || '''''Condition''''' ||
    212214|| `BADARGS`       || One of the required arguments is missing or badly formed ||
     
    223225`Renew` requests a changed expiration for one or more slivers in a slice. At some aggregates, this expiration may be shorter. This method applies both to slivers that are `geni_allocated` and to those that are already `geni_provisioned`. Depending on local aggregate configuration, the aggregate may only support `Renew` on all current slivers in the slice, or may permit renewing only some slivers. Local policy will dictate maximum expiration times. These times are typically quite short (~ 10 minutes initially, ~120 minutes maximum) for reservations (`geni_allocated`), and longer for provisioned (`geni_provisioned`) slivers (~ 5-8 days initially). Since these expiration times are different, typically `Renew` is used only for slivers in the same allocation state.
    224226
    225 Sample Return `value`:
     227'''Sample Return `value`''':
    226228{{{
    227229    [
     
    230232              geni_expires: "2012-06-16T18:00:00Z",
    231233              geni_allocation_status: "geni_provisioned",
    232               geni_operational_status: "geni_pending_allocation"
     234              geni_operational_status: "geni_pending_allocation",
     235              geni_error: "" # Optional, included here for reference
    233236          },
    234237          {
     
    241244}}}
    242245
    243 Error codes:
     246'''Error codes''':
    244247|| '''''Error''''' || '''''Condition''''' ||
    245248|| `BADARGS`       || One of the required arguments is badly formed or missing ||
     
    259262
    260263Some resource types allow experimenter access. The `geni_users` option allows specifying login key material to be installed on the resources (e.g. SSH public keys).
    261 
    262  `geni_error`::
    263     A free form string. The aggregate manager should set this to a string that could be presented to a researcher to give more detailed information about the state of the sliver if this operation fails for a given sliver.
    264264
    265265Error codes:
     
    320320Example actions include `geni_start` (boot a computer), `geni_restart` (reboot a computer), and `geni_stop` (power down a computer).
    321321
    322  `geni_error`::
    323     A free form string. The aggregate manager should set this to a string that could be presented to a researcher to give more detailed information about the state of the sliver if this operation fails for a given sliver.
    324 
    325 Error codes:
     322'''Error codes''':
    326323|| '''''Error''''' || '''''Condition''''' ||
    327324|| `BADARGS`       || One of the required arguments is badly formed or missing (e.g. unknown operation) ||
     
    345342This operation should generally succeed for a valid sliver, despite the `geni_best_effort` option. However, when `geni_best_effort` is supplied and is false, and an aggregate cannot delete all the named slivers, no slivers are deleted.
    346343
    347 Error codes:
     344'''Error codes''':
    348345|| '''''Error''''' || '''''Condition''''' ||
    349346|| `BADARGS`       || One of the required arguments is badly formed or missing ||