oracle.oci.oci_fusion_apps_fusion_environment_facts – Fetches details about one or multiple FusionEnvironment 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_fusion_apps_fusion_environment_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns a list of FusionEnvironments.

  • If fusion_environment_id is specified, the details of a single FusionEnvironment 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 fusion_environments.
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 filter to return only resources that match the entire display name given.

aliases: name
fusion_environment_family_id
string
The ID of the fusion environment family in which to list resources.
fusion_environment_id
string
unique FusionEnvironment identifier
Required to get a specific fusion_environment.

aliases: id
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • INACTIVE
  • DELETING
  • DELETED
  • FAILED
A filter that returns all resources that match the specified lifecycle state.
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:
  • TIME_CREATED
  • DISPLAY_NAME
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

Examples

- name: Get a specific fusion_environment
  oci_fusion_apps_fusion_environment_facts:
    # required
    fusion_environment_id: "ocid1.fusionenvironment.oc1..xxxxxxEXAMPLExxxxxx"

- name: List fusion_environments
  oci_fusion_apps_fusion_environment_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    fusion_environment_family_id: "ocid1.fusionenvironmentfamily.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    lifecycle_state: CREATING
    sort_order: ASC
    sort_by: TIME_CREATED

Return Values

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

Key Returned Description
fusion_environments
complex
on success
List of FusionEnvironment resources

Sample:
[{'additional_language_packs': [], 'applied_patch_bundles': [], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'dns_prefix': 'dns_prefix_example', 'domain_id': 'ocid1.domain.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'fusion_environment_family_id': 'ocid1.fusionenvironmentfamily.oc1..xxxxxxEXAMPLExxxxxx', 'fusion_environment_type': 'PRODUCTION', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'idcs_domain_url': 'idcs_domain_url_example', 'is_break_glass_enabled': True, 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'kms_key_info': {}, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'lockbox_id': 'ocid1.lockbox.oc1..xxxxxxEXAMPLExxxxxx', 'maintenance_policy': {'environment_maintenance_override': 'environment_maintenance_override_example', 'monthly_patching_override': 'monthly_patching_override_example', 'quarterly_upgrade_begin_times': {'begin_times_value': 'begin_times_value_example', 'override_type': 'OVERRIDDEN'}}, 'public_url': 'public_url_example', 'refresh': {'source_fusion_environment_id': 'ocid1.sourcefusionenvironment.oc1..xxxxxxEXAMPLExxxxxx', 'time_finished': '2013-10-20T19:20:30+01:00', 'time_of_restoration_point': '2013-10-20T19:20:30+01:00'}, 'rules': [{'action': 'ALLOW', 'conditions': [{'attribute_name': 'SOURCE_IP_ADDRESS', 'attribute_value': 'attribute_value_example'}], 'description': 'description_example'}], 'subscription_ids': [], 'system_name': 'system_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_upcoming_maintenance': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}]
 
additional_language_packs
list / elements=string
on success
Language packs

 
applied_patch_bundles
list / elements=string
on success
Patch bundle names

 
compartment_id
string
on success
Compartment Identifier

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
FusionEnvironment Identifier, can be renamed

Sample:
display_name_example
 
dns_prefix
string
on success
DNS prefix

Sample:
dns_prefix_example
 
domain_id
string
on success
The IDCS domain created for the fusion instance
Returned for get operation

Sample:
ocid1.domain.oc1..xxxxxxEXAMPLExxxxxx
 
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'}
 
fusion_environment_family_id
string
on success
FusionEnvironmentFamily Identifier

Sample:
ocid1.fusionenvironmentfamily.oc1..xxxxxxEXAMPLExxxxxx
 
fusion_environment_type
string
on success
Type of the FusionEnvironment.

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

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
idcs_domain_url
string
on success
The IDCS Domain URL
Returned for get operation

Sample:
idcs_domain_url_example
 
is_break_glass_enabled
boolean
on success
If it's true, then the Break Glass feature is enabled

Sample:
True
 
kms_key_id
string
on success
BYOK key id
Returned for get operation

Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
 
kms_key_info
dictionary
on success
BYOK key info
Returned for get operation

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

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the ServiceInstance.

Sample:
CREATING
 
lockbox_id
string
on success
The lockbox Id of this fusion environment. If there's no lockbox id, this field will be null

Sample:
ocid1.lockbox.oc1..xxxxxxEXAMPLExxxxxx
 
maintenance_policy
complex
on success

   
environment_maintenance_override
string
on success
User choice to upgrade both production and non-production environments at the same time. Overrides the Fusion environment family setting.

Sample:
environment_maintenance_override_example
   
monthly_patching_override
string
on success
Whether the Fusion environment will be updated monthly or updated on the quarterly cycle. This setting overrides the monthly patching setting of its Fusion environment family.

Sample:
monthly_patching_override_example
   
quarterly_upgrade_begin_times
complex
on success

     
begin_times_value
string
on success
The frequency and month when maintenance occurs for the Fusion environment.

Sample:
begin_times_value_example
     
override_type
string
on success
Determines if the maintenance schedule of the Fusion environment is inherited from the Fusion environment family.

Sample:
OVERRIDDEN
 
public_url
string
on success
Public URL

Sample:
public_url_example
 
refresh
complex
on success
Returned for get operation

   
source_fusion_environment_id
string
on success
The source environment id for the last refresh

Sample:
ocid1.sourcefusionenvironment.oc1..xxxxxxEXAMPLExxxxxx
   
time_finished
string
on success
The time of when the last refresh finish

Sample:
2013-10-20T19:20:30+01:00
   
time_of_restoration_point
string
on success
The point of time of the latest DB backup for the last refresh

Sample:
2013-10-20T19:20:30+01:00
 
rules
complex
on success
Network Access Control Rules
Returned for get operation

   
action
string
on success
Rule type

Sample:
ALLOW
   
conditions
complex
on success

     
attribute_name
string
on success
RuleCondition type

Sample:
SOURCE_IP_ADDRESS
     
attribute_value
string
on success
An IPv4 or IPv6 address range that the source IP address of an incoming packet must match. The service accepts only classless inter-domain routing (CIDR) format (x.x.x.x/y or x:x::x/y) strings. Specify 0.0.0.0/0 or ::/0 to match all incoming traffic. example: "192.168.0.0/16"

Sample:
attribute_value_example
   
description
string
on success
A brief description of the access control rule. Avoid entering confidential information. example: `192.168.0.0/16 and 2001:db8::/32 are trusted clients. Whitelist them.`

Sample:
description_example
 
subscription_ids
list / elements=string
on success
List of subscription IDs.

 
system_name
string
on success
Environment Specific Guid/ System Name
Returned for get operation

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

Sample:
2013-10-20T19:20:30+01:00
 
time_upcoming_maintenance
string
on success
The next maintenance for this environment

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

Sample:
2013-10-20T19:20:30+01:00
 
version
string
on success
Version of Fusion Apps used by this environment

Sample:
version_example


Authors

  • Oracle (@oracle)