oracle.oci.oci_oce_instance_facts – Fetches details about one or multiple OceInstance resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple OceInstance resources in Oracle Cloud Infrastructure

  • Returns a list of OceInstances.

  • If oce_instance_id is specified, the details of a single OceInstance will be returned.

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.
compartment_id
string
The ID of the compartment in which to list resources.
Required to list multiple oce_instances.
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.
display_name
string
A user-friendly name. Does not have to be unique, and it's changeable.
Example: `My new resource`
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
Filter results on lifecycleState.
name
string
Use name along with the other options to return only resources that match the given name exactly.
oce_instance_id
string
unique OceInstance identifier
Required to get a specific oce_instance.

aliases: id
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.
sort_by
string
    Choices:
  • timeCreated
  • displayName
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
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
tenancy_id
string
The ID of the tenancy in which to list resources.

Examples

- name: Get a specific oce_instance
  oci_oce_instance_facts:
    # required
    oce_instance_id: "ocid1.oceinstance.oc1..xxxxxxEXAMPLExxxxxx"

- name: List oce_instances
  oci_oce_instance_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    tenancy_id: "ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    sort_order: ASC
    sort_by: timeCreated
    lifecycle_state: CREATING

Return Values

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

Key Returned Description
oce_instances
complex
on success
List of OceInstance resources

Sample:
[{'add_on_features': [], 'admin_email': 'admin_email_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'freeform_tags': {'Department': 'Finance'}, 'guid': 'guid_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'idcs_tenancy': 'idcs_tenancy_example', 'identity_stripe': {'service_name': 'service_name_example', 'tenancy': 'tenancy_example'}, 'instance_access_type': 'PUBLIC', 'instance_license_type': 'NEW', 'instance_usage_type': 'PRIMARY', 'lifecycle_details': 'STANDBY', 'lifecycle_state': 'CREATING', 'name': 'name_example', 'object_storage_namespace': 'object_storage_namespace_example', 'service': {}, 'state_message': 'state_message_example', 'system_tags': {}, 'tenancy_id': 'ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx', 'tenancy_name': 'tenancy_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'upgrade_schedule': 'UPGRADE_IMMEDIATELY', 'waf_primary_domain': 'waf_primary_domain_example'}]
 
add_on_features
list / elements=string
on success
a list of add-on features for the ocm instance

 
admin_email
string
on success
Admin Email for Notification

Sample:
admin_email_example
 
compartment_id
string
on success
Compartment Identifier

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
OceInstance description, can be updated

Sample:
description_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
guid
string
on success
Unique GUID identifier that is immutable on creation

Sample:
guid_example
 
id
string
on success
Unique identifier that is immutable on creation

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
idcs_tenancy
string
on success
IDCS Tenancy Identifier

Sample:
idcs_tenancy_example
 
identity_stripe
complex
on success
Returned for get operation

   
service_name
string
on success
Name of the Identity Cloud Service instance in My Services to be used. Example: `secondstripe`

Sample:
service_name_example
   
tenancy
string
on success
Value of the Identity Cloud Service tenancy. Example: `idcs-8416ebdd0d674f84803f4193cce026e9`

Sample:
tenancy_example
 
instance_access_type
string
on success
Flag indicating whether the instance access is private or public

Sample:
PUBLIC
 
instance_license_type
string
on success
Flag indicating whether the instance license is new cloud or bring your own license

Sample:
NEW
 
instance_usage_type
string
on success
Instance type based on its usage

Sample:
PRIMARY
 
lifecycle_details
string
on success
Details of the current state of the instance lifecycle

Sample:
STANDBY
 
lifecycle_state
string
on success
The current state of the instance lifecycle.

Sample:
CREATING
 
name
string
on success
OceInstance Name

Sample:
name_example
 
object_storage_namespace
string
on success
Object Storage Namespace of tenancy

Sample:
object_storage_namespace_example
 
service
dictionary
on success
SERVICE data. Example: `{"service": {"IDCS": "value"}}`

 
state_message
string
on success
An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Sample:
state_message_example
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
tenancy_id
string
on success
Tenancy Identifier

Sample:
ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx
 
tenancy_name
string
on success
Tenancy Name

Sample:
tenancy_name_example
 
time_created
string
on success
The time the the OceInstance was created. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the OceInstance was updated. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00
 
upgrade_schedule
string
on success
Upgrade schedule type representing service to be upgraded immediately whenever latest version is released or delay upgrade of the service to previous released version

Sample:
UPGRADE_IMMEDIATELY
 
waf_primary_domain
string
on success
Web Application Firewall(WAF) primary domain

Sample:
waf_primary_domain_example


Authors

  • Oracle (@oracle)