Try SpotterManage a ComputeCapacityReport resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0This module allows the user to create a ComputeCapacityReport resource in Oracle Cloud Infrastructure
For I(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.
- 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
state:
choices:
- present
default: present
description:
- The state of the ComputeCapacityReport.
- Use I(state=present) to create a ComputeCapacityReport.
required: false
type: str
key_by:
description: 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.
elements: str
type: list
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
force_create:
default: false
description: 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 I(key_by).
type: bool
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
for the compartment. This should always be the root compartment.
required: true
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
availability_domain:
description:
- The availability domain for the capacity report.
- 'Example: `Uocm:PHX-AD-1`'
required: true
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
shape_availabilities:
description:
- Information about the shapes in the capacity report.
elements: dict
required: true
suboptions:
fault_domain:
description:
- The fault domain for the capacity report.
- If you do not specify a fault domain, the capacity report includes information
about all fault domains.
type: str
instance_shape:
description:
- The shape that you want to request a capacity report for. You can enumerate
all available shapes by calling L(ListShapes,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Shape/ListShapes).
required: true
type: str
instance_shape_config:
description:
- ''
suboptions:
memory_in_gbs:
description:
- The total amount of memory available to the instance, in gigabytes.
type: float
nvmes:
description:
- The number of NVMe drives to be used for storage.
type: int
ocpus:
description:
- The total number of OCPUs available to the instance.
type: float
type: dict
type: list
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
compute_capacity_report:
contains:
availability_domain:
description:
- The availability domain for the capacity report.
- 'Example: `Uocm:PHX-AD-1`'
returned: on success
sample: Uocm:PHX-AD-1
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
for the compartment. This should always be the root compartment.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
shape_availabilities:
contains:
availability_status:
description:
- A flag denoting whether capacity is available.
returned: on success
sample: OUT_OF_HOST_CAPACITY
type: str
available_count:
description:
- The total number of new instances that can be created with the specified
shape configuration.
returned: on success
sample: 56
type: int
fault_domain:
description:
- The fault domain for the capacity report.
- If you do not specify the fault domain, the capacity report includes information
about all fault domains.
returned: on success
sample: FAULT-DOMAIN-1
type: str
instance_shape:
description:
- The shape that the capacity report was requested for.
returned: on success
sample: instance_shape_example
type: str
instance_shape_config:
contains:
memory_in_gbs:
description:
- The total amount of memory available to the instance, in gigabytes.
returned: on success
sample: 3.4
type: float
nvmes:
description:
- The number of NVMe drives to be used for storage.
returned: on success
sample: 56
type: int
ocpus:
description:
- The total number of OCPUs available to the instance.
returned: on success
sample: 3.4
type: float
description:
- ''
returned: on success
type: complex
description:
- Information about the available capacity for each shape in a capacity report.
returned: on success
type: complex
time_created:
description:
- The date and time the capacity report was created, in the format defined by
L(RFC3339,https://tools.ietf.org/html/rfc3339).
- 'Example: `2016-08-25T21:10:29.600Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- Details of the ComputeCapacityReport resource acted upon by the current operation
returned: on success
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'
type: complex