oracle.oci.oci_compute_capacity_reservation – Manage a ComputeCapacityReservation resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_compute_capacity_reservation.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a ComputeCapacityReservation resource in Oracle Cloud Infrastructure

  • For state=present, creates a new compute capacity reservation in the specified compartment and availability domain. Compute capacity reservations let you reserve instances in a compartment. When you launch an instance using this reservation, you are assured that you have enough space for your instance, and you won’t get out of capacity errors. For more information, see Reserved Capacity.

  • This resource has the following action operations in the oracle.oci.oci_compute_capacity_reservation_actions module: change_compartment.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
availability_domain
string
The availability domain of this compute capacity reservation.
Example: `Uocm:PHX-AD-1`
Required for create using state=present.
capacity_reservation_id
string
The OCID of the compute capacity reservation.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The OCID of the compartment containing the capacity reservation.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
display_name
string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
This parameter is updatable.
instance_reservation_configs
list / elements=dictionary
The capacity configurations for the capacity reservation.
To use the reservation for the desired shape, specify the shape, count, and optionally the fault domain where you want this configuration.
This parameter is updatable.
cluster_config
dictionary
hpc_island_id
string / required
The OCID of the HPC island.
network_block_ids
list / elements=string
The list of OCIDs of the network blocks.
fault_domain
string
The fault domain to use for instances created using this capacity configuration. For more information, see Fault Domains. If you do not specify the fault domain, the capacity is available for an instance that does not specify a fault domain. To change the fault domain for a reservation, delete the reservation and create a new one in the preferred fault domain.
To retrieve a list of fault domains, use the `ListFaultDomains` operation in the Identity and Access Management Service API.
Example: `FAULT-DOMAIN-1`
instance_shape
string / required
The shape requested when launching instances using reserved capacity. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. You can list all available shapes by calling ListComputeCapacityReservationInstanceShapes.
instance_shape_config
dictionary
memory_in_gbs
float
The total amount of memory available to the instance, in gigabytes.
ocpus
float
The total number of OCPUs available to the instance.
reserved_count
integer / required
The total number of instances that can be launched from the capacity configuration.
is_default_reservation
boolean
    Choices:
  • no
  • yes
Whether this capacity reservation is the default. For more information, see Capacity Reservations.
This parameter is updatable.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state
string
    Choices:
  • present ←
  • absent
The state of the ComputeCapacityReservation.
Use state=present to create or update a ComputeCapacityReservation.
Use state=absent to delete a ComputeCapacityReservation.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create compute_capacity_reservation
  oci_compute_capacity_reservation:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    availability_domain: Uocm:PHX-AD-1

    # optional
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    is_default_reservation: true
    instance_reservation_configs:
    - # required
      instance_shape: instance_shape_example
      reserved_count: 56

      # optional
      instance_shape_config:
        # optional
        ocpus: 3.4
        memory_in_gbs: 3.4
      fault_domain: FAULT-DOMAIN-1
      cluster_config:
        # required
        hpc_island_id: "ocid1.hpcisland.oc1..xxxxxxEXAMPLExxxxxx"

        # optional
        network_block_ids: [ "network_block_ids_example" ]

- name: Update compute_capacity_reservation
  oci_compute_capacity_reservation:
    # required
    capacity_reservation_id: "ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    is_default_reservation: true
    instance_reservation_configs:
    - # required
      instance_shape: instance_shape_example
      reserved_count: 56

      # optional
      instance_shape_config:
        # optional
        ocpus: 3.4
        memory_in_gbs: 3.4
      fault_domain: FAULT-DOMAIN-1
      cluster_config:
        # required
        hpc_island_id: "ocid1.hpcisland.oc1..xxxxxxEXAMPLExxxxxx"

        # optional
        network_block_ids: [ "network_block_ids_example" ]

- name: Update compute_capacity_reservation using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_compute_capacity_reservation:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}
    is_default_reservation: true
    instance_reservation_configs:
    - # required
      instance_shape: instance_shape_example
      reserved_count: 56

      # optional
      instance_shape_config:
        # optional
        ocpus: 3.4
        memory_in_gbs: 3.4
      fault_domain: FAULT-DOMAIN-1
      cluster_config:
        # required
        hpc_island_id: "ocid1.hpcisland.oc1..xxxxxxEXAMPLExxxxxx"

        # optional
        network_block_ids: [ "network_block_ids_example" ]

- name: Delete compute_capacity_reservation
  oci_compute_capacity_reservation:
    # required
    capacity_reservation_id: "ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete compute_capacity_reservation using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_compute_capacity_reservation:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
compute_capacity_reservation
complex
on success
Details of the ComputeCapacityReservation resource acted upon by the current operation

Sample:
{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'instance_reservation_configs': [{'cluster_config': {'hpc_island_id': 'ocid1.hpcisland.oc1..xxxxxxEXAMPLExxxxxx', 'network_block_ids': []}, 'fault_domain': 'FAULT-DOMAIN-1', 'instance_shape': 'instance_shape_example', 'instance_shape_config': {'memory_in_gbs': 3.4, 'ocpus': 3.4}, 'reserved_count': 56, 'used_count': 56}], 'is_default_reservation': True, 'lifecycle_state': 'ACTIVE', 'reserved_instance_count': 56, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'used_instance_count': 56}
 
availability_domain
string
on success
The availability domain of the compute capacity reservation.
Example: `Uocm:PHX-AD-1`

Sample:
Uocm:PHX-AD-1
 
compartment_id
string
on success
The OCID of the compartment containing the compute capacity reservation.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the compute capacity reservation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
instance_reservation_configs
complex
on success
The capacity configurations for the capacity reservation.
To use the reservation for the desired shape, specify the shape, count, and optionally the fault domain where you want this configuration.
   
cluster_config
complex
on success

     
hpc_island_id
string
on success
The OCID of the HPC island.

Sample:
ocid1.hpcisland.oc1..xxxxxxEXAMPLExxxxxx
     
network_block_ids
list / elements=string
on success
The list of OCIDs of the network blocks.
   
fault_domain
string
on success
The fault domain of this capacity configuration. If a value is not supplied, this capacity configuration is applicable to all fault domains in the specified availability domain. For more information, see Capacity Reservations.

Sample:
FAULT-DOMAIN-1
   
instance_shape
string
on success
The shape to use when launching instances using compute capacity reservations. The shape determines the number of CPUs, the amount of memory, and other resources allocated to the instance. You can list all available shapes by calling ListComputeCapacityReservationInstanceShapes.

Sample:
instance_shape_example
   
instance_shape_config
complex
on success

     
memory_in_gbs
float
on success
The total amount of memory available to the instance, in gigabytes.

Sample:
3.4
     
ocpus
float
on success
The total number of OCPUs available to the instance.

Sample:
3.4
   
reserved_count
integer
on success
The total number of instances that can be launched from the capacity configuration.

Sample:
56
   
used_count
integer
on success
The amount of capacity in use out of the total capacity reserved in this capacity configuration.

Sample:
56
 
is_default_reservation
boolean
on success
Whether this capacity reservation is the default. For more information, see Capacity Reservations.

Sample:
True
 
lifecycle_state
string
on success
The current state of the compute capacity reservation.

Sample:
ACTIVE
 
reserved_instance_count
integer
on success
The number of instances for which capacity will be held with this compute capacity reservation. This number is the sum of the values of the `reservedCount` fields for all of the instance capacity configurations under this reservation. The purpose of this field is to calculate the percentage usage of the reservation.

Sample:
56
 
time_created
string
on success
The date and time the compute capacity reservation was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the compute capacity reservation was updated, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
used_instance_count
integer
on success
The total number of instances currently consuming space in this compute capacity reservation. This number is the sum of the values of the `usedCount` fields for all of the instance capacity configurations under this reservation. The purpose of this field is to calculate the percentage usage of the reservation.

Sample:
56


Authors

  • Oracle (@oracle)