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 Dynamic Set 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: dynamicSet paths: /dynamicSets: get: description: Lists dynamic sets that match the specified compartment or dynamic set OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS version. operationId: ListDynamicSets parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DynamicSetIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DynamicSetSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of dynamic sets 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-total-items: description: 'The total number of items in the result. Used for pagination of a list of items. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/DynamicSetCollection' 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 dynamic sets in a compartment tags: - dynamicSet x-example: 'GET 20220901/dynamicSets?compartmentId=<compartment_OCID> Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DynamicSet' post: description: 'Creates a new dynamic set. ' operationId: CreateDynamicSet parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The dynamic set 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/DynamicSet' 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 DynamicSet tags: - dynamicSet x-example: "POST 20220901/dynamicSets\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 dynamic set.\",\n \"freeformTags\": {},\n \"definedTags\": {}\n}\n" x-related-resource: '#/definitions/DynamicSet' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDynamicSetDetails' description: Provides the information used to create the dynamic set. required: true /dynamicSets/actions/previewManagedInstances: post: description: Preview a dynamic set operationId: PreviewManagedInstances parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubTreeQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ManagedInstanceSortByQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' responses: 200: description: Preview of the dynamic set 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-total-items: description: 'The total number of items in the result. Used for pagination of a list of items. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ManagedInstanceCollection' 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: Preview managed instances in a dynamic set tags: - dynamicSet x-related-resource: '#/definitions/DynamicSet' requestBody: content: application/json: schema: $ref: '#/components/schemas/PreviewManagedInstancesDetails' description: Provides the information used to Preview the dynamic set. required: true /dynamicSets/{dynamicSetId}: delete: description: 'Deletes the specific dynamic set ' operationId: DeleteDynamicSet parameters: - $ref: '#/components/parameters/DynamicSetIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The dynamic set 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: Deletes a DynamicSet tags: - dynamicSet x-example: 'DELETE 20220901/dynamicSets/<resource_OCID> Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> If-Match: "" ' x-related-resource: '#/definitions/DynamicSet' get: description: Gets information about the specified dynamic set. operationId: GetDynamicSet parameters: - $ref: '#/components/parameters/DynamicSetIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The dynamic set 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 retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/DynamicSet' 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 DynamicSet tags: - dynamicSet x-example: 'GET 20220901/dynamicSets/<resource_OCID> Host: osmh.us-phoenix-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DynamicSet' put: description: 'Updates the specified dynamic set. ' operationId: UpdateDynamicSet parameters: - $ref: '#/components/parameters/DynamicSetIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The dynamic set 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/DynamicSet' 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 dynamic set identified by the id tags: - dynamicSet x-example: "PUT 20220901/dynamicSets/<resource_OCID>\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"displayName\": \"<updated_display_name>\"\n}\n" x-related-resource: '#/definitions/DynamicSet' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDynamicSetDetails' description: Details to update a dynamic set. required: true /dynamicSets/{dynamicSetId}/actions/changeCompartment: post: description: Move the specified Dynamic Set to a different compartment operationId: ChangeDynamicSetCompartment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/ChangeDynamicSetCompartmentDetailsParam' - $ref: '#/components/parameters/DynamicSetIdPathParam' 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: Move a Dynamic Sey into a different compartment tags: - dynamicSet x-related-resource: '#/definitions/DynamicSet' /dynamicSets/{dynamicSetId}/actions/installPackages: post: description: Installs specified software packages on all managed instances in the dynamic set. operationId: InstallPackagesOnDynamicSet parameters: - $ref: '#/components/parameters/DynamicSetIdPathParam' - $ref: '#/components/parameters/InstallPackagesOnDynamicSetDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The package will be installed on the dynamic set. 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: Install packages on a dynamic set tags: - dynamicSet x-example: "POST 20220901/dynamicSets/<resource_OCID>/actions/installPackages\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"packageNames\": [\"<package_name>\"]\n}\n" x-related-resource: '#/definitions/DynamicSet' /dynamicSets/{dynamicSetId}/actions/reboot: post: description: Initiates a reboot of all managed instances within the specified dynamic set. operationId: RebootDynamicSet parameters: - $ref: '#/components/parameters/DynamicSetIdPathParam' - $ref: '#/components/parameters/RebootDynamicSetParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. Reboot initiated. 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: Reboot a dynamic set tags: - dynamicSet x-related-resource: '#/definitions/DynamicSet' /dynamicSets/{dynamicSetId}/actions/removePackages: post: description: Removes specified software packages from all managed instances in the dynamic set. operationId: RemovePackagesFromDynamicSet parameters: - $ref: '#/components/parameters/DynamicSetIdPathParam' - $ref: '#/components/parameters/RemovePackagesFromDynamicSetDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The package will be removed from the dynamic set. 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: Remove packages from a dynamic set tags: - dynamicSet x-example: "POST 20220901/dynamicSets/<resource_OCID>/actions/removePackages\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"packageNames\": [\"<package_name>\"]\n}\n" x-related-resource: '#/definitions/DynamicSet' /dynamicSets/{dynamicSetId}/actions/updatePackages: post: description: Updates all installed software packages on managed instances in the dynamic set. operationId: UpdatePackagesOnDynamicSet parameters: - $ref: '#/components/parameters/DynamicSetIdPathParam' - $ref: '#/components/parameters/UpdatePackagesOnDynamicSetDetailsParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The package will be updated on the dynamic set. 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: Update packages on a dynamic set tags: - dynamicSet x-example: "POST 20220901/dynamicSets/<resource_OCID>/actions/updatePackages\nHost: osmh.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\nIf-Match: \"\"\n{\n \"packageNames\": [\"<package_name>\"]\n}\n" x-related-resource: '#/definitions/DynamicSet' /dynamicSets/{dynamicSetId}/managedInstances: get: description: Retrieves a list of managed instances associated with a specified dynamic set. operationId: ListManagedInstancesInDynamicSet parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubTreeQueryParam' - $ref: '#/components/parameters/DynamicSetIdPathParam' - $ref: '#/components/parameters/DisplayNameContainsQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ManagedInstanceSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of 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 opc-total-items: description: 'The total number of items in the result. Used for pagination of a list of items. ' schema: type: integer 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: List managed instances in a dynamic set tags: - dynamicSet x-related-resource: '#/definitions/DynamicSet' components: schemas: MatchingRule: description: An object that defines the set of rules that identifies the target instances in a dynamic set. minProperties: 2 properties: architectures: description: The list of managed instance architectures. items: enum: - X86_64 - AARCH64 type: string x-obmcs-top-level-enum: '#/definitions/CpuArchType' maxItems: 2 type: array uniqueItems: true displayNames: description: The list of managed instance display names. items: type: string maxItems: 25 type: array uniqueItems: true isRebootRequired: description: Indicates if the managed instance needs to be rebooted. type: boolean locations: description: The list of managed instance locations. items: enum: - ON_PREMISE - OCI_COMPUTE - AZURE - EC2 - GCP type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceLocation' maxItems: 5 type: array uniqueItems: true managedInstanceGroupIds: description: The list of managed instance group IDs. items: type: string maxItems: 255 type: array uniqueItems: true managedInstanceIds: description: The list of managed instance ids. items: type: string maxItems: 255 type: array uniqueItems: true osFamilies: description: The list of managed instance OS families. items: 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' maxItems: 12 type: array uniqueItems: true osNames: description: The list of managed instance OS names. items: enum: - ORACLE_LINUX - UBUNTU - WINDOWS_SERVER type: string x-obmcs-top-level-enum: '#/definitions/OsName' maxItems: 5 type: array uniqueItems: true statuses: description: The list of managed instance statuses. items: enum: - NORMAL - UNREACHABLE - ERROR - WARNING - REGISTRATION_ERROR - DELETING - ONBOARDING - REBOOTING type: string x-obmcs-top-level-enum: '#/definitions/ManagedInstanceStatus' maxItems: 8 type: array uniqueItems: true tags: description: The list of the managed instance tags. items: $ref: '#/components/schemas/Tag' maxItems: 25 type: array uniqueItems: true type: object DynamicSetSummary: description: Provides summary information for a dynamic set. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the dynamic set. ' 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 dynamic set. type: string displayName: description: User-friendly name for the dynamic set. 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 dynamic set. ' type: string lifecycleState: description: The current state of the dynamic set. type: string x-obmcs-enumref: '#/definitions/DynamicSet/lifecycleState' 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 date and time the dynamic set was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string timeUpdated: description: 'The date and time the dynamic set was last updated (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string required: - id - displayName - compartmentId type: object 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 DynamicSetCollection: description: 'The set of dynamic sets returned for the [ListDynamicSets](#/en/osmh/latest/DynamicSet/ListDynamicSets) operation. ' properties: items: description: List of dynamic sets. items: $ref: '#/components/schemas/DynamicSetSummary' type: array required: - items type: object RebootDynamicSetDetails: description: Provides the information used for the reboot job. properties: managedInstances: description: The list of managed instance OCIDs to be attached/detached. items: type: string type: array 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 ChangeDynamicSetCompartmentDetails: description: 'Provides the information used to move the dynamic set 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 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 DynamicSet: description: An object that defines the dynamic set. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the dynamic set. ' 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 for the dynamic set. maxLength: 400 minLength: 1 type: string displayName: description: User-friendly name for the dynamic set. 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 id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. ' type: string lifecycleState: description: The current state of the event. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string matchType: description: Include either any or all attributes. enum: - ANY - ALL type: string x-obmcs-top-level-enum: '#/definitions/MatchType' matchingRule: $ref: '#/components/schemas/MatchingRule' scheduledJobCount: description: Number of scheduled jobs currently targeting this dynamic set. type: string 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 targetCompartments: description: The list of compartment details. items: $ref: '#/components/schemas/TargetCompartmentDetails' minItems: 1 type: array uniqueItems: true timeCreated: description: 'The date and time the dynamic set was created (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string timeUpdated: description: 'The date and time the dynamic set was last updated (in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) format). ' format: date-time type: string required: - id - displayName - compartmentId - lifecycleState - timeCreated - freeformTags - definedTags type: object 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 Tag: description: Metadata tag assigned to a resource. discriminator: propertyName: type properties: key: description: 'The key of the tag. ' type: string type: description: 'The type of the tag. Common values include `defined` or `freeform`. ' enum: - DEFINED - FREEFORM type: string value: description: 'The value associated with the tag key. ' type: string required: - type type: object TargetCompartmentDetails: description: Details of the compartment. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. type: string doesIncludeChildren: default: false description: 'Indicates if the child compartments are included in the matching rule. ' type: boolean required: - compartmentId - doesIncludeChildren type: object InstallPackagesOnDynamicSetDetails: description: Provides the information used to install software packages on a dynamic set. properties: managedInstances: description: The list of managed instance OCIDs to be attached/detached. items: type: string type: array packageNames: description: The list of package names. items: type: string maxItems: 255 type: array workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - packageNames type: object UpdateDynamicSetDetails: description: Provides the information used to update a dynamic set. 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 description: description: User-specified description of the dynamic set. Avoid entering confidential information. maxLength: 400 minLength: 0 type: string displayName: description: User-friendly name for the dynamic set. 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 matchType: description: Include either any or all attributes. enum: - ANY - ALL type: string x-obmcs-top-level-enum: '#/definitions/MatchType' matchingRule: $ref: '#/components/schemas/MatchingRule' targetCompartments: description: The list of compartment details. items: $ref: '#/components/schemas/TargetCompartmentDetails' minItems: 1 type: array uniqueItems: true type: object RemovePackagesFromDynamicSetDetails: description: Provides the information used to remove software packages from a dynamic set. properties: managedInstances: description: The list of managed instance OCIDs to be attached/detached. items: type: string type: array packageNames: description: The list of package names. items: type: string maxItems: 255 type: array workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' required: - packageNames type: object UpdatePackagesOnDynamicSetDetails: description: Provides the information used to update software packages on a dynamic set. properties: managedInstances: description: The list of managed instance OCIDs to be attached/detached. items: type: string type: array updateTypes: description: The types 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' type: array uniqueItems: true workRequestDetails: $ref: '#/components/schemas/WorkRequestDetails' type: object CreateDynamicSetDetails: description: Details for creating a dynamic set. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the dynamic set. ' 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 for the dynamic set. maxLength: 400 minLength: 1 type: string displayName: description: User-friendly name for the dynamic set. 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 matchType: description: Include either any or all attributes. enum: - ANY - ALL type: string x-obmcs-top-level-enum: '#/definitions/MatchType' matchingRule: $ref: '#/components/schemas/MatchingRule' targetCompartments: description: The list of compartment details. items: $ref: '#/components/schemas/TargetCompartmentDetails' minItems: 1 type: array uniqueItems: true required: - compartmentId - matchType - targetCompartments - matchingRule type: object 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 PreviewManagedInstancesDetails: description: PreviewManagedInstancesDetails. 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 matchType: description: Include either any or all attributes. enum: - ANY - ALL type: string x-obmcs-top-level-enum: '#/definitions/MatchType' matchingRule: $ref: '#/components/schemas/MatchingRule' targetCompartments: description: The list of compartment details. items: $ref: '#/components/schemas/TargetCompartmentDetails' minItems: 1 type: array uniqueItems: true required: - targetCompartments - matchType - matchingRule type: object parameters: 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 DynamicSetIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set. in: path name: dynamicSetId required: true schema: type: string ChangeDynamicSetCompartmentDetailsParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the group to. in: body name: ChangeDynamicSetCompartmentDetails required: true schema: $ref: '#/components/schemas/ChangeDynamicSetCompartmentDetails' DynamicSetIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dynamic set. This filter returns resources associated with this dynamic set. in: query name: dynamicSetId 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 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 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 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 InstallPackagesOnDynamicSetDetailsParam: description: Details about packages to be installed on a dynamic set. in: body name: InstallPackagesOnDynamicSetDetails required: true schema: $ref: '#/components/schemas/InstallPackagesOnDynamicSetDetails' 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 RemovePackagesFromDynamicSetDetailsParam: description: Details about packages to be removed on a dynamic set. in: body name: RemovePackagesFromDynamicSetDetails required: true schema: $ref: '#/components/schemas/RemovePackagesFromDynamicSetDetails' RebootDynamicSetParam: description: "The timeout to be set for the reboot job. The timeout is the amount of time in minutes that the service waits for \nthe reboot to complete before marking the job as failed.\n" in: body name: RebootDynamicSetDetails required: true schema: $ref: '#/components/schemas/RebootDynamicSetDetails' 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 UpdatePackagesOnDynamicSetDetailsParam: description: Details about packages to be updated on a dynamic set. in: body name: UpdatePackagesOnDynamicSetDetails required: true schema: $ref: '#/components/schemas/UpdatePackagesOnDynamicSetDetails' ManagedInstanceSortByQueryParam: 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 DynamicSetSortByQueryParam: 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 DisplayNameQueryParam: description: A filter to return resources that match the given user-friendly name. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 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 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