oracle.oci.oci_compute_image_shape_compatibility_entry – Manage an ImageShapeCompatibilityEntry resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to update and delete an ImageShapeCompatibilityEntry resource in Oracle Cloud Infrastructure

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
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.
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.
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.
image_id
string / required
The OCID of the image.
memory_constraints
dictionary
This parameter is updatable.
max_in_gbs
integer
The maximum amount of memory, in gigabytes.
This parameter is updatable.
min_in_gbs
integer
The minimum amount of memory, in gigabytes.
This parameter is updatable.
ocpu_constraints
dictionary
This parameter is updatable.
max
integer
The maximum number of OCPUs supported for this image and shape.
This parameter is updatable.
min
integer
The minimum number of OCPUs supported for this image and shape.
This parameter is updatable.
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_name
string / required
Shape name.
state
string
    Choices:
  • present ←
  • absent
The state of the ImageShapeCompatibilityEntry.
Use state=present to update an existing an ImageShapeCompatibilityEntry.
Use state=absent to delete an ImageShapeCompatibilityEntry.
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: Update image_shape_compatibility_entry
  oci_compute_image_shape_compatibility_entry:
    # required
    image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"
    shape_name: shape_name_example

    # optional
    memory_constraints:
      # optional
      min_in_gbs: 56
      max_in_gbs: 56
    ocpu_constraints:
      # optional
      min: 56
      max: 56

- name: Delete image_shape_compatibility_entry
  oci_compute_image_shape_compatibility_entry:
    # required
    image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"
    shape_name: shape_name_example
    state: absent

Return Values

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

Key Returned Description
image_shape_compatibility_entry
complex
on success
Details of the ImageShapeCompatibilityEntry resource acted upon by the current operation

Sample:
{'image_id': 'ocid1.image.oc1..xxxxxxEXAMPLExxxxxx', 'memory_constraints': {'max_in_gbs': 56, 'min_in_gbs': 56}, 'ocpu_constraints': {'max': 56, 'min': 56}, 'shape': 'shape_example'}
 
image_id
string
on success
The image OCID.

Sample:
ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
 
memory_constraints
complex
on success

   
max_in_gbs
integer
on success
The maximum amount of memory, in gigabytes.

Sample:
56
   
min_in_gbs
integer
on success
The minimum amount of memory, in gigabytes.

Sample:
56
 
ocpu_constraints
complex
on success

   
max
integer
on success
The maximum number of OCPUs supported for this image and shape.

Sample:
56
   
min
integer
on success
The minimum number of OCPUs supported for this image and shape.

Sample:
56
 
shape
string
on success
The shape name.

Sample:
shape_example


Authors

  • Oracle (@oracle)