Skip to main content

ims orchestration allocation reserve

Reserve a payload from an allocation.

Synopsis​

The reserve command allows you to reserve a payload from an allocation. The command takes a an optional JSON payload (CreateReservationV0Body) either through a pipe or using the --file flag.

The JSON payload contains:

  • payload_metadata: the metadata that is applied to the payload when reserved.
  • selectors: an ordered list of payload selectors used to prioritise/filter which payloads can satisfy the reservation.

It should be in the following format:

{
  "payload_metadata": {},
  "selectors": [{}]
}

For more details on the CreateReservationV0Body please refer to the OpenAPI specification https://docs.ims.improbable.io/openapi/ims-zeuz/orchestration-api#operation/CreateReservationV0

ims orchestration allocation reserve [flags]

Examples​

ims orchestration allocation reserve --project-id alpha-beta-123456 --allocation-id 1a2b3c4d-1a2b-3c4d-5e6f-1a2b3c4d5e6f --file ./CreateReservationV0Body.json
cat ./CreateReservationV0Body.json | ims orchestration allocation reserve --project-id alpha-beta-123456 --allocation-id 1a2b3c4d-1a2b-3c4d-5e6f-1a2b3c4d5e6f

Options​

      --allocation-id string   allocation id to reserve allocation in (required)
      --file string            path to a json file that contains the JSON CreateReservationV0Body see: https://docs.ims.improbable.io/openapi/ims-zeuz/orchestration-api#operation/CreateReservationV0
  -h, --help                   help for reserve
      --project-id string      IMS project id to reserve allocation in (required)

Options inherited from parent commands​

      --ci                   include this when running in a CI environment, this switches to the IMS service account authentication flow
      --config string        config file location, defaults to $HOME/.ims
      --output-type string   command output type (human/json) (default "human")

SEE ALSO​