com.oracle.bmc.osmanagementhub

Interface ManagedInstance

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ManagedInstanceClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public interface ManagedInstance
extends AutoCloseable

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.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
AttachProfileToManagedInstanceResponse	attachProfileToManagedInstance(AttachProfileToManagedInstanceRequest request) Adds profile to a managed instance.
AttachSoftwareSourcesToManagedInstanceResponse	attachSoftwareSourcesToManagedInstance(AttachSoftwareSourcesToManagedInstanceRequest request) Adds software sources to a managed instance.
DeleteManagedInstanceResponse	deleteManagedInstance(DeleteManagedInstanceRequest request) Unregisters the specified managed instance from the service.
DetachProfileFromManagedInstanceResponse	detachProfileFromManagedInstance(DetachProfileFromManagedInstanceRequest request) Detaches profile from a managed instance.
DetachSoftwareSourcesFromManagedInstanceResponse	detachSoftwareSourcesFromManagedInstance(DetachSoftwareSourcesFromManagedInstanceRequest request) Removes software sources from a managed instance.
DisableModuleStreamOnManagedInstanceResponse	disableModuleStreamOnManagedInstance(DisableModuleStreamOnManagedInstanceRequest request) Disables a module stream on a managed instance.
EnableModuleStreamOnManagedInstanceResponse	enableModuleStreamOnManagedInstance(EnableModuleStreamOnManagedInstanceRequest request) Enables a module stream on a managed instance.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetManagedInstanceResponse	getManagedInstance(GetManagedInstanceRequest request) Gets information about the specified managed instance.
ManagedInstancePaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetWindowsUpdateResponse	getWindowsUpdate(GetWindowsUpdateRequest request) Returns a Windows Update object.
InstallAllWindowsUpdatesOnManagedInstancesInCompartmentResponse	installAllWindowsUpdatesOnManagedInstancesInCompartment(InstallAllWindowsUpdatesOnManagedInstancesInCompartmentRequest request) Installs all of the available Windows updates for managed instances in a compartment.
InstallModuleStreamProfileOnManagedInstanceResponse	installModuleStreamProfileOnManagedInstance(InstallModuleStreamProfileOnManagedInstanceRequest request) Installs a profile for an module stream.
InstallPackagesOnManagedInstanceResponse	installPackagesOnManagedInstance(InstallPackagesOnManagedInstanceRequest request) Installs packages on a managed instance.
InstallWindowsUpdatesOnManagedInstanceResponse	installWindowsUpdatesOnManagedInstance(InstallWindowsUpdatesOnManagedInstanceRequest request) Installs Windows updates on the specified managed instance.
ListManagedInstanceAvailablePackagesResponse	listManagedInstanceAvailablePackages(ListManagedInstanceAvailablePackagesRequest request) Returns a list of packages that are available for installation on a managed instance.
ListManagedInstanceAvailableSoftwareSourcesResponse	listManagedInstanceAvailableSoftwareSources(ListManagedInstanceAvailableSoftwareSourcesRequest request) Returns a list of software sources that can be attached to the specified managed instance.
ListManagedInstanceAvailableWindowsUpdatesResponse	listManagedInstanceAvailableWindowsUpdates(ListManagedInstanceAvailableWindowsUpdatesRequest request) Returns a list of Windows updates that can be installed on the specified managed instance.
ListManagedInstanceErrataResponse	listManagedInstanceErrata(ListManagedInstanceErrataRequest request) Returns a list of applicable errata on the managed instance.
ListManagedInstanceInstalledPackagesResponse	listManagedInstanceInstalledPackages(ListManagedInstanceInstalledPackagesRequest request) Lists the packages that are installed on the managed instance.
ListManagedInstanceInstalledWindowsUpdatesResponse	listManagedInstanceInstalledWindowsUpdates(ListManagedInstanceInstalledWindowsUpdatesRequest request) Returns a list of Windows updates that have been installed on the specified managed instance.
ListManagedInstanceModulesResponse	listManagedInstanceModules(ListManagedInstanceModulesRequest request) Retrieves a list of modules, along with streams of the modules, from a managed instance.
ListManagedInstancesResponse	listManagedInstances(ListManagedInstancesRequest request) Lists managed instances that match the specified compartment or managed instance OCID.
ListManagedInstanceUpdatablePackagesResponse	listManagedInstanceUpdatablePackages(ListManagedInstanceUpdatablePackagesRequest request) Returns a list of updatable packages for a managed instance.
ListWindowsUpdatesResponse	listWindowsUpdates(ListWindowsUpdatesRequest request) Lists Windows updates that have been reported to the service.
ManageModuleStreamsOnManagedInstanceResponse	manageModuleStreamsOnManagedInstance(ManageModuleStreamsOnManagedInstanceRequest request) Enables or disables module streams and installs or removes module stream profiles.
void	refreshClient() Rebuilds the client from scratch.
RefreshSoftwareOnManagedInstanceResponse	refreshSoftwareOnManagedInstance(RefreshSoftwareOnManagedInstanceRequest request) Refreshes the package or Windows update information on a managed instance with the latest data from the software source.
RemoveModuleStreamProfileFromManagedInstanceResponse	removeModuleStreamProfileFromManagedInstance(RemoveModuleStreamProfileFromManagedInstanceRequest request) Removes a profile for a module stream that is installed on a managed instance.
RemovePackagesFromManagedInstanceResponse	removePackagesFromManagedInstance(RemovePackagesFromManagedInstanceRequest request) Removes an installed package from a managed instance.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
SwitchModuleStreamOnManagedInstanceResponse	switchModuleStreamOnManagedInstance(SwitchModuleStreamOnManagedInstanceRequest request) Enables a new stream for a module that already has a stream enabled.
UpdateAllPackagesOnManagedInstancesInCompartmentResponse	updateAllPackagesOnManagedInstancesInCompartment(UpdateAllPackagesOnManagedInstancesInCompartmentRequest request) Install all of the available package updates for all of the managed instances in a compartment.
UpdateManagedInstanceResponse	updateManagedInstance(UpdateManagedInstanceRequest request) Updates the specified managed instance information, such as description, ONS topic, and associated management station.
UpdatePackagesOnManagedInstanceResponse	updatePackagesOnManagedInstance(UpdatePackagesOnManagedInstanceRequest request) Updates a package on a managed instance.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

attachProfileToManagedInstance

AttachProfileToManagedInstanceResponse attachProfileToManagedInstance(AttachProfileToManagedInstanceRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use AttachProfileToManagedInstance API.

attachSoftwareSourcesToManagedInstance

AttachSoftwareSourcesToManagedInstanceResponse attachSoftwareSourcesToManagedInstance(AttachSoftwareSourcesToManagedInstanceRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use AttachSoftwareSourcesToManagedInstance API.

deleteManagedInstance

DeleteManagedInstanceResponse deleteManagedInstance(DeleteManagedInstanceRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteManagedInstance API.

detachProfileFromManagedInstance

DetachProfileFromManagedInstanceResponse detachProfileFromManagedInstance(DetachProfileFromManagedInstanceRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DetachProfileFromManagedInstance API.

detachSoftwareSourcesFromManagedInstance

DetachSoftwareSourcesFromManagedInstanceResponse detachSoftwareSourcesFromManagedInstance(DetachSoftwareSourcesFromManagedInstanceRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DetachSoftwareSourcesFromManagedInstance API.

disableModuleStreamOnManagedInstance

DisableModuleStreamOnManagedInstanceResponse disableModuleStreamOnManagedInstance(DisableModuleStreamOnManagedInstanceRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DisableModuleStreamOnManagedInstance API.

enableModuleStreamOnManagedInstance

EnableModuleStreamOnManagedInstanceResponse enableModuleStreamOnManagedInstance(EnableModuleStreamOnManagedInstanceRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use EnableModuleStreamOnManagedInstance API.

getManagedInstance

GetManagedInstanceResponse getManagedInstance(GetManagedInstanceRequest request)

Gets information about the specified managed instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetManagedInstance API.

getWindowsUpdate

GetWindowsUpdateResponse getWindowsUpdate(GetWindowsUpdateRequest request)

Returns a Windows Update object.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetWindowsUpdate API.

installAllWindowsUpdatesOnManagedInstancesInCompartment

InstallAllWindowsUpdatesOnManagedInstancesInCompartmentResponse installAllWindowsUpdatesOnManagedInstancesInCompartment(InstallAllWindowsUpdatesOnManagedInstancesInCompartmentRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use InstallAllWindowsUpdatesOnManagedInstancesInCompartment API.

installModuleStreamProfileOnManagedInstance

InstallModuleStreamProfileOnManagedInstanceResponse installModuleStreamProfileOnManagedInstance(InstallModuleStreamProfileOnManagedInstanceRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use InstallModuleStreamProfileOnManagedInstance API.

installPackagesOnManagedInstance

InstallPackagesOnManagedInstanceResponse installPackagesOnManagedInstance(InstallPackagesOnManagedInstanceRequest request)

Installs packages on a managed instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use InstallPackagesOnManagedInstance API.

installWindowsUpdatesOnManagedInstance

InstallWindowsUpdatesOnManagedInstanceResponse installWindowsUpdatesOnManagedInstance(InstallWindowsUpdatesOnManagedInstanceRequest request)

Installs Windows updates on the specified managed instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use InstallWindowsUpdatesOnManagedInstance API.

listManagedInstanceAvailablePackages

ListManagedInstanceAvailablePackagesResponse listManagedInstanceAvailablePackages(ListManagedInstanceAvailablePackagesRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListManagedInstanceAvailablePackages API.

listManagedInstanceAvailableSoftwareSources

ListManagedInstanceAvailableSoftwareSourcesResponse listManagedInstanceAvailableSoftwareSources(ListManagedInstanceAvailableSoftwareSourcesRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListManagedInstanceAvailableSoftwareSources API.

listManagedInstanceAvailableWindowsUpdates

ListManagedInstanceAvailableWindowsUpdatesResponse listManagedInstanceAvailableWindowsUpdates(ListManagedInstanceAvailableWindowsUpdatesRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListManagedInstanceAvailableWindowsUpdates API.

listManagedInstanceErrata

ListManagedInstanceErrataResponse listManagedInstanceErrata(ListManagedInstanceErrataRequest request)

Returns a list of applicable errata on the managed instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListManagedInstanceErrata API.

listManagedInstanceInstalledPackages

ListManagedInstanceInstalledPackagesResponse listManagedInstanceInstalledPackages(ListManagedInstanceInstalledPackagesRequest request)

Lists the packages that are installed on the managed instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListManagedInstanceInstalledPackages API.

listManagedInstanceInstalledWindowsUpdates

ListManagedInstanceInstalledWindowsUpdatesResponse listManagedInstanceInstalledWindowsUpdates(ListManagedInstanceInstalledWindowsUpdatesRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListManagedInstanceInstalledWindowsUpdates API.

listManagedInstanceModules

ListManagedInstanceModulesResponse listManagedInstanceModules(ListManagedInstanceModulesRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListManagedInstanceModules API.

listManagedInstanceUpdatablePackages

ListManagedInstanceUpdatablePackagesResponse listManagedInstanceUpdatablePackages(ListManagedInstanceUpdatablePackagesRequest request)

Returns a list of updatable packages for a managed instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListManagedInstanceUpdatablePackages API.

listManagedInstances

ListManagedInstancesResponse listManagedInstances(ListManagedInstancesRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListManagedInstances API.

listWindowsUpdates

ListWindowsUpdatesResponse listWindowsUpdates(ListWindowsUpdatesRequest request)

Lists Windows updates that have been reported to the service.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListWindowsUpdates API.

manageModuleStreamsOnManagedInstance

ManageModuleStreamsOnManagedInstanceResponse manageModuleStreamsOnManagedInstance(ManageModuleStreamsOnManagedInstanceRequest request)

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 manageModuleStreamsOnManagedInstanceDetails 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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ManageModuleStreamsOnManagedInstance API.

refreshSoftwareOnManagedInstance

RefreshSoftwareOnManagedInstanceResponse refreshSoftwareOnManagedInstance(RefreshSoftwareOnManagedInstanceRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use RefreshSoftwareOnManagedInstance API.

removeModuleStreamProfileFromManagedInstance

RemoveModuleStreamProfileFromManagedInstanceResponse removeModuleStreamProfileFromManagedInstance(RemoveModuleStreamProfileFromManagedInstanceRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use RemoveModuleStreamProfileFromManagedInstance API.

removePackagesFromManagedInstance

RemovePackagesFromManagedInstanceResponse removePackagesFromManagedInstance(RemovePackagesFromManagedInstanceRequest request)

Removes an installed package from a managed instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use RemovePackagesFromManagedInstance API.

switchModuleStreamOnManagedInstance

SwitchModuleStreamOnManagedInstanceResponse switchModuleStreamOnManagedInstance(SwitchModuleStreamOnManagedInstanceRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use SwitchModuleStreamOnManagedInstance API.

updateAllPackagesOnManagedInstancesInCompartment

UpdateAllPackagesOnManagedInstancesInCompartmentResponse updateAllPackagesOnManagedInstancesInCompartment(UpdateAllPackagesOnManagedInstancesInCompartmentRequest request)

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:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateAllPackagesOnManagedInstancesInCompartment API.

updateManagedInstance

UpdateManagedInstanceResponse updateManagedInstance(UpdateManagedInstanceRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateManagedInstance API.

updatePackagesOnManagedInstance

UpdatePackagesOnManagedInstanceResponse updatePackagesOnManagedInstance(UpdatePackagesOnManagedInstanceRequest request)

Updates a package on a managed instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdatePackagesOnManagedInstance API.

getPaginators

ManagedInstancePaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.