oracle.oci.oci_fusion_apps_refresh_activity_facts – Fetches details about one or multiple RefreshActivity resources 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_fusion_apps_refresh_activity_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns a list of RefreshActivities.

  • If refresh_activity_id is specified, the details of a single RefreshActivity 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.
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_id
string / required
unique FusionEnvironment identifier
lifecycle_state
string
    Choices:
  • ACCEPTED
  • IN_PROGRESS
  • NEEDS_ATTENTION
  • FAILED
  • SUCCEEDED
  • CANCELED
A filter that returns all resources that match the specified status
refresh_activity_id
string
The unique identifier (OCID) of the Refresh activity.
Required to get a specific refresh_activity.

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:
  • 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
time_expected_finish_less_than_or_equal_to
string
A filter that returns all resources that end before this date
time_scheduled_start_greater_than_or_equal_to
string
A filter that returns all resources that are scheduled after this date

Examples

- name: Get a specific refresh_activity
  oci_fusion_apps_refresh_activity_facts:
    # required
    refresh_activity_id: "ocid1.refreshactivity.oc1..xxxxxxEXAMPLExxxxxx"
    fusion_environment_id: "ocid1.fusionenvironment.oc1..xxxxxxEXAMPLExxxxxx"

- name: List refresh_activities
  oci_fusion_apps_refresh_activity_facts:
    # required
    fusion_environment_id: "ocid1.fusionenvironment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    time_scheduled_start_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_expected_finish_less_than_or_equal_to: 2013-10-20T19:20:30+01:00
    lifecycle_state: ACCEPTED
    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
refresh_activities
complex
on success
List of RefreshActivity resources

Sample:
[{'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'NONE', 'lifecycle_state': 'ACCEPTED', 'refresh_issue_details_list': [{'refresh_issues': 'refresh_issues_example'}], 'service_availability': 'AVAILABLE', 'source_fusion_environment_id': 'ocid1.sourcefusionenvironment.oc1..xxxxxxEXAMPLExxxxxx', 'time_accepted': '2013-10-20T19:20:30+01:00', 'time_expected_finish': '2013-10-20T19:20:30+01:00', 'time_finished': '2013-10-20T19:20:30+01:00', 'time_of_restoration_point': '2013-10-20T19:20:30+01:00', 'time_scheduled_start': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
display_name
string
on success
A friendly name for the refresh activity. Can be changed later.

Sample:
display_name_example
 
id
string
on success
The unique identifier (OCID) of the refresh activity. Can't be changed after creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
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:
NONE
 
lifecycle_state
string
on success
The current state of the refreshActivity.

Sample:
ACCEPTED
 
refresh_issue_details_list
complex
on success
Details of refresh investigation information, each item represents a different issue.

   
refresh_issues
string
on success
Detail reasons of refresh failure or validation failure that needs to be shown to customer.

Sample:
refresh_issues_example
 
service_availability
string
on success
Service availability / impact during refresh activity execution up down

Sample:
AVAILABLE
 
source_fusion_environment_id
string
on success
The OCID of the Fusion environment that is the source environment for the refresh.

Sample:
ocid1.sourcefusionenvironment.oc1..xxxxxxEXAMPLExxxxxx
 
time_accepted
string
on success
The time the refresh activity record was created. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_expected_finish
string
on success
The time the refresh activity is scheduled to end. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_finished
string
on success
The time the refresh activity actually completed / cancelled / failed. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_of_restoration_point
string
on success
The date and time of the most recent source environment backup used for the environment refresh.

Sample:
2013-10-20T19:20:30+01:00
 
time_scheduled_start
string
on success
The time the refresh activity is scheduled to start. An RFC3339 formatted datetime string.

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

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)