ManagedInstanceClient¶

class oci.os_management_hub.ManagedInstanceClient(config, **kwargs)¶

Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. For more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`attach_profile_to_managed_instance`(…)	Adds profile to a managed instance.
`attach_software_sources_to_managed_instance`(…)	Adds software sources to a managed instance.
`delete_managed_instance`(managed_instance_id, …)	Unregisters the specified managed instance from the service.
`detach_profile_from_managed_instance`(…)	Detaches profile from a managed instance.
`detach_software_sources_from_managed_instance`(…)	Removes software sources 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_managed_instance`(managed_instance_id, …)	Gets information about the specified managed instance.
`get_windows_update`(windows_update_id, **kwargs)	Returns a Windows Update object.
`install_all_windows_updates_on_managed_instances_in_compartment`(…)	Installs all of the available Windows updates for managed instances in a compartment.
`install_module_stream_profile_on_managed_instance`(…)	Installs a profile for an module stream.
`install_packages_on_managed_instance`(…)	Installs packages on a managed instance.
`install_windows_updates_on_managed_instance`(…)	Installs Windows updates on the specified managed instance.
`list_managed_instance_available_packages`(…)	Returns a list of packages that are available for installation on a managed instance.
`list_managed_instance_available_software_sources`(…)	Returns a list of software sources that can be attached to the specified managed instance.
`list_managed_instance_available_windows_updates`(…)	Returns a list of Windows updates that can be installed on the specified managed instance.
`list_managed_instance_errata`(…)	Returns a list of applicable errata on the managed instance.
`list_managed_instance_installed_packages`(…)	Lists the packages that are installed on the managed instance.
`list_managed_instance_installed_windows_updates`(…)	Returns a list of Windows updates that have been installed on the specified managed instance.
`list_managed_instance_modules`(…)	Retrieves a list of modules, along with streams of the modules, from a managed instance.
`list_managed_instance_updatable_packages`(…)	Returns a list of updatable packages for a managed instance.
`list_managed_instances`(**kwargs)	Lists managed instances that match the specified compartment or managed instance OCID.
`list_windows_updates`(compartment_id, **kwargs)	Lists Windows updates that have been reported to the service.
`manage_module_streams_on_managed_instance`(…)	Enables or disables module streams and installs or removes module stream profiles.
`refresh_software_on_managed_instance`(…)	Refreshes the package or Windows update information on a managed instance with the latest data from the software source.
`remove_module_stream_profile_from_managed_instance`(…)	Removes a profile for a module stream that is installed on a managed instance.
`remove_packages_from_managed_instance`(…)	Removes an installed package from a managed instance.
`switch_module_stream_on_managed_instance`(…)	Enables a new stream for a module that already has a stream enabled.
`update_all_packages_on_managed_instances_in_compartment`(…)	Install all of the available package updates for all of the managed instances in a compartment.
`update_managed_instance`(managed_instance_id, …)	Updates the specified managed instance information, such as description, ONS topic, and associated management station.
`update_packages_on_managed_instance`(…)	Updates a package on a managed instance.

__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.

attach_profile_to_managed_instance(managed_instance_id, attach_profile_to_managed_instance_details, **kwargs)¶

Adds profile to a managed instance. After the profile has been added, the instance can be registered as a managed instance.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. attach_profile_to_managed_instance_details (oci.os_management_hub.models.AttachProfileToManagedInstanceDetails) – (required) Details of the registration profile to be attached to a managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_profile_to_managed_instance API.

attach_software_sources_to_managed_instance(managed_instance_id, attach_software_sources_to_managed_instance_details, **kwargs)¶

Adds software sources 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) The OCID of the managed instance. attach_software_sources_to_managed_instance_details (oci.os_management_hub.models.AttachSoftwareSourcesToManagedInstanceDetails) – (required) Details of software sources to be attached to a managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_software_sources_to_managed_instance API.

delete_managed_instance(managed_instance_id, **kwargs)¶

Unregisters the specified managed instance from the service. Once unregistered, the service will no longer manage the instance. For Linux instances, yum or DNF repository files will be restored to their state prior to registration.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 API.

detach_profile_from_managed_instance(managed_instance_id, **kwargs)¶

Detaches profile from a managed instance. After the profile has been removed, the instance cannot be registered as a managed instance.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_profile_from_managed_instance API.

detach_software_sources_from_managed_instance(managed_instance_id, detach_software_sources_from_managed_instance_details, **kwargs)¶

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

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. detach_software_sources_from_managed_instance_details (oci.os_management_hub.models.DetachSoftwareSourcesFromManagedInstanceDetails) – (required) Details of software sources to be detached from a managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_software_sources_from_managed_instance API.

disable_module_stream_on_managed_instance(managed_instance_id, disable_module_stream_on_managed_instance_details, **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) The OCID of the managed instance. disable_module_stream_on_managed_instance_details (oci.os_management_hub.models.DisableModuleStreamOnManagedInstanceDetails) – (required) The details of the module stream to be disabled on a managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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, enable_module_stream_on_managed_instance_details, **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) The OCID of the managed instance. enable_module_stream_on_managed_instance_details (oci.os_management_hub.models.EnableModuleStreamOnManagedInstanceDetails) – (required) The details of the module stream to be enabled on a managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_managed_instance(managed_instance_id, **kwargs)¶

Gets information about the specified managed instance.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_windows_update(windows_update_id, **kwargs)¶

Returns a Windows Update object.

Parameters:	windows_update_id (str) – (required) The unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. Example: ‘6981d463-cd91-4a26-b7c4-ea4ded9183ed’ opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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.

install_all_windows_updates_on_managed_instances_in_compartment(install_all_windows_updates_on_managed_instances_in_compartment_details, **kwargs)¶

Installs all of the available Windows updates for managed instances in a compartment. This applies only to standalone Windows instances. This will not update instances that belong to a group.

Parameters:	install_all_windows_updates_on_managed_instances_in_compartment_details (oci.os_management_hub.models.InstallAllWindowsUpdatesOnManagedInstancesInCompartmentDetails) – (required) The details about Windows update types to be installed on all managed instances in a compartment. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_instances_in_compartment API.

install_module_stream_profile_on_managed_instance(managed_instance_id, install_module_stream_profile_on_managed_instance_details, **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) The OCID of the managed instance. install_module_stream_profile_on_managed_instance_details (oci.os_management_hub.models.InstallModuleStreamProfileOnManagedInstanceDetails) – (required) The details of the module stream profile to be installed on a managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_packages_on_managed_instance(managed_instance_id, install_packages_on_managed_instance_details, **kwargs)¶

Installs packages on a managed instance.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. install_packages_on_managed_instance_details (oci.os_management_hub.models.InstallPackagesOnManagedInstanceDetails) – (required) Details about packages to be installed on a managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_packages_on_managed_instance API.

install_windows_updates_on_managed_instance(managed_instance_id, install_windows_updates_on_managed_instance_details, **kwargs)¶

Installs Windows updates on the specified managed instance.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. install_windows_updates_on_managed_instance_details (oci.os_management_hub.models.InstallWindowsUpdatesOnManagedInstanceDetails) – (required) Details about Windows updates to be installed on a managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_updates_on_managed_instance API.

list_managed_instance_available_packages(managed_instance_id, **kwargs)¶

Returns a list of packages that are available for installation on a managed instance.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. display_name (list[str]) – (optional) A filter to return resources that match the given display names. display_name_contains (str) – (optional) A filter to return resources that may partially match the given display name. compartment_id (str) – (optional) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. Example: 3 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. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `AvailablePackageCollection`
Return type:	`Response`
Example:

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

list_managed_instance_available_software_sources(managed_instance_id, **kwargs)¶

Returns a list of software sources that can be attached to the specified managed instance. Any software sources already attached to the instance are not included in the list.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. display_name (list[str]) – (optional) A filter to return resources that match the given display names. display_name_contains (str) – (optional) A filter to return resources that may partially match the given display name. compartment_id (str) – (optional) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. Example: 3 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. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `AvailableSoftwareSourceCollection`
Return type:	`Response`
Example:

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

list_managed_instance_available_windows_updates(managed_instance_id, **kwargs)¶

Returns a list of Windows updates that can be installed on the specified managed instance.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. classification_type (list[str]) – (optional) A filter to return only packages that match the given update classification type. Allowed values are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”, “OTHER” name (list[str]) – (optional) A filter based on the unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. Example: ‘6981d463-cd91-4a26-b7c4-ea4ded9183ed’ display_name (str) – (optional) A filter to return resources that match the given user-friendly name. display_name_contains (str) – (optional) A filter to return resources that may partially match the given display name. is_installable (str) – (optional) Indicates if the update can be installed by the OS Management Hub service. Allowed values are: “INSTALLABLE”, “NOT_INSTALLABLE” compartment_id (str) – (optional) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. Example: 3 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 timeInstalled is descending. Default order for name or displayName is ascending. Allowed values are: “timeCreated”, “name”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `AvailableWindowsUpdateCollection`
Return type:	`Response`
Example:

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

list_managed_instance_errata(managed_instance_id, **kwargs)¶

Returns a list of applicable errata on the managed instance.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. classification_type (list[str]) – (optional) A filter to return only packages that match the given update classification type. Allowed values are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”, “OTHER” name (list[str]) – (optional) The assigned erratum name. It’s unique and not changeable. Example: ELSA-2020-5804 name_contains (str) – (optional) A filter to return resources that may partially match the erratum name given. compartment_id (str) – (optional) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. Example: 3 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 timeIssued is descending. Default order for name is ascending. If no value is specified timeIssued is default. Allowed values are: “timeIssued”, “name” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `ManagedInstanceErratumSummaryCollection`
Return type:	`Response`
Example:

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

list_managed_instance_installed_packages(managed_instance_id, **kwargs)¶

Lists the packages that are installed on the managed instance.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. display_name (list[str]) – (optional) A filter to return resources that match the given display names. display_name_contains (str) – (optional) A filter to return resources that may partially match the given display name. time_install_date_start (datetime) – (optional) The install date after which to list all packages, in ISO 8601 format Example: 2017-07-14T02:40:00.000Z time_install_date_end (datetime) – (optional) A filter to return only packages that were installed on or before the date provided, in ISO 8601 format. Example: 2017-07-14T02:40:00.000Z compartment_id (str) – (optional) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. Example: 3 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 timeInstalled is descending. Default order for displayName is ascending. Allowed values are: “timeInstalled”, “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `InstalledPackageCollection`
Return type:	`Response`
Example:

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

list_managed_instance_installed_windows_updates(managed_instance_id, **kwargs)¶

Returns a list of Windows updates that have been installed on the specified managed instance.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. name (list[str]) – (optional) A filter based on the unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. Example: ‘6981d463-cd91-4a26-b7c4-ea4ded9183ed’ display_name (str) – (optional) A filter to return resources that match the given user-friendly name. display_name_contains (str) – (optional) A filter to return resources that may partially match the given display name. compartment_id (str) – (optional) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. Example: 3 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 timeInstalled is descending. Default order for name or displayName is ascending. Allowed values are: “timeCreated”, “name”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `InstalledWindowsUpdateCollection`
Return type:	`Response`
Example:

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

list_managed_instance_modules(managed_instance_id, **kwargs)¶

Retrieves a list of modules, along with streams of the modules, from a managed instance. Filters may be applied to select a subset of modules based on the filter criteria.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. compartment_id (str) – (optional) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. name (str) – (optional) The resource name. name_contains (str) – (optional) A filter to return resources that may partially match the name given. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. Example: 3 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 name is ascending. Allowed values are: “name” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `ManagedInstanceModuleCollection`
Return type:	`Response`
Example:

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

list_managed_instance_updatable_packages(managed_instance_id, **kwargs)¶

Returns a list of updatable packages for a managed instance.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. classification_type (list[str]) – (optional) A filter to return only packages that match the given update classification type. Allowed values are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”, “OTHER” display_name (list[str]) – (optional) A filter to return resources that match the given display names. display_name_contains (str) – (optional) A filter to return resources that may partially match the given display name. advisory_name (list[str]) – (optional) The assigned erratum name. It’s unique and not changeable. Example: ELSA-2020-5804 compartment_id (str) – (optional) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. Example: 3 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. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `UpdatablePackageCollection`
Return type:	`Response`
Example:

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

list_managed_instances(**kwargs)¶

Lists managed instances that match the specified compartment or managed instance OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS version.

Parameters:	compartment_id (str) – (optional) The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. display_name (list[str]) – (optional) A filter to return resources that match the given display names. display_name_contains (str) – (optional) A filter to return resources that may partially match the given display name. managed_instance_id (str) – (optional) The OCID of the managed instance. This filter returns resources associated with this managed instance. status (list[str]) – (optional) A filter to return only managed instances whose status matches the status provided. Allowed values are: “NORMAL”, “UNREACHABLE”, “ERROR”, “WARNING”, “REGISTRATION_ERROR”, “DELETING”, “ONBOARDING” arch_type (list[str]) – (optional) A filter to return only instances whose architecture type matches the given architecture. Allowed values are: “X86_64”, “AARCH64”, “I686”, “NOARCH”, “SRC” os_family (list[str]) – (optional) A filter to return only resources that match the given operating system family. Allowed values are: “ORACLE_LINUX_9”, “ORACLE_LINUX_8”, “ORACLE_LINUX_7”, “ORACLE_LINUX_6”, “WINDOWS_SERVER_2016”, “WINDOWS_SERVER_2019”, “WINDOWS_SERVER_2022”, “ALL” is_management_station (bool) – (optional) A filter to return only managed instances that are acting as management stations. group (str) – (optional) A filter to return only managed instances that are attached to the specified group. group_not_equal_to (str) – (optional) A filter to return only managed instances that are NOT attached to the specified group. lifecycle_stage (str) – (optional) A filter to return only managed instances that are associated with the specified lifecycle environment. lifecycle_stage_not_equal_to (str) – (optional) A filter to return only managed instances that are NOT associated with the specified lifecycle environment. is_attached_to_group_or_lifecycle_stage (bool) – (optional) A filter to return only managed instances that are attached to the specified group or lifecycle environment. software_source_id (str) – (optional) The OCID of the software source. This filter returns resources associated with this software source. advisory_name (list[str]) – (optional) The assigned erratum name. It’s unique and not changeable. Example: ELSA-2020-5804 lifecycle_environment (str) – (optional) A filter to return only managed instances in a specific lifecycle environment. lifecycle_environment_not_equal_to (str) – (optional) A filter to return only managed instances that aren’t in a specific lifecycle environment. location (list[str]) – (optional) A filter to return only resources whose location matches the given value. Allowed values are: “ON_PREMISE”, “OCI_COMPUTE”, “AZURE”, “EC2”, “GCP” location_not_equal_to (list[str]) – (optional) A filter to return only resources whose location does not match the given value. Allowed values are: “ON_PREMISE”, “OCI_COMPUTE”, “AZURE”, “EC2”, “GCP” profile (list[str]) – (optional) A multi filter to return only managed instances that match the given profile ids. profile_not_equal_to (list[str]) – (optional) A multi filter to return only managed instances that don’t contain the given profile OCIDs. is_profile_attached (bool) – (optional) A filter to return only managed instances with a registration profile attached. is_managed_by_autonomous_linux (bool) – (optional) Indicates whether to list only resources managed by the Autonomous Linux service. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. Example: 3 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. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `ManagedInstanceCollection`
Return type:	`Response`
Example:

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

list_windows_updates(compartment_id, **kwargs)¶

Lists Windows updates that have been reported to the service.

Parameters:	compartment_id (str) – (required) The OCID of the compartment. This parameter is required and returns only resources contained within the specified compartment. classification_type (list[str]) – (optional) A filter to return only packages that match the given update classification type. Allowed values are: “SECURITY”, “BUGFIX”, “ENHANCEMENT”, “OTHER” name (list[str]) – (optional) A filter based on the unique identifier for the Windows update. Note that this is not an OCID, but is a unique identifier assigned by Microsoft. Example: ‘6981d463-cd91-4a26-b7c4-ea4ded9183ed’ display_name_contains (str) – (optional) A filter to return resources that may partially match the given display name. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Example: 50 page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. Example: 3 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 timeInstalled is descending. Default order for name or displayName is ascending. Allowed values are: “timeCreated”, “name”, “displayName” opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 `WindowsUpdateCollection`
Return type:	`Response`
Example:

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

manage_module_streams_on_managed_instance(managed_instance_id, manage_module_streams_on_managed_instance_details, **kwargs)¶

Enables or disables module streams and installs or removes module stream profiles. Once complete, the state of the modules, streams, and profiles will match the state indicated in the operation. See manage_module_streams_on_managed_instance_details() for more information. You can preform this operation as a dry run. For a dry run, the service evaluates the operation against the current module, stream, and profile state on the managed instance, but does not commit the changes. Instead, the service returns work request log or error entries indicating the impact of the operation.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. manage_module_streams_on_managed_instance_details (oci.os_management_hub.models.ManageModuleStreamsOnManagedInstanceDetails) – (required) A description of an operation to perform against the modules, streams, and profiles of a managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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.

refresh_software_on_managed_instance(managed_instance_id, **kwargs)¶

Refreshes the package or Windows update information on a managed instance with the latest data from the software source. This does not update packages on the instance. It provides the service with the latest package data.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 refresh_software_on_managed_instance API.

remove_module_stream_profile_from_managed_instance(managed_instance_id, remove_module_stream_profile_from_managed_instance_details, **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) The OCID of the managed instance. remove_module_stream_profile_from_managed_instance_details (oci.os_management_hub.models.RemoveModuleStreamProfileFromManagedInstanceDetails) – (required) The details of the module stream profile to be removed from a managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_packages_from_managed_instance(managed_instance_id, remove_packages_from_managed_instance_details, **kwargs)¶

Removes an installed package from a managed instance.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. remove_packages_from_managed_instance_details (oci.os_management_hub.models.RemovePackagesFromManagedInstanceDetails) – (required) Details about packages to be removed on a managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_managed_instance API.

switch_module_stream_on_managed_instance(managed_instance_id, switch_module_stream_on_managed_instance_details, **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) The OCID of the managed instance. switch_module_stream_on_managed_instance_details (oci.os_management_hub.models.SwitchModuleStreamOnManagedInstanceDetails) – (required) The details of the module stream to be switched on a managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_all_packages_on_managed_instances_in_compartment(update_all_packages_on_managed_instances_in_compartment_details, **kwargs)¶

Install all of the available package updates for all of the managed instances in a compartment. This applies only to standalone non-Windows instances. This will not update instances that belong to a group or lifecycle environment.

Parameters:	update_all_packages_on_managed_instances_in_compartment_details (oci.os_management_hub.models.UpdateAllPackagesOnManagedInstancesInCompartmentDetails) – (required) The details about package types are to be updated on all managed instances in a compartment. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 update_all_packages_on_managed_instances_in_compartment API.

update_managed_instance(managed_instance_id, update_managed_instance_details, **kwargs)¶

Updates the specified managed instance information, such as description, ONS topic, and associated management station.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. update_managed_instance_details (oci.os_management_hub.models.UpdateManagedInstanceDetails) – (required) Details about a managed instance to be updated. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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_packages_on_managed_instance(managed_instance_id, update_packages_on_managed_instance_details, **kwargs)¶

Updates a package on a managed instance.

Parameters:	managed_instance_id (str) – (required) The OCID of the managed instance. update_packages_on_managed_instance_details (oci.os_management_hub.models.UpdatePackagesOnManagedInstanceDetails) – (required) Details about packages to be updated on a managed instance. 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_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 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 uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. 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 update_packages_on_managed_instance API.