oracle.oci.oci_os_management_managed_instance_facts – Fetches details about one or multiple ManagedInstance 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_os_management_managed_instance_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns a list of all Managed Instances.

  • If managed_instance_id is specified, the details of a single ManagedInstance 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 managed_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`

aliases: name
managed_instance_id
string
OCID for the managed instance
Required to get a specific managed_instance.

aliases: id
os_family
string
    Choices:
  • LINUX
  • WINDOWS
  • ALL
The OS family for which to list resources.
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

Examples

- name: Get a specific managed_instance
  oci_os_management_managed_instance_facts:
    # required
    managed_instance_id: "ocid1.managedinstance.oc1..xxxxxxEXAMPLExxxxxx"

- name: List managed_instances
  oci_os_management_managed_instance_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    sort_order: ASC
    sort_by: TIMECREATED
    os_family: LINUX

Return Values

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

Key Returned Description
managed_instances
complex
on success
List of ManagedInstance resources

Sample:
[{'autonomous': {'is_auto_update_enabled': True}, 'bug_updates_available': 56, 'child_software_sources': [{'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'display_name': 'display_name_example', 'enhancement_updates_available': 56, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_data_collection_authorized': True, 'is_reboot_required': True, 'ksplice_effective_kernel_version': 'ksplice_effective_kernel_version_example', 'last_boot': 'last_boot_example', 'last_checkin': 'last_checkin_example', 'managed_instance_groups': [{'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}], 'notification_topic_id': 'ocid1.notificationtopic.oc1..xxxxxxEXAMPLExxxxxx', 'os_family': 'LINUX', 'os_kernel_version': 'os_kernel_version_example', 'os_name': 'os_name_example', 'os_version': 'os_version_example', 'other_updates_available': 56, 'parent_software_source': {'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example'}, 'scheduled_job_count': 56, 'security_updates_available': 56, 'status': 'NORMAL', 'updates_available': 56, 'work_request_count': 56}]
 
autonomous
complex
on success
if present, indicates the Managed Instance is an autonomous instance. Holds all the Autonomous specific information
Returned for get operation

   
is_auto_update_enabled
boolean
on success
True if daily updates are enabled

Sample:
True
 
bug_updates_available
integer
on success
Number of bug fix type updates available to be installed
Returned for get operation

Sample:
56
 
child_software_sources
complex
on success
list of child Software Sources attached to the Managed Instance
Returned for get operation

   
id
string
on success
software source identifier

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
name
string
on success
software source name

Sample:
name_example
 
compartment_id
string
on success
OCID for the Compartment

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
description
string
on success
Information specified by the user about the managed instance

Sample:
description_example
 
display_name
string
on success
Managed Instance identifier

Sample:
display_name_example
 
enhancement_updates_available
integer
on success
Number of enhancement type updates available to be installed
Returned for get operation

Sample:
56
 
id
string
on success
OCID for the managed instance

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_data_collection_authorized
boolean
on success
True if user allow data collection for this instance
Returned for get operation

Sample:
True
 
is_reboot_required
boolean
on success
Indicates whether a reboot is required to complete installation of updates.

Sample:
True
 
ksplice_effective_kernel_version
string
on success
The ksplice effective kernel version
Returned for get operation

Sample:
ksplice_effective_kernel_version_example
 
last_boot
string
on success
Time at which the instance last booted

Sample:
last_boot_example
 
last_checkin
string
on success
Time at which the instance last checked in

Sample:
last_checkin_example
 
managed_instance_groups
complex
on success
The ids of the managed instance groups of which this instance is a member.
Returned for get operation

   
display_name
string
on success
User friendly name

Sample:
display_name_example
   
id
string
on success
unique identifier that is immutable on creation

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
notification_topic_id
string
on success
OCID of the ONS topic used to send notification to users
Returned for get operation

Sample:
ocid1.notificationtopic.oc1..xxxxxxEXAMPLExxxxxx
 
os_family
string
on success
The Operating System type of the managed instance.

Sample:
LINUX
 
os_kernel_version
string
on success
Operating System Kernel Version
Returned for get operation

Sample:
os_kernel_version_example
 
os_name
string
on success
Operating System Name
Returned for get operation

Sample:
os_name_example
 
os_version
string
on success
Operating System Version
Returned for get operation

Sample:
os_version_example
 
other_updates_available
integer
on success
Number of non-classified updates available to be installed
Returned for get operation

Sample:
56
 
parent_software_source
complex
on success
the parent (base) Software Source attached to the Managed Instance
Returned for get operation

   
id
string
on success
software source identifier

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
name
string
on success
software source name

Sample:
name_example
 
scheduled_job_count
integer
on success
Number of scheduled jobs associated with this instance
Returned for get operation

Sample:
56
 
security_updates_available
integer
on success
Number of security type updates available to be installed
Returned for get operation

Sample:
56
 
status
string
on success
status of the managed instance.

Sample:
NORMAL
 
updates_available
integer
on success
Number of updates available to be installed

Sample:
56
 
work_request_count
integer
on success
Number of work requests associated with this instance
Returned for get operation

Sample:
56


Authors

  • Oracle (@oracle)