openapi: 3.2.0 info: description: 'Fleet Application Management provides a centralized platform to help you automate resource management tasks, validate patch compliance, and enhance operational efficiency across an enterprise. ' title: Fleet Application Management Service Fleet Apps Management Runbooks API version: '20250228' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/df204aad719edd6386b3f6458501f6b29625fcd70779d4c9febf12d041946740.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Fleet Application Management Service 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/df204aad719edd6386b3f6458501f6b29625fcd70779d4c9febf12d041946740.yaml what: the harvested document for Fleet Application Management Service API servers: - url: http://127.0.0.1/20250228 - url: https://127.0.0.1/20250228 tags: - name: fleetAppsManagementRunbooks paths: /runbookVersions: get: description: 'List versions for a runbook in Fleet Application Management. ' operationId: ListRunbookVersions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RunbookVersionLifecycleStateQueryParam' - $ref: '#/components/parameters/AssociatedRunbookIdentifierQueryParam' - $ref: '#/components/parameters/RunbookVersionIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NameQueryParam' responses: 200: description: A page of RunbookVersionSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/RunbookVersionCollection' 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 versions for a runbook in a compartment tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/RunbookVersionCollection' post: description: 'Add RunbookVersion in Fleet Application Management. ' operationId: CreateRunbookVersion parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The RunbookVersion will be created. headers: content-location: description: Same as location schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created RunbookVersion, the RunbookVersion id will be generated after this request is sent. schema: type: string format: uri-reference 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/RunbookVersion' 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 Runbook Version tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/RunbookVersion' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRunbookVersionDetails' description: Details for the new Runbook Version. required: true /runbookVersions/actions/import: post: description: 'Export the specified version of the runbook. ' operationId: ImportRunbookVersion parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. 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: Import a RunbookVersion tags: - fleetAppsManagementRunbooks x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ImportRunbookVersionDetails' requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportRunbookVersionDetails' description: Details for publishing the specified version of runbook. required: true /runbookVersions/{runbookVersionId}: delete: description: Removes a Runbook Version from the runbook in Fleet Application Management. operationId: DeleteRunbookVersion parameters: - $ref: '#/components/parameters/RunbookVersionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Runbook Version will be 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 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' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned Runbook Version tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/RunbookVersion' get: description: Gets a Runbook Version by identifier. operationId: GetRunbookVersion parameters: - $ref: '#/components/parameters/RunbookVersionIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the RunbookVersion with the given id 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/RunbookVersion' 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 RunbookVersion tags: - fleetAppsManagementRunbooks put: description: Updates the RunbookVersion. operationId: UpdateRunbookVersion parameters: - $ref: '#/components/parameters/RunbookVersionIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The RunbookVersion will be updated. 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' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the RunbookVersion identified by the id tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/RunbookVersion' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRunbookVersionDetails' description: The information to be updated. required: true /runbookVersions/{runbookVersionId}/actions/export: post: description: 'Export the specified version of the runbook. ' operationId: ExportRunbookVersion parameters: - $ref: '#/components/parameters/RunbookVersionIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. 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: Export a RunbookVersion tags: - fleetAppsManagementRunbooks x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Runbook' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportRunbookVersionDetails' description: Details for publishing the specified version of runbook. required: true /runbooks: get: description: 'Returns a list of all the runbooks in the specified compartment. The query parameter `compartmentId` is required unless the query parameter `id` is specified. ' operationId: ListRunbooks parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RunbookLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RunbookIdentifierQueryParam' - $ref: '#/components/parameters/RunbookTypeQueryParam' - $ref: '#/components/parameters/PlatformQueryParam' - $ref: '#/components/parameters/LifecycleQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RunbookSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of RunbookSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/RunbookCollection' 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 Runbooks in a compartment tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/RunbookCollection' post: description: 'Creates a runbook. ' operationId: CreateRunbook parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The runbook will be created. headers: content-location: description: Same as location schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created runbook, the runbook id will be generated after this request is sent. schema: type: string format: uri-reference 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/Runbook' 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 Runbook tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/Runbook' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRunbookDetails' description: Details for the new Runbook. required: true /runbooks/actions/findExportDependencies: post: description: 'Find runbook export Dependencies ' operationId: FindRunbookExportDependency parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of RunbookExportDependencySummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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: A number representing the the total number of results available. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/RunbookExportDependencyCollection' 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: Find runbook export Dependencies tags: - fleetAppsManagementRunbooks x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/RunbookExportDependencyCollection' requestBody: content: application/json: schema: $ref: '#/components/schemas/FindRunbookExportDependencyDetails' description: Details for finding runbook export dependencies. required: true /runbooks/actions/findImportDependencies: post: description: 'Find runbook import Dependencies ' operationId: FindRunbookImportDependency parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of RunbookImportDependencySummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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: A number representing the the total number of results available. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/RunbookImportDependencyCollection' 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: Find runbook import Dependencies tags: - fleetAppsManagementRunbooks x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/RunbookImportDependencyCollection' requestBody: content: application/json: schema: $ref: '#/components/schemas/FindRunbookImportDependencyDetails' description: Details for finding runbook import dependencies. required: true /runbooks/actions/import: post: description: 'Import the specified version of the runbook. ' operationId: ImportRunbook parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. 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: Import a Runbook tags: - fleetAppsManagementRunbooks x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ImportRunbookDetails' requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportRunbookDetails' description: Details for importing the specified runbook. required: true /runbooks/actions/importPrecheck: post: description: 'Precheck for import runbook. ' operationId: ImportRunbookPrecheck parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. 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: Precheck Runbook import tags: - fleetAppsManagementRunbooks x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ImportRunbookPrecheckDetails' requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportRunbookPrecheckDetails' description: Details for precheck of specified runbook import. required: true /runbooks/actions/publishRunbook: post: description: 'Publish the specified version of the runbook. The specified version of the runbook becomes acitve when it is published.Only active versions of runbook can be used in execution. ' operationId: PublishRunbook parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. 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: Publish a Runbook tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/Runbook' requestBody: content: application/json: schema: $ref: '#/components/schemas/PublishRunbookDetails' description: Details for publishing the specified version of runbook. required: true /runbooks/actions/setDefaultRunbook: post: description: 'Set a runbook as default. ' operationId: SetDefaultRunbook parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Runbook 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/Runbook' 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: Set a runbook as default for a platform and operation. tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/Runbook' requestBody: content: application/json: schema: $ref: '#/components/schemas/SetDefaultRunbookDetails' description: Details for setting the runbook as default for a platform and operation. required: true /runbooks/exportStatus: get: description: 'Returns a list of all the Runbook export status in the specified compartment. The query parameter `compartmentId` is required. ' operationId: ListRunbookExportStatuses parameters: - $ref: '#/components/parameters/MandatoryCompartmentIdQueryParam' - $ref: '#/components/parameters/RunbookIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of RunbookExportStatusSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/RunbookExportStatusCollection' 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 Runbook export status. tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/RunbookExportStatusCollection' /runbooks/importStatus: get: description: 'Returns a list of all the Runbook import status in the specified compartment. The query parameter `compartmentId` is required. ' operationId: ListRunbookImportStatuses parameters: - $ref: '#/components/parameters/MandatoryCompartmentIdQueryParam' - $ref: '#/components/parameters/RunbookIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of RunbookImportStatusSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/RunbookImportStatusCollection' 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 Runbook import status. tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/RunbookImportStatusCollection' /runbooks/{runbookId}: delete: description: Deletes a runbook specified by the identifier. operationId: DeleteRunbook parameters: - $ref: '#/components/parameters/RunbookIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Runbook will be 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 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: Delete a provisioned Runbook tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/Runbook' get: description: Get the details of a runbook in Fleet Application Management. operationId: GetRunbook parameters: - $ref: '#/components/parameters/RunbookIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Runbook with the given id 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/Runbook' 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 Runbook tags: - fleetAppsManagementRunbooks put: description: Updates the runbook specified by the identifier. operationId: UpdateRunbook parameters: - $ref: '#/components/parameters/RunbookIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Runbook will be updated. 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' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Runbook specified by the identifier tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/Runbook' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRunbookDetails' description: The information to be updated. required: true /runbooks/{runbookId}/actions/changeCompartment: post: description: 'Moves a Runbook into 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: ChangeRunbookCompartment parameters: - $ref: '#/components/parameters/RunbookIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The Runbook will be moved into a different 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 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' summary: Moves a Runbook into a different compartment. tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/Runbook' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeRunbookCompartmentDetails' description: Details of the target compartment. required: true /runbooks/{runbookId}/actions/export: post: description: 'Export the specified version of the runbook. ' operationId: ExportRunbook parameters: - $ref: '#/components/parameters/RunbookIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. 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: Export a Runbook tags: - fleetAppsManagementRunbooks x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Runbook' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportRunbookDetails' description: Details for publishing the specified version of runbook. required: true /runbooks/{runbookId}/exports/{exportId}: get: description: Get the runbook export status for provided runbook and exportId. operationId: GetRunbookExport parameters: - $ref: '#/components/parameters/RunbookIdentifierPathParam' - $ref: '#/components/parameters/RunbookExportIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Runbook with the given id 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/RunbookExport' 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 Runbook export status tags: - fleetAppsManagementRunbooks /runbooks/{runbookId}/imports/{importId}: get: description: Get the runbook import status for provided runbook and importId. operationId: GetRunbookImport parameters: - $ref: '#/components/parameters/RunbookIdentifierPathParam' - $ref: '#/components/parameters/RunbookImportIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Runbook with the given id 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/RunbookImport' 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 Runbook import status tags: - fleetAppsManagementRunbooks /taskRecords: get: description: 'Returns a list of all the task records in the specified compartment. The query parameter `compartmentId` is required unless the query parameter `id` is specified. ' operationId: ListTaskRecords parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/TaskRecordPlatformQueryParam' - $ref: '#/components/parameters/TaskRecordTypeQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/TaskRecordLifecycleQueryParam' - $ref: '#/components/parameters/TaskRecordIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/TaskRecordLifecycleStateQueryParam' - $ref: '#/components/parameters/TaskRecordSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of TaskRecordSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/TaskRecordCollection' 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 task records in a compartment. tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/TaskRecordCollection' post: description: 'Creates a new task record. ' operationId: CreateTaskRecord parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Task record created successfully. 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/TaskRecord' 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 task record. tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/TaskRecord' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTaskRecordDetails' description: Attributes to create a task record. required: true /taskRecords/{taskRecordId}: delete: description: Deletes the task record specified by an identifier. operationId: DeleteTaskRecord parameters: - $ref: '#/components/parameters/TaskRecordIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The task record will be 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 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: Deletes the task record specified by an identifier. tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/TaskRecord' get: description: Gets information for the specified task record. operationId: GetTaskRecord parameters: - $ref: '#/components/parameters/TaskRecordIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The task record's information has been 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/TaskRecord' 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 task tecord. tags: - fleetAppsManagementRunbooks put: description: Updates certain attributes for the specified task record. operationId: UpdateTaskRecord parameters: - $ref: '#/components/parameters/TaskRecordIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The task record will be updated. 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' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates certain attributes for the specified task record. tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/TaskRecord' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTaskRecordDetails' description: Attributes to update a task record. required: true /taskRecords/{taskRecordId}/actions/changeCompartment: post: description: 'Moves a task record into 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: ChangeTaskRecordCompartment parameters: - $ref: '#/components/parameters/TaskRecordIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The Task record will be moved into a different 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 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' summary: Moves a task record into a different compartment. tags: - fleetAppsManagementRunbooks x-related-resource: '#/definitions/TaskRecord' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeTaskRecordCompartmentDetails' description: Details of the target compartment. required: true components: parameters: NameQueryParam: description: A filter to return only resources that match the entire name given. in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RunbookVersionLifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/RunbookVersion/lifecycleState' 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 TaskRecordSortByQueryParam: 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 x-default-description: timeCreated x-obmcs-top-level-enum: '#/definitions/TaskRecordSortBy' schema: type: string enum: - timeCreated - displayName RunbookIdentifierPathParam: description: Unique Runbook identifier in: path name: runbookId required: true schema: type: string RunbookLifecycleStateQueryParam: description: A filter to return only resources whose lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Runbook/lifecycleState' schema: type: string 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 RunbookImportIdentifierPathParam: description: Unique tracking identifier to fetch runbook import status in: path name: importId required: true schema: type: string RunbookTypeQueryParam: description: A filter to return runbooks whose type matches the given type. in: query name: type x-default-description: USER_DEFINED x-obmcs-enumref: '#/definitions/Runbook/type' schema: type: string RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string TaskRecordLifecycleStateQueryParam: description: The current state of the task record. in: query name: lifecycleState x-default-description: 'null' x-obmcs-enumref: '#/definitions/TaskRecord/lifecycleState' schema: type: string RunbookExportIdentifierPathParam: description: Unique tracking identifier to fetch runbook export status in: path name: exportId required: true schema: type: string SortByQueryParam: 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 x-default-description: timeCreated x-obmcs-top-level-enum: '#/definitions/SortBy' schema: type: string enum: - timeCreated - displayName MandatoryCompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId required: true x-default-description: 'null' schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PlatformQueryParam: description: A filter to return runbooks whose platform matches the given platform. in: query name: platform x-default-description: 'null' schema: type: string PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page x-default-description: page schema: type: string minLength: 1 RunbookIdentifierQueryParam: description: 'Unique identifier or OCID for listing a single Runbook by id. Either compartmentId or id must be provided. ' in: query name: id x-default-description: 'null' schema: type: string AssociatedRunbookIdentifierQueryParam: description: A filter to return only schedule definitions whose associated runbookId matches the given runbookId. in: query name: runbookId x-default-description: 'null' schema: type: string TaskRecordTypeQueryParam: description: The type of the Task. in: query name: type x-default-description: USER_DEFINED x-obmcs-enumref: '#/definitions/TaskRecord/type' schema: type: string LifecycleQueryParam: description: A filter to return runbooks whose operation matches the given lifecycle operation. in: query name: operation x-default-description: 'null' schema: type: string RunbookVersionIdentifierPathParam: description: Unique Runbook Version identifier in: path name: runbookVersionId required: true schema: type: string 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 TaskRecordPlatformQueryParam: description: The platform for the task record. in: query name: platform x-default-description: 'null' schema: type: string TaskRecordIdentifierPathParam: description: The OCID of the task record. in: path name: taskRecordId required: true schema: type: string TaskRecordLifecycleQueryParam: description: A filter to return task records whose operation matches the given lifecycle operation. in: query name: operation x-default-description: 'null' schema: type: string RunbookVersionIdentifierQueryParam: description: A filter to return runbook versions whose identifier matches the given identifier. in: query name: id x-default-description: 'null' schema: type: string TaskRecordIdentifierQueryParam: description: "Unique identifier or OCID for listing a single task record by id.\nEither compartmentId or id must be provided.\n \n" in: query name: id x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: 'The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified. ' in: query name: compartmentId x-default-description: 'null' schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 RunbookSortByQueryParam: 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 x-default-description: timeCreated x-obmcs-top-level-enum: '#/definitions/RunbookSortBy' schema: type: string enum: - timeCreated - displayName schemas: RunbookExportStatusCollection: description: Results of a runbook search. Contains RunbookExportStatusSummary items and other information. properties: items: description: List of Runbook export status. items: $ref: '#/components/schemas/RunbookExportStatusSummary' type: array required: - items type: object FindRunbookExportDependencyDetails: description: Request to find runbook export dependencies. properties: runbookId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string runbookVersionId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string required: - runbookId type: object Error: description: Error Information. 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 TaskRecordSummary: description: Summary of the task record. properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string details: $ref: '#/components/schemas/Details' displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the task record. type: string x-obmcs-enumref: '#/definitions/TaskRecord/lifecycleState' resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' 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 this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: Task type. type: string x-obmcs-enumref: '#/definitions/TaskRecord/type' version: description: The version of the task record. type: string required: - id - displayName - type - lifecycleState - timeCreated - timeUpdated - details - compartmentId type: object PauseDetails: description: Pause Details discriminator: propertyName: kind properties: kind: description: 'Pause based On. ' enum: - USER_ACTION - TIME_BASED type: string required: - kind ChangeRunbookCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the Planner to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object OutputVariableMapping: description: 'Output variable to Input variable mapping details. Output variable of a task can be used as an input variable for a subsequent task. ' properties: name: description: The name of the input variable. maxLength: 200 minLength: 1 type: string outputVariableDetails: $ref: '#/components/schemas/OutputVariableDetails' required: - name - outputVariableDetails TransferRunbookContentDetails: description: Content Source details. discriminator: propertyName: sourceType properties: sourceType: description: 'Content Source type details. ' enum: - OBJECT_STORAGE_BUCKET - PAR_URL type: string required: - sourceType RunbookImportDependencyCollection: description: Results of a find runbook import dependency. Contains RunbookTransferDependencySummary. properties: items: description: List of Runbook Import Dependencies. items: $ref: '#/components/schemas/RunbookTransferDependencySummary' type: array required: - items type: object RunbookVersionSummary: description: Summary of the runbook version. properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object executionWorkflowDetails: $ref: '#/components/schemas/ExecutionWorkflowDetails' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object groups: description: 'The groups of the runbook. ' items: $ref: '#/components/schemas/Group' maxItems: 50 type: array id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string isLatest: default: false description: 'Is the latest version for the runbook? ' type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Runbook version. type: string x-obmcs-enumref: '#/definitions/RunbookVersion/lifecycleState' name: description: The version of the runbook. type: string rollbackWorkflowDetails: $ref: '#/components/schemas/RollbackWorkflowDetails' runbookId: description: The OCID of the resource. maxLength: 255 minLength: 1 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 tasks: description: A set of tasks to execute in the runbook. items: $ref: '#/components/schemas/Task' maxItems: 50 type: array timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - tasks - groups - executionWorkflowDetails type: object AssociatedTaskDetails: description: The details of the task. discriminator: propertyName: scope properties: scope: description: The scope of the task. enum: - LOCAL - SHARED type: string x-obmcs-top-level-enum: '#/definitions/TaskScope' required: - scope ImportRunbookPrecheckRequiredValue: allOf: - $ref: '#/components/schemas/RequiredValue' - description: RequiredValue with additional properties properties: placeholder: description: placeholder. maxLength: 255 minLength: 1 type: string stepName: description: Step name for required value. maxLength: 255 minLength: 1 type: string value: description: Value for required value. maxLength: 255 minLength: 1 type: string type: object description: Runbook import precheck required value. RunbookCollection: description: Results of a runbook search. Contains RunbookSummary items and other information, such as metadata. properties: items: description: List of runbooks. items: $ref: '#/components/schemas/RunbookSummary' type: array required: - items type: object RequiredValue: description: Required value. properties: field: description: Field for required value. maxLength: 255 minLength: 1 type: string required: - field UpdateRunbookDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string estimatedTime: description: Estimated time to successfully complete the runbook execution. format: x-obmcs-duration type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isDefault: default: false description: Is the runbook default? type: boolean isSudoAccessNeeded: description: Does this runbook need SUDO access to execute? type: boolean operation: description: The lifecycle operation performed by the runbook. maxLength: 200 minLength: 1 type: string osType: description: The OS type for the runbook. enum: - WINDOWS - LINUX - GENERIC type: string x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OsType' platform: description: The platform of the runbook. maxLength: 200 minLength: 1 type: string type: object RunbookImportStatusCollection: description: Results of a runbook search. Contains RunbookImportStatusSummary items and other information. properties: items: description: List of Runbook import status. items: $ref: '#/components/schemas/RunbookImportStatusSummary' type: array required: - items type: object RunbookImport: description: Runbook Import Status check details. properties: details: additionalProperties: type: string description: Map of details type: object runbookId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string runbookName: description: Runbook name. maxLength: 255 minLength: 1 type: string runbookVersion: description: Runbook version. maxLength: 255 minLength: 1 type: string status: description: Status. maxLength: 255 minLength: 1 type: string trackingId: description: Tracking Id. type: string required: - trackingId - runbookId - runbookName - runbookVersion - status - details RunbookVersion: description: 'Version for the runbook. Versioning runbooks in Fleet Application Management involve assigning unique identifiers or version numbers to different iterations of the runbook to track changes, improvements, and updates over time. ' properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object executionWorkflowDetails: $ref: '#/components/schemas/ExecutionWorkflowDetails' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object groups: description: 'The groups of the runbook. ' items: $ref: '#/components/schemas/Group' maxItems: 50 type: array id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the runbook version. enum: - ACTIVE - DELETED - FAILED - NEEDS_ATTENTION - INACTIVE - CREATING - DELETING - UPDATING type: string name: description: The version of the runbook. type: string rollbackWorkflowDetails: $ref: '#/components/schemas/RollbackWorkflowDetails' runbookId: description: The OCID of the resource. maxLength: 255 minLength: 1 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 tasks: description: A set of tasks to execute in the runbook. items: $ref: '#/components/schemas/Task' maxItems: 50 type: array timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - tasks - groups - executionWorkflowDetails - runbookId type: object PublishRunbookDetails: description: Request to publish Runbook. properties: runbookId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string runbookVersionId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string required: - runbookId - runbookVersionId TaskNotificationPreferences: description: Preferences to send notifications on the task activities. properties: shouldNotifyOnPause: default: false description: Enables notification on pause. type: boolean shouldNotifyOnTaskFailure: default: false description: Enables or disables notification on Task Failures. type: boolean shouldNotifyOnTaskSuccess: default: false description: Enables or disables notification on Task Success. type: boolean type: object UpdateRunbookVersionDetails: description: 'The information to be updated. Versioning runbooks in Fleet Application Management involve assigning unique identifiers or version numbers to different iterations of the runbook to track changes, improvements, and updates over time. ' properties: executionWorkflowDetails: $ref: '#/components/schemas/ExecutionWorkflowDetails' groups: description: 'The groups of the runbook version. ' items: $ref: '#/components/schemas/Group' maxItems: 50 type: array rollbackWorkflowDetails: $ref: '#/components/schemas/RollbackWorkflowDetails' tasks: description: A set of tasks to execute in the runbook. items: $ref: '#/components/schemas/Task' maxItems: 50 type: array type: object CreateRunbookVersionDetails: description: 'The information about new runbook version. Versioning runbooks in Fleet Application Management involve assigning unique identifiers or version numbers to different iterations of the runbook to track changes, improvements, and updates over time. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object executionWorkflowDetails: $ref: '#/components/schemas/ExecutionWorkflowDetails' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object groups: description: 'The groups of the runbook version. ' items: $ref: '#/components/schemas/Group' maxItems: 50 type: array rollbackWorkflowDetails: $ref: '#/components/schemas/RollbackWorkflowDetails' runbookId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string tasks: description: A set of tasks to execute in the runbook. items: $ref: '#/components/schemas/Task' maxItems: 50 type: array required: - tasks - groups - executionWorkflowDetails - runbookId type: object ImportRunbookDetails: description: Request to Import Runbook. properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string contentDestination: $ref: '#/components/schemas/TransferRunbookContentDetails' contentSource: $ref: '#/components/schemas/TransferRunbookContentDetails' importOption: description: 'ImportOptions for Runbook. ' enum: - RETAIN - REPLACE - INCREMENT type: string requiredValues: description: List of required values. items: $ref: '#/components/schemas/RunbookImportRequiredValue' type: array runbookName: description: The name of the runbook. maxLength: 255 minLength: 1 type: string version: description: Version number. maxLength: 255 minLength: 1 type: string required: - contentSource - contentDestination - compartmentId Properties: description: The properties of the task. properties: numRetries: description: The number of retries allowed. type: integer timeoutInSeconds: description: The timeout in seconds for the task. type: integer required: - numRetries - timeoutInSeconds type: object UpdateTaskRecordDetails: description: Attributes to update a task record. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string details: $ref: '#/components/schemas/Details' displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object type: object RunbookImportDependencyFinderRequiredValue: allOf: - $ref: '#/components/schemas/RequiredValue' - description: RequiredValue with additional properties properties: expectedAssignment: description: 'Expected assignment. ' enum: - TF_PACKAGE - NON_TF_PACKAGE - CONFIG_FILE - 'NULL' type: string label: description: Label for required value. maxLength: 255 minLength: 1 type: string placeholderAssignment: description: Placeholder assignment for required value. maxLength: 255 minLength: 1 type: string renderingComponent: description: Rendering component value for required value. enum: - SINGLE_CHOICE - MULTI_CHOICE - INPUT_TEXT type: string stepName: description: Step name for required value. maxLength: 255 minLength: 1 type: string type: object description: Runbook import required value. CreateTaskRecordDetails: description: Attributes to create a task record. properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string details: $ref: '#/components/schemas/Details' displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object required: - compartmentId - details - displayName type: object RunOnDetails: description: The runon conditions discriminator: propertyName: kind properties: kind: description: 'Run on based On. ' enum: - SCHEDULED_INSTANCES - SELF_HOSTED_INSTANCES - PREVIOUS_TASK_INSTANCES - SCHEDULE_INSTANCE_TARGETS type: string required: - kind type: object Choice: description: choice. properties: requiredValues: description: List of required values. items: $ref: '#/components/schemas/RunbookImportDependencyFinderRequiredValue' type: array required: - requiredValues ComponentProperties: description: The properties of the component. properties: actionOnFailure: description: The action to be taken in case of a failure. enum: - ABORT - CONTINUE - ROLLBACK type: string notificationPreferences: $ref: '#/components/schemas/TaskNotificationPreferences' pauseDetails: $ref: '#/components/schemas/PauseDetails' preCondition: description: 'Build control flow conditions that determine the relevance of the task execution. ' maxLength: 2048 minLength: 1 type: string runOn: $ref: '#/components/schemas/RunOnDetails' required: - actionOnFailure type: object Placeholder: description: Place Holder. properties: key: description: key for placeholder. maxLength: 255 minLength: 1 type: string placeholder: description: placeholder value . maxLength: 255 minLength: 1 type: string stepName: description: Step name for placeholder. maxLength: 255 minLength: 1 type: string required: - stepName RunbookExport: description: Runbook Export Status check details. properties: details: additionalProperties: type: string description: Map of details type: object runbookId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string runbookName: description: Runbook name. maxLength: 255 minLength: 1 type: string runbookVersion: description: Runbook version. maxLength: 255 minLength: 1 type: string status: description: Status. maxLength: 255 minLength: 1 type: string trackingId: description: Tracking Id. maxLength: 255 minLength: 1 type: string required: - trackingId - runbookId - runbookName - runbookVersion - status - details ExportRunbookVersionDetails: description: Request to Export Runbook Version. properties: contentDestination: $ref: '#/components/schemas/TransferRunbookContentDetails' version: description: Export Runbook Version Details. format: float type: number required: - contentDestination ImportRunbookVersionDetails: description: Request to Export Runbook Version. properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string contentDestination: $ref: '#/components/schemas/TransferRunbookContentDetails' contentSource: $ref: '#/components/schemas/TransferRunbookContentDetails' importOption: description: 'ImportOptions for Runbook. ' type: string x-obmcs-enumref: '#/definitions/ImportRunbookDetails/importOption' requiredValues: description: List of required values. items: $ref: '#/components/schemas/RunbookImportRequiredValue' type: array runbookId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string version: description: Version number. maxLength: 255 minLength: 1 type: string required: - contentSource - contentDestination - compartmentId RunbookSummary: description: Summary of the Runbook. properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string estimatedTime: description: Estimated time to successfully complete the runbook execution. format: x-obmcs-duration type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hasDraftVersion: default: false description: Does this runbook has draft versions? type: boolean id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string isDefault: default: false description: 'Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation. ' type: boolean latestVersion: description: Latest runbook version type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Runbook. type: string x-obmcs-enumref: '#/definitions/Runbook/lifecycleState' operation: description: The lifecycle operation performed by the runbook. maxLength: 200 minLength: 1 type: string originalVersion: description: Original runbook version. This version belongs to original runbook using which new runbook was exported. maxLength: 255 minLength: 1 type: string osType: description: The OS type for the runbook. enum: - WINDOWS - LINUX - GENERIC type: string x-default-description: GENERIC x-obmcs-top-level-enum: '#/definitions/OsType' platform: description: The platform of the runbook. maxLength: 200 minLength: 1 type: string resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' 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 this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: The type of the runbook. type: string x-obmcs-enumref: '#/definitions/Runbook/type' required: - id - displayName - type - operation - isDefault - lifecycleState - timeCreated - timeUpdated - compartmentId type: object Version: description: 'Version for the runbook. Versioning runbooks in Fleet Application Management involve assigning unique identifiers or version numbers to different iterations of the runbook to track changes, improvements, and updates over time. ' properties: executionWorkflowDetails: $ref: '#/components/schemas/ExecutionWorkflowDetails' groups: description: 'The groups of the runbook. ' items: $ref: '#/components/schemas/Group' maxItems: 50 type: array isLatest: default: false description: 'Is this version the latest? ' type: boolean rollbackWorkflowDetails: $ref: '#/components/schemas/RollbackWorkflowDetails' tasks: description: A set of tasks to execute in the runbook. items: $ref: '#/components/schemas/Task' maxItems: 50 type: array version: description: The version of the runbook. type: string required: - tasks - groups - executionWorkflowDetails type: object SetDefaultRunbookDetails: description: Request to set default Runbook properties: runbookId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string required: - runbookId ExportRunbookDetails: description: Request to Export Runbook. properties: contentDestination: $ref: '#/components/schemas/TransferRunbookContentDetails' exportAs: description: 'Export Runbook As Type. ' enum: - TERRAFORM - NON_TERRAFORM type: string required: - contentDestination Association: description: Association. properties: displayName: description: Display name for placeholder. maxLength: 255 minLength: 1 type: string id: description: Id for association. maxLength: 255 minLength: 1 type: string required: - id - displayName ImportRunbookPrecheckDetails: description: Request for precheck of Runbook import. properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string contentDestination: $ref: '#/components/schemas/TransferRunbookContentDetails' contentSource: $ref: '#/components/schemas/TransferRunbookContentDetails' importAs: $ref: '#/components/schemas/RunbookImportAs' requiredValues: description: List of required values. items: $ref: '#/components/schemas/ImportRunbookPrecheckRequiredValue' type: array required: - contentSource - contentDestination - compartmentId FindRunbookImportDependencyDetails: description: Request to find runbook import dependencies. properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string content: $ref: '#/components/schemas/TransferRunbookContentDetails' required: - content - compartmentId type: object WorkflowGroup: description: Workflow Group Layout. properties: groupName: description: Name of the group. maxLength: 400 minLength: 1 type: string steps: description: Steps within the Group. items: $ref: '#/components/schemas/WorkflowComponent' maxItems: 30 type: array type: description: 'Workflow Group Details. ' enum: - PARALLEL_RESOURCE_GROUP - ROLLING_RESOURCE_GROUP type: string required: - groupName - type - steps type: object WorkflowComponent: description: Workflow Component Details. discriminator: propertyName: type properties: type: description: 'Content Source Details. ' enum: - TASK - PARALLEL_TASK_GROUP type: string required: - type Prompt: description: Prompt. properties: acceptanceCondition: description: 'acceptance condition. ' enum: - ANY - ALL type: string choiceGroup: description: List of choice. items: $ref: '#/components/schemas/Choice' type: array required: - acceptanceCondition RunbookVersionCollection: description: Results of a RunbookVersion search. Contains RunbookVersionSummary. properties: items: description: List of fleetResources. items: $ref: '#/components/schemas/RunbookVersionSummary' type: array required: - items type: object RunbookExportDependencyCollection: description: Results of a find runbook export dependency. Contains RunbookExportDependencySummary. properties: items: description: List of Runbook Export Dependencies. items: $ref: '#/components/schemas/RunbookTransferDependencySummary' type: array required: - items type: object RunbookExportStatusSummary: description: Summary of the Runbook export status. properties: runbookId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string runbookName: description: Runbook name. maxLength: 255 minLength: 1 type: string runbookVersion: description: Runbook version. maxLength: 255 minLength: 1 type: string status: description: Status. maxLength: 255 minLength: 1 type: string trackingId: description: Tracking Id. type: string required: - trackingId - runbookId - runbookName - runbookVersion - status type: object Details: description: The details of the task. properties: executionDetails: $ref: '#/components/schemas/ExecutionDetails' isApplySubjectTask: default: false description: "Is this an Apply Subject Task? \nSet this to true for a Patch Execution Task which applies patches(subjects) on a target.\n" type: boolean isDiscoveryOutputTask: default: false description: Is this a discovery output task? type: boolean operation: description: The lifecycle operation performed by the runbook. maxLength: 200 minLength: 1 type: string osType: default: GENERIC description: The OS for the task enum: - WINDOWS - LINUX - GENERIC type: string x-obmcs-top-level-enum: '#/definitions/OsType' platform: description: The platform of the runbook. type: string properties: $ref: '#/components/schemas/Properties' scope: description: The scope of the task enum: - LOCAL - SHARED type: string x-obmcs-top-level-enum: '#/definitions/TaskScope' required: - scope - executionDetails type: object RunbookImportAs: description: Runbook import as type. discriminator: propertyName: importType properties: importOption: description: 'ImportOptions for Runbook. ' type: string x-obmcs-enumref: '#/definitions/ImportRunbookDetails/importOption' importType: description: 'Import type. ' enum: - RUNBOOK - RUNBOOK_VERSION type: string version: description: Version number. maxLength: 255 minLength: 1 type: string required: - importType - importOption OutputVariableDetails: description: The details of the output variable that will be used for mapping. properties: outputVariableName: description: The name of the output variable whose value has to be mapped. maxLength: 200 minLength: 1 type: string stepName: description: The name of the task step the output variable belongs to. maxLength: 255 minLength: 1 type: string required: - stepName - outputVariableName ExecutionDetails: description: Execution details. discriminator: propertyName: executionType properties: executionType: description: The action type of the task enum: - SCRIPT - API - TERRAFORM type: string x-obmcs-top-level-enum: '#/definitions/TaskExecutionType' required: - executionType ExecutionWorkflowDetails: description: Execution Workflow details. properties: workflow: description: Execution Workflow for the runbook. items: $ref: '#/components/schemas/WorkflowGroup' maxItems: 30 type: array required: - workflow type: object RollbackWorkflowDetails: description: Rollback Workflow details. properties: scope: description: 'rollback Scope ' enum: - ACTION_GROUP - TARGET type: string workflow: description: Rollback Workflow for the runbook. items: $ref: '#/components/schemas/WorkflowGroup' maxItems: 30 type: array required: - scope - workflow type: object TaskRecord: description: Attributes of a task record. properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string details: $ref: '#/components/schemas/Details' displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the task record. enum: - ACTIVE - INACTIVE - DELETED - DELETING - FAILED - UPDATING type: string resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' 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 this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: Task type. enum: - USER_DEFINED - ORACLE_DEFINED - SYSTEM_DEFINED type: string version: description: The version of the task record. type: string required: - id - displayName - type - lifecycleState - timeCreated - timeUpdated - details - compartmentId type: object RunbookTransferDependencySummary: description: Summary of the Runbook transfer dependencies. properties: count: description: Count. format: int64 type: integer dependency: $ref: '#/components/schemas/RunbookTransferDependency' entity: description: 'Entity name. ' maxLength: 100 minLength: 1 type: string required: - count - entity - dependency type: object RunbookTransferDependency: description: Runbook transfer dependency. properties: associationsFound: description: List of associations found. items: $ref: '#/components/schemas/Association' type: array placeholders: description: List of placeholders. items: $ref: '#/components/schemas/Placeholder' type: array prompt: $ref: '#/components/schemas/Prompt' type: object Task: description: The details of the task. properties: outputVariableMappings: description: Mapping output variables of previous tasks to the input variables of the current task. items: $ref: '#/components/schemas/OutputVariableMapping' maxItems: 100 type: array stepName: description: The name of the task step. maxLength: 255 minLength: 1 type: string stepProperties: $ref: '#/components/schemas/ComponentProperties' taskRecordDetails: $ref: '#/components/schemas/AssociatedTaskDetails' required: - stepName - taskRecordDetails type: object CreateRunbookDetails: description: The information about new Runbook. properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string estimatedTime: description: Estimated time to successfully complete the runbook execution. format: x-obmcs-duration type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isDefault: default: false description: Is the runbook default? type: boolean isSudoAccessNeeded: default: false description: Does this runbook need SUDO access to execute? type: boolean operation: description: The lifecycle operation performed by the task. maxLength: 200 minLength: 1 type: string osType: description: The OS type for the runbook. enum: - WINDOWS - LINUX - GENERIC type: string x-default-description: GENERIC x-obmcs-top-level-enum: '#/definitions/OsType' platform: description: The platform of the runbook. maxLength: 200 minLength: 1 type: string runbookVersion: $ref: '#/components/schemas/Version' required: - compartmentId - operation - displayName - runbookVersion type: object ChangeTaskRecordCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the task record to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object RunbookImportRequiredValue: allOf: - $ref: '#/components/schemas/RequiredValue' - description: RequiredValue with additional properties properties: placeholder: description: Placeholder for required value. maxLength: 255 minLength: 1 type: string stepName: description: Stepname for required value. maxLength: 255 minLength: 1 type: string value: description: Value for required value. maxLength: 255 minLength: 1 type: string type: object description: Runbook import required value. Runbook: description: 'Runbook definition. Runbooks allow you to capture procedural tasks for handling a workflow. Only active versions of runbook will be available for executions. ' properties: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string estimatedTime: description: Estimated time to successfully complete the runbook execution. format: x-obmcs-duration type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hasDraftVersion: default: false description: Does this runbook has draft versions? type: boolean id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string isDefault: default: false description: 'Is the runbook default? Sets this runbook as the default for the chosen product/product stack for the specified lifecycle operation. ' type: boolean isSudoAccessNeeded: default: false description: Does this runbook need SUDO access to execute? type: boolean latestVersion: description: Latest runbook version. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the runbook. enum: - ACTIVE - DELETED - FAILED - INACTIVE - CREATING - DELETING - UPDATING type: string operation: description: The lifecycle operation performed by the runbook. maxLength: 200 minLength: 1 type: string osType: description: The OS type for the runbook. enum: - WINDOWS - LINUX - GENERIC type: string x-default-description: GENERIC x-obmcs-top-level-enum: '#/definitions/OsType' platform: description: The platform of the runbook. maxLength: 200 minLength: 1 type: string resourceRegion: description: Associated region maxLength: 255 type: string x-default-description: 'null' runbookVersion: $ref: '#/components/schemas/Version' 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 this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string type: description: The type of the runbook. enum: - USER_DEFINED - ORACLE_DEFINED - SYSTEM_DEFINED type: string required: - id - displayName - type - operation - isDefault - lifecycleState - timeCreated - timeUpdated - compartmentId type: object Group: description: 'The group of the runbook. ' properties: name: description: The name of the group. maxLength: 400 minLength: 1 type: string properties: $ref: '#/components/schemas/ComponentProperties' type: description: 'The type of the group. PARALLEL_TASK_GROUP : Helps to execute tasks parallelly inside a resource. PARALLEL_RESOURCE_GROUP : Executes tasks across resources parallelly. ROLLING_RESOURCE_GROUP : Executes tasks across resources in a rolling order. ' enum: - PARALLEL_TASK_GROUP - PARALLEL_RESOURCE_GROUP - ROLLING_RESOURCE_GROUP type: string required: - name - type type: object TaskRecordCollection: description: Results of a task record search. Contains boh TaskRecordSummary items and other information, such as metadata. properties: items: description: List of task records. items: $ref: '#/components/schemas/TaskRecordSummary' type: array required: - items type: object RunbookImportStatusSummary: description: Summary of the Runbook import status. properties: runbookId: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string runbookName: description: Runbook name. maxLength: 255 minLength: 1 type: string runbookVersion: description: Runbook version. maxLength: 255 minLength: 1 type: string status: description: Status. maxLength: 255 minLength: 1 type: string trackingId: description: Tracking Id. type: string required: - trackingId - runbookId - runbookName - runbookVersion - status 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: content-length: description: The content size of the body in bytes. format: int64 type: integer content-type: description: The content type of the body. type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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: A number representing the the total number of results available. 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: compartmentId: description: OCID of the compartment to which the resource belongs to. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A user-friendly description. To provide some insight about the resource. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. Example: `My new resource` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object name: description: "A user-friendly name. Should be unique within the tenancy, and cannot be changed after creation. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string ocid: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string region: description: Associated region maxLength: 255 type: string x-default-description: 'null' 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 tenancyId: description: OCID of the tenancy to which the resource belongs to. maxLength: 255 minLength: 1 type: string timeCreated: description: The time this resource was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time this resource was last updated. An RFC3339 formatted datetime string. format: date-time type: string uniqueId: description: The unique id of the resource. maxLength: 255 minLength: 1 type: string x-tag-groups: adminWorkRequest: - fleetAppsManagementAdmin announcement: - fleetAppsManagement catalogItem: - fleetAppsManagementCatalog category: - fleetAppsManagementAdmin compliance: - fleetAppsManagementOperations compliancePolicy: - fleetAppsManagementAdmin compliancePolicyRule: - fleetAppsManagementAdmin famProvision: - fleetAppsManagementProvision famReport: - fleetAppsManagementOperations fleet: - fleetAppsManagement fleetCredential: - fleetAppsManagement fleetProperty: - fleetAppsManagement fleetResource: - fleetAppsManagement fleetWorkRequest: - fleetAppsManagementWorkRequest inventory: - fleetAppsManagementOperations inventoryResource: - fleetAppsManagement maintenanceWindow: - fleetAppsManagementMaintenanceWindow onboard: - fleetAppsManagementAdmin patch: - fleetAppsManagementOperations platformConfiguration: - fleetAppsManagementAdmin property: - fleetAppsManagementAdmin runbook: - fleetAppsManagementRunbooks schedulerDefinition: - fleetAppsManagementOperations schedulerJob: - fleetAppsManagementOperations taskRecord: - fleetAppsManagementRunbooks x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.oci.fams