Try SpotterFetches details about one or multiple Shape resources 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.0Fetches details about one or multiple Shape resources in Oracle Cloud Infrastructure
Lists the shapes that can be used to launch an instance within the specified compartment. You can filter the list by compatibility with a specific image.
- name: List shapes
oci_compute_shape_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
availability_domain: Uocm:PHX-AD-1
image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"
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
image_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of an image.
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
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the 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 name of the availability domain.
- 'Example: `Uocm:PHX-AD-1`'
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
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
shapes:
contains:
baseline_ocpu_utilizations:
description:
- For a subcore burstable VM, the supported baseline OCPU utilization for instances
that use this shape.
returned: on success
sample: []
type: list
billing_type:
description:
- How instances that use this shape are charged.
returned: on success
sample: ALWAYS_FREE
type: str
gpu_description:
description:
- A short description of the graphics processing unit (GPU) available for this
shape.
- If the shape does not have any GPUs, this field is `null`.
returned: on success
sample: gpu_description_example
type: str
gpus:
description:
- The number of GPUs available for this shape.
returned: on success
sample: 56
type: int
is_billed_for_stopped_instance:
description:
- Whether billing continues when the instances that use this shape are in the
stopped state.
returned: on success
sample: true
type: bool
is_flexible:
description:
- Whether the shape supports creating flexible instances. A L(flexible shape,https://docs.cloud.oracle.com/iaas/Content/Compute/References/computeshapes.htm#flexible)
is a shape that lets you customize the number of OCPUs and the amount of memory
when launching or resizing your instance.
returned: on success
sample: true
type: bool
is_live_migration_supported:
description:
- Whether live migration is supported for this shape.
returned: on success
sample: true
type: bool
is_subcore:
description:
- Whether the shape supports creating subcore or burstable instances. A L(burstable
instance,https://docs.cloud.oracle.com/iaas/Content/Compute/References/burstable-instances.htm)
is a virtual machine (VM) instance that provides a baseline level of CPU performance
with the ability to burst to a higher level to support occasional spikes in
usage.
returned: on success
sample: true
type: bool
local_disk_description:
description:
- A short description of the local disks available for this shape.
- If the shape does not have any local disks, this field is `null`.
returned: on success
sample: local_disk_description_example
type: str
local_disks:
description:
- The number of local disks available for this shape.
returned: on success
sample: 56
type: int
local_disks_total_size_in_gbs:
description:
- The aggregate size of the local disks available for this shape, in gigabytes.
- If the shape does not have any local disks, this field is `null`.
returned: on success
sample: 3.4
type: float
max_vnic_attachment_options:
contains:
default_per_ocpu:
description:
- The default number of VNIC attachments allowed per OCPU.
returned: on success
sample: 3.4
type: float
max:
description:
- The highest maximum value of VNIC attachments.
returned: on success
sample: 3.4
type: float
min:
description:
- The lowest maximum value of VNIC attachments.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
max_vnic_attachments:
description:
- The maximum number of VNIC attachments available for this shape.
returned: on success
sample: 56
type: int
memory_in_gbs:
description:
- The default amount of memory available for this shape, in gigabytes.
returned: on success
sample: 3.4
type: float
memory_options:
contains:
default_per_ocpu_in_g_bs:
description:
- The default amount of memory per OCPU available for this shape, in gigabytes.
returned: on success
sample: 3.4
type: float
max_in_g_bs:
description:
- The maximum amount of memory, in gigabytes.
returned: on success
sample: 3.4
type: float
max_per_numa_node_in_gbs:
description:
- The maximum amount of memory per NUMA node, in gigabytes.
returned: on success
sample: 3.4
type: float
max_per_ocpu_in_gbs:
description:
- The maximum amount of memory per OCPU available for this shape, in gigabytes.
returned: on success
sample: 3.4
type: float
min_in_g_bs:
description:
- The minimum amount of memory, in gigabytes.
returned: on success
sample: 3.4
type: float
min_per_ocpu_in_gbs:
description:
- The minimum amount of memory per OCPU available for this shape, in gigabytes.
returned: on success
sample: 3.4
type: float
description:
- ''
returned: on success
type: complex
min_total_baseline_ocpus_required:
description:
- For a subcore burstable VM, the minimum total baseline OCPUs required. The
total baseline OCPUs is equal to baselineOcpuUtilization chosen multiplied
by the number of OCPUs chosen.
returned: on success
sample: 10
type: float
network_ports:
description:
- The number of physical network interface card (NIC) ports available for this
shape.
returned: on success
sample: 56
type: int
networking_bandwidth_in_gbps:
description:
- The networking bandwidth available for this shape, in gigabits per second.
returned: on success
sample: 3.4
type: float
networking_bandwidth_options:
contains:
default_per_ocpu_in_gbps:
description:
- The default amount of networking bandwidth per OCPU, in gigabits per second.
returned: on success
sample: 3.4
type: float
max_in_gbps:
description:
- The maximum amount of networking bandwidth, in gigabits per second.
returned: on success
sample: 3.4
type: float
min_in_gbps:
description:
- The minimum amount of networking bandwidth, in gigabits per second.
returned: on success
sample: 3.4
type: float
description:
- ''
returned: on success
type: complex
ocpu_options:
contains:
max:
description:
- The maximum number of OCPUs.
returned: on success
sample: 3.4
type: float
max_per_numa_node:
description:
- The maximum number of cores available per NUMA node.
returned: on success
sample: 3.4
type: float
min:
description:
- The minimum number of OCPUs.
returned: on success
sample: 3.4
type: float
description:
- ''
returned: on success
type: complex
ocpus:
description:
- The default number of OCPUs available for this shape.
returned: on success
sample: 3.4
type: float
platform_config_options:
contains:
access_control_service_options:
contains:
allowed_values:
description:
- Whether the Access Control Service can be enabled.
returned: on success
sample: []
type: list
is_default_enabled:
description:
- Whether the Access Control Service is enabled by default.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
input_output_memory_management_unit_options:
contains:
allowed_values:
description:
- Whether the input-output memory management unit can be enabled.
returned: on success
sample: []
type: list
is_default_enabled:
description:
- Whether the input-output memory management unit is enabled by default.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
measured_boot_options:
contains:
allowed_values:
description:
- Boolean values that indicate whether the Measured Boot feature can
be enabled or disabled.
returned: on success
sample: []
type: list
is_default_enabled:
description:
- Whether the Measured Boot feature is enabled by default.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
memory_encryption_options:
contains:
allowed_values:
description:
- Whether memory encryption can be enabled.
returned: on success
sample: []
type: list
is_default_enabled:
description:
- Whether memory encryption is enabled by default.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
numa_nodes_per_socket_platform_options:
contains:
default_value:
description:
- The default NUMA nodes per socket configuration.
returned: on success
sample: default_value_example
type: str
service_allowed_values:
description:
- The supported values for this platform configuration property.
returned: on success
sample: []
type: list
description:
- ''
returned: on success
type: complex
percentage_of_cores_enabled_options:
contains:
default_value:
description:
- The default percentage of cores enabled.
returned: on success
sample: 56
type: int
max:
description:
- The maximum allowed percentage of cores enabled.
returned: on success
sample: 56
type: int
min:
description:
- The minimum allowed percentage of cores enabled.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
secure_boot_options:
contains:
allowed_values:
description:
- Boolean values that indicate whether Secure Boot can be enabled or
disabled.
returned: on success
sample: []
type: list
is_default_enabled:
description:
- Whether Secure Boot is enabled by default.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
symmetric_multi_threading_options:
contains:
allowed_values:
description:
- Whether symmetric multithreading can be enabled.
returned: on success
sample: []
type: list
is_default_enabled:
description:
- Whether symmetric multithreading is enabled by default.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
trusted_platform_module_options:
contains:
allowed_values:
description:
- Boolean values that indicate whether the Trusted Platform Module can
be enabled or disabled.
returned: on success
sample: []
type: list
is_default_enabled:
description:
- Whether the Trusted Platform Module is enabled by default.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
type:
description:
- The type of platform being configured.
returned: on success
sample: AMD_MILAN_BM
type: str
virtual_instructions_options:
contains:
allowed_values:
description:
- Whether virtualization instructions can be enabled.
returned: on success
sample: []
type: list
is_default_enabled:
description:
- Whether virtualization instructions are enabled by default.
returned: on success
sample: true
type: bool
description:
- ''
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
processor_description:
description:
- A short description of the shape's processor (CPU).
returned: on success
sample: processor_description_example
type: str
quota_names:
description:
- The list of of compartment quotas for the shape.
returned: on success
sample: []
type: list
rdma_bandwidth_in_gbps:
description:
- The networking bandwidth available for the remote direct memory access (RDMA)
network for this shape, in gigabits per second.
returned: on success
sample: 56
type: int
rdma_ports:
description:
- The number of networking ports available for the remote direct memory access
(RDMA) network between nodes in a high performance computing (HPC) cluster
network. If the shape does not support cluster networks, this value is `0`.
returned: on success
sample: 56
type: int
recommended_alternatives:
contains:
shape_name:
description:
- The name of the shape.
returned: on success
sample: shape_name_example
type: str
description:
- The list of shapes and shape details (if applicable) that Oracle recommends
that you use as an alternative to the current shape.
returned: on success
type: complex
resize_compatible_shapes:
description:
- The list of compatible shapes that this shape can be changed to. For more
information, see L(Changing the Shape of an Instance,https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/resizinginstances.htm).
returned: on success
sample: []
type: list
shape:
description:
- The name of the shape. You can enumerate all available shapes by calling L(ListShapes,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Shape/ListShapes).
returned: on success
sample: shape_example
type: str
description:
- List of Shape resources
returned: on success
sample:
- baseline_ocpu_utilizations: []
billing_type: ALWAYS_FREE
gpu_description: gpu_description_example
gpus: 56
is_billed_for_stopped_instance: true
is_flexible: true
is_live_migration_supported: true
is_subcore: true
local_disk_description: local_disk_description_example
local_disks: 56
local_disks_total_size_in_gbs: 3.4
max_vnic_attachment_options:
default_per_ocpu: 3.4
max: 3.4
min: 56
max_vnic_attachments: 56
memory_in_gbs: 3.4
memory_options:
default_per_ocpu_in_g_bs: 3.4
max_in_g_bs: 3.4
max_per_numa_node_in_gbs: 3.4
max_per_ocpu_in_gbs: 3.4
min_in_g_bs: 3.4
min_per_ocpu_in_gbs: 3.4
min_total_baseline_ocpus_required: 10
network_ports: 56
networking_bandwidth_in_gbps: 3.4
networking_bandwidth_options:
default_per_ocpu_in_gbps: 3.4
max_in_gbps: 3.4
min_in_gbps: 3.4
ocpu_options:
max: 3.4
max_per_numa_node: 3.4
min: 3.4
ocpus: 3.4
platform_config_options:
access_control_service_options:
allowed_values: []
is_default_enabled: true
input_output_memory_management_unit_options:
allowed_values: []
is_default_enabled: true
measured_boot_options:
allowed_values: []
is_default_enabled: true
memory_encryption_options:
allowed_values: []
is_default_enabled: true
numa_nodes_per_socket_platform_options:
default_value: default_value_example
service_allowed_values: []
percentage_of_cores_enabled_options:
default_value: 56
max: 56
min: 56
secure_boot_options:
allowed_values: []
is_default_enabled: true
symmetric_multi_threading_options:
allowed_values: []
is_default_enabled: true
trusted_platform_module_options:
allowed_values: []
is_default_enabled: true
type: AMD_MILAN_BM
virtual_instructions_options:
allowed_values: []
is_default_enabled: true
processor_description: processor_description_example
quota_names: []
rdma_bandwidth_in_gbps: 56
rdma_ports: 56
recommended_alternatives:
- shape_name: shape_name_example
resize_compatible_shapes: []
shape: shape_example
type: complex