Changes between Version 35 and Version 36 of AaronHelsinger/GAPI_AM_API_DRAFT


Ignore:
Timestamp:
03/30/12 11:12:11 (7 years ago)
Author:
Aaron Helsinger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • AaronHelsinger/GAPI_AM_API_DRAFT

    v35 v36  
    552552`geni_operational_status` MUST be the current operational status of the sliver after this action (as would be returned by !SliverStatus). An optional `geni_resource_status` field MAY be returned for each sliver which contains a resource-specific status that may be more nuanced than the options for `geni_operational_status`.
    553553
    554 Calling this method with a slice_urn functions as if all the child sliver_urn had been passed in - specifically the action is performed on all slivers and all sliver_urn and their statuses are returned. No status is returned for the slice as a whole.
     554Calling this method with a slice_urn functions as if all the child sliver_urn's had been passed in - specifically the action is performed on all slivers and all sliver_urn's and their statuses are returned. No status is returned for the slice as a whole.
    555555
    556556This is a fast synchronous operation, and MAY start long-running sliver transitions whose status can be queried using !SliverStatus.
     
    11251125Form 2:
    11261126{{{
    1127 struct Renew(string sliver_urn[],
     1127struct Renew(string sliver_urns[],
    11281128                    struct credentials[],
    11291129                    dateTime.rfc3339 expiration_time,
     
    11661166Form 2:
    11671167{{{
    1168 struct UpdateAllocations(string sliver_urn[], struct credentials[], geni.rspec rspec,
     1168struct UpdateAllocations(string sliver_urns[], struct credentials[], geni.rspec rspec,
    11691169                                struct options)
    11701170}}}
     
    12101210Form 2:
    12111211{{{
    1212 struct ProvisionSlivers(string sliver_urn[], struct credentials[], 
     1212struct ProvisionSlivers(string sliver_urns[], struct credentials[], 
    12131213                                   struct options)
    12141214}}}
     
    12481248This method has two forms: one takes a single slice URN, the other takes a list of one or more sliver URNs, all contained in the same slice. When a slice URN is supplied, the method operates on all slivers contained in that slice at this aggregate. All other arguments and returns are identical.
    12491249
    1250 {{{
    1251 struct UpdateSlivers(string urn[], struct credentials[], geni.rspec rspec,
     1250Form 1:
     1251{{{
     1252struct UpdateSlivers(string slice_urn, struct credentials[], geni.rspec rspec,
    12521253                                                 struct options)
    12531254}}}
    12541255
    1255 Where credentials is the standard argument defined above.
     1256Form 2:
     1257{{{
     1258struct UpdateSlivers(string sliver_urns[], struct credentials[], geni.rspec rspec,
     1259                                                 struct options)
     1260}}}
     1261
     1262`credentials` is the standard argument defined above.
    12561263
    12571264Options include:
     
    12721279        ...
    12731280    ]
    1274  <others that are AM specific>
    12751281}
    12761282}}}
     
    12791285The manifest is a manifest of only referenced provisioned slivers.
    12801286
    1281 FIXME: Split Update(slice) from Update(slivers)
    12821287FIXME: Is this the same method as for updating allocated slivers?
    12831288FIXME: Return both a manifest and a delta RSpec?
     
    12891294This method has two forms: one takes a single slice URN, the other takes a list of one or more sliver URNs, all contained in the same slice. When a slice URN is supplied, the method operates on all slivers contained in that slice at this aggregate. All other arguments and returns are identical.
    12901295
    1291 {{{
    1292 struct SliversStatus(string urn[], struct credentials[], struct options)
    1293 }}}
    1294 
    1295 Where credentials is the standard argument defined above.
     1296Form 1:
     1297{{{
     1298struct SliversStatus(string slice_urn, struct credentials[], struct options)
     1299}}}
     1300
     1301Form 2:
     1302{{{
     1303struct SliversStatus(string sliver_urns[], struct credentials[], struct options)
     1304}}}
     1305
     1306`credentials` is the standard argument defined above.
    12961307
    12971308Return:
     
    13161327}}}
    13171328
    1318 FIXME: Split Status(slice) from Status(slivers)
    1319 
    13201329 == !PerformOperationalAction ==
    13211330Perform the named operational action on the named slivers, possibly changing the `geni_operational_status` of the named slivers.
     
    13231332This method has two forms: one takes a single slice URN, the other takes a list of one or more sliver URNs, all contained in the same slice. When a slice URN is supplied, the method operates on all slivers contained in that slice at this aggregate. All other arguments and returns are identical.
    13241333
    1325 {{{
    1326 struct PerformOperationalAction (string urn[], struct credentials[], string action,
     1334Form 1:
     1335{{{
     1336struct PerformOperationalAction (string slice_urn, struct credentials[], string action,
    13271337                                                    struct options={})
    13281338}}}
    13291339
    1330 Where credentials is the standard argument defined above.
     1340Form 2:
     1341{{{
     1342struct PerformOperationalAction (string sliver_urns[], struct credentials[], string action,
     1343                                                    struct options={})
     1344}}}
     1345
     1346`credentials` is the standard argument defined above.
    13311347
    13321348Options include: {{{geni_best_effort}}}
     
    13451361}}}
    13461362
    1347 FIXME: Split Perform(slice) from Perform(slivers)
    1348 
    13491363 == !DeleteSlivers ==
    13501364Delete the named slivers, making them `geni_unallocated`. Resources are de-provisioned. No further AM API operations may be performed on slivers that have been deleted.
     
    13521366This method has two forms: one takes a single slice URN, the other takes a list of one or more sliver URNs, all contained in the same slice. When a slice URN is supplied, the method operates on all slivers contained in that slice at this aggregate. All other arguments and returns are identical.
    13531367
    1354 {{{
    1355 struct DeleteSlivers(string urn[], struct credentials[], struct options)
    1356 }}}
    1357 
    1358 Where credentials is the standard argument defined above.
     1368Form 1:
     1369{{{
     1370struct DeleteSlivers(string slice_urn, struct credentials[], struct options)
     1371}}}
     1372
     1373Form 2:
     1374{{{
     1375struct DeleteSlivers(string sliver_urns[], struct credentials[], struct options)
     1376}}}
     1377
     1378`credentials` is the standard argument defined above.
    13591379
    13601380Options include: {{{geni_best_effort}}}
     
    13781398}}}
    13791399
    1380 Where credentials is the standard argument defined above.
     1400`credentials` is the standard argument defined above.
    13811401
    13821402Return: XML-RPC boolean