oracle.oci.oci_os_management_hub_lifecycle_stage_facts – Fetches details about one or multiple LifecycleStage resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists lifecycle stages that match the specified compartment or lifecycle stage OCID. Filter the list against

  • If lifecycle_stage_id is specified, the details of a single LifecycleStage 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).
arch_type
string
    Choices:
  • X86_64
  • AARCH64
  • I686
  • NOARCH
  • SRC
A filter to return only profiles that match the given archType.
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
  • security_token
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 OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment.
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
list / elements=string
A filter to return resources that match the given display names.

aliases: name
display_name_contains
string
A filter to return resources that may partially match the given display name.
lifecycle_stage_id
string
The OCID of the lifecycle stage.
Required to get a specific lifecycle_stage.

aliases: id
lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
A filter to return only lifecycle stages whose lifecycle state matches the given lifecycle state.
location
list / elements=string
    Choices:
  • ON_PREMISE
  • OCI_COMPUTE
  • AZURE
  • EC2
  • GCP
A filter to return only resources whose location matches the given value.
location_not_equal_to
list / elements=string
    Choices:
  • ON_PREMISE
  • OCI_COMPUTE
  • AZURE
  • EC2
  • GCP
A filter to return only resources whose location does not match the given value.
os_family
string
    Choices:
  • ORACLE_LINUX_9
  • ORACLE_LINUX_8
  • ORACLE_LINUX_7
  • ORACLE_LINUX_6
  • WINDOWS_SERVER_2016
  • WINDOWS_SERVER_2019
  • WINDOWS_SERVER_2022
  • ALL
A filter to return only resources that match the given operating system family.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
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.
software_source_id
string
The OCID of the software source. This filter returns resources associated with this software source.
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.
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 lifecycle_stage
  oci_os_management_hub_lifecycle_stage_facts:
    # required
    lifecycle_stage_id: "ocid1.lifecyclestage.oc1..xxxxxxEXAMPLExxxxxx"

- name: List lifecycle_stages
  oci_os_management_hub_lifecycle_stage_facts:

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: [ "display_name_example" ]
    display_name_contains: display_name_contains_example
    lifecycle_stage_id: "ocid1.lifecyclestage.oc1..xxxxxxEXAMPLExxxxxx"
    software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"
    arch_type: X86_64
    os_family: ORACLE_LINUX_9
    location: [ "ON_PREMISE" ]
    location_not_equal_to: [ "ON_PREMISE" ]
    lifecycle_state: CREATING
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
lifecycle_stages
complex
on success
List of LifecycleStage resources

Sample:
[{'arch_type': 'X86_64', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_environment_display_name': 'lifecycle_environment_display_name_example', 'lifecycle_environment_id': 'ocid1.lifecycleenvironment.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'location': 'ON_PREMISE', 'managed_instance_ids': [{'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}], 'managed_instances': 56, 'os_family': 'ORACLE_LINUX_9', 'rank': 56, 'software_source_id': {'description': 'description_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_mandatory_for_autonomous_linux': True, 'software_source_type': 'VENDOR'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_modified': '2013-10-20T19:20:30+01:00', 'vendor_name': 'ORACLE'}]
 
arch_type
string
on success
The CPU architecture of the managed instances in the lifecycle stage.

Sample:
X86_64
 
compartment_id
string
on success
The OCID of the compartment that contains the lifecycle stage.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
The user-friendly name for the lifecycle stage.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the lifecycle stage.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_environment_display_name
string
on success
The user-friendly name for the lifecycle environment. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Returned for list operation

Sample:
lifecycle_environment_display_name_example
 
lifecycle_environment_id
string
on success
The OCID of the lifecycle environment that contains the lifecycle stage.

Sample:
ocid1.lifecycleenvironment.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the lifecycle stage.

Sample:
CREATING
 
location
string
on success
The location of managed instances associated with the lifecycle stage.

Sample:
ON_PREMISE
 
managed_instance_ids
complex
on success
The list of managed instances associated with the lifecycle stage.
Returned for get operation
   
display_name
string
on success
Managed instance name.

Sample:
display_name_example
   
id
string
on success
The OCID of the managed instance.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
managed_instances
integer
on success
The list of managed instances associated with the lifecycle stage.
Returned for list operation

Sample:
56
 
os_family
string
on success
The operating system of the managed instances in the lifecycle stage.

Sample:
ORACLE_LINUX_9
 
rank
integer
on success
User-specified rank for the lifecycle stage. Rank determines the hierarchy of the lifecycle stages within the lifecycle environment.

Sample:
56
 
software_source_id
complex
on success

   
description
string
on success
Software source description.

Sample:
description_example
   
display_name
string
on success
Software source name.

Sample:
display_name_example
   
id
string
on success
The OCID of the software source.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
is_mandatory_for_autonomous_linux
boolean
on success
Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it.

Sample:
True
   
software_source_type
string
on success
Type of the software source.

Sample:
VENDOR
 
system_tags
dictionary
on success
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
time_created
string
on success
The time the lifecycle stage was created (in RFC 3339 format).

Sample:
2013-10-20T19:20:30+01:00
 
time_modified
string
on success
The time the lifecycle stage was last modified (in RFC 3339 format).

Sample:
2013-10-20T19:20:30+01:00
 
vendor_name
string
on success
The vendor of the operating system used by the managed instances in the lifecycle stage.

Sample:
ORACLE


Authors

  • Oracle (@oracle)