OsManagementClientCompositeOperations

class oci.os_management.OsManagementClientCompositeOperations(client, **kwargs)

This class provides a wrapper around OsManagementClient 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 functionality

Methods

__init__(client, **kwargs) Creates a new OsManagementClientCompositeOperations object
create_managed_instance_group_and_wait_for_state(…) Calls create_managed_instance_group() and waits for the ManagedInstanceGroup acted upon to enter the given state(s).
create_scheduled_job_and_wait_for_state(…) Calls create_scheduled_job() and waits for the ScheduledJob acted upon to enter the given state(s).
create_software_source_and_wait_for_state(…) Calls create_software_source() and waits for the SoftwareSource acted upon to enter the given state(s).
delete_managed_instance_group_and_wait_for_state(…) Calls delete_managed_instance_group() and waits for the ManagedInstanceGroup acted upon to enter the given state(s).
delete_scheduled_job_and_wait_for_state(…) Calls delete_scheduled_job() and waits for the ScheduledJob acted upon to enter the given state(s).
delete_software_source_and_wait_for_state(…) Calls delete_software_source() and waits for the SoftwareSource acted upon to enter the given state(s).
install_all_package_updates_on_managed_instance_and_wait_for_state(…) Calls install_all_package_updates_on_managed_instance() and waits for the WorkRequest to enter the given state(s).
install_all_updates_on_managed_instance_group_and_wait_for_state(…) Calls install_all_updates_on_managed_instance_group() and waits for the WorkRequest to enter the given state(s).
install_all_windows_updates_on_managed_instance_and_wait_for_state(…) Calls install_all_windows_updates_on_managed_instance() and waits for the WorkRequest to enter the given state(s).
install_package_on_managed_instance_and_wait_for_state(…) Calls install_package_on_managed_instance() and waits for the WorkRequest to enter the given state(s).
install_package_update_on_managed_instance_and_wait_for_state(…) Calls install_package_update_on_managed_instance() and waits for the WorkRequest to enter the given state(s).
install_windows_update_on_managed_instance_and_wait_for_state(…) Calls install_windows_update_on_managed_instance() and waits for the WorkRequest to enter the given state(s).
remove_package_from_managed_instance_and_wait_for_state(…) Calls remove_package_from_managed_instance() and waits for the WorkRequest to enter the given state(s).
update_managed_instance_group_and_wait_for_state(…) Calls update_managed_instance_group() and waits for the ManagedInstanceGroup acted upon to enter the given state(s).
update_scheduled_job_and_wait_for_state(…) Calls update_scheduled_job() and waits for the ScheduledJob acted upon to enter the given state(s).
update_software_source_and_wait_for_state(…) Calls update_software_source() and waits for the SoftwareSource acted upon to enter the given state(s).
__init__(client, **kwargs)

Creates a new OsManagementClientCompositeOperations object

Parameters:client (OsManagementClient) – The service client which will be wrapped by this object
create_managed_instance_group_and_wait_for_state(create_managed_instance_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_managed_instance_group() and waits for the ManagedInstanceGroup acted upon to enter the given state(s).

Parameters:
  • create_managed_instance_group_details (oci.os_management.models.CreateManagedInstanceGroupDetails) – (required) Details about a Managed Instance Group to create
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_managed_instance_group()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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
create_scheduled_job_and_wait_for_state(create_scheduled_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_scheduled_job() and waits for the ScheduledJob acted upon to enter the given state(s).

Parameters:
  • create_scheduled_job_details (oci.os_management.models.CreateScheduledJobDetails) – (required) Details about a Scheduled Job to create
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_scheduled_job()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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
create_software_source_and_wait_for_state(create_software_source_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_software_source() and waits for the SoftwareSource acted upon to enter the given state(s).

Parameters:
  • create_software_source_details (oci.os_management.models.CreateSoftwareSourceDetails) – (required) Details about a Sofware Source to create
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to create_software_source()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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
delete_managed_instance_group_and_wait_for_state(managed_instance_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_managed_instance_group() and waits for the ManagedInstanceGroup acted upon to enter the given state(s).

Parameters:
  • managed_instance_group_id (str) – (required) OCID for the managed instance group
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_managed_instance_group()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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
delete_scheduled_job_and_wait_for_state(scheduled_job_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_scheduled_job() and waits for the ScheduledJob acted upon to enter the given state(s).

Parameters:
  • scheduled_job_id (str) – (required) The ID of the scheduled job.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_scheduled_job()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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
delete_software_source_and_wait_for_state(software_source_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_software_source() and waits for the SoftwareSource acted upon to enter the given state(s).

Parameters:
  • software_source_id (str) – (required) The OCID of the software source.
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to delete_software_source()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_all_package_updates_on_managed_instance_and_wait_for_state(managed_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls install_all_package_updates_on_managed_instance() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • managed_instance_id (str) – (required) OCID for 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 install_all_package_updates_on_managed_instance()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_all_updates_on_managed_instance_group_and_wait_for_state(managed_instance_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls install_all_updates_on_managed_instance_group() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • managed_instance_group_id (str) – (required) OCID for the managed instance group
  • 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_updates_on_managed_instance_group()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_all_windows_updates_on_managed_instance_and_wait_for_state(managed_instance_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls install_all_windows_updates_on_managed_instance() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • managed_instance_id (str) – (required) OCID for 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 install_all_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 pass max_interval_seconds or max_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_package_on_managed_instance_and_wait_for_state(managed_instance_id, software_package_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls install_package_on_managed_instance() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • software_package_name (str) – (required) Package name
  • 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_package_on_managed_instance()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_package_update_on_managed_instance_and_wait_for_state(managed_instance_id, software_package_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls install_package_update_on_managed_instance() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • software_package_name (str) – (required) Package name
  • 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_package_update_on_managed_instance()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_windows_update_on_managed_instance_and_wait_for_state(managed_instance_id, windows_update_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls install_windows_update_on_managed_instance() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • windows_update_name (str) – (required) Unique identifier for the Windows update. NOTE - This is not an OCID, but is a unique identifier assigned by Microsoft. Example: 6981d463-cd91-4a26-b7c4-ea4ded9183ed
  • 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_update_on_managed_instance()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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
remove_package_from_managed_instance_and_wait_for_state(managed_instance_id, software_package_name, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls remove_package_from_managed_instance() and waits for the WorkRequest to enter the given state(s).

Parameters:
  • managed_instance_id (str) – (required) OCID for the managed instance
  • software_package_name (str) – (required) Package name
  • 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_package_from_managed_instance()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_managed_instance_group_and_wait_for_state(managed_instance_group_id, update_managed_instance_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_managed_instance_group() and waits for the ManagedInstanceGroup acted upon to enter the given state(s).

Parameters:
  • managed_instance_group_id (str) – (required) OCID for the managed instance group
  • update_managed_instance_group_details (oci.os_management.models.UpdateManagedInstanceGroupDetails) – (required) Details about a Managed Instance Group to update
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_managed_instance_group()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_scheduled_job_and_wait_for_state(scheduled_job_id, update_scheduled_job_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_scheduled_job() and waits for the ScheduledJob acted upon to enter the given state(s).

Parameters:
  • scheduled_job_id (str) – (required) The ID of the scheduled job.
  • update_scheduled_job_details (oci.os_management.models.UpdateScheduledJobDetails) – (required) Details about a Scheduled Job to update
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_scheduled_job()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_software_source_and_wait_for_state(software_source_id, update_software_source_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_software_source() and waits for the SoftwareSource acted upon to enter the given state(s).

Parameters:
  • software_source_id (str) – (required) The OCID of the software source.
  • update_software_source_details (oci.os_management.models.UpdateSoftwareSourceDetails) – (required) Details about a Sofware Source to update
  • wait_for_states (list[str]) – An array of states to wait on. These should be valid values for lifecycle_state
  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to update_software_source()
  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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