oracle.oci.oci_os_management_hub_managed_instance – Manage a ManagedInstance resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to update and delete a ManagedInstance resource in Oracle Cloud Infrastructure

  • This resource has the following action operations in the oracle.oci.oci_os_management_hub_managed_instance_actions module: attach_profile, attach_software_sources, detach_profile, detach_software_sources, disable_module_stream, enable_module_stream, install_all_windows_updates_on_managed_instances_in_compartment, install_module_stream_profile, install_packages, install_windows_updates, manage_module_streams, refresh_software, remove_module_stream_profile, remove_packages, switch_module_stream, update_all_packages_on_managed_instances_in_compartment, update_packages.

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
  • 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.
autonomous_settings
dictionary
This parameter is updatable.
is_data_collection_authorized
boolean
    Choices:
  • no
  • yes
Indicates whether Autonomous Linux will collect crash files.
This parameter is updatable.
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.
description
string
User-specified description of the managed instance. Avoid entering confidential information.
This parameter is updatable.
managed_instance_id
string / required
The OCID of the managed instance.

aliases: id
notification_topic_id
string
The OCID for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer.
This parameter is updatable.
primary_management_station_id
string
The OCID of the management station for the instance to use as primary management station.
This parameter is updatable.
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.
secondary_management_station_id
string
The OCID of the management station for the instance to use as secondary management station.
This parameter is updatable.
state
string
    Choices:
  • present ←
  • absent
The state of the ManagedInstance.
Use state=present to update an existing a ManagedInstance.
Use state=absent to delete a ManagedInstance.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Update managed_instance
  oci_os_management_hub_managed_instance:
    # required
    managed_instance_id: "ocid1.managedinstance.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    description: description_example
    primary_management_station_id: "ocid1.primarymanagementstation.oc1..xxxxxxEXAMPLExxxxxx"
    secondary_management_station_id: "ocid1.secondarymanagementstation.oc1..xxxxxxEXAMPLExxxxxx"
    notification_topic_id: "ocid1.notificationtopic.oc1..xxxxxxEXAMPLExxxxxx"
    autonomous_settings:
      # optional
      is_data_collection_authorized: true

- name: Delete managed_instance
  oci_os_management_hub_managed_instance:
    # required
    managed_instance_id: "ocid1.managedinstance.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
managed_instance
complex
on success
Details of the ManagedInstance resource acted upon by the current operation

Sample:
{'architecture': 'X86_64', 'autonomous_settings': {'is_data_collection_authorized': True, 'scheduled_job_id': 'ocid1.scheduledjob.oc1..xxxxxxEXAMPLExxxxxx'}, 'bug_updates_available': 56, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'display_name': 'display_name_example', 'enhancement_updates_available': 56, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'installed_packages': 56, 'installed_windows_updates': 56, 'is_managed_by_autonomous_linux': True, 'is_management_station': True, 'is_reboot_required': True, 'ksplice_effective_kernel_version': 'ksplice_effective_kernel_version_example', 'lifecycle_environment': {'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}, 'lifecycle_stage': {'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}, 'location': 'ON_PREMISE', 'managed_instance_group': {'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}, 'notification_topic_id': 'ocid1.notificationtopic.oc1..xxxxxxEXAMPLExxxxxx', 'os_family': 'ORACLE_LINUX_9', 'os_kernel_version': 'os_kernel_version_example', 'os_name': 'os_name_example', 'os_version': 'os_version_example', 'other_updates_available': 56, 'primary_management_station_id': 'ocid1.primarymanagementstation.oc1..xxxxxxEXAMPLExxxxxx', 'profile': 'profile_example', 'scheduled_job_count': 56, 'secondary_management_station_id': 'ocid1.secondarymanagementstation.oc1..xxxxxxEXAMPLExxxxxx', 'security_updates_available': 56, 'software_sources': [{'description': 'description_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_mandatory_for_autonomous_linux': True, 'software_source_type': 'VENDOR'}], 'status': 'NORMAL', 'tenancy_id': 'ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_last_boot': '2013-10-20T19:20:30+01:00', 'time_last_checkin': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'updates_available': 56, 'work_request_count': 56}
 
architecture
string
on success
The CPU architecture type of the managed instance.

Sample:
X86_64
 
autonomous_settings
complex
on success

   
is_data_collection_authorized
boolean
on success
Indicates whether Autonomous Linux will collect crash files. This setting can be changed by the user.

Sample:
True
   
scheduled_job_id
string
on success
The OCID of the restricted scheduled job associated with this instance. This value cannot be deleted by the user.

Sample:
ocid1.scheduledjob.oc1..xxxxxxEXAMPLExxxxxx
 
bug_updates_available
integer
on success
Number of bug fix type updates available for installation.

Sample:
56
 
compartment_id
string
on success
The OCID of the compartment that contains the managed instance.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
description
string
on success
User-specified description for the managed instance.

Sample:
description_example
 
display_name
string
on success
User-friendly name for the managed instance.

Sample:
display_name_example
 
enhancement_updates_available
integer
on success
Number of enhancement type updates available for installation.

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

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
installed_packages
integer
on success
Number of packages installed on the instance.

Sample:
56
 
installed_windows_updates
integer
on success
Number of Windows updates installed on the instance.

Sample:
56
 
is_managed_by_autonomous_linux
boolean
on success
Indicates whether the Autonomous Linux service manages the instance.

Sample:
True
 
is_management_station
boolean
on success
Indicates whether this managed instance is acting as an on-premises management station.

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.

Sample:
ksplice_effective_kernel_version_example
 
lifecycle_environment
complex
on success

   
display_name
string
on success
User-friendly name.

Sample:
display_name_example
   
id
string
on success
The OCID of the resource that is immutable on creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_stage
complex
on success

   
display_name
string
on success
User-friendly name.

Sample:
display_name_example
   
id
string
on success
The OCID of the resource that is immutable on creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
location
string
on success
The location of the managed instance.

Sample:
ON_PREMISE
 
managed_instance_group
complex
on success

   
display_name
string
on success
User-friendly name.

Sample:
display_name_example
   
id
string
on success
The OCID of the resource that is immutable on creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
notification_topic_id
string
on success
The OCID for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer.

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

Sample:
ORACLE_LINUX_9
 
os_kernel_version
string
on success
Operating system kernel version.

Sample:
os_kernel_version_example
 
os_name
string
on success
Operating system name.

Sample:
os_name_example
 
os_version
string
on success
Operating system version.

Sample:
os_version_example
 
other_updates_available
integer
on success
Number of non-classified (other) updates available for installation.

Sample:
56
 
primary_management_station_id
string
on success
The OCID of the management station for the instance to use as primary management station.

Sample:
ocid1.primarymanagementstation.oc1..xxxxxxEXAMPLExxxxxx
 
profile
string
on success
The profile that was used to register this instance with the service.

Sample:
profile_example
 
scheduled_job_count
integer
on success
Number of scheduled jobs associated with this instance.

Sample:
56
 
secondary_management_station_id
string
on success
The OCID of the management station for the instance to use as secondary managment station.

Sample:
ocid1.secondarymanagementstation.oc1..xxxxxxEXAMPLExxxxxx
 
security_updates_available
integer
on success
Number of security type updates available for installation.

Sample:
56
 
software_sources
complex
on success
The list of software sources currently attached to the managed instance.
   
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
 
status
string
on success
Current status of the managed instance.

Sample:
NORMAL
 
tenancy_id
string
on success
The OCID of the tenancy that the managed instance resides in.

Sample:
ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time the instance was created (in RFC 3339 format).

Sample:
2013-10-20T19:20:30+01:00
 
time_last_boot
string
on success
Time that the instance last booted (in RFC 3339 format).

Sample:
2013-10-20T19:20:30+01:00
 
time_last_checkin
string
on success
Time that the instance last checked in with the service (in RFC 3339 format).

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the instance was last updated (in RFC 3339 format).

Sample:
2013-10-20T19:20:30+01:00
 
updates_available
integer
on success
Number of updates available for installation.

Sample:
56
 
work_request_count
integer
on success
Number of work requests associated with this instance.

Sample:
56


Authors

  • Oracle (@oracle)