openapi: 3.2.0 info: description: "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. \nFor more information, see [Overview of OS Management Hub](https://docs.cloud.oracle.com/iaas/osmh/doc/overview.htm).\n" title: OS Management Hub Managed Instance Group API version: '20220901' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the OS Management Hub API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/53a02334fff4534e79601c527b7a16800905500d2c670af774e682c05d12a1e6.yaml what: the harvested document for OS Management Hub API servers: - url: http://127.0.0.1/20220901 - url: https://127.0.0.1/20220901 tags: - name: managedInstanceGroup paths: /managedInstanceGroups: get: description: 'Lists managed instance groups that match the specified compartment or managed instance group [OCID](/iaas/Content/General/Concepts/identifiers.htm). Filter the list against a variety of criteria including but not limited to name, status, architecture, and OS family. ' operationId: ListManagedInstanceGroups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ManagedInstanceGroupIdQueryParam' - $ref: '#/components/parameters/SoftwareSourceIdQueryParam' - $ref: '#/components/parameters/MultiDisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/ArchTypeQueryParam' - $ref: '#/components/parameters/OsFamilyQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ManagedInstanceGroupLifecycleStateQueryParam' - $ref: '#/components/parameters/MultiLocationQueryParam' - $ref: '#/components/parameters/MultiLocationNotEqualToQueryParam' - $ref: '#/components/parameters/IsManagedByAutonomousLinuxQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ManagedInstanceGroupSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of managed instance groups was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedInstanceGroupCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all managed instance groups in a compartment. tags: - managedInstanceGroup x-example: 'GET 20220901/managedInstanceGroups Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstanceGroup' post: description: 'Creates a new managed instance group. ' operationId: CreateManagedInstanceGroup parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The managed instance group was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedInstanceGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new ManagedInstanceGroup tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n \"displayName\": \"My-Display-Name\",\n \"description\": \"User-specified information about the managed instance group.\",\n \"managedInstanceIds\": [\n \"ocid1.instance.oc1..\"\n ],\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateManagedInstanceGroupDetails' description: Provides the information used to create the managed instance group. required: true /managedInstanceGroups/{managedInstanceGroupId}: delete: description: Deletes the specified managed instance group. operationId: DeleteManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The managed instance group was deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned ManagedInstanceGroup tags: - managedInstanceGroup x-example: 'DELETE 20220901/managedInstanceGroups/{managedInstanceGroupId} Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstanceGroup' get: description: Gets information about the specified managed instance group. operationId: GetManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The managed instance group was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedInstanceGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get ManagedInstanceGroup tags: - managedInstanceGroup x-example: 'GET 20220901/managedInstanceGroups/<resource_OCID> Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' put: description: Updates the specified managed instance group's name, description, and tags. operationId: UpdateManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The managed instance group was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedInstanceGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the ManagedInstanceGroup identified by the id tags: - managedInstanceGroup x-example: "PUT 20220901/managedInstanceGroups/{managedInstanceGroupId}\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"My-Updated-Display-Name\",\n \"description\": \"User-specified information about the managed instance group.\",\n \"managedInstanceIds\": [\n \"ocid1.instance.oc1..\"\n ],\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateManagedInstanceGroupDetails' description: Provides the details used to update the managed instance group. required: true /managedInstanceGroups/{managedInstanceGroupId}/actions/attachManagedInstances: post: description: 'Adds managed instances to the specified managed instance group. After adding instances to the group, any operation applied to the group will be applied to all instances in the group. ' operationId: AttachManagedInstancesToManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The managed instances are being added to the managed instance group. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Adds managed instances to a managed instance group tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/attachManagedInstances\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"managedInstances\": [\n \"ocid1.instance.oc1..\"\n ]\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/AttachManagedInstancesToManagedInstanceGroupDetails' description: The managed instances [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to attach to the managed instance group. required: true /managedInstanceGroups/{managedInstanceGroupId}/actions/attachSoftwareSources: post: description: 'Attaches software sources to the specified managed instance group. The software sources must be compatible with the type of instances in the group. ' operationId: AttachSoftwareSourcesToManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: 'The software sources were attached to the managed instance group. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Attaches software sources to a managed instance group tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/attachSoftwareSources\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"softwareSources\": [\n \"ocid1.softwareSource.oc1..\"\n ]\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/AttachSoftwareSourcesToManagedInstanceGroupDetails' description: The software source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to attach to the managed instance group. required: true /managedInstanceGroups/{managedInstanceGroupId}/actions/changeCompartment: post: description: 'Moves the specified managed instance group to a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeManagedInstanceGroupCompartment parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ChangeManagedInstanceGroupCompartmentDetailsParam' responses: 204: description: 'The managed instance group was moved to the specified compartment. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves a Managed Instance Group into a different compartment tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/changeCompartment\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..\"\n}\n" x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/ManagedInstanceGroup' /managedInstanceGroups/{managedInstanceGroupId}/actions/detachManagedInstances: post: description: 'Removes a managed instance from the specified managed instance group. ' operationId: DetachManagedInstancesFromManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: 'The managed instance was removed from the managed instance group. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Removes the specified managed instances from a managed instance group. tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/detachManagedInstances\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"managedInstances\": [\n \"ocid1.instance.oc1..\"\n ]\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/DetachManagedInstancesFromManagedInstanceGroupDetails' description: The managed instance [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to detach from the managed instance group. required: true /managedInstanceGroups/{managedInstanceGroupId}/actions/detachSoftwareSources: post: description: 'Detaches the specified software sources from a managed instance group. ' operationId: DetachSoftwareSourcesFromManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: 'The software sources were detached from the managed instance group. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Detaches software sources from a managed instance group tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/detachSoftwareSources\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"softwareSources\": [\n \"ocid1.softwareSource.oc1..\"\n ]\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/DetachSoftwareSourcesFromManagedInstanceGroupDetails' description: The software source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to detach from the managed instance group. required: true /managedInstanceGroups/{managedInstanceGroupId}/actions/disableModuleStream: post: description: '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 [RemoveModuleStreamProfileFromManagedInstanceGroup](#/en/osmh/latest//ManagedInstanceGroup/RemoveModuleStreamProfileFromManagedInstanceGroup) operation. ' operationId: DisableModuleStreamOnManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The module stream will be disabled on the managed instance. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Disable a specific module stream on a managed instance group tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/disableModuleStream\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"moduleName\": \"module_name\",\n \"streamName\": \"stream_name\"\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/DisableModuleStreamOnManagedInstanceGroupDetails' description: The details used to disable modules on the managed instance group. required: true /managedInstanceGroups/{managedInstanceGroupId}/actions/enableModuleStream: post: description: '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 [SwitchModuleStreamOnManagedInstanceGroup](#/en/osmh/latest/ManagedInstanceGroup/SwitchModuleStreamOnManagedInstanceGroup) operation. ' operationId: EnableModuleStreamOnManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The module stream will be enabled on the managed instance group. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Enable a specific module stream on a managed instance tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/enableModuleStream\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"moduleName\": \"module_name\",\n \"streamName\": \"stream_name\"\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableModuleStreamOnManagedInstanceGroupDetails' description: The details used to enable the module stream on the managed instance group. required: true /managedInstanceGroups/{managedInstanceGroupId}/actions/installPackages: post: description: 'Installs the specified packages on each managed instance in a managed instance group. The package must be compatible with the instances in the group. ' operationId: InstallPackagesOnManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The package will be installed on the managed instance(s). headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Installs package(s) on each managed instance in a managed instance group tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/installPackages\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"packageName\": \"package_name\"\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/InstallPackagesOnManagedInstanceGroupDetails' description: The names of packages to install on the specified managed instance group. required: true /managedInstanceGroups/{managedInstanceGroupId}/actions/installStreamProfile: post: description: 'Installs a profile for an enabled module stream. If a module stream defines multiple profiles, you can install each one independently. ' operationId: InstallModuleStreamProfileOnManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The module stream profile will be installed on the managed instance. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Installs a profile for an enabled module stream tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/installStreamProfile\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"moduleName\": \"module_name\",\n \"streamName\": \"stream_name\",\n \"profileName\": \"profile_name\"\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/InstallModuleStreamProfileOnManagedInstanceGroupDetails' description: The details used to install module stream profiles on a managed instance gorup. required: true /managedInstanceGroups/{managedInstanceGroupId}/actions/installWindowsUpdates: post: description: 'Installs Windows updates on each managed instance in the managed instance group. ' operationId: InstallWindowsUpdatesOnManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/InstallWindowsUpdatesOnManagedInstanceGroupDetailsParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The Windows updates will be installed on the managed instances. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Installs Windows update(s) on each managed instance in a managed instance group tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/installWindowsUpdates\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"updateType\": \"update_type\"\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' /managedInstanceGroups/{managedInstanceGroupId}/actions/manageModuleStreams: post: description: '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 [ManageModuleStreamsOnManagedInstanceGroupDetails](#/en/osmh/latest/datatypes/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. ' operationId: ManageModuleStreamsOnManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The operation will be processed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Perform an operation involving modules, streams, and profiles on a managed instance group tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/manageModuleStreams\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"moduleName\": \"module_name\",\n \"streamName\": \"stream_name\",\n \"action\": \"action\"\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ManageModuleStreamsOnManagedInstanceGroupDetails' description: The set of changes to make to the modules, streams, and profiles on a managed instance group. required: true /managedInstanceGroups/{managedInstanceGroupId}/actions/moduleStreams/switchModuleStream: post: description: '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. ' operationId: SwitchModuleStreamOnManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/SwitchModuleStreamOnManagedInstanceGroupDetailsParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The module stream will be switched on the managed instance group. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Changes the enabled stream for a module on a managed instance group tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/switchModuleStream\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"moduleName\": \"module_name\",\n \"streamName\": \"stream_name\",\n \"newStreamName\": \"new_stream_name\"\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' /managedInstanceGroups/{managedInstanceGroupId}/actions/reboot: post: description: 'Reboots all managed instances in the specified group. ' operationId: RebootManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The managed instance group will be rebooted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Reboots managed instances in a managed instance group. tags: - managedInstanceGroup x-example: 'POST 20220901/managedInstanceGroups/<resource_OCID>/actions/reboot Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/RebootManagedInstanceGroupDetails' description: Provides the information used to reboot managed instances in a group. required: true /managedInstanceGroups/{managedInstanceGroupId}/actions/refreshSoftware: post: description: 'Refreshes the package, Windows update or Snap 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. ' operationId: RefreshSoftwareOnManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The software data on the managed instances in the group will be refreshed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Refresh the software information on instances in a managed instance group tags: - managedInstanceGroup x-example: 'POST 20220901/managedInstanceGroups/<resource_OCID>/actions/refreshSoftware Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> If-Match: "" ' x-related-resource: '#/definitions/ManagedInstanceGroup' /managedInstanceGroups/{managedInstanceGroupId}/actions/removePackages: post: description: 'Removes the specified packages from each managed instance in a managed instance group. ' operationId: RemovePackagesFromManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The package will be removed from the managed instance. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Removes package(s) from each managed instance in a managed instance group tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/removePackages\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"packageName\": \"package_name\"\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemovePackagesFromManagedInstanceGroupDetails' description: The names of packages to remove from the specified managed instance group. required: true /managedInstanceGroups/{managedInstanceGroupId}/actions/removeStreamProfile: post: description: '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. ' operationId: RemoveModuleStreamProfileFromManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The module stream profile or profiles will be removed from the managed instance. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Removes an installed profile for a module stream from a managed instance group tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/removeStreamProfile\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"moduleName\": \"module_name\",\n \"streamName\": \"stream_name\",\n \"profileName\": \"profile_name\"\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveModuleStreamProfileFromManagedInstanceGroupDetails' description: The details used to remove profiles from the managed instance group. Providing the module stream name (without specifying a profile name) removes all profiles that have been installed for the module stream. required: true /managedInstanceGroups/{managedInstanceGroupId}/actions/updateAllPackages: post: description: 'Updates all packages on each managed instance in the specified managed instance group. ' operationId: UpdateAllPackagesOnManagedInstanceGroup parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The packages will be updated on the managed instances. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates all packages listed as installed on the managed instance group onto each managed instance in the managed instance group tags: - managedInstanceGroup x-example: "POST 20220901/managedInstanceGroups/<resource_OCID>/actions/updateAllPackages\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"updateType\": \"update_type\"\n}\n" x-related-resource: '#/definitions/ManagedInstanceGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAllPackagesOnManagedInstanceGroupDetails' description: Details for update operation on the managed instance group. required: true /managedInstanceGroups/{managedInstanceGroupId}/availableModules: get: description: '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. ' operationId: ListManagedInstanceGroupAvailableModules parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/NameParam' - $ref: '#/components/parameters/NameContainsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/NameSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of available module streams was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedInstanceGroupAvailableModuleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all modules available for a managed instance group tags: - managedInstanceGroup x-example: 'GET 20220901/managedInstanceGroups/<resource_OCID>/availableModules Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstanceGroup' /managedInstanceGroups/{managedInstanceGroupId}/availablePackages: get: description: "Lists available packages on the specified managed instances group. Filter the list against a variety \nof criteria including but not limited to the package name.\n" operationId: ListManagedInstanceGroupAvailablePackages parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/MultiDisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ManagedInstanceGroupSortByQueryParam' - $ref: '#/components/parameters/isLatestQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of available packages was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedInstanceGroupAvailablePackageCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all packages available for install on a managed instance group tags: - managedInstanceGroup x-example: 'GET 20220901/managedInstanceGroups/<resource_OCID>/availablePackages Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstanceGroup' /managedInstanceGroups/{managedInstanceGroupId}/availableSoftwareSources: get: description: '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. ' operationId: ListManagedInstanceGroupAvailableSoftwareSources parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/MultiDisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ManagedInstanceGroupSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of available software sources was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AvailableSoftwareSourceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all software sources available for the managed instance group. These only include software sources that are not already added to the managed instance group, but can be added. tags: - managedInstanceGroup x-example: 'GET 20220901/managedInstanceGroups/<resource_OCID>/availableSoftwareSources Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstanceGroup' /managedInstanceGroups/{managedInstanceGroupId}/installedPackages: get: description: "Lists installed packages on the specified managed instances group. Filter the list against a variety \nof criteria including but not limited to the package name.\n" operationId: ListManagedInstanceGroupInstalledPackages parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/MultiDisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/StartInstallDateQueryParam' - $ref: '#/components/parameters/EndInstallDateQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/InstalledPackageSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of installed packages was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedInstanceGroupInstalledPackageCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all packages installed on the managed instance group tags: - managedInstanceGroup x-example: 'GET 20220901/managedInstanceGroups/<resource_OCID>/installedPackages Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstanceGroup' /managedInstanceGroups/{managedInstanceGroupId}/managedInstances: get: description: 'Lists all managed instances for a specified managed instance group. Filter the list against a variety of criteria including but not limited to the managed instance name. The results list all managed instances that have already been added to the group. ' operationId: ListManagedInstanceGroupManagedInstances parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/ManagedInstanceIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubTreeQueryParam' - $ref: '#/components/parameters/MultiDisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ManagedInstanceGroupSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list managed instances was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedInstanceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all managed instances attached to a managed instance group. These only include instances that are already added to the managed instance group. tags: - managedInstanceGroup x-example: 'GET 20220901/managedInstanceGroups/<resource_OCID>/managedInstances Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstanceGroup' /managedInstanceGroups/{managedInstanceGroupId}/modules: get: description: '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. ' operationId: ListManagedInstanceGroupModules parameters: - $ref: '#/components/parameters/ManagedInstanceGroupIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/NameParam' - $ref: '#/components/parameters/NameContainsQueryParam' - $ref: '#/components/parameters/ModuleStreamNameParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/NameSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of module streams was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ManagedInstanceGroupModuleCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieve a list of module streams from a managed instance group. tags: - managedInstanceGroup x-example: 'GET 20220901/managedInstanceGroups/{managedInstanceGroupId}/modules Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/ManagedInstanceGroup' components: parameters: ChangeManagedInstanceGroupCompartmentDetailsParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the group to. in: body name: ChangeManagedInstanceGroupCompartmentDetails required: true schema: $ref: '#/components/schemas/ChangeManagedInstanceGroupCompartmentDetails' PaginationTokenQueryParam: description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `3` ' in: query name: page x-default-description: 'null' schema: type: string minLength: 1 OsFamilyQueryParam: description: A filter to return only resources that match the given operating system family. in: query name: osFamily x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OsFamily' schema: type: string enum: - ORACLE_LINUX_10 - ORACLE_LINUX_9 - ORACLE_LINUX_8 - ORACLE_LINUX_7 - ORACLE_LINUX_6 - WINDOWS_SERVER_2016 - WINDOWS_SERVER_2019 - WINDOWS_SERVER_2022 - WINDOWS_SERVER_2025 - WINDOWS_11 - ALL - UBUNTU_20_04 - UBUNTU_22_04 - UBUNTU_24_04 MultiDisplayNameQueryParam: description: A filter to return resources that match the given display names. in: query name: displayName x-default-description: 'null' style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string maxItems: 5 uniqueItems: true NameParam: description: 'The resource name. ' in: query name: name required: false x-default-description: 'null' schema: type: string DisplayNameContainsQueryParam: description: A filter to return resources that may partially match the given display name. in: query name: displayNameContains x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string MultiLocationQueryParam: description: A filter to return only resources whose location matches the given value. in: query name: location x-default-description: 'null' style: form explode: true schema: type: array items: enum: - ON_PREMISE - OCI_COMPUTE - AZURE - EC2 - GCP type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation' maxItems: 5 uniqueItems: true ManagedInstanceGroupIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group. This filter returns resources associated with this group. in: query name: managedInstanceGroupId required: false x-default-description: 'null' schema: type: string InstalledPackageSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeInstalled is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeInstalled - timeCreated - displayName default: timeInstalled CompartmentIdQueryParam: description: The OCID of the compartment that contains the resources to list. This filter returns only resources contained within the specified compartment. in: query name: compartmentId x-default-description: 'null' schema: type: string PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 10 maximum: 100 minimum: 1 SoftwareSourceIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source. This filter returns resources associated with this software source. in: query name: softwareSourceId required: false x-default-description: 'null' schema: type: string isLatestQueryParam: description: Indicates whether to list only the latest versions of packages, module streams, and stream profiles. in: query name: isLatest required: false x-default-description: 'null' schema: type: boolean EndInstallDateQueryParam: description: 'A filter to return only packages that were installed on or before the date provided, in ISO 8601 format. Example: 2017-07-14T02:40:00.000Z ' in: query name: timeInstallDateEnd required: false x-default-description: 'null' schema: type: string format: date-time CompartmentIdInSubTreeQueryParam: description: Indicates whether to include subcompartments in the returned results. Default is false. in: query name: compartmentIdInSubtree required: false x-default-description: false schema: type: boolean SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC NameSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for name is ascending. ' in: query name: sortBy schema: type: string enum: - name default: name SwitchModuleStreamOnManagedInstanceGroupDetailsParam: description: Provides the details used to switch module streams on a managed instance group. in: body name: SwitchModuleStreamOnManagedInstanceGroupDetails required: true schema: $ref: '#/components/schemas/SwitchModuleStreamOnManagedInstanceGroupDetails' MultiLocationNotEqualToQueryParam: description: A filter to return only resources whose location does not match the given value. in: query name: locationNotEqualTo x-default-description: 'null' style: form explode: true schema: type: array items: enum: - ON_PREMISE - OCI_COMPUTE - AZURE - EC2 - GCP type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation' maxItems: 5 uniqueItems: true NameContainsQueryParam: description: A filter to return resources that may partially match the name given. in: query name: nameContains required: false x-default-description: 'null' schema: type: string InstallWindowsUpdatesOnManagedInstanceGroupDetailsParam: description: Provides the details used to install Windows updates on a managed instance group. in: body name: InstallWindowsUpdatesOnManagedInstanceGroupDetails required: true schema: $ref: '#/components/schemas/InstallWindowsUpdatesOnManagedInstanceGroupDetails' RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 IsManagedByAutonomousLinuxQueryParam: description: 'Indicates whether to list only resources managed by the Autonomous Linux service. ' in: query name: isManagedByAutonomousLinux required: false x-default-description: 'null' schema: type: boolean ModuleStreamNameParam: description: The name of the module stream. This parameter is required if a profile name is specified. in: query name: streamName required: false x-default-description: 'null' schema: type: string ManagedInstanceGroupLifecycleStateQueryParam: description: A filter to return only managed instance groups that are in the specified state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/ManagedInstanceGroup/lifecycleState' schema: type: string ArchTypeQueryParam: description: A filter to return only profiles that match the given archType. in: query name: archType x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ArchType' schema: type: string enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL ManagedInstanceGroupSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated RequestIdHeader: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. in: header name: opc-request-id schema: type: string ManagedInstanceIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. This filter returns resources associated with this managed instance. in: query name: managedInstanceId required: false x-default-description: 'null' schema: type: string StartInstallDateQueryParam: description: 'The install date after which to list all packages, in ISO 8601 format Example: 2017-07-14T02:40:00.000Z ' in: query name: timeInstallDateStart required: false x-default-description: 'null' schema: type: string format: date-time ManagedInstanceGroupIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group. in: path name: managedInstanceGroupId required: true schema: type: string schemas: ModuleStreamProfileDetails: description: Provides the information used to update a module stream profile. properties: moduleName: description: The name of a module. type: string profileName: description: The name of a profile of the specified module stream. type: string softwareSourceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. ' type: string streamName: description: The name of a stream of the specified module. type: string required: - moduleName - streamName - profileName ManagedInstanceGroupAvailablePackageCollection: description: A set of available packages returned for the [ListManagedInstanceGroupAvailablePackages](#/en/osmh/latest/ManagedInstanceGroup/ListManagedInstanceGroupAvailablePackages) operation. properties: items: description: List of available packages. items: $ref: '#/components/schemas/ManagedInstanceGroupAvailablePackageSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"name\": \"Package-Name-1\",\n \"architecture\": \"x86_64\"\n },\n {\n \"name\": \"Package-Name-2\",\n \"architecture\": \"x86_64\"\n },\n {\n \"name\": \"Package-Name-3\",\n \"architecture\": \"x86_64\"\n }\n ]\n}\n" EnableModuleStreamOnManagedInstanceGroupDetails: description: Provides the details for enabling a module stream on a managed instance group. properties: moduleName: description: The name of the module. type: string softwareSourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source that provides the module stream type: string streamName: description: The name of a stream of the specified module. type: string workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - moduleName Error: description: Provides the information for an error. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message Id: description: Id and name of a resource to simplify the display for the user. properties: displayName: description: User-friendly name. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource that is immutable on creation. type: string required: - displayName - id ManagedInstanceSummary: description: Provides summary information for a managed instance. properties: agentVersion: description: The version of osmh-agent running on the managed instance type: string architecture: description: The CPU architecture type of the managed instance. enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL type: string x-obmcs-top-level-enum: '#/definitions/ArchType' autonomousSettings: $ref: '#/components/schemas/AutonomousSettings' compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the managed instance. ' type: string description: description: User-specified description of the managed instance. type: string displayName: description: User-friendly name for the managed instance. type: string id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance. ' type: string isManagedByAutonomousLinux: description: Indicates whether Autonomous Linux manages this instance. type: boolean isManagementStation: description: Whether this managed instance is acting as an on-premises management station. type: boolean isRebootRequired: description: Indicates whether a reboot is required to complete installation of updates. type: boolean lifecycleEnvironment: $ref: '#/components/schemas/Id' lifecycleStage: $ref: '#/components/schemas/Id' location: description: The location of the managed instance. enum: - ON_PREMISE - OCI_COMPUTE - AZURE - EC2 - GCP type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation' managedInstanceGroup: $ref: '#/components/schemas/Id' notificationTopicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. ' type: string osFamily: description: The operating system type of the managed instance. enum: - ORACLE_LINUX_10 - ORACLE_LINUX_9 - ORACLE_LINUX_8 - ORACLE_LINUX_7 - ORACLE_LINUX_6 - WINDOWS_SERVER_2016 - WINDOWS_SERVER_2019 - WINDOWS_SERVER_2022 - WINDOWS_SERVER_2025 - WINDOWS_11 - ALL - UBUNTU_20_04 - UBUNTU_22_04 - UBUNTU_24_04 type: string x-obmcs-top-level-enum: '#/definitions/OsFamily' status: description: Current status of the managed instance. enum: - NORMAL - UNREACHABLE - ERROR - WARNING - REGISTRATION_ERROR - DELETING - ONBOARDING - REBOOTING type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceStatus' tenancyId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tenancy this managed instance resides in. ' type: string timeLastBoot: description: 'Time that the instance last booted (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string updatesAvailable: description: Number of updates available for installation. type: integer required: - id - displayName - tenancyId - compartmentId - status type: object ManagedInstanceGroup: description: An object that defines the managed instance group. properties: archType: description: The CPU architecture of the instances in the managed instance group. enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL type: string x-obmcs-top-level-enum: '#/definitions/ArchType' autonomousSettings: $ref: '#/components/schemas/AutonomousSettings' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the managed instance group. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: User-specified information about the managed instance group. type: string displayName: description: A user-friendly name for the managed instance group. format: x-obmcs-ascii-identifier pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group. type: string isManagedByAutonomousLinux: description: Indicates whether the Autonomous Linux service manages the group. type: boolean lifecycleState: description: The current state of the managed instance group. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string location: description: The location of managed instances attached to the group. enum: - ON_PREMISE - OCI_COMPUTE - AZURE - EC2 - GCP type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation' managedInstanceCount: description: The number of managed instances in the group. type: integer managedInstanceIds: description: The list of managed instance [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) attached to the managed instance group. items: type: string type: array notificationTopicId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. type: string osFamily: description: The operating system type of the instances in the managed instance group. enum: - ORACLE_LINUX_10 - ORACLE_LINUX_9 - ORACLE_LINUX_8 - ORACLE_LINUX_7 - ORACLE_LINUX_6 - WINDOWS_SERVER_2016 - WINDOWS_SERVER_2019 - WINDOWS_SERVER_2022 - WINDOWS_SERVER_2025 - WINDOWS_11 - ALL - UBUNTU_20_04 - UBUNTU_22_04 - UBUNTU_24_04 type: string x-obmcs-top-level-enum: '#/definitions/OsFamily' pendingJobCount: description: The number of scheduled jobs pending against the managed instance group. type: integer softwareSourceIds: description: The list of software source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) that the managed instance group will use. items: $ref: '#/components/schemas/SoftwareSourceDetails' type: array softwareSources: description: The list of software sources that the managed instance group will use. items: $ref: '#/components/schemas/SoftwareSourceDetails' type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the managed instance group was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). format: date-time type: string timeModified: description: The time the managed instance group was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). format: date-time type: string vendorName: description: The vendor of the operating system used by the managed instances in the group. enum: - ORACLE - MICROSOFT - CANONICAL type: string x-obmcs-top-level-enum: '#/definitions/VendorName' required: - id - compartmentId - lifecycleState type: object x-example: "{\n \"id\": \"ocid1.osmhmanagedinstancegroup.oc1..<unique_id>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"displayName\": \"My-Managed-Instance-Group\",\n \"description\": \"User-specified information about the managed instance group.\",\n \"timeCreated\": \"2025-02-06T16:04:40.078Z\",\n \"timeModified\": \"2025-02-06T16:04:40.078Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"osFamily\": \"ORACLE_LINUX_8\",\n \"archType\": \"X86_64\",\n \"vendorName\": \"ORACLE\",\n \"softwareSourceIds\": [\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-3\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": true\n },\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-2\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": true\n },\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-3\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": false\n }\n ],\n \"softwareSources\": [\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-3\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": true\n },\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-2\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": true\n },\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-3\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": false\n }\n ],\n \"managedInstanceIds\": [\n \"ocid1.instance.oc1..<unique_id>\"\n ],\n \"managedInstanceCount\": 1,\n \"location\": \"OCI_COMPUTE\",\n \"pendingJobCount\": 1,\n \"notificationTopicId\": \"ocid1.onstopic.oc1..<unique_id>\",\n \"autonomousSettings\": {\n \"isDataCollectionAuthorized\": true,\n \"scheduledJobId\": \"ocid1.osmhscheduledjob.oc1..<unique_id>\"\n },\n \"isManagedByAutonomousLinux\": true,\n \"freeformTags\": {},\n \"definedTags\": {},\n \"systemTags\": {}\n}\n" ManagedInstanceGroupAvailableModuleSummary: description: Provides summary information about a module stream made available to a managed instance group. properties: name: description: The name of the module that is available to the managed instance group. type: string softwareSourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source that provides the module. type: string required: - name type: object RebootManagedInstanceGroupDetails: description: Provides the information used for the reboot job. properties: rebootTimeoutInMins: default: 20 description: "The number of minutes the service waits for the reboot to complete. If the instances in the group don't reboot \nwithin this time, the reboot job status is set to failed.\n" maximum: 240 minimum: 5 type: integer workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' type: object AvailableSoftwareSourceSummary: description: "Provides summary information about an available software source. \nAn available software source can be added to a managed instance. \nAfter a software source is added, packages from that software source can be installed on that managed instance.\n" properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the software source. type: string description: description: Software source description. type: string displayName: description: User-friendly name for the software source. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source. type: string softwareSourceType: description: Type of the software source. enum: - VENDOR - CUSTOM - VERSIONED - PRIVATE - THIRD_PARTY type: string x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType' required: - displayName - id - compartmentId - softwareSourceType type: object DetachSoftwareSourcesFromManagedInstanceGroupDetails: description: Provides the information used to detach software sources from a managed instance group. properties: softwareSources: description: List of software source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to detach from the group. items: type: string type: array workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - softwareSources CreateManagedInstanceGroupDetails: description: Provides the information used to create a new managed instance group. properties: archType: description: 'The CPU architecture type of the managed instances that will be attached to this group. ' enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL maxLength: 255 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/ArchType' autonomousSettings: $ref: '#/components/schemas/UpdatableAutonomousSettings' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the managed instance group. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: User-specified description of the managed instance group. Avoid entering confidential information. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly name for the managed instance group. Does not have to be unique and you can change the name later. Avoid entering confidential information. format: x-obmcs-ascii-identifier maxLength: 255 minLength: 1 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object location: description: 'The location of managed instances attached to the group. If no location is provided, the default is on premises. ' enum: - ON_PREMISE - OCI_COMPUTE - AZURE - EC2 - GCP type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation' managedInstanceIds: description: The list of managed instance [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to be added to the group. items: type: string maxItems: 255 type: array notificationTopicId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. type: string osFamily: description: 'The operating system type of the managed instances that will be attached to this group. ' enum: - ORACLE_LINUX_10 - ORACLE_LINUX_9 - ORACLE_LINUX_8 - ORACLE_LINUX_7 - ORACLE_LINUX_6 - WINDOWS_SERVER_2016 - WINDOWS_SERVER_2019 - WINDOWS_SERVER_2022 - WINDOWS_SERVER_2025 - WINDOWS_11 - ALL - UBUNTU_20_04 - UBUNTU_22_04 - UBUNTU_24_04 maxLength: 255 minLength: 1 type: string x-obmcs-top-level-enum: '#/definitions/OsFamily' softwareSourceIds: description: The list of software source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) available to the managed instances in the group. items: type: string maxItems: 25 minItems: 1 type: array vendorName: description: 'The vendor of the operating system that will be used by the managed instances in the group. ' enum: - ORACLE - MICROSOFT - CANONICAL type: string x-obmcs-top-level-enum: '#/definitions/VendorName' required: - displayName - compartmentId - osFamily - archType - vendorName type: object x-example: "{\n \"id\": \"ocid1.osmhmanagedinstancegroup.oc1..<unique_id>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"displayName\": \"My-Managed-Instance-Group\",\n \"description\": \"User-specified description of the managed instance group.\",\n \"timeCreated\": \"2025-02-06T21:14:45.032Z\",\n \"timeModified\": \"2025-02-06T21:14:45.032Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"osFamily\": \"ORACLE_LINUX_8\",\n \"archType\": \"X86_64\",\n \"vendorName\": \"ORACLE\",\n \"location\": \"OCI_COMPUTE\",\n \"softwareSourceIds\": [\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-3\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": true\n },\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-2\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": true\n },\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-3\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": false\n }\n ],\n \"softwareSources\": [\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-3\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": true\n },\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-2\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": true\n },\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-3\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": false\n }\n ],\n \"managedInstanceIds\": [\n \"ocid1.instance.oc1..<unique_id>\"\n ],\n \"managedInstanceCount\": 0,\n \"location\": \"OCI_COMPUTE\",\n \"pendingJobCount\": 0,\n \"notificationTopicId\": null,\n \"autonomousSettings\": {\n \"isDataCollectionAuthorized\": false,\n \"scheduledJobId\": null\n },\n \"isManagedByAutonomousLinux\": false,\n \"notificationTopicId\": null,\n \"autonomousSettings\": {},\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" RemovePackagesFromManagedInstanceGroupDetails: description: The names of the packages to be removed from the managed instance group. properties: packageNames: description: The list of package names. items: type: string type: array workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - packageNames UpdatableAutonomousSettings: description: Updatable settings for the Autonomous Linux service. This is required when creating an Autonomous Linux Managed Instance Group. Do not include it when creating a standard (non-Autonomous) Managed Instance Group. properties: isDataCollectionAuthorized: description: Indicates whether Autonomous Linux will collect crash files. type: boolean type: object SwitchModuleStreamOnManagedInstanceGroupDetails: description: Provides the details for switching module streams on the managed instance group. properties: moduleName: description: The name of the module. type: string softwareSourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source that provides the module stream type: string streamName: description: The name of a stream of the specified module. type: string workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - moduleName - streamName AutonomousSettings: description: Settings for the Autonomous Linux service. properties: isDataCollectionAuthorized: description: Indicates whether Autonomous Linux will collect crash files. This setting can be changed by the user. type: boolean scheduledJobId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the restricted scheduled job associated with this instance. This value cannot be deleted by the user. type: string type: object ModuleStreamDetails: description: Provides the information used to update a module stream. properties: moduleName: description: The name of a module. type: string softwareSourceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source that contains the module stream. ' type: string streamName: description: The name of a stream of the specified module. type: string required: - moduleName - streamName UpdateManagedInstanceGroupDetails: description: Provides the information used to update the managed instance group. properties: autonomousSettings: $ref: '#/components/schemas/UpdatableAutonomousSettings' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: User-specified description of the managed instance group. Avoid entering confidential information. maxLength: 400 minLength: 0 type: string displayName: description: A user-friendly name for the managed instance group. Avoid entering confidential information. format: x-obmcs-ascii-identifier maxLength: 255 minLength: 1 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object notificationTopicId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. type: string type: object x-example: "{\n \"id\": \"ocid1.osmhmanagedinstancegroup.oc1..<unique_id>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"displayName\": \"My-Group\",\n \"description\": \"User-specified information about the managed instance group.\",\n \"timeCreated\": \"2025-02-06T16:03:48.005Z\",\n \"timeModified\": \"2025-02-06T21:05:38.921Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"osFamily\": \"ORACLE_LINUX_8\",\n \"archType\": \"X86_64\",\n \"vendorName\": \"ORACLE\",\n \"softwareSourceIds\": [\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-3\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": true\n },\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-2\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": true\n },\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-3\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": false\n }\n ],\n \"softwareSources\": [\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-3\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": true\n },\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-2\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": true\n },\n {\n \"id\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\",\n \"displayName\": \"My-SS-Name-3\",\n \"description\": null,\n \"softwareSourceType\": \"VENDOR\",\n \"isMandatoryForAutonomousLinux\": false\n }\n ],\n \"managedInstanceIds\": [\n \"ocid1.instance.oc1..<unique_id>\" \n],\n \"managedInstanceCount\": 1,\n \"location\": \"OCI_COMPUTE\",\n \"pendingJobCount\": null,\n \"notificationTopicId\": null,\n \"autonomousSettings\": {\n \"isDataCollectionAuthorized\": false,\n \"scheduledJobId\": null\n },\n \"isManagedByAutonomousLinux\": false,\n \"freeformTags\": null,\n \"definedTags\": null,\n \"systemTags\": null\n}\n" InstallModuleStreamProfileOnManagedInstanceGroupDetails: description: Provides the details for installing a module stream profile on a managed instance group. properties: moduleName: description: The name of the module. type: string profileName: description: The name of a profile of the specified module stream. type: string softwareSourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source that provides the module stream type: string streamName: description: The name of a stream of the specified module. type: string workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - moduleName ManagedInstanceCollection: description: 'The set of managed instances returned for the [ListManagedInstances](#/en/osmh/latest/ManagedInstance/ListManagedInstances) operation. ' properties: items: description: List of managed instances. items: $ref: '#/components/schemas/ManagedInstanceSummary' type: array required: - items type: object RemoveModuleStreamProfileFromManagedInstanceGroupDetails: description: Provides the details for removing a module stream profile from a managed instance group. properties: moduleName: description: The name of the module. type: string profileName: description: The name of a profile of the specified module stream. type: string softwareSourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source that provides the module stream type: string streamName: description: The name of a stream of the specified module. type: string workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - moduleName ManagedInstanceGroupSummary: description: Summary of the managed instance group. properties: archType: description: The CPU architecture of the instances in the managed instance group. enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL type: string x-obmcs-top-level-enum: '#/definitions/ArchType' autonomousSettings: $ref: '#/components/schemas/AutonomousSettings' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the managed instance group type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: User-specified information about the managed instance group. type: string displayName: description: A user-friendly name for the managed instance group. format: x-obmcs-ascii-identifier pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the managed instance group. type: string isManagedByAutonomousLinux: description: Indicates whether the Autonomous Linux service manages the group. type: boolean lifecycleState: description: The current state of the managed instance group. type: string x-obmcs-enumref: '#/definitions/ManagedInstanceGroup/lifecycleState' location: description: The location of managed instances attached to the group. enum: - ON_PREMISE - OCI_COMPUTE - AZURE - EC2 - GCP type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation' managedInstanceCount: description: The number of managed instances in the group. type: integer notificationTopicId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer. type: string osFamily: description: The operating system type of the instances in the managed instance group. enum: - ORACLE_LINUX_10 - ORACLE_LINUX_9 - ORACLE_LINUX_8 - ORACLE_LINUX_7 - ORACLE_LINUX_6 - WINDOWS_SERVER_2016 - WINDOWS_SERVER_2019 - WINDOWS_SERVER_2022 - WINDOWS_SERVER_2025 - WINDOWS_11 - ALL - UBUNTU_20_04 - UBUNTU_22_04 - UBUNTU_24_04 type: string x-obmcs-top-level-enum: '#/definitions/OsFamily' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the managed instance group was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). format: date-time type: string timeModified: description: The time the managed instance group was last modified (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). format: date-time type: string vendorName: description: The vendor of the operating system used by the managed instances in the group. enum: - ORACLE - MICROSOFT - CANONICAL type: string x-obmcs-top-level-enum: '#/definitions/VendorName' required: - id - compartmentId - lifecycleState type: object InstallPackagesOnManagedInstanceGroupDetails: description: The names of the packages to be installed on the managed instance group. properties: isLatest: description: Indicates whether this is the latest package version. type: boolean packageNames: description: The list of package names. items: type: string type: array workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - packageNames SoftwareSourceDetails: description: Provides identifying information for the specified software source. properties: description: description: Software source description. type: string displayName: description: Software source name. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source. type: string isMandatoryForAutonomousLinux: description: Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it. type: boolean softwareSourceType: description: Type of the software source. enum: - VENDOR - CUSTOM - VERSIONED - PRIVATE - THIRD_PARTY type: string x-obmcs-top-level-enum: '#/definitions/SoftwareSourceType' required: - id type: object ManagedInstanceGroupCollection: description: A set of managed instance groups returned for the [ListManagagedInstanceGroups](#/en/osmh/latest/ManagedInstanceGroup/ListManagedInstanceGroups) operation. properties: items: description: List of managed instance groups. items: $ref: '#/components/schemas/ManagedInstanceGroupSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"id\": \"ocid1.osmhmanagedinstancegroup.oc1..<unique_id>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"displayName\": \"My-Managed-Instance-Group-1\",\n \"description\": \"User-specified information about the managed instance group.\",\n \"managedInstanceCount\": 1,\n \"location\": \"OCI_COMPUTE\",\n \"timeCreated\": \"2025-02-06T16:04:40.078Z\",\n \"timeModified\": \"2025-02-06T16:04:40.078Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"osFamily\": \"ORACLE_LINUX_8\",\n \"archType\": \"X86_64\",\n \"vendorName\": \"ORACLE\",\n \"notificationTopicId\": \"ocid1.onstopic.oc1..<unique_id>\",\n \"autonomousSettings\": {\n \"isDataCollectionAuthorized\": true,\n \"scheduledJobId\": \"ocid1.osmhscheduledjob.oc1..<unique_id>\"\n },\n \"isManagedByAutonomousLinux\": true,\n \"freeformTags\": {},\n \"definedTags\": {},\n \"systemTags\": {}\n },\n {\n \"id\": \"ocid1.osmhmanagedinstancegroup.oc1..<unique_id>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"displayName\": \"My-Managed-Instance-Group-2\",\n \"description\": \"User-specified information about the managed instance group.\",\n \"managedInstanceCount\": 2,\n \"location\": \"OCI_COMPUTE\",\n \"timeCreated\": \"2025-02-06T16:04:40.078Z\",\n \"timeModified\": \"2025-02-06T16:04:40.078Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"osFamily\": \"ORACLE_LINUX_8\",\n \"archType\": \"X86_64\",\n \"vendorName\": \"ORACLE\",\n \"notificationTopicId\": null,\n \"autonomousSettings\": {},\n \"isManagedByAutonomousLinux\": false,\n \"freeformTags\": {},\n \"definedTags\": {},\n \"systemTags\": {}\n }\n ]\n}\n" ManagedInstanceGroupInstalledPackageSummary: description: Provides summary information for a package installed on a managed instance group. properties: architecture: description: 'The architecture of the package that is installed on the managed instance group. ' type: string name: description: 'The name of the package that is installed on the managed instance group. ' type: string required: - name - architecture type: object ManagedInstanceGroupInstalledPackageCollection: description: 'A set of installed packages returned for the [ListManagedInstanceGroupInstalledPackages](#/en/osmh/latest/ManagedInstanceGroup/ListManagedInstanceGroupInstalledPackages) operation. ' properties: items: description: List of installed packages. items: $ref: '#/components/schemas/ManagedInstanceGroupInstalledPackageSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"name\": \"Package-Name-1\",\n \"architecture\": \"x86_64\"\n },\n {\n \"name\": \"Package-Name-2\",\n \"architecture\": \"x86_64\"\n },\n {\n \"name\": \"Package-Name-3\",\n \"architecture\": \"x86_64\"\n }\n ]\n}\n" ManageModuleStreamsOnManagedInstanceGroupDetails: description: The set of changes to make to the state of the modules, streams, and profiles on a managed instance group. properties: disable: description: The set of module streams to disable. items: $ref: '#/components/schemas/ModuleStreamDetails' maxItems: 255 type: array enable: description: The set of module streams to enable. items: $ref: '#/components/schemas/ModuleStreamDetails' maxItems: 255 type: array install: description: The set of module stream profiles to install. items: $ref: '#/components/schemas/ModuleStreamProfileDetails' maxItems: 255 type: array isDryRun: default: false description: 'Indicates if this operation is a dry run or if the operation should be committed. If set to true, the result of the operation will be evaluated but not committed. If set to false, the operation is committed to the managed instance(s). The default is false. ' type: boolean remove: description: The set of module stream profiles to remove. items: $ref: '#/components/schemas/ModuleStreamProfileDetails' maxItems: 255 type: array workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' type: object x-example: "{\n \"items\": [\n {\n \"name\": \"Module-Name-1\",\n \"enabledStream\": \"Module-Stream\",\n \"installedProfiles\": [\n \"Profile-Name\"\n ],\n \"softwareSourceId\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\"\n },\n {\n \"name\": \"Module-Name-1\",\n \"enabledStream\": \"Module-Stream\",\n \"installedProfiles\": [\n \"Profile-Name\"\n ],\n \"softwareSourceId\": null\n }\n ]\n}\n" AttachSoftwareSourcesToManagedInstanceGroupDetails: description: Provides the information used to attach software sources to a managed instance group. properties: softwareSources: description: List of software source [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to attach to the group. items: type: string type: array workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - softwareSources DetachManagedInstancesFromManagedInstanceGroupDetails: description: Provides the information used to detach managed instances from a group. properties: managedInstances: description: List of managed instance [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to detach from the group. items: type: string type: array required: - managedInstances ManagedInstanceGroupAvailablePackageSummary: description: Provides summary information for an available package for a managed instance group. properties: architecture: description: The architecture for which this package was built. enum: - X86_64 - AARCH64 - I686 - NOARCH - SRC - I386 - AMD64 - ARM64 - ALL type: string x-obmcs-top-level-enum: '#/definitions/ArchType' displayName: description: Package name. type: string isLatest: description: Indicates whether this is the latest package version. type: boolean name: description: Unique identifier for the package. Note that this is not an OCID. type: string softwareSources: description: List of software sources that provide the software package. items: $ref: '#/components/schemas/SoftwareSourceDetails' type: array type: description: Type of the package. type: string version: description: Version of the available package. type: string required: - displayName - type - version - name UpdateAllPackagesOnManagedInstanceGroupDetails: description: Provides the details for updating the packages on the managed instance. properties: updateTypes: description: The type of updates to be applied. items: enum: - SECURITY - BUGFIX - ENHANCEMENT - OTHER - KSPLICE_KERNEL - KSPLICE_USERSPACE - ALL type: string x-obmcs-top-level-enum: '#/definitions/UpdateTypes' maxItems: 20 type: array uniqueItems: true workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' ManagedInstanceGroupModuleSummary: description: Provides the summary information about a module on a managed instance group. properties: enabledStream: description: The name of the module stream that is enabled for the group. type: string installedProfiles: description: The list of installed profiles under the currently enabled module stream. items: type: string maxItems: 50 type: array name: description: The name of the module. type: string softwareSourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source that provides this module stream. type: string required: - name type: object AttachManagedInstancesToManagedInstanceGroupDetails: description: Provides the information used to attach managed instances to a group. properties: managedInstances: description: List of managed instance [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) to attach to the group. items: type: string type: array workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - managedInstances ManagedInstanceGroupAvailableModuleCollection: description: A set of modules returned for the [ListManagedInstanceGroupAvailableModules](#/en/osmh/latest/ManagedInstanceGroup/ListManagedInstanceGroupAvailableModules) operation. properties: items: description: List of available modules. items: $ref: '#/components/schemas/ManagedInstanceGroupAvailableModuleSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"name\": \"Module-Name-1\",\n \"softwareSourceId\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\"\n },\n {\n \"name\": \"Module-Name-2\",\n \"softwareSourceId\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\"\n },\n {\n \"name\": \"Module-Name-3\",\n \"softwareSourceId\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\"\n },\n {\n \"name\": \"Module-Name-4\",\n \"softwareSourceId\": \"ocid1.osmssoftwaresource.oc1..<unique_id>\"\n }\n ]\n}\n" InstallWindowsUpdatesOnManagedInstanceGroupDetails: description: Provides the details for the Windows update installed on the managed instance group. properties: windowsUpdateTypes: description: The type of Windows updates to be applied. items: enum: - SECURITY - BUGFIX - ENHANCEMENT - OTHER - ALL type: string x-obmcs-top-level-enum: '#/definitions/WindowsUpdateTypes' maxItems: 5 type: array uniqueItems: true workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - windowsUpdateTypes type: object ChangeManagedInstanceGroupCompartmentDetails: description: 'Provides the information used to move the managed instance group to another compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the group to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object DisableModuleStreamOnManagedInstanceGroupDetails: description: Provides the details for disabling a module stream on a managed instance group. properties: moduleName: description: The name of the module. type: string softwareSourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the software source that provides the module stream type: string streamName: description: The name of a stream of the specified module. type: string workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - moduleName WorkRequestDetails: description: Provides the name and description of the job. properties: description: description: User-specified information about the job. Avoid entering confidential information. maxLength: 400 minLength: 0 type: string displayName: description: A user-friendly name for the job. The name does not have to be unique. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string type: object ManagedInstanceGroupModuleCollection: description: 'A set of module streams returned for the [ListManagagedInstanceGroupModules](#/en/osmh/latest/ManagedInstanceGroup/ListManagedInstanceGroupModules) operation. ' properties: items: description: List of module streams. items: $ref: '#/components/schemas/ManagedInstanceGroupModuleSummary' type: array required: - items type: object AvailableSoftwareSourceCollection: description: "The set of available software sources returned for the [ListManagedInstanceAvailableSoftwareSources](#/en/osmh/latest/ManagedInstance/ListManagedInstanceAvailableSoftwareSources) or the \n[ListManagedInstanceGroupAvailableSoftwareSources](#/en/osmh/latest/ManagedInstanceGroup/ListManagedInstanceGroupAvailableSoftwareSources) operation.\n" properties: items: description: List of available software sources. items: $ref: '#/components/schemas/AvailableSoftwareSourceSummary' type: array required: - items type: object responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-total-items: description: 'The total number of items in the result. Used for pagination of a list of items. ' type: integer opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.oci.osmh.api