OsManagementClient¶

class oci.os_management.OsManagementClient(config, **kwargs)¶

API for the OS Management service. Use these API operations for working with Managed instances and Managed instance groups.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`add_packages_to_software_source`(…)	Adds a given list of Software Packages to a specific Software Source.
`attach_child_software_source_to_managed_instance`(…)	Adds a child software source to a managed instance.
`attach_managed_instance_to_managed_instance_group`(…)	Adds a Managed Instance to a Managed Instance Group.
`attach_parent_software_source_to_managed_instance`(…)	Adds a parent software source to a managed instance.
`change_managed_instance_group_compartment`(…)	Moves a resource into a different compartment.
`change_scheduled_job_compartment`(…)	Moves a resource into a different compartment.
`change_software_source_compartment`(…)	Moves a resource into a different compartment.
`create_managed_instance_group`(…)	Creates a new Managed Instance Group on the management system.
`create_scheduled_job`(…)	Creates a new Scheduled Job to perform a specific package operation on a set of managed instances or managed instance groups.
`create_software_source`(…)	Creates a new custom Software Source on the management system.
`delete_managed_instance_group`(…)	Deletes a Managed Instance Group from the management system
`delete_scheduled_job`(scheduled_job_id, **kwargs)	Cancels an existing Scheduled Job on the management system
`delete_software_source`(software_source_id, …)	Deletes a custom Software Source on the management system
`detach_child_software_source_from_managed_instance`(…)	Removes a child software source from a managed instance.
`detach_managed_instance_from_managed_instance_group`(…)	Removes a Managed Instance from a Managed Instance Group.
`detach_parent_software_source_from_managed_instance`(…)	Removes a software source from a managed instance.
`disable_module_stream_on_managed_instance`(…)	Disables a module stream on a managed instance.
`enable_module_stream_on_managed_instance`(…)	Enables a module stream on a managed instance.
`get_erratum`(erratum_id, **kwargs)	Returns a specific erratum.
`get_managed_instance`(managed_instance_id, …)	Returns a specific Managed Instance.
`get_managed_instance_group`(…)	Returns a specific Managed Instance Group.
`get_module_stream`(software_source_id, …)	Retrieve a detailed description of a module stream from a software source.
`get_module_stream_profile`(…)	Retrieve a detailed description of a module stream profile from a software source.
`get_scheduled_job`(scheduled_job_id, **kwargs)	Gets the detailed information for the Scheduled Job with the given ID.
`get_software_package`(software_source_id, …)	Returns a specific Software Package.
`get_software_source`(software_source_id, **kwargs)	Returns a specific Software Source.
`get_windows_update`(windows_update, **kwargs)	Returns a Windows Update object.
`get_work_request`(work_request_id, **kwargs)	Gets the detailed information for the work request with the given ID.
`install_all_package_updates_on_managed_instance`(…)	Install all of the available package updates for the managed instance.
`install_all_updates_on_managed_instance_group`(…)	Install all of the available updates for the Managed Instance Group.
`install_all_windows_updates_on_managed_instance`(…)	Install all of the available Windows updates for the managed instance.
`install_module_stream_profile_on_managed_instance`(…)	Installs a profile for an module stream.
`install_package_on_managed_instance`(…)	Installs a package on a managed instance.
`install_package_update_on_managed_instance`(…)	Updates a package on a managed instance.
`install_windows_update_on_managed_instance`(…)	Installs a Windows update on a managed instance.
`list_available_packages_for_managed_instance`(…)	Returns a list of packages available for install on the Managed Instance.
`list_available_software_sources_for_managed_instance`(…)	Returns a list of available software sources for a Managed Instance.
`list_available_updates_for_managed_instance`(…)	Returns a list of available updates for a Managed Instance.
`list_available_windows_updates_for_managed_instance`(…)	Returns a list of available Windows updates for a Managed Instance.
`list_errata`(**kwargs)	Returns a list of all of the currently available Errata in the system
`list_managed_instance_errata`(…)	Returns a list of errata relevant to the Managed Instance.
`list_managed_instance_groups`(compartment_id, …)	Returns a list of all Managed Instance Groups.
`list_managed_instances`(compartment_id, **kwargs)	Returns a list of all Managed Instances.
`list_module_stream_profiles`(…)	Retrieve a list of module stream profiles from a software source.
`list_module_stream_profiles_on_managed_instance`(…)	Retrieve a list of module stream profiles, along with a summary of their of their status, from a managed instance.
`list_module_streams`(software_source_id, **kwargs)	Retrieve a list of module streams from a software source.
`list_module_streams_on_managed_instance`(…)	Retrieve a list of module streams, along with a summary of their status, from a managed instance.
`list_packages_installed_on_managed_instance`(…)	Returns a list of installed packages on the Managed Instance.
`list_scheduled_jobs`(compartment_id, **kwargs)	Returns a list of all of the currently active Scheduled Jobs in the system
`list_software_source_packages`(…)	Lists Software Packages in a Software Source
`list_software_sources`(compartment_id, **kwargs)	Returns a list of all Software Sources.
`list_upcoming_scheduled_jobs`(compartment_id, …)	Returns a list of all of the Scheduled Jobs whose next execution time is at or before the specified time.
`list_windows_updates`(**kwargs)	Returns a list of Windows Updates.
`list_windows_updates_installed_on_managed_instance`(…)	Returns a list of installed Windows updates for a Managed Instance.
`list_work_request_errors`(work_request_id, …)	Gets the errors for the work request with the given ID.
`list_work_request_logs`(work_request_id, **kwargs)	Lists the log entries for the work request with the given ID.
`list_work_requests`(compartment_id, **kwargs)	Lists the work requests in a compartment.
`manage_module_streams_on_managed_instance`(…)	Perform an operation involving modules, streams, and profiles on a managed instance.
`remove_module_stream_profile_from_managed_instance`(…)	Removes a profile for a module stream that is installed on a managed instance.
`remove_package_from_managed_instance`(…)	Removes an installed package from a managed instance.
`remove_packages_from_software_source`(…)	Removes a given list of Software Packages from a specific Software Source.
`run_scheduled_job_now`(scheduled_job_id, **kwargs)	This will trigger an already created Scheduled Job to being executing immediately instead of waiting for its next regularly scheduled time.
`search_software_packages`(**kwargs)	Searches all of the available Software Sources and returns any/all Software Packages matching the search criteria.
`skip_next_scheduled_job_execution`(…)	This will force an already created Scheduled Job to skip its
`switch_module_stream_on_managed_instance`(…)	Enables a new stream for a module that already has a stream enabled.
`update_managed_instance`(managed_instance_id, …)	Updates a specific Managed Instance.
`update_managed_instance_group`(…)	Updates a specific Managed Instance Group.
`update_scheduled_job`(scheduled_job_id, …)	Updates an existing Scheduled Job on the management system.
`update_software_source`(software_source_id, …)	Updates an existing custom Software Source on the management system.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

add_packages_to_software_source(software_source_id, add_packages_to_software_source_details, **kwargs)¶

Adds a given list of Software Packages to a specific Software Source.

Parameters:	software_source_id (str) – (required) The OCID of the software source. add_packages_to_software_source_details (oci.os_management.models.AddPackagesToSoftwareSourceDetails) – (required) A list of package identifiers opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use add_packages_to_software_source API.

attach_child_software_source_to_managed_instance(managed_instance_id, attach_child_software_source_to_managed_instance_details, **kwargs)¶

Adds a child software source to a managed instance. After the software source has been added, then packages from that software source can be installed on the managed instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance attach_child_software_source_to_managed_instance_details (oci.os_management.models.AttachChildSoftwareSourceToManagedInstanceDetails) – (required) Details for attaching a Software Source to a Managed Instance opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use attach_child_software_source_to_managed_instance API.

attach_managed_instance_to_managed_instance_group(managed_instance_group_id, managed_instance_id, **kwargs)¶

Adds a Managed Instance to a Managed Instance Group. After the Managed Instance has been added, then operations can be performed on the Managed Instance Group which will then apply to all Managed Instances in the group.

Parameters:	managed_instance_group_id (str) – (required) OCID for the managed instance group managed_instance_id (str) – (required) OCID for the managed instance opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use attach_managed_instance_to_managed_instance_group API.

attach_parent_software_source_to_managed_instance(managed_instance_id, attach_parent_software_source_to_managed_instance_details, **kwargs)¶

Adds a parent software source to a managed instance. After the software source has been added, then packages from that software source can be installed on the managed instance. Software sources that have this software source as a parent will be able to be added to this managed instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance attach_parent_software_source_to_managed_instance_details (oci.os_management.models.AttachParentSoftwareSourceToManagedInstanceDetails) – (required) Details for attaching a Software Source to a Managed Instance opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use attach_parent_software_source_to_managed_instance API.

change_managed_instance_group_compartment(managed_instance_group_id, change_managed_instance_group_compartment_details, **kwargs)¶

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters:	managed_instance_group_id (str) – (required) OCID for the managed instance group change_managed_instance_group_compartment_details (oci.os_management.models.ChangeManagedInstanceGroupCompartmentDetails) – (required) OCID for the compartment to which the resource will be moved. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_managed_instance_group_compartment API.

change_scheduled_job_compartment(scheduled_job_id, change_scheduled_job_compartment_details, **kwargs)¶

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters:	scheduled_job_id (str) – (required) The ID of the scheduled job. change_scheduled_job_compartment_details (oci.os_management.models.ChangeScheduledJobCompartmentDetails) – (required) OCID for the compartment to which the resource will be moved. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_scheduled_job_compartment API.

change_software_source_compartment(software_source_id, change_software_source_compartment_details, **kwargs)¶

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters:	software_source_id (str) – (required) The OCID of the software source. change_software_source_compartment_details (oci.os_management.models.ChangeSoftwareSourceCompartmentDetails) – (required) OCID for the compartment to which the resource will be moved. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_software_source_compartment API.

create_managed_instance_group(create_managed_instance_group_details, **kwargs)¶

Creates a new Managed Instance Group on the management system. This will not contain any managed instances after it is first created, and they must be added later.

Parameters:	create_managed_instance_group_details (oci.os_management.models.CreateManagedInstanceGroupDetails) – (required) Details about a Managed Instance Group to create opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagedInstanceGroup`
Return type:	`Response`
Example:

Click here to see an example of how to use create_managed_instance_group API.

create_scheduled_job(create_scheduled_job_details, **kwargs)¶

Creates a new Scheduled Job to perform a specific package operation on a set of managed instances or managed instance groups. Can be created as a one-time execution in the future, or as a recurring execution that repeats on a defined interval.

Parameters:	create_scheduled_job_details (oci.os_management.models.CreateScheduledJobDetails) – (required) Details about a Scheduled Job to create opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ScheduledJob`
Return type:	`Response`
Example:

Click here to see an example of how to use create_scheduled_job API.

create_software_source(create_software_source_details, **kwargs)¶

Creates a new custom Software Source on the management system. This will not contain any packages after it is first created, and they must be added later.

Parameters:	create_software_source_details (oci.os_management.models.CreateSoftwareSourceDetails) – (required) Details about a Sofware Source to create opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SoftwareSource`
Return type:	`Response`
Example:

Click here to see an example of how to use create_software_source API.

delete_managed_instance_group(managed_instance_group_id, **kwargs)¶

Deletes a Managed Instance Group from the management system

Parameters:	managed_instance_group_id (str) – (required) OCID for the managed instance group opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_managed_instance_group API.

delete_scheduled_job(scheduled_job_id, **kwargs)¶

Cancels an existing Scheduled Job on the management system

Parameters:	scheduled_job_id (str) – (required) The ID of the scheduled job. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_scheduled_job API.

delete_software_source(software_source_id, **kwargs)¶

Deletes a custom Software Source on the management system

Parameters:	software_source_id (str) – (required) The OCID of the software source. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_software_source API.

detach_child_software_source_from_managed_instance(managed_instance_id, detach_child_software_source_from_managed_instance_details, **kwargs)¶

Removes a child software source from a managed instance. Packages will no longer be able to be installed from these software sources.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance detach_child_software_source_from_managed_instance_details (oci.os_management.models.DetachChildSoftwareSourceFromManagedInstanceDetails) – (required) Details for detaching a Software Source from a Managed Instance opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use detach_child_software_source_from_managed_instance API.

detach_managed_instance_from_managed_instance_group(managed_instance_group_id, managed_instance_id, **kwargs)¶

Removes a Managed Instance from a Managed Instance Group.

Parameters:	managed_instance_group_id (str) – (required) OCID for the managed instance group managed_instance_id (str) – (required) OCID for the managed instance opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use detach_managed_instance_from_managed_instance_group API.

detach_parent_software_source_from_managed_instance(managed_instance_id, detach_parent_software_source_from_managed_instance_details, **kwargs)¶

Removes a software source from a managed instance. All child software sources will also be removed from the managed instance. Packages will no longer be able to be installed from these software sources.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance detach_parent_software_source_from_managed_instance_details (oci.os_management.models.DetachParentSoftwareSourceFromManagedInstanceDetails) – (required) Details for detaching a Software Source from a Managed Instance opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use detach_parent_software_source_from_managed_instance API.

disable_module_stream_on_managed_instance(managed_instance_id, module_name, **kwargs)¶

Disables a module stream on a managed instance. After the stream is disabled, it is no longer possible to install the profiles that are contained by the stream. All installed profiles must be removed prior to disabling a module stream.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance module_name (str) – (required) The name of a module. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. stream_name (str) – (optional) The name of the stream of the containing module. This parameter is required if a profileName is specified. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use disable_module_stream_on_managed_instance API.

enable_module_stream_on_managed_instance(managed_instance_id, module_name, **kwargs)¶

Enables a module stream on a managed instance. After the stream is enabled, it is possible to install the profiles that are contained by the stream. Enabling a stream that is already enabled will succeed. Attempting to enable a different stream for a module that already has a stream enabled results in an error.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance module_name (str) – (required) The name of a module. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. stream_name (str) – (optional) The name of the stream of the containing module. This parameter is required if a profileName is specified. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use enable_module_stream_on_managed_instance API.

get_erratum(erratum_id, **kwargs)¶

Returns a specific erratum.

Parameters:	erratum_id (str) – (required) The OCID of the erratum. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Erratum`
Return type:	`Response`
Example:

Click here to see an example of how to use get_erratum API.

get_managed_instance(managed_instance_id, **kwargs)¶

Returns a specific Managed Instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagedInstance`
Return type:	`Response`
Example:

Click here to see an example of how to use get_managed_instance API.

get_managed_instance_group(managed_instance_group_id, **kwargs)¶

Returns a specific Managed Instance Group.

Parameters:	managed_instance_group_id (str) – (required) OCID for the managed instance group opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagedInstanceGroup`
Return type:	`Response`
Example:

Click here to see an example of how to use get_managed_instance_group API.

get_module_stream(software_source_id, module_name, stream_name, **kwargs)¶

Retrieve a detailed description of a module stream from a software source.

Parameters:	software_source_id (str) – (required) The OCID of the software source. module_name (str) – (required) The name of the module stream_name (str) – (required) The name of the stream of the containing module opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ModuleStream`
Return type:	`Response`
Example:

Click here to see an example of how to use get_module_stream API.

get_module_stream_profile(software_source_id, module_name, stream_name, profile_name, **kwargs)¶

Retrieve a detailed description of a module stream profile from a software source.

Parameters:	software_source_id (str) – (required) The OCID of the software source. module_name (str) – (required) The name of the module stream_name (str) – (required) The name of the stream of the containing module profile_name (str) – (required) The name of the profile of the containing module stream opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ModuleStreamProfile`
Return type:	`Response`
Example:

Click here to see an example of how to use get_module_stream_profile API.

get_scheduled_job(scheduled_job_id, **kwargs)¶

Gets the detailed information for the Scheduled Job with the given ID.

Parameters:	scheduled_job_id (str) – (required) The ID of the scheduled job. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ScheduledJob`
Return type:	`Response`
Example:

Click here to see an example of how to use get_scheduled_job API.

get_software_package(software_source_id, software_package_name, **kwargs)¶

Returns a specific Software Package.

Parameters:	software_source_id (str) – (required) The OCID of the software source. software_package_name (str) – (required) The id of the software package. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SoftwarePackage`
Return type:	`Response`
Example:

Click here to see an example of how to use get_software_package API.

get_software_source(software_source_id, **kwargs)¶

Returns a specific Software Source.

Parameters:	software_source_id (str) – (required) The OCID of the software source. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SoftwareSource`
Return type:	`Response`
Example:

Click here to see an example of how to use get_software_source API.

get_windows_update(windows_update, **kwargs)¶

Returns a Windows Update object.

Parameters:	windows_update (str) – (required) The Windows Update opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WindowsUpdate`
Return type:	`Response`
Example:

Click here to see an example of how to use get_windows_update API.

get_work_request(work_request_id, **kwargs)¶

Gets the detailed information for the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use get_work_request API.

install_all_package_updates_on_managed_instance(managed_instance_id, **kwargs)¶

Install all of the available package updates for the managed instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance update_type (str) – (optional) The type of updates to be applied Allowed values are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”, “OTHER”, “KSPLICE”, “ALL” opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use install_all_package_updates_on_managed_instance API.

install_all_updates_on_managed_instance_group(managed_instance_group_id, **kwargs)¶

Install all of the available updates for the Managed Instance Group.

Parameters:	managed_instance_group_id (str) – (required) OCID for the managed instance group update_type (str) – (optional) The type of updates to be applied Allowed values are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”, “OTHER”, “KSPLICE”, “ALL” opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use install_all_updates_on_managed_instance_group API.

install_all_windows_updates_on_managed_instance(managed_instance_id, **kwargs)¶

Install all of the available Windows updates for the managed instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance update_type (str) – (optional) The type of updates to be applied Allowed values are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”, “OTHER”, “KSPLICE”, “ALL” opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use install_all_windows_updates_on_managed_instance API.

install_module_stream_profile_on_managed_instance(managed_instance_id, module_name, **kwargs)¶

Installs a profile for an module stream. The stream must be enabled before a profile can be installed. If a module stream defines multiple profiles, each one can be installed independently.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance module_name (str) – (required) The name of a module. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. stream_name (str) – (optional) The name of the stream of the containing module. This parameter is required if a profileName is specified. profile_name (str) – (optional) The name of the profile of the containing module stream retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use install_module_stream_profile_on_managed_instance API.

install_package_on_managed_instance(managed_instance_id, software_package_name, **kwargs)¶

Installs a package on a managed instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance software_package_name (str) – (required) Package name opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use install_package_on_managed_instance API.

install_package_update_on_managed_instance(managed_instance_id, software_package_name, **kwargs)¶

Updates a package on a managed instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance software_package_name (str) – (required) Package name opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use install_package_update_on_managed_instance API.

install_windows_update_on_managed_instance(managed_instance_id, windows_update_name, **kwargs)¶

Installs a Windows update on a managed instance.

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 opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use install_windows_update_on_managed_instance API.

list_available_packages_for_managed_instance(managed_instance_id, **kwargs)¶

Returns a list of packages available for install on the Managed Instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `InstallablePackageSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_available_packages_for_managed_instance API.

list_available_software_sources_for_managed_instance(managed_instance_id, **kwargs)¶

Returns a list of available software sources for a Managed Instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `AvailableSoftwareSourceSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_available_software_sources_for_managed_instance API.

list_available_updates_for_managed_instance(managed_instance_id, **kwargs)¶

Returns a list of available updates for a Managed Instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `AvailableUpdateSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_available_updates_for_managed_instance API.

list_available_windows_updates_for_managed_instance(managed_instance_id, **kwargs)¶

Returns a list of available Windows updates for a Managed Instance. This is only applicable to Windows instances.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. is_eligible_for_installation (str) – (optional) Indicator of whether the update can be installed using OSMS. Allowed values are: “INSTALLABLE”, “NOT_INSTALLABLE”, “UNKNOWN” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `AvailableWindowsUpdateSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_available_windows_updates_for_managed_instance API.

list_errata(**kwargs)¶

Returns a list of all of the currently available Errata in the system

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. erratum_id (str) – (optional) The OCID of the erratum. advisory_name (str) – (optional) The assigned erratum name. It’s unique and not changeable. Example: ELSA-2020-5804 time_issue_date_start (datetime) – (optional) The issue date after which to list all errata, in ISO 8601 format Example: 2017-07-14T02:40:00.000Z time_issue_date_end (datetime) – (optional) The issue date before which to list all errata, in ISO 8601 format Example: 2017-07-14T02:40:00.000Z limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort errata by. Only one sort order may be provided. Default order for ISSUEDATE is descending. Default order for ADVISORYNAME is ascending. If no value is specified ISSUEDATE is default. Allowed values are: “ISSUEDATE”, “ADVISORYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ErratumSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_errata API.

list_managed_instance_errata(managed_instance_id, **kwargs)¶

Returns a list of errata relevant to the Managed Instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ErratumSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_managed_instance_errata API.

list_managed_instance_groups(compartment_id, **kwargs)¶

Returns a list of all Managed Instance Groups.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. lifecycle_state (str) – (optional) The current lifecycle state for the object. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” os_family (str) – (optional) The OS family for which to list resources. Allowed values are: “LINUX”, “WINDOWS”, “ALL” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ManagedInstanceGroupSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_managed_instance_groups API.

list_managed_instances(compartment_id, **kwargs)¶

Returns a list of all Managed Instances.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. os_family (str) – (optional) The OS family for which to list resources. Allowed values are: “LINUX”, “WINDOWS”, “ALL” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ManagedInstanceSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_managed_instances API.

list_module_stream_profiles(software_source_id, **kwargs)¶

Retrieve a list of module stream profiles from a software source. Filters may be applied to select a subset of module stream profiles based on the filter criteria.

The “moduleName”, “streamName”, and “profileName” attributes combine to form a set of filters on the list of module stream profiles. If a “moduleName” is provided, only profiles that belong to that module are returned. If both a “moduleName” and “streamName” are given, only profiles belonging to that module stream are returned. Finally, if all three are given then only the particular profile indicated by the triple is returned. It is not valid to supply a “streamName” without a “moduleName”. It is also not valid to supply a “profileName” without a “streamName”.

Parameters:	software_source_id (str) – (required) The OCID of the software source. compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. module_name (str) – (optional) The name of a module. This parameter is required if a streamName is specified. stream_name (str) – (optional) The name of the stream of the containing module. This parameter is required if a profileName is specified. profile_name (str) – (optional) The name of the profile of the containing module stream limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ModuleStreamProfileSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_module_stream_profiles API.

list_module_stream_profiles_on_managed_instance(managed_instance_id, **kwargs)¶

Retrieve a list of module stream profiles, along with a summary of their of their status, from a managed instance. Filters may be applied to select a subset of profiles based on the filter criteria.

The “moduleName”, “streamName”, and “profileName” attributes combine to form a set of filters on the list of module stream profiles. If a “modulName” is provided, only profiles that belong to that module are returned. If both a “moduleName” and “streamName” are given, only profiles belonging to that module stream are returned. Finally, if all three are given then only the particular profile indicated by the triple is returned. It is not valid to supply a “streamName” without a “moduleName”. It is also not valid to supply a “profileName” without a “streamName”.

The “status” attribute filters against the state of a module stream profile. Valid values are “INSTALLED” and “AVAILABLE”. If the attribute is set to “INSTALLED”, only module stream profiles that are installed are included in the result set. If the attribute is set to “AVAILABLE”, only module stream profiles that are not installed are included in the result set. If the attribute is not defined, the request is not subject to this filter.

When sorting by display name, the result set is sorted first by module name, then by stream name, and finally by profile name.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. module_name (str) – (optional) The name of a module. This parameter is required if a streamName is specified. stream_name (str) – (optional) The name of the stream of the containing module. This parameter is required if a profileName is specified. profile_name (str) – (optional) The name of the profile of the containing module stream profile_status (str) – (optional) The status of the profile. A profile with the “INSTALLED” status indicates that the profile has been installed. A profile with the “AVAILABLE” status indicates that the profile is not installed, but can be. Allowed values are: “INSTALLED”, “AVAILABLE” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ModuleStreamProfileOnManagedInstanceSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_module_stream_profiles_on_managed_instance API.

list_module_streams(software_source_id, **kwargs)¶

Retrieve a list of module streams from a software source. Filters may be applied to select a subset of module streams based on the filter criteria.

The ‘moduleName’ attribute filters against the name of a module. It accepts strings of the format “<module>”. If this attribute is defined, only streams that belong to the specified module are included in the result set. If it is not defined, the request is not subject to this filter. The ‘streamName’ attribute filters against the name of a stream of a module. If this attribute is defined, only the particular module stream that matches both the module and stream names is included in the result set. It is not valid to supply ‘streamName’ without also supplying a ‘moduleName’.

When sorting by display name, the result set is sorted first by module name, then by stream name.

Parameters:	software_source_id (str) – (required) The OCID of the software source. compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. module_name (str) – (optional) The name of a module. This parameter is required if a streamName is specified. stream_name (str) – (optional) The name of the stream of the containing module. This parameter is required if a profileName is specified. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ModuleStreamSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_module_streams API.

list_module_streams_on_managed_instance(managed_instance_id, **kwargs)¶

Retrieve a list of module streams, along with a summary of their status, from a managed instance. Filters may be applied to select a subset of module streams based on the filter criteria.

The ‘moduleName’ attribute filters against the name of a module. It accepts strings of the format “<module>”. If this attribute is defined, only streams that belong to the specified module are included in the result set. If it is not defined, the request is not subject to this filter.

The “status” attribute filters against the state of a module stream. Valid values are “ENABLED”, “DISABLED”, and “ACTIVE”. If the attribute is set to “ENABLED”, only module streams that are enabled are included in the result set. If the attribute is set to “DISABLED”, only module streams that are not enabled are included in the result set. If the attribute is set to “ACTIVE”, only module streams that are active are included in the result set. If the attribute is not defined, the request is not subject to this filter.

When sorting by the display name, the result set is sorted first by the module name and then by the stream name.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. module_name (str) – (optional) The name of a module. This parameter is required if a streamName is specified. stream_name (str) – (optional) The name of the stream of the containing module. This parameter is required if a profileName is specified. stream_status (str) – (optional) The status of the stream A stream with the “ENABLED” status can be used as a source for installing profiles. Streams with this status are also “ACTIVE”. A stream with the “DISABLED” status cannot be the source for installing profiles. To install profiles and packages from this stream, it must be enabled. A stream with the “ACTIVE” status can be used as a source for installing profiles. The packages that comprise the stream are also used when a matching package is installed directly. In general, a stream can have this status if it is the default stream for the module and no stream has been explicitly enabled. Allowed values are: “ENABLED”, “DISABLED”, “ACTIVE” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ModuleStreamOnManagedInstanceSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_module_streams_on_managed_instance API.

list_packages_installed_on_managed_instance(managed_instance_id, **kwargs)¶

Returns a list of installed packages on the Managed Instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `InstalledPackageSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_packages_installed_on_managed_instance API.

list_scheduled_jobs(compartment_id, **kwargs)¶

Returns a list of all of the currently active Scheduled Jobs in the system

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource managed_instance_id (str) – (optional) The ID of the managed instance for which to list resources. managed_instance_group_id (str) – (optional) The ID of the managed instace group for which to list resources. operation_type (str) – (optional) The operation type for which to list resources Allowed values are: “INSTALL”, “UPDATE”, “REMOVE”, “UPDATEALL”, “ENABLEMODULESTREAM”, “DISABLEMODULESTREAM”, “SWITCHMODULESTREAM”, “INSTALLMODULESTREAMPROFILE”, “REMOVEMODULESTREAMPROFILE”, “COMPOUND” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” lifecycle_state (str) – (optional) The current lifecycle state for the object. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” opc_request_id (str) – (optional) The client request ID for tracing. os_family (str) – (optional) The OS family for which to list resources. Allowed values are: “LINUX”, “WINDOWS”, “ALL” is_restricted (bool) – (optional) If true, will only filter out restricted Autonomous Linux Scheduled Job retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ScheduledJobSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_scheduled_jobs API.

list_software_source_packages(software_source_id, **kwargs)¶

Lists Software Packages in a Software Source

Parameters:	software_source_id (str) – (required) The OCID of the software source. compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `SoftwarePackageSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_software_source_packages API.

list_software_sources(compartment_id, **kwargs)¶

Returns a list of all Software Sources.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” lifecycle_state (str) – (optional) The current lifecycle state for the object. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `SoftwareSourceSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_software_sources API.

list_upcoming_scheduled_jobs(compartment_id, time_end, **kwargs)¶

Returns a list of all of the Scheduled Jobs whose next execution time is at or before the specified time.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. time_end (datetime) – (required) The cut-off time before which to list all upcoming schedules, in ISO 8601 format Example: 2017-07-14T02:40:00.000Z display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” tag_name (str) – (optional) The name of the tag. tag_value (str) – (optional) The value for the tag. lifecycle_state (str) – (optional) The current lifecycle state for the object. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” opc_request_id (str) – (optional) The client request ID for tracing. os_family (str) – (optional) The OS family for which to list resources. Allowed values are: “LINUX”, “WINDOWS”, “ALL” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ScheduledJobSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_upcoming_scheduled_jobs API.

list_windows_updates(**kwargs)¶

Returns a list of Windows Updates.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WindowsUpdateSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_windows_updates API.

list_windows_updates_installed_on_managed_instance(managed_instance_id, **kwargs)¶

Returns a list of installed Windows updates for a Managed Instance. This is only applicable to Windows instances.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource compartment_id (str) – (optional) The ID of the compartment in which to list resources. This parameter is optional and in some cases may have no effect. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `InstalledWindowsUpdateSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_windows_updates_installed_on_managed_instance API.

list_work_request_errors(work_request_id, **kwargs)¶

Gets the errors for the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequestError`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)¶

Lists the log entries for the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequestLogEntry`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(compartment_id, **kwargs)¶

Lists the work requests in a compartment.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource managed_instance_id (str) – (optional) The ID of the managed instance for which to list resources. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. os_family (str) – (optional) The OS family for which to list resources. Allowed values are: “LINUX”, “WINDOWS”, “ALL” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequestSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_requests API.

manage_module_streams_on_managed_instance(managed_instance_id, manage_module_streams_on_managed_instance_details, **kwargs)¶

Perform an operation involving modules, streams, and profiles on a managed instance. Each operation may enable or disable an arbitrary amount of module streams, and install or remove an arbitrary number of module stream profiles. When the operation is complete, the state of the modules, streams, and profiles on the managed instance will match the state indicated in the operation.

Each module stream specified in the list of module streams to enable will be in the “ENABLED” state upon completion of the operation. If there was already a stream of that module enabled, any work required to switch from the current stream to the new stream is performed implicitly.

Each module stream specified in the list of module streams to disable will be in the “DISABLED” state upon completion of the operation. Any profiles that are installed for the module stream will be removed as part of the operation.

Each module stream profile specified in the list of profiles to install will be in the “INSTALLED” state upon completion of the operation, indicating that any packages that are part of the profile are installed on the managed instance. If the module stream containing the profile is not enabled, it will be enabled as part of the operation. There is an exception when attempting to install a stream of a profile when another stream of the same module is enabled. It is an error to attempt to install a profile of another module stream, unless enabling the new module stream is explicitly included in this operation.

Each module stream profile specified in the list of profiles to remove will be in the “AVAILABLE” state upon completion of the operation. The status of packages within the profile after the operation is complete is defined by the package manager on the managed instance.

Operations that contain one or more elements that are not allowed are rejected.

The result of this request is a WorkRequest object. The returned WorkRequest is the parent of a structure of other WorkRequests. Taken as a whole, this structure indicates the entire set of work to be performed to complete the operation.

This interface can also be used to perform a dry run of the operation rather than committing it to a managed instance. If a dry run is requested, the OS Management Service will evaluate the operation against the current module, stream, and profile state on the managed instance. It will calculate the impact of the operation on all modules, streams, and profiles on the managed instance, including those that are implicitly impacted by the operation.

The WorkRequest resulting from a dry run behaves differently than a WorkRequest resulting from a committable operation. Dry run WorkRequests are always singletons and never have children. The impact of the operation is returned using the log and error facilities of WorkRequests. The impact of operations that are allowed by the OS Management Service are communicated as one or more work request log entries. Operations that are not allowed by the OS Management Service are communicated as one or more work requst error entries. Each entry, for either logs or errors, contains a structured message containing the results of one or more operations.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance manage_module_streams_on_managed_instance_details (oci.os_management.models.ManageModuleStreamsOnManagedInstanceDetails) – (required) A description of an operation to perform against the modules, streams, and profiles of a managed instance opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use manage_module_streams_on_managed_instance API.

remove_module_stream_profile_from_managed_instance(managed_instance_id, module_name, **kwargs)¶

Removes a profile for a module stream that is installed on a managed instance. If a module stream is provided, rather than a fully qualified profile, all profiles that have been installed for the module stream will be removed.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance module_name (str) – (required) The name of a module. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. stream_name (str) – (optional) The name of the stream of the containing module. This parameter is required if a profileName is specified. profile_name (str) – (optional) The name of the profile of the containing module stream retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use remove_module_stream_profile_from_managed_instance API.

remove_package_from_managed_instance(managed_instance_id, software_package_name, **kwargs)¶

Removes an installed package from a managed instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance software_package_name (str) – (required) Package name opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use remove_package_from_managed_instance API.

remove_packages_from_software_source(software_source_id, remove_packages_from_software_source_details, **kwargs)¶

Removes a given list of Software Packages from a specific Software Source.

Parameters:	software_source_id (str) – (required) The OCID of the software source. remove_packages_from_software_source_details (oci.os_management.models.RemovePackagesFromSoftwareSourceDetails) – (required) A list of package identifiers opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use remove_packages_from_software_source API.

run_scheduled_job_now(scheduled_job_id, **kwargs)¶

This will trigger an already created Scheduled Job to being executing immediately instead of waiting for its next regularly scheduled time.

Parameters:	scheduled_job_id (str) – (required) The ID of the scheduled job. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use run_scheduled_job_now API.

search_software_packages(**kwargs)¶

Searches all of the available Software Sources and returns any/all Software Packages matching the search criteria.

Parameters:	software_package_name (str) – (optional) the identifier for the software package (not an OCID) display_name (str) – (optional) A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource cve_name (str) – (optional) The name of the CVE as published. Example: CVE-2006-4535 limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “TIMECREATED”, “DISPLAYNAME” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `SoftwarePackageSearchSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use search_software_packages API.

skip_next_scheduled_job_execution(scheduled_job_id, **kwargs)¶

This will force an already created Scheduled Job to skip its next regularly scheduled execution

Parameters:	scheduled_job_id (str) – (required) The ID of the scheduled job. opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use skip_next_scheduled_job_execution API.

switch_module_stream_on_managed_instance(managed_instance_id, module_name, **kwargs)¶

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.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance module_name (str) – (required) The name of a module. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. stream_name (str) – (optional) The name of the stream of the containing module. This parameter is required if a profileName is specified. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use switch_module_stream_on_managed_instance API.

update_managed_instance(managed_instance_id, update_managed_instance_details, **kwargs)¶

Updates a specific Managed Instance.

Parameters:	managed_instance_id (str) – (required) OCID for the managed instance update_managed_instance_details (oci.os_management.models.UpdateManagedInstanceDetails) – (required) Details about a Managed Instance to update opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagedInstance`
Return type:	`Response`
Example:

Click here to see an example of how to use update_managed_instance API.

update_managed_instance_group(managed_instance_group_id, update_managed_instance_group_details, **kwargs)¶

Updates a specific Managed Instance Group.

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 opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ManagedInstanceGroup`
Return type:	`Response`
Example:

Click here to see an example of how to use update_managed_instance_group API.

update_scheduled_job(scheduled_job_id, update_scheduled_job_details, **kwargs)¶

Updates an existing Scheduled Job on the management system.

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 opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ScheduledJob`
Return type:	`Response`
Example:

Click here to see an example of how to use update_scheduled_job API.

update_software_source(software_source_id, update_software_source_details, **kwargs)¶

Updates an existing custom Software Source on the management system.

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 opc_request_id (str) – (optional) The client request ID for tracing. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SoftwareSource`
Return type:	`Response`
Example:

Click here to see an example of how to use update_software_source API.