ManagedInstanceClientCompositeOperations¶
-
class
oci.os_management_hub.
ManagedInstanceClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
ManagedInstanceClient
and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionalityMethods
-
__init__
(client, **kwargs)¶ Creates a new ManagedInstanceClientCompositeOperations object
Parameters: client (ManagedInstanceClient) – The service client which will be wrapped by this object
-
associate_managed_instances_with_management_station_and_wait_for_state
(management_station_id, associate_managed_instances_with_management_station_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
associate_managed_instances_with_management_station()
and waits for theWorkRequest
to enter the given state(s).Parameters: - management_station_id (str) –
(required) The OCID of the management station.
- associate_managed_instances_with_management_station_details (oci.os_management_hub.models.AssociateManagedInstancesWithManagementStationDetails) –
(required) The managed instances OCIDs to associate to the management station.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
associate_managed_instances_with_management_station()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- management_station_id (str) –
-
attach_software_sources_to_managed_instance_and_wait_for_state
(managed_instance_id, attach_software_sources_to_managed_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
attach_software_sources_to_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- attach_software_sources_to_managed_instance_details (oci.os_management_hub.models.AttachSoftwareSourcesToManagedInstanceDetails) – (required) Details of software sources to be attached to a managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
attach_software_sources_to_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
delete_managed_instance_and_wait_for_state
(managed_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
detach_software_sources_from_managed_instance_and_wait_for_state
(managed_instance_id, detach_software_sources_from_managed_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
detach_software_sources_from_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- detach_software_sources_from_managed_instance_details (oci.os_management_hub.models.DetachSoftwareSourcesFromManagedInstanceDetails) – (required) Details of software sources to be detached from a managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
detach_software_sources_from_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
disable_module_stream_on_managed_instance_and_wait_for_state
(managed_instance_id, disable_module_stream_on_managed_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
disable_module_stream_on_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- disable_module_stream_on_managed_instance_details (oci.os_management_hub.models.DisableModuleStreamOnManagedInstanceDetails) – (required) The details of the module stream to be disabled on a managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
disable_module_stream_on_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
enable_module_stream_on_managed_instance_and_wait_for_state
(managed_instance_id, enable_module_stream_on_managed_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
enable_module_stream_on_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- enable_module_stream_on_managed_instance_details (oci.os_management_hub.models.EnableModuleStreamOnManagedInstanceDetails) – (required) The details of the module stream to be enabled on a managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
enable_module_stream_on_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
install_all_windows_updates_on_managed_instances_in_compartment_and_wait_for_state
(install_all_windows_updates_on_managed_instances_in_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
install_all_windows_updates_on_managed_instances_in_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - install_all_windows_updates_on_managed_instances_in_compartment_details (oci.os_management_hub.models.InstallAllWindowsUpdatesOnManagedInstancesInCompartmentDetails) – (required) The details about Windows update types to be installed on all managed instances in a compartment.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
install_all_windows_updates_on_managed_instances_in_compartment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
install_module_stream_profile_on_managed_instance_and_wait_for_state
(managed_instance_id, install_module_stream_profile_on_managed_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
install_module_stream_profile_on_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- install_module_stream_profile_on_managed_instance_details (oci.os_management_hub.models.InstallModuleStreamProfileOnManagedInstanceDetails) – (required) The details of the module stream profile to be installed on a managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
install_module_stream_profile_on_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
install_packages_on_managed_instance_and_wait_for_state
(managed_instance_id, install_packages_on_managed_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
install_packages_on_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- install_packages_on_managed_instance_details (oci.os_management_hub.models.InstallPackagesOnManagedInstanceDetails) – (required) Details about packages to be installed on a managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
install_packages_on_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
install_windows_updates_on_managed_instance_and_wait_for_state
(managed_instance_id, install_windows_updates_on_managed_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
install_windows_updates_on_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- install_windows_updates_on_managed_instance_details (oci.os_management_hub.models.InstallWindowsUpdatesOnManagedInstanceDetails) – (required) Details about Windows updates to be installed on a managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
install_windows_updates_on_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
list_managed_instance_modules_and_wait_for_state
(managed_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
list_managed_instance_modules()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
list_managed_instance_modules()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
manage_module_streams_on_managed_instance_and_wait_for_state
(managed_instance_id, manage_module_streams_on_managed_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
manage_module_streams_on_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- manage_module_streams_on_managed_instance_details (oci.os_management_hub.models.ManageModuleStreamsOnManagedInstanceDetails) – (required) A description of an operation to perform against the modules, streams, and profiles of a managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
manage_module_streams_on_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
reboot_managed_instance_and_wait_for_state
(managed_instance_id, reboot_managed_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
reboot_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- reboot_managed_instance_details (oci.os_management_hub.models.RebootManagedInstanceDetails) – (required) The timeout to be set for the reboot job. The timeout is the amount of time in minutes that the service waits for the reboot to complete before marking the job as failed.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
reboot_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
refresh_software_on_managed_instance_and_wait_for_state
(managed_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
refresh_software_on_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
refresh_software_on_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
remove_module_stream_profile_from_managed_instance_and_wait_for_state
(managed_instance_id, remove_module_stream_profile_from_managed_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
remove_module_stream_profile_from_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- remove_module_stream_profile_from_managed_instance_details (oci.os_management_hub.models.RemoveModuleStreamProfileFromManagedInstanceDetails) – (required) The details of the module stream profile to be removed from a managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
remove_module_stream_profile_from_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
remove_packages_from_managed_instance_and_wait_for_state
(managed_instance_id, remove_packages_from_managed_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
remove_packages_from_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- remove_packages_from_managed_instance_details (oci.os_management_hub.models.RemovePackagesFromManagedInstanceDetails) – (required) Details about packages to be removed on a managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
remove_packages_from_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
switch_module_stream_on_managed_instance_and_wait_for_state
(managed_instance_id, switch_module_stream_on_managed_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
switch_module_stream_on_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- switch_module_stream_on_managed_instance_details (oci.os_management_hub.models.SwitchModuleStreamOnManagedInstanceDetails) – (required) The details of the module stream to be switched on a managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
switch_module_stream_on_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-
update_all_packages_on_managed_instances_in_compartment_and_wait_for_state
(update_all_packages_on_managed_instances_in_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_all_packages_on_managed_instances_in_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - update_all_packages_on_managed_instances_in_compartment_details (oci.os_management_hub.models.UpdateAllPackagesOnManagedInstancesInCompartmentDetails) – (required) The details about package types are to be updated on all managed instances in a compartment.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_all_packages_on_managed_instances_in_compartment()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
update_packages_on_managed_instance_and_wait_for_state
(managed_instance_id, update_packages_on_managed_instance_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_packages_on_managed_instance()
and waits for theWorkRequest
to enter the given state(s).Parameters: - managed_instance_id (str) –
(required) The OCID of the managed instance.
- update_packages_on_managed_instance_details (oci.os_management_hub.models.UpdatePackagesOnManagedInstanceDetails) – (required) Details about packages to be updated on a managed instance.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_packages_on_managed_instance()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- managed_instance_id (str) –
-