Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ManagedInstanceGroupClient

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

  • ManagedInstanceGroupClient

Constructors

constructor

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

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

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

attachManagedInstancesToManagedInstanceGroup

attachSoftwareSourcesToManagedInstanceGroup

changeManagedInstanceGroupCompartment

close

  • close(): void

createManagedInstanceGroup

createWaiters

deleteManagedInstanceGroup

detachManagedInstancesFromManagedInstanceGroup

detachSoftwareSourcesFromManagedInstanceGroup

disableModuleStreamOnManagedInstanceGroup

  • Disables a module stream on a managed instance group. After the stream is disabled, you can no longer install the profiles contained by the stream. Before removing the stream, you must remove all installed profiles for the stream by using the {@link #removeModuleStreamProfileFromManagedInstanceGroup(RemoveModuleStreamProfileFromManagedInstanceGroupRequest) removeModuleStreamProfileFromManagedInstanceGroup} 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 DisableModuleStreamOnManagedInstanceGroup API.

    Parameters

    Returns Promise<DisableModuleStreamOnManagedInstanceGroupResponse>

    DisableModuleStreamOnManagedInstanceGroupResponse

enableModuleStreamOnManagedInstanceGroup

  • Enables a module stream on a managed instance group. After the stream is enabled, you can install a module stream profile. Enabling a stream that is already enabled will succeed. Enabling a different stream for a module that already has a stream enabled results in an error. Instead, use the {@link #switchModuleStreamOnManagedInstanceGroup(SwitchModuleStreamOnManagedInstanceGroupRequest) switchModuleStreamOnManagedInstanceGroup} 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 EnableModuleStreamOnManagedInstanceGroup API.

    Parameters

    Returns Promise<EnableModuleStreamOnManagedInstanceGroupResponse>

    EnableModuleStreamOnManagedInstanceGroupResponse

getManagedInstanceGroup

getWaiters

installModuleStreamProfileOnManagedInstanceGroup

installPackagesOnManagedInstanceGroup

installWindowsUpdatesOnManagedInstanceGroup

listManagedInstanceGroupAvailableModules

  • List modules that are available for installation on the specified managed instance group. Filter the list against a variety of criteria including but not limited to module name.

    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 ListManagedInstanceGroupAvailableModules API.

    Parameters

    Returns Promise<ListManagedInstanceGroupAvailableModulesResponse>

    ListManagedInstanceGroupAvailableModulesResponse

listManagedInstanceGroupAvailablePackages

listManagedInstanceGroupAvailableSoftwareSources

  • Lists available software sources for a specified managed instance group. Filter the list against a variety of criteria including but not limited to the software source name. The results list only software sources that have not already been added to the group.

    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 ListManagedInstanceGroupAvailableSoftwareSources API.

    Parameters

    Returns Promise<ListManagedInstanceGroupAvailableSoftwareSourcesResponse>

    ListManagedInstanceGroupAvailableSoftwareSourcesResponse

listManagedInstanceGroupInstalledPackages

listManagedInstanceGroupModules

  • Retrieve a list of module streams, along with a summary of their status, from a managed instance group. 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 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 ListManagedInstanceGroupModules API.

    Parameters

    Returns Promise<ListManagedInstanceGroupModulesResponse>

    ListManagedInstanceGroupModulesResponse

listManagedInstanceGroups

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

    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 ListManagedInstanceGroups API.

    Parameters

    Returns Promise<ListManagedInstanceGroupsResponse>

    ListManagedInstanceGroupsResponse

manageModuleStreamsOnManagedInstanceGroup

  • 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 #manageModuleStreamsOnManagedInstanceGroupDetails(ManageModuleStreamsOnManagedInstanceGroupDetailsRequest) manageModuleStreamsOnManagedInstanceGroupDetails} 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 ManageModuleStreamsOnManagedInstanceGroup API.

    Parameters

    Returns Promise<ManageModuleStreamsOnManagedInstanceGroupResponse>

    ManageModuleStreamsOnManagedInstanceGroupResponse

removeModuleStreamProfileFromManagedInstanceGroup

  • Removes a profile for a module stream that is installed on a managed instance group. Providing the module stream name (without specifying a profile name) removes all profiles that have been installed for the 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 RemoveModuleStreamProfileFromManagedInstanceGroup API.

    Parameters

    Returns Promise<RemoveModuleStreamProfileFromManagedInstanceGroupResponse>

    RemoveModuleStreamProfileFromManagedInstanceGroupResponse

removePackagesFromManagedInstanceGroup

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

switchModuleStreamOnManagedInstanceGroup

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

    Parameters

    Returns Promise<SwitchModuleStreamOnManagedInstanceGroupResponse>

    SwitchModuleStreamOnManagedInstanceGroupResponse

updateAllPackagesOnManagedInstanceGroup

updateManagedInstanceGroup