oracle.oci.oci_os_management_hub_managed_instance_group_actions – Perform actions on a ManagedInstanceGroup resource 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_managed_instance_group_actions.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Perform actions on a ManagedInstanceGroup resource in Oracle Cloud Infrastructure
For action=attach_managed_instances, adds managed instances to the specified managed instance group. After adding instances to the group, any operation applied to the group will be applied to all instances in the group.
For action=attach_software_sources, attaches software sources to the specified managed instance group. The software sources must be compatible with the type of instances in the group.
For action=change_compartment, moves the specified managed instance group to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
For action=detach_managed_instances, removes a managed instance from the specified managed instance group.
For action=detach_software_sources, detaches the specified software sources from a managed instance group.
For action=disable_module_stream, disables a module stream on a managed instance group. After the stream is disabled, you can no longer install the profiles contained by the stream. Before removing the stream, you must remove all installed profiles for the stream by using the RemoveModuleStreamProfileFromManagedInstanceGroup operation.
For action=enable_module_stream, enables a module stream on a managed instance group. After the stream is enabled, you can install a module stream profile. Enabling a stream that is already enabled will succeed. Enabling a different stream for a module that already has a stream enabled results in an error. Instead, use the SwitchModuleStreamOnManagedInstanceGroup operation.
For action=install_module_stream_profile, installs a profile for an enabled module stream. If a module stream defines multiple profiles, you can install each one independently.
For action=install_packages, installs the specified packages on each managed instance in a managed instance group. The package must be compatible with the instances in the group.
For action=install_windows_updates, installs Windows updates on each managed instance in the managed instance group.
For action=manage_module_streams, enables or disables module streams and installs or removes module stream profiles. Once complete, the state of the modules, streams, and profiles will match the state indicated in the operation. See ManageModuleStreamsOnManagedInstanceGroupDetails for more information. You can preform this operation as a dry run. For a dry run, the service evaluates the operation against the current module, stream, and profile state on the managed instance, but does not commit the changes. Instead, the service returns work request log or error entries indicating the impact of the operation.
For action=remove_module_stream_profile, removes a profile for a module stream that is installed on a managed instance group. Providing the module stream name (without specifying a profile name) removes all profiles that have been installed for the module stream.
For action=remove_packages, removes the specified packages from each managed instance in a managed instance group.
For action=switch_module_stream, enables a new stream for a module that already has a stream enabled. If any profiles or packages from the original module are installed, switching to a new stream will remove the existing packages and install their counterparts in the new stream.
For action=update_all_packages, updates all packages on each managed instance in the specified managed instance group.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter		Choices/Defaults	Comments
action string / required		Choices: attach_managed_instances attach_software_sources change_compartment detach_managed_instances detach_software_sources disable_module_stream enable_module_stream install_module_stream_profile install_packages install_windows_updates manage_module_streams remove_module_stream_profile remove_packages switch_module_stream update_all_packages	The action to perform on the ManagedInstanceGroup.
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.
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 to move the group to. Required for action=change_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`.
disable list / elements=dictionary			The set of module streams to disable. Applicable only for action=manage_module_streams.
	module_name string / required		The name of a module.
	software_source_id string		The OCID of the software source that contains the module stream.
	stream_name string / required		The name of a stream of the specified module.
enable list / elements=dictionary			The set of module streams to enable. Applicable only for action=manage_module_streams.
	module_name string / required		The name of a module.
	software_source_id string		The OCID of the software source that contains the module stream.
	stream_name string / required		The name of a stream of the specified module.
install list / elements=dictionary			The set of module stream profiles to install. Applicable only for action=manage_module_streams.
	module_name string / required		The name of a module.
	profile_name string / required		The name of a profile of the specified module stream.
	software_source_id string		The OCID of the software source that contains the module stream.
	stream_name string / required		The name of a stream of the specified module.
is_dry_run boolean		Choices: no yes	Indicates if this operation is a dry run or if the operation should be committed. If set to true, the result of the operation will be evaluated but not committed. If set to false, the operation is committed to the managed instance(s). The default is false. Applicable only for action=manage_module_streams.
managed_instance_group_id string / required			The OCID of the managed instance group. aliases: id
managed_instances list / elements=string			List of managed instance OCIDs to attach to the group. Required for action=attach_managed_instances, action=detach_managed_instances.
module_name string			The name of the module. Required for action=disable_module_stream, action=enable_module_stream, action=install_module_stream_profile, action=remove_module_stream_profile, action=switch_module_stream.
package_names list / elements=string			The list of package names. Required for action=install_packages, action=remove_packages.
profile_name string			The name of a profile of the specified module stream. Applicable only for action=install_module_stream_profileaction=remove_module_stream_profile.
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.
remove list / elements=dictionary			The set of module stream profiles to remove. Applicable only for action=manage_module_streams.
	module_name string / required		The name of a module.
	profile_name string / required		The name of a profile of the specified module stream.
	software_source_id string		The OCID of the software source that contains the module stream.
	stream_name string / required		The name of a stream of the specified module.
software_source_id string			The OCID of the software source that provides the module stream Applicable only for action=disable_module_streamaction=enable_module_streamaction=install_module_stream_profileaction=remove_module_str eam_profileaction=switch_module_stream.
software_sources list / elements=string			List of software source OCIDs to attach to the group. Required for action=attach_software_sources, action=detach_software_sources.
stream_name string			The name of a stream of the specified module. Required for action=switch_module_stream.
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
update_types list / elements=string		Choices: SECURITY BUGFIX ENHANCEMENT OTHER KSPLICE_KERNEL KSPLICE_USERSPACE ALL	The type of updates to be applied. Applicable only for action=update_all_packages.
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.
windows_update_types list / elements=string		Choices: SECURITY BUGFIX ENHANCEMENT OTHER ALL	The type of Windows updates to be applied. Required for action=install_windows_updates.
work_request_details dictionary			Applicable only for action=attach_managed_instancesaction=attach_software_sourcesaction=detach_software_sourcesaction=disable_module_st reamaction=enable_module_streamaction=install_module_stream_profileaction=install_packagesaction=install_windows_updatesaction=mana ge_module_streamsaction=remove_module_stream_profileaction=remove_packagesaction=switch_module_streamaction=update_all_packages.
	description string		User-specified information about the job. Avoid entering confidential information.
	display_name string		A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. aliases: name

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Perform action attach_managed_instances on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    managed_instances: [ "managed_instances_example" ]
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: attach_managed_instances

    # optional
    work_request_details:
      # optional
      display_name: display_name_example
      description: description_example

- name: Perform action attach_software_sources on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    software_sources: [ "software_sources_example" ]
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: attach_software_sources

    # optional
    work_request_details:
      # optional
      display_name: display_name_example
      description: description_example

- name: Perform action change_compartment on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action detach_managed_instances on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    managed_instances: [ "managed_instances_example" ]
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: detach_managed_instances

- name: Perform action detach_software_sources on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    software_sources: [ "software_sources_example" ]
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: detach_software_sources

    # optional
    work_request_details:
      # optional
      display_name: display_name_example
      description: description_example

- name: Perform action disable_module_stream on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    module_name: module_name_example
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: disable_module_stream

    # optional
    stream_name: stream_name_example
    software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"
    work_request_details:
      # optional
      display_name: display_name_example
      description: description_example

- name: Perform action enable_module_stream on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    module_name: module_name_example
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: enable_module_stream

    # optional
    stream_name: stream_name_example
    software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"
    work_request_details:
      # optional
      display_name: display_name_example
      description: description_example

- name: Perform action install_module_stream_profile on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    module_name: module_name_example
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: install_module_stream_profile

    # optional
    profile_name: profile_name_example
    stream_name: stream_name_example
    software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"
    work_request_details:
      # optional
      display_name: display_name_example
      description: description_example

- name: Perform action install_packages on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    package_names: [ "package_names_example" ]
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: install_packages

    # optional
    work_request_details:
      # optional
      display_name: display_name_example
      description: description_example

- name: Perform action install_windows_updates on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    windows_update_types: [ "SECURITY" ]
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: install_windows_updates

    # optional
    work_request_details:
      # optional
      display_name: display_name_example
      description: description_example

- name: Perform action manage_module_streams on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: manage_module_streams

    # optional
    is_dry_run: true
    enable:
    - # required
      module_name: module_name_example
      stream_name: stream_name_example

      # optional
      software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"
    disable:
    - # required
      module_name: module_name_example
      stream_name: stream_name_example

      # optional
      software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"
    install:
    - # required
      module_name: module_name_example
      stream_name: stream_name_example
      profile_name: profile_name_example

      # optional
      software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"
    remove:
    - # required
      module_name: module_name_example
      stream_name: stream_name_example
      profile_name: profile_name_example

      # optional
      software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"
    work_request_details:
      # optional
      display_name: display_name_example
      description: description_example

- name: Perform action remove_module_stream_profile on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    module_name: module_name_example
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: remove_module_stream_profile

    # optional
    profile_name: profile_name_example
    stream_name: stream_name_example
    software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"
    work_request_details:
      # optional
      display_name: display_name_example
      description: description_example

- name: Perform action remove_packages on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    package_names: [ "package_names_example" ]
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: remove_packages

    # optional
    work_request_details:
      # optional
      display_name: display_name_example
      description: description_example

- name: Perform action switch_module_stream on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    module_name: module_name_example
    stream_name: stream_name_example
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: switch_module_stream

    # optional
    software_source_id: "ocid1.softwaresource.oc1..xxxxxxEXAMPLExxxxxx"
    work_request_details:
      # optional
      display_name: display_name_example
      description: description_example

- name: Perform action update_all_packages on managed_instance_group
  oci_os_management_hub_managed_instance_group_actions:
    # required
    managed_instance_group_id: "ocid1.managedinstancegroup.oc1..xxxxxxEXAMPLExxxxxx"
    action: update_all_packages

    # optional
    update_types: [ "SECURITY" ]
    work_request_details:
      # optional
      display_name: display_name_example
      description: description_example

Return Values ¶

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

Key			Returned	Description
managed_instance_group complex			on success	Details of the ManagedInstanceGroup resource acted upon by the current operation Sample: {'arch_type': 'X86_64', 'autonomous_settings': {'is_data_collection_authorized': True, 'scheduled_job_id': 'ocid1.scheduledjob.oc1..xxxxxxEXAMPLExxxxxx'}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_managed_by_autonomous_linux': True, 'lifecycle_state': 'CREATING', 'location': 'ON_PREMISE', 'managed_instance_count': 56, 'managed_instance_ids': [], 'notification_topic_id': 'ocid1.notificationtopic.oc1..xxxxxxEXAMPLExxxxxx', 'os_family': 'ORACLE_LINUX_9', 'pending_job_count': 56, 'software_source_ids': [{'description': 'description_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_mandatory_for_autonomous_linux': True, 'software_source_type': 'VENDOR'}], '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'}], '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 instances in the managed instance group. 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
	compartment_id string		on success	The OCID of the compartment that contains the managed instance group. 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'}}
	description string		on success	User-specified information about the managed instance group. Sample: description_example
	display_name string		on success	A user-friendly name for the managed instance group. 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 managed instance group. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	is_managed_by_autonomous_linux boolean		on success	Indicates whether the Autonomous Linux service manages the group. Sample: True
	lifecycle_state string		on success	The current state of the managed instance group. Sample: CREATING
	location string		on success	The location of managed instances attached to the group. Sample: ON_PREMISE
	managed_instance_count integer		on success	The number of managed instances in the group. Sample: 56
	managed_instance_ids list / elements=string		on success	The list of managed instance OCIDs attached to the managed instance group.
	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 instances in the managed instance group. Sample: ORACLE_LINUX_9
	pending_job_count integer		on success	The number of scheduled jobs pending against the managed instance group. Sample: 56
	software_source_ids complex		on success	The list of software source OCIDs that the managed instance group will use.
		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
	software_sources complex		on success	The list of software sources that the managed instance group will use.
		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 managed instance group was created (in RFC 3339 format). Sample: 2013-10-20T19:20:30+01:00
	time_modified string		on success	The time the managed instance group 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 group. Sample: ORACLE

Authors¶

Oracle (@oracle)

oracle.oci.oci_os_management_hub_managed_instance_group_actions – Perform actions on a ManagedInstanceGroup resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶