Changes between Version 17 and Version 18 of GAPI_AM_API_V3_DETAILS
- Timestamp:
- 07/13/12 13:53:02 (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
GAPI_AM_API_V3_DETAILS
v17 v18 151 151 ----- 152 152 == `Describe` Details == 153 `Describe` is used to list the resources belonging to a particular reservation. The return is always a single manifest RSpec, describing the resources in the set of slivers whose URNs were supplied, or describing the entire single slice whose URN was supplied as an argument.153 `Describe` is used to list the resources belonging to a particular reservation. The return is the standard AM API struct, whose value is a struct that always includes a single manifest RSpec, describing the resources in the set of slivers whose URNs were supplied, or describing the entire single slice whose URN was supplied as an argument. 154 154 155 155 The manifest RSpec should contain all necessary details about resource identity, configuration, and access information necessary for experimenters to use the resources. As that configuration information may change as the resource becomes operationally `geni_ready`, this information may change. Otherwise, the manifest is mostly static. 156 156 157 Additionally, `Describe` returns basic state and expiration information for all queried slivers. 157 Additionally, `Describe` returns basic state and expiration information for all queried slivers. Valid values for `geni_allocation_status` and `geni_operational_status` are described on the Common Concepts page. 158 158 159 159 For details on options to `Describe`, see `ListResources` above, and the Common Concepts page. … … 172 172 geni_expires: "2012-06-06T12:00:00Z", 173 173 geni_allocation_status: "geni_allocated" 174 }, 174 geni_operational_status: "geni_pending_allocation", 175 }, 175 176 { 176 177 geni_sliver_urn: "urn:publicid:IDN+pgenigpolabbbncom+sliver+123457", 177 178 geni_expires: "2012-06-16T12:00:00Z", 178 179 geni_allocation_status: "geni_provisioned" 180 geni_operational_status: "geni_ready", 181 geni_error: "" 179 182 } 180 183 ] … … 217 220 218 221 == `Renew` Details == 219 `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 slivers (~ 5-8 days initially). Since these expiration times are different, typically `Renew` is used only for slivers in the same allocation state.222 `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. 220 223 221 224 Sample Return `value`: … … 252 255 Redeem a reservation, requesting that the listed slivers move from `geni_allocated` to `geni_provisioned`. Only when slivers are provisioned are the resources 'instantiated' and made ready for operational use. Note that at some aggregates and for some resource types, this operation may be a no-op. At other aggregates, this operation starts a long running process (e.g. loading an image on a machine and booting it). Tools should monitor the sliver status (by calling `Status`), looking for an operational state other than `geni_pending_allocation`. Depending on the resource type, that next state may differ. See the advertisement RSpec for the resource type specific operational states and actions. 253 256 254 As with the `Allocate` method, some aggregates may not support provisioning only some reserved resources. Also as with the `Allocate` method, experimenters may request a sliver expiration time; aggregates may succeedthe operation while ignoring the requested expiration time or granting a different expiration time.257 As with the `Allocate` method, some aggregates may not support provisioning only some reserved resources. Also as with the `Allocate` method, experimenters may request a sliver expiration time; aggregates may allow the operation while ignoring the requested expiration time or granting a different expiration time. 255 258 256 259 Some 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). … … 314 317 Operational actions, and the states that result, are resource type and aggregate specific. Aggregates advertise these in the advertisement RSpec. 315 318 316 Example actions include `geni_start` (boot a computer) and `geni_stop` (power down a computer).319 Example actions include `geni_start` (boot a computer), `geni_restart` (reboot a computer), and `geni_stop` (power down a computer). 317 320 318 321 `geni_error`::