Managing a reservation for VPC

Attaching a virtual server instance to your reservation with the UI

You can attach a virtual server to a reservation.

1. In the IBM Cloud console, click Navigation Menu icon > Infrastructure > Reservations.
2. Select a reservation in the Reservation details page.
3. From the virtual servers list, click Actions > Attach.
4. Select the server that you want to attach to the reservation and click Attach.

Detaching a server from reservation with the UI

You can detach a virtual server from your reservation.

1. In the IBM Cloud console, click Navigation Menu icon > Infrastructure > Reservations.
2. From your virtual server list or in the Reservation details page, click the server that you want to detach and then click Actions > Detach.
3. To confirm, click Detach.

If the instance is stopped and started, even though pointing to an expired reservation, it is allowed to start and is billed at pay-go prices.

Deleting a reservation with the UI

You can delete a reservation.

1. In the IBM Cloud console, click Navigation Menu icon > Infrastructure > Reservations.
2. From your Reservations list, click Actions > Delete reservation.
3. To confirm, click Delete.

Activate a reservation

You can activate a reservation by using the command-line interface (CLI). To activate a specific reservation by using the CLI, use the ibmcloud is reservation-activate command. You must specify the name or ID of the specific reservation by using the RESERVATION_NAME for the specific reservation you want to get.

ibmcloud is reservation-activate

See the following example.

ibmcloud is reservation-activate b4735ce6-f83d-45d1-b41b-4d47451c8396
Activating reservation b4735ce6-f83d-45d1-b41b-4d47451c8396 under account VPCUI-DEMO as user Sreekar.B.V@ibm.com...
Successfully activated reservation.

Where the following argument and option values are used

• RESERVATION: ID or name of the reservation.
• --output: Specify output format, only JSON is supported. One of: JSON.
• -q, --quiet: Suppress verbose output

Getting an instance with reservation

You can get instance with reservation in your region by using the command-line interface (CLI). To get a specific instance reservation by using the CLI, use the ibmcloud is instance command. You must specify the name or ID of the specific reservation by using the RESERVATION_NAME for the specific reservation you want to get. Use the NEW_NAME variable in the --name option to rename the reservation.

ibmcloud is instance RESERVATION_NAME

See the following example.

ibmcloud is reservation aaaaaaaa-aaaa-default-reservation2-aaaaaaaaaaaa
Getting reservation aaaaaaaa-aaaa-default-reservation2-aaaaaaaaaaaa under account VPCUI-DEMO as user Sreekar.B.V@ibm.com...

ID                aaaaaaaa-aaaa-default-reservation2-aaaaaaaaaaaa
Name              aaa-default-reservation-2
CRN               crn:v1:staging:public:is:jp-tok:a/823bd195e9fd4f0db40ac2e1bffef3e0::reservation:aaaaaaaa-aaaa-default-reservation2-aaaaaaaaaaaa
Status            active
Zone              us-east-1
Lifecycle state   stable
Affinity Policy   open
Resource group    -
Profile Name      mx2-2x16
Created At        2023-06-05T10:41:51.401+05:30
Expiration        At                         Policy   Term
                  2026-08-28T05:11:51.401Z   renew    three_year

Capacity          Allocated   Available   Total   Used   Status
                  8           8           8       0      -

Deleting a reservation

You can delete IBM Cloud VPC a reservation in your region by using the command-line interface (CLI). To delete a reservation by using the CLI, use the ibmcloud is reservation-delete command. You must specify the name or ID of the specific reservation by using the RESERVATION_NAME for the specific reservation you want to delete.

ibmcloud is reservation-delete RESERVATION_NAME

See the following example.

ibmcloud is reservation-delete e9e537f0-59f5-4759-b06e-86bb5cd4068e
This will delete reservation e9e537f0-59f5-4759-b06e-86bb5cd4068e and cannot be undone. Continue [y/N] ?> y
Deleting reservation e9e537f0-59f5-4759-b06e-86bb5cd4068e under account VPCUI-DEMO as user Sreekar.B.V@ibm.com...
OK
Reservation e9e537f0-59f5-4759-b06e-86bb5cd4068e is deleted.

Where the following argument and option values are used

• RESERVATION1: ID or name of the reservation.
• RESERVATION2: ID or name of the reservation.
• --force, -f: Force the operation without confirmation
• --output: Specify output format, only JSON is supported. One of: JSON.
• -q, --quiet: Suppress verbose output.

Listing all reservations

You can list all IBM Cloud VPC reservations in your region by using the command-line interface (CLI). To list all reservations by using the CLI, use the ibmcloud is reservation command.

ibmcloud is reservation

See the following example.

ibmcloud is instances
Listing instances in all resource groups and region us-south under account VPCUI-DEV as user Sreekar.B.V@ibm.com...
ID                                          Name               Status    Reserved IP     Floating IP   Profile   Image                             VPC    Zone         Resource group   Reservation Name
0735_73b1e3e5-10a2-44b0-a113-c8d6cd8c42e7   cli-in-test-1      pending   0.0.0.0         -             cx2-2x4   ibm-centos-7-9-minimal-amd64-11   test   us-south-3   Default          reservation-cli-test-1
0735_4e245881-c9c8-49f3-a21b-d890a13835bb   i4                 running   10.240.128.30   -             cx2-2x4   ibm-centos-7-9-minimal-amd64-11   test   us-south-3   Default          reservation-cli-test-3
0735_83748ac9-dffc-4ec0-9914-27c9b7e4a5f3   test-unattached2   running   10.240.128.20   -             cx2-2x4   ibm-centos-7-9-minimal-amd64-11   test   us-south-3   Default          -

Retrieving a reservation

You can retrieve a specific IBM Cloud VPC reservation in your region by using the command-line interface (CLI). To retrieve a specific reservation by using the CLI, use the ibmcloud is reservation command. You must specify the name or ID of the specific reservation by using the RESERVATION_NAME for the specific reservation you want to retrieve.

ibmcloud is reservation RESERVATION_NAME

See the following example.

ibmcloud is reservation aaaaaaaa-aaaa-default-reservation2-aaaaaaaaaaaa
Getting reservation aaaaaaaa-aaaa-default-reservation2-aaaaaaaaaaaa under account VPCUI-DEMO as user Sreekar.B.V@ibm.com...

ID                aaaaaaaa-aaaa-default-reservation2-aaaaaaaaaaaa
Name              aaa-default-reservation-2
CRN               crn:v1:staging:public:is:jp-tok:a/823bd195e9fd4f0db40ac2e1bffef3e0::reservation:aaaaaaaa-aaaa-default-reservation2-aaaaaaaaaaaa
Status            active
Zone              us-east-1
Lifecycle state   stable
Affinity Policy   open
Resource group    -
Profile Name      mx2-2x16
Created At        2023-06-05T10:41:51.401+05:30
Expiration        At                         Policy   Term
                  2026-08-28T05:11:51.401Z   renew    three_year

Capacity          Allocated   Available   Total   Used   Status
                  8           8           8       0      -

Updating a reservation

You can update a specific IBM Cloud VPC reservation in your region by using the command-line interface (CLI). To update a specific reservation by using the CLI, use the ibmcloud is reservation-update command. You must specify the name or ID of the specific reservation by using the RESERVATION_NAME for the specific reservation you want to update. Use the NEW_NAME variable in the --name option to rename the reservation.

ibmcloud is reservation-update RESERVATION_NAME [--name NEW_NAME]

See the following example.

ibmcloud is reservation-update aaaaaaaa-aaaa-default-reservation2-aaaaaaaaaaaa --name aaa-default-reservation-2-renamed
Updating reservation aaaaaaaa-aaaa-default-reservation2-aaaaaaaaaaaa under account VPCUI-DEMO as user Sreekar.B.V@ibm.com...

ID                aaaaaaaa-aaaa-default-reservation2-aaaaaaaaaaaa
Name              aaa-default-reservation-2-renamed
CRN               crn:v1:staging:public:is:us-east:a/823bd195e9fd4f0db40ac2e1bffef3e0::reservation:aaaaaaaa-aaaa-default-reservation2-aaaaaaaaaaaa
Status            active
Zone              us-east-1
Lifecycle state   stable
Affinity Policy   open
Resource group    -
Profile Name      mx2-2x16
Created At        2023-06-14T10:58:17.92+05:30
Expiration        At                         Policy    Term
                  2026-08-28T05:28:17.920Z   release   three_year

Capacity          Allocated   Available   Total   Used   Status
                  5           -           5       -      -

Where the following argument and option values are used

• --name: New name for the reservation.
• --capacity: The capacity configuration for this reservation.
• --term: Term of the reservation. One of: one_year, three_year.
• --profile: The name of the profile to use for this reservation.
• --profile-resource-type: The resource type of the profile. One of: instance_profile.
• --expiration-policy: The policy that applies when the committed use term expires. One of: release, renew.
• --output: Specify output format, only JSON is supported. One of: JSON.
• -q, --quiet: Suppress verbose output.

Listing all reservations

You can list all of the IBM Cloud VPC reservations in your region by using the application programming interface (API). To list all reservations by using the API, use List all images.

Specify a GET /reservations request to list all of the reservations. See the following example.

curl -X GET "$vpc_api_endpoint/v1/reservations?version=2024-01-27&generation=2" -H "Authorization: Bearer $iam_token"

The reservations are sorted first by their create_at property value. The newest reservations are listed first. If reservations have identical created_at property values, they are then sorted by their name property values. The list of reservations defaults to 50 reservations, but you can increase this amount up to 100.

You can filter the list further with the following property values.

• name
• resource_group.id
• zone.name

Deleting a reservation

You can delete an IBM Cloud VPC reservation in your region by using the application programming interface (API). To delete a reservation by using the API, use Delete a reservation.

Specify a DELETE /reservation request to delete a reservation. See the following example.

curl -X DELETE "$vpc_api_endpoint/v1/reservations/$id?version=2024-01-27&generation=2" - H "Authorization: Bearer $iam_token"

Retrieving a reservation

You can retrieve a specific IBM Cloud VPC reservation in your region by using the application programming interface (API). To retrieve a specific reservation by using the API, use Retrieve a reservation.

Specify a GET /reservation/{id} request to retrieve a specific reservation where id is the reservation identifier of the reservation you are retrieving. The identifier is in the URL. See the following example.

curl -X GET "$vpc_api_endpoint/v1/reservations/$id?version=2024-01-27&generation=2" - H "Authorization: Bearer $iam_token"

Updating a reservation

You update a specific IBM Cloud VPC reservation in your region by using the application programming interface (API). To update a specific reservation by using the API, use Update a reservation.

Specify a PATCH /reservations/{id} request to update a specific reservation where id is the reservation identifier of the reservation you are retrieving. The identifier is in the URL. See the following example.

curl -X PATCH "$vpc_api_endpoint/v1/reservations/$id?version=2024-01-27&generation=2" -H "Authorization: Bearer $iam_token" -d '{
      "committed_use": {
        "expiration_policy": "release"
      }
    }'

Activating a reservation

You can activate a specific IBM Cloud VPC reservation in your region by using the application programming interface (API). To activate a specific reservation by using the API, use Activate a reservation.

Specify a POST /reservations/{id}/activate request to update a specific reservation where id is the reservation identifier of the reservation you are retrieving. The identifier is in the URL. See the following example.

curl -X POST "$vpc_api_endpoint/v1/reservations/$id/activate?version=2024-01-27&generation=2" -H "Authorization: Bearer $iam_token"