Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ManagedInstanceClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • ManagedInstanceClient

Constructors

constructor

  • new ManagedInstanceClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): ManagedInstanceClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

targetService

targetService: string = "ManagedInstance"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://osmh.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • 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: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

attachProfileToManagedInstance

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AttachProfileToManagedInstance API.

    Parameters

    Returns Promise<AttachProfileToManagedInstanceResponse>

    AttachProfileToManagedInstanceResponse

attachSoftwareSourcesToManagedInstance

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AttachSoftwareSourcesToManagedInstance API.

    Parameters

    Returns Promise<AttachSoftwareSourcesToManagedInstanceResponse>

    AttachSoftwareSourcesToManagedInstanceResponse

close

  • close(): void

deleteManagedInstance

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteManagedInstance API.

    Parameters

    Returns Promise<DeleteManagedInstanceResponse>

    DeleteManagedInstanceResponse

detachProfileFromManagedInstance

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DetachProfileFromManagedInstance API.

    Parameters

    Returns Promise<DetachProfileFromManagedInstanceResponse>

    DetachProfileFromManagedInstanceResponse

detachSoftwareSourcesFromManagedInstance

disableModuleStreamOnManagedInstance

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DisableModuleStreamOnManagedInstance API.

    Parameters

    Returns Promise<DisableModuleStreamOnManagedInstanceResponse>

    DisableModuleStreamOnManagedInstanceResponse

enableModuleStreamOnManagedInstance

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use EnableModuleStreamOnManagedInstance API.

    Parameters

    Returns Promise<EnableModuleStreamOnManagedInstanceResponse>

    EnableModuleStreamOnManagedInstanceResponse

getManagedInstance

getWindowsUpdate

installAllWindowsUpdatesOnManagedInstancesInCompartment

installModuleStreamProfileOnManagedInstance

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use InstallModuleStreamProfileOnManagedInstance API.

    Parameters

    Returns Promise<InstallModuleStreamProfileOnManagedInstanceResponse>

    InstallModuleStreamProfileOnManagedInstanceResponse

installPackagesOnManagedInstance

installWindowsUpdatesOnManagedInstance

listManagedInstanceAvailablePackages

listManagedInstanceAvailableSoftwareSources

listManagedInstanceAvailableWindowsUpdates

listManagedInstanceErrata

listManagedInstanceInstalledPackages

listManagedInstanceInstalledWindowsUpdates

listManagedInstanceModules

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListManagedInstanceModules API.

    Parameters

    Returns Promise<ListManagedInstanceModulesResponse>

    ListManagedInstanceModulesResponse

listManagedInstanceUpdatablePackages

listManagedInstances

  • 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. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListManagedInstances API.

    Parameters

    Returns Promise<ListManagedInstancesResponse>

    ListManagedInstancesResponse

listWindowsUpdates

manageModuleStreamsOnManagedInstance

  • 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 {@link #manageModuleStreamsOnManagedInstanceDetails(ManageModuleStreamsOnManagedInstanceDetailsRequest) 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ManageModuleStreamsOnManagedInstance API.

    Parameters

    Returns Promise<ManageModuleStreamsOnManagedInstanceResponse>

    ManageModuleStreamsOnManagedInstanceResponse

refreshSoftwareOnManagedInstance

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RefreshSoftwareOnManagedInstance API.

    Parameters

    Returns Promise<RefreshSoftwareOnManagedInstanceResponse>

    RefreshSoftwareOnManagedInstanceResponse

removeModuleStreamProfileFromManagedInstance

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RemoveModuleStreamProfileFromManagedInstance API.

    Parameters

    Returns Promise<RemoveModuleStreamProfileFromManagedInstanceResponse>

    RemoveModuleStreamProfileFromManagedInstanceResponse

removePackagesFromManagedInstance

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

switchModuleStreamOnManagedInstance

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SwitchModuleStreamOnManagedInstance API.

    Parameters

    Returns Promise<SwitchModuleStreamOnManagedInstanceResponse>

    SwitchModuleStreamOnManagedInstanceResponse

updateAllPackagesOnManagedInstancesInCompartment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAllPackagesOnManagedInstancesInCompartment API.

    Parameters

    Returns Promise<UpdateAllPackagesOnManagedInstancesInCompartmentResponse>

    UpdateAllPackagesOnManagedInstancesInCompartmentResponse

updateManagedInstance

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateManagedInstance API.

    Parameters

    Returns Promise<UpdateManagedInstanceResponse>

    UpdateManagedInstanceResponse

updatePackagesOnManagedInstance