Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OsManagementClient

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

  • OsManagementClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

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 = ""

Protected _waiters

targetService

targetService: string = "OsManagement"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://osms.{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

addPackagesToSoftwareSource

attachChildSoftwareSourceToManagedInstance

attachManagedInstanceToManagedInstanceGroup

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AttachManagedInstanceToManagedInstanceGroup API.

    Parameters

    Returns Promise<AttachManagedInstanceToManagedInstanceGroupResponse>

    AttachManagedInstanceToManagedInstanceGroupResponse

attachParentSoftwareSourceToManagedInstance

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AttachParentSoftwareSourceToManagedInstance API.

    Parameters

    Returns Promise<AttachParentSoftwareSourceToManagedInstanceResponse>

    AttachParentSoftwareSourceToManagedInstanceResponse

changeManagedInstanceGroupCompartment

changeScheduledJobCompartment

changeSoftwareSourceCompartment

close

  • close(): void

createManagedInstanceGroup

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateManagedInstanceGroup API.

    Parameters

    Returns Promise<CreateManagedInstanceGroupResponse>

    CreateManagedInstanceGroupResponse

createScheduledJob

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateScheduledJob API.

    Parameters

    Returns Promise<CreateScheduledJobResponse>

    CreateScheduledJobResponse

createSoftwareSource

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSoftwareSource API.

    Parameters

    Returns Promise<CreateSoftwareSourceResponse>

    CreateSoftwareSourceResponse

createWaiters

  • Creates a new OsManagementWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns OsManagementWaiter

    The service waiters.

deleteManagedInstanceGroup

deleteScheduledJob

deleteSoftwareSource

detachChildSoftwareSourceFromManagedInstance

detachManagedInstanceFromManagedInstanceGroup

detachParentSoftwareSourceFromManagedInstance

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 does not retry by default if the user has not defined a retry configuration.

    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 does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use EnableModuleStreamOnManagedInstance API.

    Parameters

    Returns Promise<EnableModuleStreamOnManagedInstanceResponse>

    EnableModuleStreamOnManagedInstanceResponse

getErratum

getManagedInstance

getManagedInstanceGroup

getModuleStream

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetModuleStream API.

    Parameters

    Returns Promise<GetModuleStreamResponse>

    GetModuleStreamResponse

getModuleStreamProfile

getScheduledJob

getSoftwarePackage

getSoftwareSource

getWaiters

getWindowsUpdate

getWorkRequest

  • Gets the detailed information for the work request with the given ID. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

installAllPackageUpdatesOnManagedInstance

installAllUpdatesOnManagedInstanceGroup

installAllWindowsUpdatesOnManagedInstance

installModuleStreamProfileOnManagedInstance

installPackageOnManagedInstance

installPackageUpdateOnManagedInstance

installWindowsUpdateOnManagedInstance

listAllAvailablePackagesForManagedInstance

  • NOTE: This function is deprecated in favor of listAvailablePackagesForManagedInstanceRecordIterator function. Creates a new async iterator which will iterate over the models.InstallablePackageSummary objects contained in responses from the listAvailablePackagesForManagedInstance operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<InstallablePackageSummary>

listAllAvailablePackagesForManagedInstanceResponses

listAllAvailableSoftwareSourcesForManagedInstance

  • NOTE: This function is deprecated in favor of listAvailableSoftwareSourcesForManagedInstanceRecordIterator function. Creates a new async iterator which will iterate over the models.AvailableSoftwareSourceSummary objects contained in responses from the listAvailableSoftwareSourcesForManagedInstance operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AvailableSoftwareSourceSummary>

listAllAvailableSoftwareSourcesForManagedInstanceResponses

listAllAvailableUpdatesForManagedInstance

  • NOTE: This function is deprecated in favor of listAvailableUpdatesForManagedInstanceRecordIterator function. Creates a new async iterator which will iterate over the models.AvailableUpdateSummary objects contained in responses from the listAvailableUpdatesForManagedInstance operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AvailableUpdateSummary>

listAllAvailableUpdatesForManagedInstanceResponses

listAllAvailableWindowsUpdatesForManagedInstance

  • NOTE: This function is deprecated in favor of listAvailableWindowsUpdatesForManagedInstanceRecordIterator function. Creates a new async iterator which will iterate over the models.AvailableWindowsUpdateSummary objects contained in responses from the listAvailableWindowsUpdatesForManagedInstance operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AvailableWindowsUpdateSummary>

listAllAvailableWindowsUpdatesForManagedInstanceResponses

listAllErrata

  • NOTE: This function is deprecated in favor of listErrataRecordIterator function. Creates a new async iterator which will iterate over the models.ErratumSummary objects contained in responses from the listErrata operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ErratumSummary>

listAllErrataResponses

  • NOTE: This function is deprecated in favor of listErrataResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listErrata operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListErrataResponse>

listAllManagedInstanceErrata

  • NOTE: This function is deprecated in favor of listManagedInstanceErrataRecordIterator function. Creates a new async iterator which will iterate over the models.ErratumSummary objects contained in responses from the listManagedInstanceErrata operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ErratumSummary>

listAllManagedInstanceErrataResponses

listAllManagedInstanceGroups

  • NOTE: This function is deprecated in favor of listManagedInstanceGroupsRecordIterator function. Creates a new async iterator which will iterate over the models.ManagedInstanceGroupSummary objects contained in responses from the listManagedInstanceGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ManagedInstanceGroupSummary>

listAllManagedInstanceGroupsResponses

listAllManagedInstances

  • NOTE: This function is deprecated in favor of listManagedInstancesRecordIterator function. Creates a new async iterator which will iterate over the models.ManagedInstanceSummary objects contained in responses from the listManagedInstances operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ManagedInstanceSummary>

listAllManagedInstancesResponses

  • NOTE: This function is deprecated in favor of listManagedInstancesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listManagedInstances operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListManagedInstancesResponse>

listAllModuleStreamProfiles

  • NOTE: This function is deprecated in favor of listModuleStreamProfilesRecordIterator function. Creates a new async iterator which will iterate over the models.ModuleStreamProfileSummary objects contained in responses from the listModuleStreamProfiles operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ModuleStreamProfileSummary>

listAllModuleStreamProfilesOnManagedInstance

listAllModuleStreamProfilesOnManagedInstanceResponses

listAllModuleStreamProfilesResponses

listAllModuleStreams

  • NOTE: This function is deprecated in favor of listModuleStreamsRecordIterator function. Creates a new async iterator which will iterate over the models.ModuleStreamSummary objects contained in responses from the listModuleStreams operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ModuleStreamSummary>

listAllModuleStreamsOnManagedInstance

  • NOTE: This function is deprecated in favor of listModuleStreamsOnManagedInstanceRecordIterator function. Creates a new async iterator which will iterate over the models.ModuleStreamOnManagedInstanceSummary objects contained in responses from the listModuleStreamsOnManagedInstance operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ModuleStreamOnManagedInstanceSummary>

listAllModuleStreamsOnManagedInstanceResponses

listAllModuleStreamsResponses

  • NOTE: This function is deprecated in favor of listModuleStreamsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listModuleStreams operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListModuleStreamsResponse>

listAllPackagesInstalledOnManagedInstance

  • NOTE: This function is deprecated in favor of listPackagesInstalledOnManagedInstanceRecordIterator function. Creates a new async iterator which will iterate over the models.InstalledPackageSummary objects contained in responses from the listPackagesInstalledOnManagedInstance operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<InstalledPackageSummary>

listAllPackagesInstalledOnManagedInstanceResponses

listAllScheduledJobs

  • NOTE: This function is deprecated in favor of listScheduledJobsRecordIterator function. Creates a new async iterator which will iterate over the models.ScheduledJobSummary objects contained in responses from the listScheduledJobs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ScheduledJobSummary>

listAllScheduledJobsResponses

  • NOTE: This function is deprecated in favor of listScheduledJobsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listScheduledJobs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListScheduledJobsResponse>

listAllSoftwareSourcePackages

  • NOTE: This function is deprecated in favor of listSoftwareSourcePackagesRecordIterator function. Creates a new async iterator which will iterate over the models.SoftwarePackageSummary objects contained in responses from the listSoftwareSourcePackages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SoftwarePackageSummary>

listAllSoftwareSourcePackagesResponses

listAllSoftwareSources

  • NOTE: This function is deprecated in favor of listSoftwareSourcesRecordIterator function. Creates a new async iterator which will iterate over the models.SoftwareSourceSummary objects contained in responses from the listSoftwareSources operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SoftwareSourceSummary>

listAllSoftwareSourcesResponses

  • NOTE: This function is deprecated in favor of listSoftwareSourcesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listSoftwareSources operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListSoftwareSourcesResponse>

listAllUpcomingScheduledJobs

  • NOTE: This function is deprecated in favor of listUpcomingScheduledJobsRecordIterator function. Creates a new async iterator which will iterate over the models.ScheduledJobSummary objects contained in responses from the listUpcomingScheduledJobs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ScheduledJobSummary>

listAllUpcomingScheduledJobsResponses

listAllWindowsUpdates

  • NOTE: This function is deprecated in favor of listWindowsUpdatesRecordIterator function. Creates a new async iterator which will iterate over the models.WindowsUpdateSummary objects contained in responses from the listWindowsUpdates operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WindowsUpdateSummary>

listAllWindowsUpdatesInstalledOnManagedInstance

  • NOTE: This function is deprecated in favor of listWindowsUpdatesInstalledOnManagedInstanceRecordIterator function. Creates a new async iterator which will iterate over the models.InstalledWindowsUpdateSummary objects contained in responses from the listWindowsUpdatesInstalledOnManagedInstance operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<InstalledWindowsUpdateSummary>

listAllWindowsUpdatesInstalledOnManagedInstanceResponses

listAllWindowsUpdatesResponses

  • NOTE: This function is deprecated in favor of listWindowsUpdatesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWindowsUpdates operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWindowsUpdatesResponse>

listAllWorkRequestErrors

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listAllWorkRequestErrorsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestErrorsResponse>

listAllWorkRequestLogs

  • NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listAllWorkRequestLogsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestLogsResponse>

listAllWorkRequests

  • NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listAllWorkRequestsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listAvailablePackagesForManagedInstance

listAvailablePackagesForManagedInstanceRecordIterator

listAvailablePackagesForManagedInstanceResponseIterator

listAvailableSoftwareSourcesForManagedInstance

listAvailableSoftwareSourcesForManagedInstanceRecordIterator

listAvailableSoftwareSourcesForManagedInstanceResponseIterator

listAvailableUpdatesForManagedInstance

listAvailableUpdatesForManagedInstanceRecordIterator

listAvailableUpdatesForManagedInstanceResponseIterator

listAvailableWindowsUpdatesForManagedInstance

listAvailableWindowsUpdatesForManagedInstanceRecordIterator

listAvailableWindowsUpdatesForManagedInstanceResponseIterator

listErrata

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListErrata API.

    Parameters

    Returns Promise<ListErrataResponse>

    ListErrataResponse

listErrataRecordIterator

  • Creates a new async iterator which will iterate over the models.ErratumSummary objects contained in responses from the listErrata operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ErratumSummary>

listErrataResponseIterator

listManagedInstanceErrata

listManagedInstanceErrataRecordIterator

  • Creates a new async iterator which will iterate over the models.ErratumSummary objects contained in responses from the listManagedInstanceErrata operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ErratumSummary>

listManagedInstanceErrataResponseIterator

listManagedInstanceGroups

listManagedInstanceGroupsRecordIterator

listManagedInstanceGroupsResponseIterator

listManagedInstances

listManagedInstancesRecordIterator

listManagedInstancesResponseIterator

listModuleStreamProfiles

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

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListModuleStreamProfiles API.

    Parameters

    Returns Promise<ListModuleStreamProfilesResponse>

    ListModuleStreamProfilesResponse

listModuleStreamProfilesOnManagedInstance

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

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

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

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListModuleStreamProfilesOnManagedInstance API.

    Parameters

    Returns Promise<ListModuleStreamProfilesOnManagedInstanceResponse>

    ListModuleStreamProfilesOnManagedInstanceResponse

listModuleStreamProfilesOnManagedInstanceRecordIterator

listModuleStreamProfilesOnManagedInstanceResponseIterator

listModuleStreamProfilesRecordIterator

listModuleStreamProfilesResponseIterator

listModuleStreams

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

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

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListModuleStreams API.

    Parameters

    Returns Promise<ListModuleStreamsResponse>

    ListModuleStreamsResponse

listModuleStreamsOnManagedInstance

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

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

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

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListModuleStreamsOnManagedInstance API.

    Parameters

    Returns Promise<ListModuleStreamsOnManagedInstanceResponse>

    ListModuleStreamsOnManagedInstanceResponse

listModuleStreamsOnManagedInstanceRecordIterator

listModuleStreamsOnManagedInstanceResponseIterator

listModuleStreamsRecordIterator

  • Creates a new async iterator which will iterate over the models.ModuleStreamSummary objects contained in responses from the listModuleStreams operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ModuleStreamSummary>

listModuleStreamsResponseIterator

listPackagesInstalledOnManagedInstance

listPackagesInstalledOnManagedInstanceRecordIterator

listPackagesInstalledOnManagedInstanceResponseIterator

listScheduledJobs

listScheduledJobsRecordIterator

  • Creates a new async iterator which will iterate over the models.ScheduledJobSummary objects contained in responses from the listScheduledJobs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ScheduledJobSummary>

listScheduledJobsResponseIterator

listSoftwareSourcePackages

listSoftwareSourcePackagesRecordIterator

listSoftwareSourcePackagesResponseIterator

listSoftwareSources

listSoftwareSourcesRecordIterator

  • Creates a new async iterator which will iterate over the models.SoftwareSourceSummary objects contained in responses from the listSoftwareSources operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SoftwareSourceSummary>

listSoftwareSourcesResponseIterator

listUpcomingScheduledJobs

listUpcomingScheduledJobsRecordIterator

listUpcomingScheduledJobsResponseIterator

listWindowsUpdates

listWindowsUpdatesInstalledOnManagedInstance

listWindowsUpdatesInstalledOnManagedInstanceRecordIterator

listWindowsUpdatesInstalledOnManagedInstanceResponseIterator

listWindowsUpdatesRecordIterator

  • Creates a new async iterator which will iterate over the models.WindowsUpdateSummary objects contained in responses from the listWindowsUpdates operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WindowsUpdateSummary>

listWindowsUpdatesResponseIterator

listWorkRequestErrors

listWorkRequestErrorsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listWorkRequestErrorsResponseIterator

listWorkRequestLogs

listWorkRequestLogsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listWorkRequestLogsResponseIterator

listWorkRequests

listWorkRequestsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listWorkRequestsResponseIterator

manageModuleStreamsOnManagedInstance

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

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

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

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

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

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

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

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

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ManageModuleStreamsOnManagedInstance API.

    Parameters

    Returns Promise<ManageModuleStreamsOnManagedInstanceResponse>

    ManageModuleStreamsOnManagedInstanceResponse

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 does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RemoveModuleStreamProfileFromManagedInstance API.

    Parameters

    Returns Promise<RemoveModuleStreamProfileFromManagedInstanceResponse>

    RemoveModuleStreamProfileFromManagedInstanceResponse

removePackageFromManagedInstance

removePackagesFromSoftwareSource

runScheduledJobNow

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RunScheduledJobNow API.

    Parameters

    Returns Promise<RunScheduledJobNowResponse>

    RunScheduledJobNowResponse

searchAllSoftwarePackages

  • NOTE: This function is deprecated in favor of searchSoftwarePackagesRecordIterator function. Creates a new async iterator which will iterate over the models.SoftwarePackageSearchSummary objects contained in responses from the searchSoftwarePackages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SoftwarePackageSearchSummary>

searchAllSoftwarePackagesResponses

  • NOTE: This function is deprecated in favor of searchSoftwarePackagesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the searchSoftwarePackages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SearchSoftwarePackagesResponse>

searchSoftwarePackages

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SearchSoftwarePackages API.

    Parameters

    Returns Promise<SearchSoftwarePackagesResponse>

    SearchSoftwarePackagesResponse

searchSoftwarePackagesRecordIterator

searchSoftwarePackagesResponseIterator

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

skipNextScheduledJobExecution

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 does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SwitchModuleStreamOnManagedInstance API.

    Parameters

    Returns Promise<SwitchModuleStreamOnManagedInstanceResponse>

    SwitchModuleStreamOnManagedInstanceResponse

updateManagedInstance

updateManagedInstanceGroup

updateScheduledJob

updateSoftwareSource