oracle.oci.oci_compute_capacity_report – Manage a ComputeCapacityReport resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.0.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_report.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create a ComputeCapacityReport resource in Oracle Cloud Infrastructure

  • For state=present, generates a report of the host capacity within an availability domain that is available for you to create compute instances. Host capacity is the physical infrastructure that resources such as compute instances run on.

  • Use the capacity report to determine whether sufficient capacity is available for a shape before you create an instance or change the shape of an instance.

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 / required
The availability domain for the capacity report.
Example: `Uocm:PHX-AD-1`
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 / required
The OCID for the compartment. This should always be the root compartment.
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.
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.
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.
shape_availabilities
list / elements=dictionary / required
Information about the shapes in the capacity report.
fault_domain
string
The fault domain for the capacity report.
If you do not specify a fault domain, the capacity report includes information about all fault domains.
instance_shape
string / required
The shape that you want to request a capacity report for. You can enumerate all available shapes by calling ListShapes.
instance_shape_config
dictionary
memory_in_gbs
float
The total amount of memory available to the instance, in gigabytes.
nvmes
integer
The number of NVMe drives to be used for storage.
ocpus
float
The total number of OCPUs available to the instance.
state
string
    Choices:
  • present ←
The state of the ComputeCapacityReport.
Use state=present to create a ComputeCapacityReport.
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

Examples

- name: Create compute_capacity_report
  oci_compute_capacity_report:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    availability_domain: Uocm:PHX-AD-1
    shape_availabilities:
    - # required
      instance_shape: instance_shape_example

      # optional
      fault_domain: FAULT-DOMAIN-1
      instance_shape_config:
        # optional
        ocpus: 3.4
        memory_in_gbs: 3.4
        nvmes: 56

Return Values

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

Key Returned Description
compute_capacity_report
complex
on success
Details of the ComputeCapacityReport resource acted upon by the current operation

Sample:
{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'shape_availabilities': [{'availability_status': 'OUT_OF_HOST_CAPACITY', 'available_count': 56, 'fault_domain': 'FAULT-DOMAIN-1', 'instance_shape': 'instance_shape_example', 'instance_shape_config': {'memory_in_gbs': 3.4, 'nvmes': 56, 'ocpus': 3.4}}], 'time_created': '2013-10-20T19:20:30+01:00'}
 
availability_domain
string
on success
The availability domain for the capacity report.
Example: `Uocm:PHX-AD-1`

Sample:
Uocm:PHX-AD-1
 
compartment_id
string
on success
The OCID for the compartment. This should always be the root compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
shape_availabilities
complex
on success
Information about the available capacity for each shape in a capacity report.
   
availability_status
string
on success
A flag denoting whether capacity is available.

Sample:
OUT_OF_HOST_CAPACITY
   
available_count
integer
on success
The total number of new instances that can be created with the specified shape configuration.

Sample:
56
   
fault_domain
string
on success
The fault domain for the capacity report.
If you do not specify the fault domain, the capacity report includes information about all fault domains.

Sample:
FAULT-DOMAIN-1
   
instance_shape
string
on success
The shape that the capacity report was requested for.

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
     
nvmes
integer
on success
The number of NVMe drives to be used for storage.

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

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

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)