{ "swagger":"2.0", "info":{ "version":"2025.10.10", "title":"REST API for Oracle Fleet Patching and Provisioning", "description":"Provides users the ability to perform Fleet Provisioning, Patching and Upgrades for Oracle AI Databases and Oracle Grid Infrastructure through REST APIs. \nFleet Patching and Provisioning was known in prior releases as Rapid Home Provisioning. Oracle continues to use \"Rapid Home Provisioning\" and \"rhp\" for some descriptions of REST APIs and in directory paths and URLs.", "x-summary":"Provides users the ability to perform Fleet Provisioning, Patching and Upgrades for Oracle AI Databases and Oracle Grid Infrastructure through REST APIs." }, "basePath":"/rhp-restapi/rhp", "consumes":[ "application/json" ], "produces":[ "application/json", "text/html" ], "securityDefinitions":{ "basicAuthentication":{ "type":"basic" } }, "tags":[ { "name":"Fleet Patching and Provisioning/RHP - Manage Client Targets", "description":"You can query client details." }, { "name":"Fleet Patching and Provisioning/RHP - Manage Exadata Systems", "description":"The Oracle Fleet Patching and Provisioning Server provides an efficient and secure platform for patching Oracle Exadata Infrastructure." }, { "name":"Fleet Patching and Provisioning/RHP - Manage Gold Images", "description":"You can create gold images and series to manage your deployments." }, { "name":"Fleet Patching and Provisioning/RHP - Manage Operation Results", "description":"You can verify the status and retrieve the output messages of any operation that creates a job to handle its scheduled execution like imaging, provisioning, upgrade and patching operations of software homes." }, { "name":"Fleet Patching and Provisioning/RHP - Patch Software homes", "description":"You can move from one provisioned copy of a gold image to a provisioned copy of a gold image that is at a higher patch level." }, { "name":"Fleet Patching and Provisioning/RHP - Patch Unmanaged Software Homes", "description":"You can move from one software home that is not a copy of a gold image to a provisioned copy of a gold image that is at a higher patch level than the first software home." }, { "name":"Fleet Patching and Provisioning/RHP - Provisioning Software homes", "description":"You can provision a working copy of a gold image." }, { "name":"Fleet Patching and Provisioning/RHP - Upgrade Software homes", "description":"You can move from one provisioned copy of a gold image to a provisioned copy of a gold image that is at a higher version." }, { "name":"Fleet Patching and Provisioning/RHP - Upgrade Unmanaged Software Homes", "description":"You can move from one software home that is not a copy of a gold image to a provisioned copy of a gold image that is at a higher version level than the first software home." } ], "schemes":[ "http", "https" ], "parameters":{ "authorizationHeader":{ "name":"Authorization", "in":"header", "type":"string", "required":true, "description":"Base64 encoding of the user name and password of the user making the request. For more information, see Authentication for Fleet Patching and Provisioning." }, "dbUNamePathParam":{ "name":"dbUniqueName", "in":"path", "required":true, "type":"string", "description":"Name of database (DB_UNIQUE_NAME) to be provisioned" }, "destWcIdPatParam":{ "name":"destWcId", "in":"path", "required":true, "type":"string", "description":"Name of the destination working copy to which the Oracle Software needs to be moved" }, "clientQueryParam":{ "name":"client", "in":"query", "required":false, "type":"string", "description":"Client cluster name." }, "clientFetchWorkingcopyQueryParam":{ "name":"client", "description":"Client cluster name", "in":"query", "required":true, "type":"string" }, "imageTypeQueryParam":{ "name":"imageType", "in":"query", "required":false, "type":"string", "description":"The software type. (\"ORACLEDBSOFTWARE\" (default) for Oracle AI Database software, \"ORACLEGISOFTWARE\" for Oracle Grid Infrastructure software, ORACLEGGSOFTWARE for Oracle GoldenGate software, \"LINUXOS\" for linux Opearting System ISO, and \"SOFTWARE\" for all other software. For a custom image type, use the image type name.)" }, "imageTypePathParam":{ "name":"imageType", "in":"path", "required":true, "type":"string", "description":"The software type. (\"ORACLEDBSOFTWARE\" (default) for Oracle AI Database software, \"ORACLEGISOFTWARE\" for Oracle Grid Infrastructure software, ORACLEGGSOFTWARE for Oracle GoldenGate software, \"LINUXOS\" for linux Opearting System ISO, and \"SOFTWARE\" for all other software. For a custom image type, use the image type name.)" }, "serverNameQueryParam":{ "name":"server", "in":"query", "required":false, "type":"string", "description":"Server cluster name." }, "imageNamePathParam":{ "name":"imageId", "in":"path", "required":true, "type":"string", "description":"Name of the image." }, "imageNameQueryParam":{ "name":"image", "in":"query", "required":false, "type":"string", "description":"Name of the image." }, "jobIdPathParam":{ "name":"jobId", "in":"path", "required":true, "type":"string", "description":"Unique integer job ID value for the scheduled job." }, "pathFetchWorkingcopyQueryParam":{ "description":"Home path", "in":"query", "name":"path", "required":true, "type":"string" }, "seriesIdPathParam":{ "name":"seriesId", "in":"path", "required":true, "type":"string", "description":"Name of the series." }, "osUserNamePathParam":{ "name":"userId", "in":"path", "required":true, "type":"string", "description":"OS user name." }, "subscribeUserSeriesBodyParam":{ "in":"body", "name":"body", "required":false, "schema":{ "$ref":"#/definitions/SubscribeSeriesBody" } }, "workingcopyIdPathParam":{ "name":"workingCopyId", "in":"path", "required":true, "type":"string", "description":"Name of the working copy." }, "rhpserverQueryClientQueryParam":{ "description":"Regular expression to match the cluster name of the servers where the operation must be executed.", "in":"query", "name":"rhpserver", "required":false, "type":"string" }, "detailQueryClientQueryParam":{ "description":"Generate cluster information (HTML) for the cluster.", "in":"query", "name":"detail", "required":false, "type":"boolean" }, "nodeQueryClientQueryParam":{ "description":"Specify the name of a node in a remote cluster.", "in":"query", "name":"node", "required":false, "type":"string" }, "userQueryJobParam":{ "description":"Name of the user for whom the software home is being provisioned.", "in":"query", "name":"user", "required":false, "type":"string" }, "clientQueryJobParam":{ "description":"Client cluster name.", "in":"query", "name":"client", "required":false, "type":"string" }, "jobTagQueryJobParam":{ "description":"Tag associated with the job.", "in":"query", "name":"jobTag", "required":false, "type":"string" }, "statusQueryJobParam":{ "description":"Job status for which to get the jobs.", "in":"query", "name":"status", "required":false, "type":"string", "enum":[ "SCHEDULED", "UNKNOWN", "EXECUTING", "PAUSED", "ABORTED", "TERMINATED", "FAILED", "SUCCEEDED" ] }, "clientIdPathParam":{ "name":"clientId", "in":"path", "required":true, "type":"string", "description":"Name of the client cluster." } }, "responses":{ "jobAccepted202Response":{ "description":"Accepted. A JSON object containing job resource details of the accepted operation to obtain status and output of the progress.", "schema":{ "$ref":"#/definitions/jobResource" }, "headers":{ "Location":{ "type":"string", "description":"URL to the job that will execute the operation" } } }, "okSingleJobResponse":{ "description":"OK. A JSON object containing a job resource representation with multiple properties and the links array with at least the \"self\" link.", "schema":{ "$ref":"#/definitions/jobResource" } }, "okSingleJobOutputResponse":{ "description":"OK. A JSON object containing a job output resource representation with multiple properties and the links array with at least the \"self\" link.", "schema":{ "$ref":"#/definitions/jobOutputResource" } }, "errorResponse":{ "description":"Unexpected error. A JSON object containing error details of the issue while executing the operation.", "schema":{ "$ref":"#/definitions/errorResource" } }, "badRequestResponse":{ "description":"Bad Request. A JSON object containing error details of the issue found while parsing a parameter value or name.", "schema":{ "$ref":"#/definitions/errorResource" } }, "okArrayOfItemsResponse":{ "description":"OK. A JSON object containing an \"items\" property populated with 0 or more elements with at least an Id property and the links array with at least the \"self\" link.", "schema":{ "$ref":"#/definitions/arrayOfItems" } }, "okSingleImageResponse":{ "description":"OK. A JSON object containing an image resource representation with multiple properties and the links array with at least the \"self\" link.", "schema":{ "$ref":"#/definitions/imageResource" } }, "okDeleteImageResponse":{ "description":"OK. A JSON object containing an image resource representation with multiple properties and the links array with at least the \"self\" link. Only if it was successfully deleted.", "schema":{ "$ref":"#/definitions/imageResource" } }, "okSingleSeriesResponse":{ "description":"OK. A JSON object containing a series resource representation with multiple properties and the links array with at least the \"self\" link.", "schema":{ "$ref":"#/definitions/seriesResource" } }, "okDeleteSeriesResponse":{ "description":"OK. A JSON object containing a series resource representation with multiple properties and the links array with at least the \"self\" link. Only if it was successfully deleted.", "schema":{ "$ref":"#/definitions/seriesResource" } }, "okSingleWorkingcopyResponse":{ "description":"OK. A JSON object containing a working copy resource representation with multiple properties and the links array with at least the \"self\" link.", "schema":{ "$ref":"#/definitions/workingcopyResource" } }, "okHTMLResponse":{ "description":"Returns the HTML with the cluster information.", "schema":{ "type":"string" } } }, "paths":{ "/clients":{ "get":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Manage Client Targets" ], "summary":"Gets all the Fleet Patching and Provisioning Client clusters.", "description":"Gets all the Fleet Patching and Provisioning Client clusters.", "operationId":"listClients", "parameters":[ ], "responses":{ "200":{ "$ref":"#/responses/okArrayOfItemsResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"clients-get", "x-filename-id":"clients-get" } }, "/clients/getByServer":{ "get":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Manage Client Targets" ], "summary":"Gets all the Fleet Patching and Provisioning Client clusters by Fleet Patching and Provisioning Server.", "description":"Gets all the Fleet Patching and Provisioning Client clusters associated with the Fleet Patching and Provisioning Servers matching the regular expression given.", "operationId":"listClientsByServer", "parameters":[ { "$ref":"#/parameters/rhpserverQueryClientQueryParam" } ], "responses":{ "200":{ "$ref":"#/responses/okArrayOfItemsResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"clients-getByServer-get", "x-filename-id":"clients-getbyserver-get" } }, "/clients/{clientId}":{ "get":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Manage Client Targets" ], "summary":"Gets the details of a specific Fleet Patching and Provisioning Client.", "description":"Gets the details of a specific Fleet Patching and Provisioning Client.", "operationId":"getClientById", "parameters":[ { "$ref":"#/parameters/detailQueryClientQueryParam" }, { "$ref":"#/parameters/nodeQueryClientQueryParam" }, { "$ref":"#/parameters/clientIdPathParam" } ], "responses":{ "200":{ "$ref":"#/responses/okArrayOfItemsResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"clients-{clientId}-get", "x-filename-id":"clients-clientid-get" } }, "/clients/{clientId}/displayHTML":{ "get":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Manage Client Targets" ], "summary":"Gets HTML cluster information for the cluster.", "description":"Gets HTML cluster information for the cluster.", "operationId":"getClientById", "parameters":[ { "$ref":"#/parameters/detailQueryClientQueryParam" }, { "$ref":"#/parameters/nodeQueryClientQueryParam" }, { "$ref":"#/parameters/clientIdPathParam" } ], "responses":{ "200":{ "$ref":"#/responses/okHTMLResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"clients-{clientId}-displayHTML-get", "x-filename-id":"clients-clientid-displayhtml-get" } }, "/databases":{ "patch":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Patch Unmanaged Software Homes" ], "summary":"Patch an unmanaged Oracle AI Database Software home", "description":"Moves a database from the unamanged Oracle AI Database Software home to a patched working copy.", "operationId":"moveDatabase", "parameters":[ { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/MoveDatabaseBody" } }, { "$ref":"#/parameters/authorizationHeader" } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"databases-patch", "x-filename-id":"databases-patch" } }, "/databases/{dbUniqueName}":{ "put":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Upgrade Unmanaged Software Homes" ], "summary":"Upgrade an unmanaged Oracle AI Database Software home", "description":"Upgrade a database on the specified Oracle AI Database Software home", "operationId":"upgradeDatabase", "parameters":[ { "$ref":"#/parameters/dbUNamePathParam" }, { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/UpgradeDatabaseBody" } }, { "$ref":"#/parameters/authorizationHeader" } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"databases-{dbUniqueName}-put", "x-filename-id":"databases-dbuniquename-put" } }, "/gihome/{destWcId}":{ "put":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Upgrade Unmanaged Software Homes" ], "summary":"Upgrade unmanaged Grid Infrastructure Software home", "description":"Upgrades the Oracle Grid Infrastructure from the source home path to the destination working copy.", "operationId":"upgradeGihome", "parameters":[ { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/UpgradeGihomeBody" } }, { "$ref":"#/parameters/destWcIdPatParam" }, { "$ref":"#/parameters/authorizationHeader" } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"gihome-{destWcId}-put", "x-filename-id":"gihome-destwcid-put" }, "patch":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Patch Unmanaged Software Homes" ], "summary":"Patch unmanaged Grid Infrastructure Software home", "description":"Moves the Oracle Grid Infrastructure from the source home path to the destination working copy.", "operationId":"moveGihome", "parameters":[ { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/MoveGihomeBody" } }, { "$ref":"#/parameters/destWcIdPatParam" }, { "$ref":"#/parameters/authorizationHeader" } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"gihome-{destWcId}-patch", "x-filename-id":"gihome-destwcid-patch" } }, "/images":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Lists all the gold images", "description":"Display the name of all the existing gold images in the server.", "operationId":"queryAllImages", "parameters":[ ], "responses":{ "200":{ "$ref":"#/responses/okArrayOfItemsResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"images-get", "x-filename-id":"images-get" }, "post":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Schedules an import image operation", "description":"Create a gold image from the Software home specified in the body of this request, can be of Oracle AI Database, Grid Infrastructure or any other Software home.", "operationId":"importImage", "parameters":[ { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/ImportImageBody" } }, { "$ref":"#/parameters/authorizationHeader" } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"images-post", "x-filename-id":"images-post" } }, "/images/repository":{ "post":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Schedules an register image operation", "description":"Register a new image from the specified path", "operationId":"registerImage", "parameters":[ { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/RegisterImageBody" } }, { "$ref":"#/parameters/authorizationHeader" } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"images-repository-post", "x-filename-id":"images-repository-post" } }, "/images/{imageId}/actions/deploy":{ "post":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Propagate image to targets", "description":"Deploys an image to a specific node in a client cluster.", "operationId":"deployImage", "parameters":[ { "$ref":"#/parameters/imageNamePathParam" }, { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/DeployImageBody" } }, { "$ref":"#/parameters/authorizationHeader" } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"images-{imageId}-actions-deploy-post", "x-filename-id":"images-imageid-actions-deploy-post" } }, "/images/search":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Lists all the gold images that matches the specified query parameters.", "description":"Display the name of all the existing gold images in the server that matches the search parameters specified.", "operationId":"searchImage", "parameters":[ { "$ref":"#/parameters/clientQueryParam" }, { "$ref":"#/parameters/imageTypeQueryParam" }, { "name":"version", "in":"query", "required":false, "type":"string", "description":"The version of the images." }, { "name":"platform", "in":"query", "required":false, "type":"string", "description":"The OS platform to which the images correspond." }, { "$ref":"#/parameters/serverNameQueryParam" }, { "name":"drift", "in":"query", "required":false, "type":"string", "description":"Lists the bug fixes not included in the golden image." } ], "responses":{ "200":{ "$ref":"#/responses/okArrayOfItemsResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"images-search-get", "x-filename-id":"images-search-get" } }, "/images/{imageId}":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Display the configuration of the specified image", "description":"Display the details of the gold image associated to the given image name.", "operationId":"getImageByName", "parameters":[ { "$ref":"#/parameters/imageNamePathParam" }, { "name":"dbtemplate", "in":"query", "required":false, "type":"boolean", "default":false, "description":"Displays template file names in the default template directory." } ], "responses":{ "200":{ "$ref":"#/responses/okSingleImageResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"images-{imageId}-get", "x-filename-id":"images-imageid-get" }, "delete":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Deletes the specified image name", "description":"Delete the gold image represented by the given image name.", "operationId":"deleteImageByName", "parameters":[ { "$ref":"#/parameters/imageNamePathParam" } ], "responses":{ "200":{ "$ref":"#/responses/okDeleteImageResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"images-{imageId}-delete", "x-filename-id":"images-imageid-delete" } }, "/exadatas/actions/update":{ "post":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Manage Exadata Systems" ], "summary":"Patch Exadata system.", "description":"Updates software for Oracle Exadata Database Machine", "operationId":"updateExadata", "parameters":[ { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/UpdateExadataBody" } }, { "$ref":"#/parameters/authorizationHeader" } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"exadatas-actions-update-post", "x-filename-id":"exadatas-actions-update-post" } }, "/jobs":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Operation Results" ], "summary":"Get all the jobs", "description":"Returns a list of all the jobs available in the server.", "operationId":"listAllJobs", "parameters":[ { "$ref":"#/parameters/userQueryJobParam" }, { "$ref":"#/parameters/clientQueryJobParam" }, { "$ref":"#/parameters/jobTagQueryJobParam" }, { "$ref":"#/parameters/statusQueryJobParam" } ], "responses":{ "200":{ "$ref":"#/responses/okArrayOfItemsResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"jobs-get", "x-filename-id":"jobs-get" } }, "/jobs/actions/delete":{ "post":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Operation Results" ], "summary":"Delete jobs.", "description":"Delete jobs.", "operationId":"deleteJobs", "parameters":[ { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/DeleteJobsBody" } }, { "$ref":"#/parameters/authorizationHeader" } ], "responses":{ "200":{ "description":"OK. HTTP Status code 200 indicating delete is succesful.", "schema":{ } }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"jobs-actions-delete-post", "x-filename-id":"jobs-actions-delete-post" } }, "/jobs/{jobId}/actions/abort":{ "post":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Operation Results" ], "summary":"Abort a job.", "description":"Abort a job.", "operationId":"abortJobById", "parameters":[ { "$ref":"#/parameters/jobIdPathParam" } ], "responses":{ "200":{ "description":"OK. HTTP Status code 200 indicating abort is succesful.", "schema":{ } }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"jobs-{jobId}-actions-abort-post", "x-filename-id":"jobs-jobid-actions-abort-post" } }, "/jobs/{jobId}/actions/resume":{ "post":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Operation Results" ], "summary":"Resume a job.", "description":"Resume a job.", "operationId":"resumeJobById", "parameters":[ { "$ref":"#/parameters/jobIdPathParam" } ], "responses":{ "200":{ "description":"OK. HTTP Status code 200 indicating resume is succesful.", "schema":{ } }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"jobs-{jobId}-actions-resume-post", "x-filename-id":"jobs-jobid-actions-resume-post" } }, "/jobs/{jobId}":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Operation Results" ], "summary":"Get job details", "description":"Return the configuration of the Job resource associated to the given job Id.", "operationId":"getJobById", "parameters":[ { "$ref":"#/parameters/jobIdPathParam" } ], "responses":{ "200":{ "$ref":"#/responses/okSingleJobResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"jobs-{jobId}-get", "x-filename-id":"jobs-jobid-get" }, "put":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Operation Results" ], "summary":"Modify the scheduled date for the job.", "description":"Modify the scheduled date for the job.", "operationId":"modifyJobById", "parameters":[ { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/ModifyJobBody" } }, { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/jobIdPathParam" } ], "responses":{ "200":{ "description":"OK. HTTP Status code 200 indicating modify is succesful.", "schema":{ } }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"jobs-{jobId}-put", "x-filename-id":"jobs-jobid-put" }, "delete":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Operation Results" ], "summary":"Delete a job.", "description":"Delete a job.", "operationId":"deleteJobById", "parameters":[ { "$ref":"#/parameters/jobIdPathParam" } ], "responses":{ "200":{ "description":"OK. HTTP Status code 200 indicating delete is succesful.", "schema":{ } }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"jobs-{jobId}-delete", "x-filename-id":"jobs-jobid-delete" } }, "/jobs/{jobId}/output":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Operation Results" ], "summary":"Get the job output and result", "description":"Gets the job output presenting the job result and progress, which can be paginated using the limit and offset parameters.", "operationId":"getJobOutput", "parameters":[ { "$ref":"#/parameters/jobIdPathParam" }, { "name":"limit", "in":"query", "required":false, "type":"integer", "default":0, "description":"The number of lines from the job result to be included in the job output resource." }, { "name":"offset", "in":"query", "required":false, "type":"integer", "default":0, "description":"The identifier of the first line on the job result to be included in the job output resource." } ], "responses":{ "200":{ "$ref":"#/responses/okSingleJobOutputResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"jobs-{jobId}-output-get", "x-filename-id":"jobs-jobid-output-get" } }, "/series":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Get all the series", "description":"Returns a list of series names available in the server.", "operationId":"getAllSeries", "parameters":[ ], "responses":{ "200":{ "$ref":"#/responses/okArrayOfItemsResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"series-get", "x-filename-id":"series-get" } }, "/series/search":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Search series matching certain parameters", "description":"Returns a list of the series that matches either the image or the server provided.", "operationId":"searchSeries", "parameters":[ { "$ref":"#/parameters/imageNameQueryParam" }, { "$ref":"#/parameters/serverNameQueryParam" } ], "responses":{ "200":{ "$ref":"#/responses/okArrayOfItemsResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"series-search-get", "x-filename-id":"series-search-get" } }, "/series/{seriesId}":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Get image series", "description":"Return the series resource details of the seris associated to the given series Id and server", "operationId":"getSeriesById", "parameters":[ { "$ref":"#/parameters/seriesIdPathParam" }, { "$ref":"#/parameters/serverNameQueryParam" } ], "responses":{ "200":{ "$ref":"#/responses/okSingleSeriesResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"series-{seriesId}-get", "x-filename-id":"series-seriesid-get" }, "post":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Add a new image series", "description":"Creates a new series resource with the given name in the seriesId parameter.", "operationId":"addSeries", "parameters":[ { "$ref":"#/parameters/seriesIdPathParam" }, { "in":"body", "name":"body", "required":false, "schema":{ "$ref":"#/definitions/AddSeriesBody" } } ], "responses":{ "200":{ "$ref":"#/responses/okSingleSeriesResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"series-{seriesId}-post", "x-filename-id":"series-seriesid-post" }, "delete":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Delete image series", "description":"Delete the image series from the server, but leave all the images intact.", "operationId":"deleteSeriesById", "parameters":[ { "$ref":"#/parameters/seriesIdPathParam" }, { "in":"body", "name":"body", "required":false, "schema":{ "$ref":"#/definitions/DeleteSeriesBody" } } ], "responses":{ "200":{ "$ref":"#/responses/okDeleteSeriesResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"series-{seriesId}-delete", "x-filename-id":"series-seriesid-delete" } }, "/series/{seriesId}/images/{imageId}":{ "post":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Add image to series", "description":"Add an existing image to an existing series.", "operationId":"insertImageIntoSeries", "parameters":[ { "$ref":"#/parameters/seriesIdPathParam" }, { "$ref":"#/parameters/imageNamePathParam" }, { "in":"body", "name":"body", "required":false, "schema":{ "$ref":"#/definitions/InsertImageSeriesBody" } } ], "responses":{ "200":{ "$ref":"#/responses/okSingleSeriesResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"series-{seriesId}-images-{imageId}-post", "x-filename-id":"series-seriesid-images-imageid-post" }, "delete":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Remove image from series", "description":"Removes an existing image from an existing series.", "operationId":"deleteImageFromSeries", "parameters":[ { "$ref":"#/parameters/seriesIdPathParam" }, { "$ref":"#/parameters/imageNamePathParam" } ], "responses":{ "200":{ "$ref":"#/responses/okSingleSeriesResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"series-{seriesId}-images-{imageId}-delete", "x-filename-id":"series-seriesid-images-imageid-delete" } }, "/series/{seriesId}/users/{userId}":{ "post":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Subscribe a user to a series", "description":"Add an existing user to the subscribed users list for an existing series.", "operationId":"subscribeUserToSeries", "parameters":[ { "$ref":"#/parameters/seriesIdPathParam" }, { "$ref":"#/parameters/osUserNamePathParam" }, { "$ref":"#/parameters/subscribeUserSeriesBodyParam" } ], "responses":{ "200":{ "$ref":"#/responses/okSingleSeriesResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"series-{seriesId}-users-{userId}-post", "x-filename-id":"series-seriesid-users-userid-post" }, "delete":{ "tags":[ "Fleet Patching and Provisioning/RHP - Manage Gold Images" ], "summary":"Unsubscribe a user from a series", "description":"Removes an existing user from the subscribed users list for an existing series.", "operationId":"unsubscribeUserFromSeries", "parameters":[ { "$ref":"#/parameters/seriesIdPathParam" }, { "$ref":"#/parameters/osUserNamePathParam" }, { "$ref":"#/parameters/subscribeUserSeriesBodyParam" } ], "responses":{ "200":{ "$ref":"#/responses/okSingleSeriesResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"series-{seriesId}-users-{userId}-delete", "x-filename-id":"series-seriesid-users-userid-delete" } }, "/workingcopies":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Provisioning Software homes" ], "summary":"Get all working copies", "description":"Returns a list of names working copies available on the server.", "operationId":"getAllWorkingcopies", "parameters":[ ], "responses":{ "200":{ "$ref":"#/responses/okArrayOfItemsResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"workingcopies-get", "x-filename-id":"workingcopies-get" }, "post":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Provisioning Software homes" ], "summary":"Create working copy", "description":"Creates a new working copy using an existing gold image", "operationId":"addWorkingcopy", "parameters":[ { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/AddWorkingCopyBody" } }, { "$ref":"#/parameters/authorizationHeader" } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"workingcopies-post", "x-filename-id":"workingcopies-post" } }, "/workingcopies/fetchWorkingcopy":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Provisioning Software homes" ], "summary":"Get working copy based in client and Oracle Home", "description":"Returns the working copy matching client and Oracle Home.", "operationId":"fetchWorkingcopy", "parameters":[ { "$ref":"#/parameters/clientFetchWorkingcopyQueryParam" }, { "$ref":"#/parameters/pathFetchWorkingcopyQueryParam" } ], "responses":{ "200":{ "$ref":"#/responses/okSingleWorkingcopyResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"workingcopies-fetchWorkingcopy-get", "x-filename-id":"workingcopies-fetchworkingcopy-get" } }, "/workingcopies/imagetypes/{imageType}":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Provisioning Software homes" ], "summary":"Get working copies based on a certain image type", "description":"Return the list of working copies based on a given golden image.", "operationId":"listWorkingCopiesByImageType", "parameters":[ { "$ref":"#/parameters/imageTypePathParam" } ], "responses":{ "200":{ "$ref":"#/responses/okArrayOfItemsResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"workingcopies-imagetypes-{imageType}-get", "x-filename-id":"workingcopies-imagetypes-imagetype-get" } }, "/workingcopies/search":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Provisioning Software homes" ], "summary":"Search working copies", "description":"that matches the given parameters.", "operationId":"searchWorkingcopies", "parameters":[ { "$ref":"#/parameters/clientQueryParam" }, { "$ref":"#/parameters/imageNameQueryParam" } ], "responses":{ "200":{ "$ref":"#/responses/okArrayOfItemsResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"workingcopies-search-get", "x-filename-id":"workingcopies-search-get" } }, "/workingcopies/{workingCopyId}":{ "get":{ "tags":[ "Fleet Patching and Provisioning/RHP - Provisioning Software homes" ], "summary":"Get working copy details", "description":"Return the working copy configuration.", "operationId":"getWorkingcopyByName", "parameters":[ { "$ref":"#/parameters/workingcopyIdPathParam" } ], "responses":{ "200":{ "$ref":"#/responses/okSingleWorkingcopyResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"workingcopies-{workingCopyId}-get", "x-filename-id":"workingcopies-workingcopyid-get" } }, "/workingcopies/{workingCopyId}/databases":{ "post":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Provisioning Software homes" ], "summary":"Create Oracle AI Database Software", "description":"Provision a new Oracle AI Database on a managed working copy.", "operationId":"addDatabaseManagedWC", "parameters":[ { "$ref":"#/parameters/workingcopyIdPathParam" }, { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/AddDatabaseBody" } }, { "$ref":"#/parameters/authorizationHeader" } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"workingcopies-{workingCopyId}-databases-post", "x-filename-id":"workingcopies-workingcopyid-databases-post" }, "patch":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Patch Software homes" ], "summary":"Patch an Oracle AI Database Software home", "description":"Moves a database from a source working copy to a patched working copy.", "operationId":"moveDatabaseManagedWC", "parameters":[ { "$ref":"#/parameters/workingcopyIdPathParam" }, { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/MoveDatabaseBody" } }, { "$ref":"#/parameters/authorizationHeader" } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"workingcopies-{workingCopyId}-databases-patch", "x-filename-id":"workingcopies-workingcopyid-databases-patch" } }, "/workingcopies/{workingCopyId}/databases/{dbUniqueName}":{ "put":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Upgrade Software homes" ], "summary":"Upgrade an Oracle AI Database Software home", "description":"Upgrade a database from a source working copy to a patched working copy.", "operationId":"upgradeDatabaseManagedWC", "parameters":[ { "$ref":"#/parameters/workingcopyIdPathParam" }, { "$ref":"#/parameters/dbUNamePathParam" }, { "in":"body", "name":"body", "required":false, "schema":{ "$ref":"#/definitions/UpgradeDatabaseBody" } } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"workingcopies-{workingCopyId}-databases-{dbUniqueName}-put", "x-filename-id":"workingcopies-workingcopyid-databases-dbuniquename-put" }, "delete":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Provisioning Software homes" ], "summary":"Delete a database that was created on a working copy", "description":"Delete a database that was created on a working copy", "operationId":"deleteDatabaseManagedWC", "parameters":[ { "$ref":"#/parameters/workingcopyIdPathParam" }, { "$ref":"#/parameters/dbUNamePathParam" }, { "in":"body", "name":"body", "required":false, "schema":{ "$ref":"#/definitions/DeleteDatabaseBody" } } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"workingcopies-{workingCopyId}-databases-{dbUniqueName}-delete", "x-filename-id":"workingcopies-workingcopyid-databases-dbuniquename-delete" } }, "/workingcopies/{workingCopyId}/gihome/{destWcId}":{ "put":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Upgrade Software homes" ], "summary":"Upgrade Grid Infrastructure Software home", "description":"Upgrades the Oracle Grid Infrastructure from the source working copy to the destination working copy.", "operationId":"upgradeGihomeManagedWC", "parameters":[ { "$ref":"#/parameters/workingcopyIdPathParam" }, { "$ref":"#/parameters/destWcIdPatParam" }, { "in":"body", "name":"body", "required":false, "schema":{ "$ref":"#/definitions/UpgradeGihomeBody" } } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"workingcopies-{workingCopyId}-gihome-{destWcId}-put", "x-filename-id":"workingcopies-workingcopyid-gihome-destwcid-put" }, "patch":{ "security":[ { "basicAuthentication":[ ] } ], "tags":[ "Fleet Patching and Provisioning/RHP - Patch Software homes" ], "summary":"Patch Grid Infrastructure Software home", "description":"Moves the Oracle Grid Infrastructure from the source working copy to the destination working copy.", "operationId":"moveGihomeManagedWC", "parameters":[ { "$ref":"#/parameters/workingcopyIdPathParam" }, { "$ref":"#/parameters/destWcIdPatParam" }, { "in":"body", "name":"body", "required":true, "schema":{ "$ref":"#/definitions/MoveGihomeBody" } } ], "responses":{ "202":{ "$ref":"#/responses/jobAccepted202Response" }, "400":{ "$ref":"#/responses/badRequestResponse" }, "default":{ "$ref":"#/responses/errorResponse" } }, "x-internal-id":"workingcopies-{workingCopyId}-gihome-{destWcId}-patch", "x-filename-id":"workingcopies-workingcopyid-gihome-destwcid-patch" } } }, "definitions":{ "UpgradeGihomeBody":{ "type":"object", "properties":{ "sourcewc":{ "type":"string", "description":"Name of the source working copy from which the Oracle Grid Infrastructure needs to be upgraded." }, "destwc":{ "type":"string", "description":"Name of the destination working copy to which the Oracle Grid Infrastructure needs to be upgraded." }, "imageName":{ "type":"string", "description":"Image name from the configured images." }, "targetNode":{ "type":"string", "description":"Name of a node in a remote cluster with no Rapid Home Provisioning Client." }, "sourceHome":{ "type":"string", "description":"Source Oracle home path." }, "ignoreprereq":{ "type":"boolean", "default":false, "description":"To ignore the CVU pre-requisite checks." }, "path":{ "type":"string", "description":"The absolute path for the destination working copy." }, "root":{ "type":"boolean", "default":false, "description":"Use root credentials to access the remote node." }, "sudoUser":{ "type":"string", "description":"perform super user operations as sudo user name." }, "sudoPath":{ "type":"string", "description":"location of sudo binary." }, "superUserPasswd":{ "type":"string", "description":"The password for the super user account." }, "authArgs":{ "type":"object", "description":"Additional properties for the selected authentication plugin.", "additionalProperties":{ "type":"string" } }, "auth":{ "type":"string", "description":"Use an authentication plugin to access the remote node." }, "eval":{ "type":"boolean", "default":false, "description":"Evaluate without executing the command." }, "schedule":{ "type":"string", "description":"Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05." }, "batches":{ "type":"string", "description":"Comma-delimited list of batches of nodes (where each batch is a comma-delimited list of node names enclosed in parentheses) enclosed in double quotation marks (\"\") in the format: \"(nA,nB,...),(...,nY,nZ)\"." }, "abort":{ "type":"boolean", "default":false, "description":"Abort the ongoing operation." }, "revert":{ "type":"boolean", "default":false, "description":"Downgrade after a failed upgrade of Oracle Grid Infrastructure." }, "continue":{ "type":"boolean", "default":false, "description":"Continue upgrading the next batch of nodes." }, "gimrwc":{ "type":"string", "description":"Name of the destination working copy to which the Grid Infrastructure Management Repository database needs to be upgraded." } } }, "AddDatabaseBody":{ "type":"object", "properties":{ "pqpool":{ "type":"string", "description":"Existing PQ pool name" }, "newpqpool":{ "type":"string", "description":"Server pool name for pool to be created" }, "pqcardinality":{ "type":"string", "description":"Cardinality for new PQ pool" }, "dbTemplate":{ "type":"string", "description":"Absolute file path for the template file or relative path to the image home directory on Rapid Home Provisioning Server" }, "targetNode":{ "type":"string", "description":"Node on which operation needs to be executed" }, "datafileDestination":{ "type":"string", "description":"Data file destination location or ASM disk group name" }, "numberOfPDBs":{ "type":"integer", "format":"int32", "description":"Number of PDBs to be created" }, "pdbname":{ "type":"string", "description":"The pdbname prefix if one or more PDBs need to be created" }, "cdb":{ "type":"boolean", "default":false, "description":"To create database as container database" }, "dbType":{ "type":"string", "enum":[ "RAC", "RACONENODE", "SINGLE" ], "description":"Type of database: Oracle RAC One Node or Oracle RAC or Single Instance" }, "userActionData":{ "type":"string", "description":"Value to be passed to useractiondata parameter of useraction script" }, "root":{ "type":"boolean", "default":false, "description":"Use root credentials to access the remote node." }, "sudoUser":{ "type":"string", "description":"perform super user operations as sudo user name." }, "sudoPath":{ "type":"string", "description":"location of sudo binary." }, "superUserPasswd":{ "type":"string", "description":"The password for the super user account." }, "authArgs":{ "type":"object", "description":"Additional properties for the selected authentication plugin.", "additionalProperties":{ "type":"string" } }, "auth":{ "type":"string", "description":"Use an authentication plugin to access the remote node." }, "eval":{ "type":"boolean", "default":false, "description":"Evaluate without executing the command." }, "schedule":{ "type":"string", "description":"Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05." }, "gimr":{ "type":"boolean", "default":false, "description":"To perform the operations required for a Grid Infrastructure Management Repository (GIMR) database" }, "cardinality":{ "type":"string", "description":"Cardinality for new server pool" }, "dbcaAdditionalArgs":{ "type":"string", "description":"DBCA additional command line arguments separated by space" }, "dbcaInitParams":{ "type":"string", "description":"Comma-separated list of name=value pairs of the database initialization parameters and their valuescomma-separated list of name=value pairs of the database initialization parameters and their values" }, "newpool":{ "type":"string", "description":"Server pool name for pool to be created" }, "nodes":{ "type":"string", "description":"Comma-separated list of nodes on which database will be created" }, "serverpool":{ "type":"string", "description":"Comma-separated list of existing server pool names" } } }, "ImportImageBody":{ "type":"object", "properties":{ "imageName":{ "type":"string", "description":"Name of the image." }, "client":{ "type":"string", "description":"Client cluster name." }, "imageType":{ "type":"string", "description":"The software type. (\"ORACLEDBSOFTWARE\" (default) for Oracle AI Database software, \"EXAPATCHSOFTWARE\" for Oracle Exadata software, \"ORACLEGISOFTWARE\" for Oracle Grid Infrastructure software, ORACLEGGSOFTWARE for Oracle GoldenGate software, \"LINUXOS\" for linux Opearting System ISO, and \"SOFTWARE\" for all other software. For a custom image type, use the image type name.)" }, "schedule":{ "type":"string", "description":"Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05." }, "targetNode":{ "type":"string", "description":"Node on which operation needs to be executed." }, "userActionData":{ "type":"string", "description":"Value to be passed to useractiondata parameter of useraction script." }, "pathOwner":{ "type":"string", "description":"User with read access to files under the specified path." }, "zip":{ "type":"string", "description":"Absolute path of the compressed software home to be imported (a ZIP or TAR file)." }, "version":{ "type":"string", "description":"Oracle AI Database version for GIAAS, ODA patchbundle version for ODAPATCHSOFTWARE." }, "state":{ "type":"string", "description":"State name.", "enum":[ "TESTABLE", "RESTRICTED", "PUBLISHED" ] }, "path":{ "type":"string", "description":"Absolute path location of the software home to be imported (For database images, this will be the ORACLE_HOME)." }, "root":{ "type":"boolean", "default":false, "description":"Use root credentials to access the remote node." }, "sudoUser":{ "type":"string", "description":"perform super user operations as sudo user name." }, "sudoPath":{ "type":"string", "description":"location of sudo binary." }, "superUserPasswd":{ "type":"string", "description":"The password for the super user account." }, "authArgs":{ "type":"object", "description":"Additional properties for the selected authentication plugin.", "additionalProperties":{ "type":"string" } }, "auth":{ "type":"string", "description":"Use an authentication plugin to access the remote node." }, "host":{ "type":"string", "description":"GIAAS host name." }, "cc":{ "type":"string", "description":"List of users to whom email notifications will be sent, in addition to owner of working copy." }, "notify":{ "type":"boolean", "default":false, "description":"Send email notification." }, "psu":{ "type":"string", "description":"Bug number or downloaded zip location or released PSU/BP." }, "patches":{ "type":"string", "description":"Comma separated bug numbers or NFS downloaded zip location or combination of both." }, "port":{ "type":"string", "description":"Port number in the range of 1024-65536." }, "location":{ "type":"string", "description":"Location of the compressed image file on the target" } } }, "RegisterImageBody":{ "type":"object", "properties":{ "imageName":{ "type":"string", "description":"Name of the image" }, "path":{ "type":"string", "description":"Absolute path location of the software home to be imported (For database images, this will be the ORACLE_HOME)" }, "zip":{ "type":"string", "description":"Absolute path of the compressed software home to be imported (a ZIP or TAR file)" }, "imageType":{ "type":"string", "description":"The software type. (\"ORACLEDBSOFTWARE\" (default) for Oracle AI Database software, \"EXAPATCHSOFTWARE\" for Oracle Exadata software, \"ORACLEGISOFTWARE\" for Oracle Grid Infrastructure software, \"ORACLEGGSOFTWARE\" for Oracle GoldenGate software, \"LINUXOS\" for linux Opearting System ISO, and \"SOFTWARE\" for all other software. For a custom image type, use the image type name.)" }, "pathOwner":{ "type":"string", "description":"User with read access to files under the specified path" }, "state":{ "type":"string", "description":"State name", "enum":[ "TESTABLE", "RESTRICTED", "PUBLISHED" ] }, "client":{ "type":"string", "description":"Client cluster name" }, "targetNode":{ "type":"string", "description":"Node on which operation needs to be executed" }, "sudoPath":{ "type":"string", "description":"location of sudo binary" }, "sudoUser":{ "type":"string", "description":"perform super user operations as sudo user name" }, "root":{ "type":"boolean", "default":false, "description":"Use root credentials to access the remote node" }, "schedule":{ "type":"string", "description":"Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05" }, "userActionData":{ "type":"string", "description":"Value to be passed to useractiondata parameter of useraction script" }, "cred":{ "type":"string", "description":"Credential name to associate the user/password credentials to access a remote node" }, "ossurl":{ "type":"string", "description":"URL where the OSS mapping file is located" }, "version":{ "type":"string", "description":"Oracle AI Database version for GIAAS, ODA patchbundle version for ODAPATCHSOFTWARE, Exadata image version for EXAPATCHSOFTWARE" }, "location":{ "type":"string", "description":"Location of the compressed image file on the target" }, "authArgs":{ "type":"object", "description":"Additional properties for the selected authentication plugin.", "additionalProperties":{ "type":"string" } }, "auth":{ "type":"string", "description":"Use an authentication plugin to access the remote node." }, "temploc":{ "type":"string", "description":"Get the absolute path to be used as temporary location to download the image that will be registered." } } }, "AddWorkingCopyBody":{ "type":"object", "properties":{ "client":{ "type":"string", "description":"Client cluster name" }, "targetNode":{ "type":"string", "description":"Node on which operation needs to be executed" }, "setupSSH":{ "type":"boolean", "default":false, "description":"sets up passwordless SSH user equivalence on the remote nodes for the provisioning user." }, "node":{ "type":"string", "description":"Comma-separated list of nodes on which database will be created" }, "root":{ "type":"boolean", "default":false, "description":"Use root credentials to access the remote node." }, "sudoUser":{ "type":"string", "description":"perform super user operations as sudo user name." }, "sudoPath":{ "type":"string", "description":"location of sudo binary." }, "superUserPasswd":{ "type":"string", "description":"The password for the super user account." }, "authArgs":{ "type":"object", "description":"Additional properties for the selected authentication plugin.", "additionalProperties":{ "type":"string" } }, "auth":{ "type":"string", "description":"Use an authentication plugin to access the remote node." }, "eval":{ "type":"boolean", "default":false, "description":"Evaluate without executing the command." }, "schedule":{ "type":"string", "description":"Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05." }, "user":{ "type":"string", "description":"Name of the user for whom the software home is being provisioned." }, "clusterNodes":{ "type":"string", "description":"Comma-separated list of node information on which Oracle Clusterware will be provisioned." }, "fixup":{ "type":"boolean", "default":false, "description":"Execute fixup script. Valid only for Grid Infrastructure provisioning." }, "asmClientData":{ "type":"string", "description":"File that contains the ASM client data." }, "gnsClientData":{ "type":"string", "description":"File that contains the GNS client data." }, "clusterManifest":{ "type":"string", "description":"Location of Cluster Manifest File." }, "oracleBase":{ "type":"string", "description":"ORACLE_BASE path for provisioning Oracle AI Database home or Oracle Grid Infrastructure home." }, "agpath":{ "type":"string", "description":"Read/write path for the persistent Oracle home path." }, "aupath":{ "type":"string", "description":"Read-only gold image path for the persistent Oracle home path." }, "ignorePrereq":{ "type":"boolean", "default":false, "description":"To ignore the CVU pre-requisite checks." }, "path":{ "type":"string", "description":"Absolute path location of the software home to be imported (For database images, this will be the ORACLE_HOME)." }, "dbTemplate":{ "type":"string", "description":"Absolute file path for the template file or relative path to the image home directory on Rapid Home Provisioning Server." }, "dbname":{ "type":"string", "description":"Name of database (DB_UNIQUE_NAME) to be provisioned." }, "cardinality":{ "type":"string", "description":"Cardinality for new server pool." }, "storagetype":{ "type":"string", "description":"Type of storage for the home.", "enum":[ "LOCAL", "RHP_MANAGED" ] }, "datafileDestination":{ "type":"string", "description":"Data file destination location or ASM disk group name." }, "serverpool":{ "type":"string", "description":"Comma-separated list of existing server pool names." }, "numberOfPDBs":{ "type":"integer", "format":"int32", "description":"Number of PDBs to be created." }, "newpool":{ "type":"string", "description":"Server pool name for pool to be created." }, "pdbname":{ "type":"string", "description":"The pdbname prefix if one or more PDBs need to be created." }, "cdb":{ "type":"boolean", "default":false, "description":"To create database as container database." }, "softwareOnly":{ "type":"string", "default":false, "description":"Perform Grid Infrastructure software-only provisioning." }, "transferAsZip":{ "type":"boolean", "default":false, "description":"Transfer the software image as a zip file to remote node for provisioning." }, "groups":{ "type":"string", "description":"Comma-separated list of Oracle groups to be configured for the working copy. Specify a valid key such as OSDBA, OSOPER, OSASM, OSBACKUP, OSDG, OSKM, or OSRAC, equated to a valid group name as value." }, "dbType":{ "type":"string", "enum":[ "RAC", "RACONENODE", "SINGLE" ], "description":"Type of database: Oracle RAC One Node or Oracle RAC or Single Instance." }, "edition":{ "type":"string", "enum":[ "ENTERPRISE", "STANDARD" ], "description":"Type of the Oracle Home to be provisioned: 'ENTERPRISE' or 'STANDARD'." }, "gimr":{ "type":"boolean", "default":false, "description":"To perform the operations required for a Grid Infrastructure Management Repository (GIMR) database" }, "readOnly":{ "type":"boolean", "description":"Add database workingcopy as a read-only home" }, "clusterNameAlias":{ "type":"string", "description":"Cluster name alias" }, "imageName":{ "type":"string", "description":"Name of the image." }, "inventory":{ "type":"string", "description":"Location of Oracle Inventory." }, "localmount":{ "type":"string", "description":"Provision from locally mounted compressed image file." }, "location":{ "type":"string", "description":"Location of the compressed image file on the target." }, "newpqpool":{ "type":"string", "description":"PQ pool name for pool to be created." }, "pqcardinality":{ "type":"string", "description":"Cardinality for new PQ pool." }, "pqpool":{ "type":"string", "description":"Existing PQ pool name." }, "responsefile":{ "type":"string", "description":"Response file to be used to perform Oracle Grid Infrastructure provisioning." }, "workingcopy":{ "type":"string", "description":"Name of the working copy to be created." } } }, "UpgradeDatabaseBody":{ "type":"object", "properties":{ "sourcewc":{ "type":"string", "description":"Name of the source working copy from which the Oracle Grid Infrastructure needs to be upgraded." }, "imageName":{ "type":"string", "description":"Name of the image." }, "client":{ "type":"string", "description":"Client cluster name" }, "targetNode":{ "type":"string", "description":"Node on which operation needs to be executed" }, "sourceHome":{ "type":"string", "description":"Source Oracle home path." }, "ignoreprereq":{ "type":"boolean", "default":false, "description":"To ignore the CVU pre-requisite checks." }, "path":{ "type":"string", "description":"Absolute path location of the software home to be imported (For database images, this will be the ORACLE_HOME)." }, "root":{ "type":"boolean", "default":false, "description":"Use root credentials to access the remote node." }, "sudoUser":{ "type":"string", "description":"perform super user operations as sudo user name." }, "sudoPath":{ "type":"string", "description":"location of sudo binary." }, "superUserPasswd":{ "type":"string", "description":"The password for the super user account." }, "authArgs":{ "type":"object", "description":"Additional properties for the selected authentication plugin.", "additionalProperties":{ "type":"string" } }, "auth":{ "type":"string", "description":"Use an authentication plugin to access the remote node." }, "eval":{ "type":"boolean", "default":false, "description":"Evaluate without executing the command." }, "schedule":{ "type":"string", "description":"Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05." }, "fra":{ "type":"string", "description":"Location of the flash recovery area." }, "grp":{ "type":"string", "description":"Autoupgrade generates a guarantee restore point (GRP) for database restoration. Default is YES." }, "ignoreGroupCheck":{ "type":"string", "description":"Skip group check except for OSDBA and OSASM during upgrade database" }, "ignoreMissingPatches":{ "type":"string", "description":"Proceed with the move/upgrade even though the specified patches, which are present in the source path or working copy, might be missing from the destination path or working copy" }, "preupg":{ "type":"string", "description":"Execute the pre-upgrade checks for the specified database." }, "revert":{ "type":"string", "description":"Revert the failed upgrade of Oracle AI Database" }, "runUtlrp":{ "type":"string", "description":"Enable or disable the recompilation of invalid objects as part of the autoupgrade process. Default is YES." }, "tgtCdbName":{ "type":"string", "description":"DB_UNIQUE_NAME of the target CDB into which the non-CDB Oracle AI Database will be plugged in." }, "tgtPdbName":{ "type":"string", "description":"New name to assign to the non-CDB source database once is plugged in as a PDB to target CDB." }, "upgTimezone":{ "type":"string", "description":"Enable or disable time zone upgrade as part of the autoupgrade. Default is YES." }, "abort":{ "type":"string", "description":"Abort the ongoing operation" }, "dbuaArgs":{ "type":"string", "description":"Quoted string containing optional arguments for DBUA" }, "destwc":{ "type":"string", "description":"Name of the destination working copy to which the database needs to be upgraded" }, "drainTimeout":{ "type":"string", "description":"Service drain timeout specified in seconds" } } }, "AddSeriesBody":{ "type":"object", "properties":{ "imageName":{ "type":"string", "description":"Name of the image." } } }, "MoveDatabaseBody":{ "type":"object", "properties":{ "dbname":{ "type":"string", "description":"Name of database (DB_UNIQUE_NAME) to be provisioned." }, "agpath":{ "type":"string", "description":"Read/write path for the persistent Oracle home path." }, "aupath":{ "type":"string", "description":"Read-only gold image path for the persistent Oracle home path." }, "cc":{ "type":"string", "description":"List of users to whom email notifications will be sent, in addition to owner of working copy." }, "ignorewcpatches":{ "type":"boolean", "default":false, "description":"Ignores if the patched working copy is missing some patches which are present in the source path or working copy." }, "notify":{ "type":"boolean", "default":false, "description":"Send email notification." }, "noDataPatch":{ "type":"boolean", "default":false, "description":"Indicates that \"datapatch\" should not be executed for databases being moved." }, "userActionData":{ "type":"string", "description":"Value to be passed to useractiondata parameter of useraction script" }, "root":{ "type":"boolean", "default":false, "description":"Use root credentials to access the remote node." }, "sudoUser":{ "type":"string", "description":"perform super user operations as sudo user name." }, "sudoPath":{ "type":"string", "description":"location of sudo binary." }, "superUserPasswd":{ "type":"string", "description":"The password for the super user account." }, "authArgs":{ "type":"object", "description":"Additional properties for the selected authentication plugin.", "additionalProperties":{ "type":"string" } }, "auth":{ "type":"string", "description":"Use an authentication plugin to access the remote node." }, "eval":{ "type":"boolean", "default":false, "description":"Evaluate without executing the command." }, "schedule":{ "type":"string", "description":"Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05." }, "abort":{ "type":"boolean", "default":false, "description":"Abort the ongoing \"move\" operation." }, "drainTimeout":{ "type":"integer", "format":"int32", "description":"Service drain timeout specified in seconds." }, "forceRolling":{ "type":"boolean", "default":false, "description":"Force the Oracle home to move in rolling mode." }, "ignoreNonRolling":{ "type":"string", "description":"Proceed with the rolling move even though the specified non-rolling patches exists in destination path or working copy. This option accepts comma separated list of non-rolling patches, for example: ,...,. This can not be used with forceRolling and nonrolling option." }, "smartMove":{ "type":"boolean", "default":false, "description":"Auto-generate the list of batches of nodes and move databases by restarting instances batch after batch." }, "skip":{ "type":"boolean", "default":false, "description":"Skip current batch of nodes and restart databases on the next batch of nodes." }, "stopoption":{ "type":"string", "description":"Stop option for database: ABORT, IMMEDIATE, NORMAL, TRANSACTIONAL, TRANSACTIONAL_LOCAL.", "enum":[ "ABORT", "IMMEDIATE", "NORMAL", "TRANSACTIONAL", "TRANSACTIONAL_LOCAL" ] }, "continue":{ "type":"boolean", "default":false, "description":"Continue restarting databases on the next batch of nodes." }, "disconnect":{ "type":"boolean", "default":false, "description":"Disconnect all sessions before stopping or relocating services." }, "keepplacement":{ "type":"boolean", "default":false, "description":"Ensure that services of administrator-managed Oracle RAC or Oracle RAC One databases are running on the same instances before and after the move operation." }, "revert":{ "type":"boolean", "default":false, "description":"Revert to source Oracle home or working copy in case of batch-move or smartmove." }, "noreplay":{ "type":"boolean", "default":false, "description":"Disable session replay during disconnection." }, "path":{ "type":"string" }, "targetNode":{ "type":"string", "description":"Node on which operation needs to be executed" }, "separate":{ "type":"boolean", "default":false, "description":"Process batches separately. Move operation pauses for user intervention before continuing with the next batch." }, "saf":{ "type":"string", "description":"Service availability factor, the minimum percentage of instances on which a service must remain running during the move." }, "client":{ "type":"string", "description":"Client cluster name" }, "oraclebase":{ "type":"string", "description":"ORACLE_BASE path for provisioning Oracle AI Database home or Oracle Grid Infrastructure home." }, "nonrolling":{ "type":"boolean", "default":false, "description":"Move the Oracle home in non-rolling mode." }, "dualInstance":{ "type":"string", "enum":[ "YES", "NO" ], "description":"Enables or disables dual instance patching, default value is NO, this option can not be used with keepplacement and nonrolling." }, "batches":{ "type":"string", "description":"Comma-delimited list of batches of nodes (where each batch is a comma-delimited list of node names enclosed in parentheses) enclosed in double quotation marks (\"\") in the format: \"(nA,nB,...),(...,nY,nZ)\"." }, "chainBatches":{ "type":"boolean", "default":false, "description":"Perform move operation on all user specified batches one after other without stopping after every batch" }, "ignoreCvuPostCheck":{ "type":"boolean", "default":false, "description":"Ignore the Oracle AI Database post-patching CVU checks" }, "ignoreCvuPreCheck":{ "type":"boolean", "default":false, "description":"Ignore the Oracle AI Database pre-patching CVU checks" }, "patchedwc":{ "type":"string", "description":"Name of the new working copy to which the database needs to be moved" }, "server":{ "type":"string", "description":"Server cluster name" }, "skipCvuPreCheck":{ "type":"boolean", "default":false, "description":"Skip the Oracle AI Database pre-patching CVU checks" }, "skipDatapatchChecks":{ "type":"boolean", "default":false, "description":"Do not execute datapatch sanity checks" }, "sourceHome":{ "type":"string", "description":"Source Oracle home path" } } }, "MoveGihomeBody":{ "type":"object", "properties":{ "imageName":{ "type":"string", "description":"Name of the image." }, "targetNode":{ "type":"string", "description":"Node on which operation needs to be executed" }, "agpath":{ "type":"string", "description":"Read/write path for the persistent Oracle home path." }, "aupath":{ "type":"string", "description":"Read-only gold image path for the persistent Oracle home path." }, "ignorewcpatches":{ "type":"boolean", "default":false, "description":"Ignores if the patched working copy is missing some patches which are present in the source path or working copy." }, "abort":{ "type":"boolean", "default":false, "description":"Abort the ongoing \"move\" operation." }, "saf":{ "type":"string", "description":"Service availability factor, the minimum percentage of instances on which a service must remain running during the move." }, "batches":{ "type":"string", "description":"Comma-delimited list of batches of nodes (where each batch is a comma-delimited list of node names enclosed in parentheses) enclosed in double quotation marks (\"\") in the format: \"(nA,nB,...),(...,nY,nZ)\"." }, "nonrolling":{ "type":"boolean", "default":false, "description":"Move the Oracle home in non-rolling mode." }, "smartMove":{ "type":"boolean", "default":false, "description":"Auto-generate the list of batches of nodes and move databases by restarting instances batch after batch." }, "firstnode":{ "type":"string", "description":"Deprecated." }, "excludedblist":{ "type":"string", "description":"Patch all databases except the specified databases." }, "cleanpids":{ "type":"boolean", "default":false, "description":"Cleans up processes during Oracle Grid Infrastructure move operation." }, "continue":{ "type":"boolean", "default":false, "description":"Continue restarting CRS stack on the next batch of nodes." }, "forceComplete":{ "type":"boolean", "default":false, "description":"force complete the ongoing move operation." }, "userActionData":{ "type":"string", "description":"Value to be passed to useractiondata parameter of useraction script." }, "drainTimeout":{ "type":"integer", "format":"int32", "description":"Service drain timeout specified in seconds." }, "nodatapatch":{ "type":"boolean", "default":false, "description":"Indicates that \"datapatch\" should not be executed for databases being moved." }, "dbhomes":{ "type":"string", "description":"Mapping of source and destination working copies in the format: \"=,...,=\"." }, "auto":{ "type":"boolean", "default":false, "description":"Automatically patch databases along with patching Grid Infrastructure." }, "dblist":{ "type":"string", "description":"Patch only the specified databases." }, "disconnect":{ "type":"boolean", "default":false, "description":"Disconnect all sessions before stopping or relocating services." }, "keepplacement":{ "type":"boolean", "default":false, "description":"Ensure that services of administrator-managed Oracle RAC or Oracle RAC One databases are running on the same instances before and after the move operation." }, "revert":{ "type":"boolean", "default":false, "description":"Revert to source Oracle home or working copy in case of batch-move or smartmove." }, "path":{ "type":"string", "description":"The absolute path for the destination working copy." }, "root":{ "type":"boolean", "default":false, "description":"Use root credentials to access the remote node." }, "sudoUser":{ "type":"string", "description":"Perform super user operations as sudo user name." }, "sudoPath":{ "type":"string", "description":"Location of sudo binary." }, "superUserPasswd":{ "type":"string", "description":"The password for the super user account." }, "authArgs":{ "type":"object", "description":"Additional properties for the selected authentication plugin.", "additionalProperties":{ "type":"string" } }, "auth":{ "type":"string", "description":"Use an authentication plugin to access the remote node." }, "eval":{ "type":"boolean", "default":false, "description":"Evaluate without executing the command." }, "schedule":{ "type":"string", "description":"Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05." }, "ignoreDBStartError":{ "type":"boolean", "default":false, "description":"Ignore any database startup errors during Oracle Grid Infrastructure patching." }, "tgip":{ "type":"boolean", "default":"false", "description":"Performs a transparent move of the Oracle Grid Infrastructure home." }, "noDriverUpdate":{ "type":"boolean", "default":"false", "description":"Skips the patching of the drivers if the patch contains a driver patch." }, "ignoreCvuPreCheck":{ "type":"boolean", "default":false, "description":"Ignore the Oracle Grid Infrastructure pre-patching CVU checks." }, "skipCvuPreCheck":{ "type":"boolean", "default":false, "description":"Skip the Oracle Grid Infrastructure pre-patching CVU checks." }, "ignoreCvuPostCheck":{ "type":"boolean", "default":false, "description":"Ignore the Oracle Grid Infrastructure post-patching CVU checks." }, "skipCvuPostCheck":{ "type":"boolean", "default":false, "description":"Skip the Oracle Grid Infrastructure post-patching CVU checks." }, "patchMgrLoc":{ "type":"string", "description":"Location of patch manager" }, "patchMgrArgs":{ "type":"string", "description":"Quoted string containing optional arguments for patch manager" }, "isoRepo":{ "type":"string", "description":"Specifies the ISO image name" }, "smtpTo":{ "type":"string", "description":"The addresses to which patchmgr notifications are sent " }, "smtpFrom":{ "type":"string", "description":"The address from which patchmgr notifications are sent" }, "liveUpdate":{ "type":"string", "enum":[ "highcvss", "allcvss", "full" ], "description":"Perform Exadata Database node live update" }, "chainBatches":{ "type":"boolean", "default":false, "description":"Perform move operation on all user specified batches one after other without stopping after every batch" }, "checkDbPatching":{ "type":"boolean", "default":false, "description":"Ensure that there is not a \"move database\" operation in progress already in the target cluster" }, "excludeDbs":{ "type":"string", "description":"Path of a file containing a comma-separated list of names of databases (DB_UNIQUE_NAME) excluded from being started by FPP" }, "noDataPatch":{ "type":"boolean", "default":false, "description":"Indicates that 'datapatch' should not be executed for databases being moved" }, "noParallel":{ "type":"string", "enum":[ "YES", "NO" ], "description":"Process the nodes in the input batch serially and exit after all nodes in the batch are done" }, "skipDatapatchChecks":{ "type":"boolean", "default":false, "description":"Do not execute datapatch sanity checks" }, "sourceHome":{ "type":"string", "description":"Source Oracle home path" }, "stopoption":{ "type":"string", "enum":[ "ABORT", "IMMEDIATE", "NORMAL", "TRANSACTIONAL", "TRANSACTIONAL_LOCAL" ], "description":"Stop option for databas" } } }, "UpdateExadataBody":{ "type":"object", "properties":{ "abort":{ "type":"boolean", "default":false, "description":"Abort the ongoing 'update exadata' operation" }, "backup":{ "type":"boolean", "default":false, "description":"Perform backup for the Exadata database servers" }, "batches":{ "type":"string", "description":"List of batches of nodes in the format: \"(Ba),...,(Bz)\"" }, "cells":{ "type":"string", "description":"Comma-separated list of cell nodes" }, "client":{ "type":"string", "description":"Client cluster name" }, "continue":{ "type":"boolean", "default":false, "description":"Continue update exadata on the next batch of nodes when using -batches option" }, "dbNodes":{ "type":"string", "description":"Comma-separated list of db nodes/empty value for auto discovery of the db nodes (active nodes in the cluster" }, "downgrade":{ "type":"boolean", "default":false, "description":"Downgrade the InfiniBand Network Fabric switches" }, "drainTimeout":{ "type":"integer", "format":"int32", "description":"Service drain timeout specified in seconds." }, "eval":{ "type":"boolean", "default":false, "description":"Evaluate without executing the command" }, "fromNode":{ "type":"string", "description":"Node name from where the patchmgr is to be run" }, "ibSwitches":{ "type":"string", "description":"Comma-separated list of switch nodes" }, "imageName":{ "type":"string", "description":"Name of the exadata image" }, "isoRepo":{ "type":"string", "description":"Specifies the ISO image name" }, "patchMgrArgs":{ "type":"string", "description":"Quoted string containing optional arguments for patch manager" }, "patchMgrDrivingSystem":{ "type":"string", "description":"Patch manager driving system node" }, "patchMgrLoc":{ "type":"string", "description":"Location of patch manager" }, "path":{ "type":"string", "description":"The absolute path for deploying image for upgrading/downgrading IB switches in VM environment" }, "roceSwitches":{ "type":"string", "description":"Comma-separated list of ROCE switches or file containing the list of RoCE switches, one siwtch name in each line" }, "rollback":{ "type":"boolean", "default":false, "description":"Rolls back the patch" }, "schedule":{ "type":"string", "description":"Preferred time to execute the operation, in ISO-8601 format.", "example":"2016-12-21T19:13:17+05" }, "server":{ "type":"boolean", "default":false, "description":"Patch Exadata from FPP server" }, "smtpFrom":{ "type":"string", "description":"The address from which patchmgr notifications are sent" }, "smtpTo":{ "type":"string", "description":"The addresses to which patchmgr notifications are sent " }, "user":{ "type":"string", "description":"Name of the user for whom the software home is being provisioned" }, "liveupdate":{ "type":"string", "enum":[ "HIGHCVSS", "ALLCVSS", "FULL" ], "description":"Perform Exadata Database node live update" } } }, "DeployImageBody":{ "type":"object", "properties":{ "imageName":{ "type":"string", "description":"Name of the image" }, "client":{ "type":"string", "description":"Client cluster name" }, "path":{ "type":"string", "description":"Absolute path location of the software home to be imported (For database images, this will be the ORACLE_HOME)" }, "targetNode":{ "type":"string", "description":"Node on which operation needs to be executed" }, "root":{ "type":"boolean", "default":false, "description":"Use root credentials to access the remote node" }, "cred":{ "type":"string", "description":"Credential name to associate the user/password credentials to access a remote node" }, "authArgs":{ "type":"object", "description":"Additional properties for the selected authentication plugin", "additionalProperties":{ "type":"string" } }, "auth":{ "type":"string", "description":"Use an authentication plugin to access the remote node" }, "skipcopy":{ "type":"string", "description":"Skips copying the content" } } }, "InsertImageSeriesBody":{ "type":"object", "properties":{ "before":{ "type":"string", "description":"Name of the image before which new image will inserted." } } }, "DeleteSeriesBody":{ "type":"object", "properties":{ "force":{ "type":"boolean", "default":false, "description":"To remove forcibily." } } }, "SubscribeSeriesBody":{ "type":"object", "properties":{ "client":{ "type":"string", "description":"Client cluster name" } } }, "DeleteDatabaseBody":{ "type":"object", "properties":{ "cred":{ "type":"string", "description":"Credential name to associate the user/password credentials to access a remote node" }, "auth":{ "type":"string", "description":"Use an authentication plugin to access the remote node" }, "authArgs":{ "type":"object", "description":"Additional properties for the selected authentication plugin.", "additionalProperties":{ "type":"string" } }, "root":{ "type":"boolean", "default":false, "description":"Use root credentials to access the remote node." }, "sudoUser":{ "type":"string", "description":"perform super user operations as sudo user name." }, "sudoPath":{ "type":"string", "description":"location of sudo binary." }, "superUserPasswd":{ "type":"string", "description":"The password for the super user account." }, "targetNode":{ "type":"string", "description":"Name of a node in a remote cluster with no Rapid Home Provisioning Client." }, "userActionData":{ "type":"string", "description":"Value to be passed to useractiondata parameter of useraction script" }, "schedule":{ "type":"string", "description":"Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05." } } }, "ModifyJobBody":{ "type":"object", "properties":{ "schedule":{ "type":"string", "description":"Preferred time to execute the operation, in ISO-8601 format.", "example":"2016-12-21T19:13:17+05" } } }, "DeleteJobsBody":{ "type":"object", "properties":{ "jobsIds":{ "type":"string", "description":"Comma separated list of one or more jobs to be deleted" }, "status":{ "type":"string", "description":"Job status for which to get the jobs.", "enum":[ "SCHEDULED", "UNKNOWN", "EXECUTING", "PAUSED", "ABORTED", "TERMINATED", "FAILED", "SUCCEEDED" ] }, "user":{ "type":"string", "description":"User name attribute of the jobs to be deleted" }, "client":{ "type":"string", "description":"Client name attribute of the jobs to be deleted" } } }, "errorResource":{ "type":"object", "properties":{ "status":{ "type":"integer", "description":"HTTP status code." }, "type":{ "type":"string", "description":"Link to HTTP error code page." }, "title":{ "type":"string", "description":"Summary error message." }, "instance":{ "type":"string", "description":"URI to the link that provides more detail about the error." }, "errorDetails":{ "type":"array", "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.", "items":{ "$ref":"#/definitions/errorResource" } }, "errorPath":{ "type":"string", "description":"XPath or JSON path to indicate where the error occurs." }, "errorCode":{ "type":"string", "description":"Application specific error code, related to the error message shown at tittle." } } }, "jobResource":{ "type":"object", "properties":{ "jobId":{ "type":"string" }, "status":{ "type":"string", "enum":[ "SCHEDULED", "UNKNOWN", "EXECUTING", "PAUSED", "ABORTED", "TERMINATED", "FAILED", "SUCCEEDED" ] }, "operation":{ "type":"string" }, "output":{ "$ref":"#/definitions/jobOutputResource" }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/singleResourceLinks" } } } }, "jobOutputResource":{ "type":"object", "properties":{ "output":{ "type":"string" }, "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "hasMore":{ "type":"boolean", "default":false }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/collectionResourceLinks" } } } }, "workingcopyResource":{ "type":"object", "properties":{ "accessControl":{ "type":"array", "items":{ "type":"string" } }, "additionalBugFixesNotInImage":{ "type":"string" }, "additionalPatchesComparedToImage":{ "type":"string" }, "allPatchesAvailableInHome":{ "type":"string" }, "clusterClient":{ "type":"string" }, "clusterClass":{ "type":"string" }, "clusterName":{ "type":"string" }, "clusterNodes":{ "type":"array", "items":{ "type":"string" } }, "clusterType":{ "type":"string" }, "complete":{ "type":"boolean", "default":false }, "configuredDatabases":{ "type":"array", "items":{ "type":"string" } }, "goldImagePath":{ "type":"string" }, "groupsConfiguredInWorkingCopy":{ "type":"array", "items":{ "type":"string" } }, "imageName":{ "type":"string" }, "imageTypeName":{ "type":"string" }, "oracleBase":{ "type":"string" }, "owner":{ "type":"string" }, "softwareHomePath":{ "type":"string" }, "storageType":{ "type":"string" }, "workingCopyId":{ "type":"string" }, "workPath":{ "type":"string" }, "softwareOnly":{ "type":"boolean", "default":false }, "clusterNameAlias":{ "type":"string" }, "clusterMode":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/singleResourceLinks" } } } }, "imageResource":{ "type":"object", "properties":{ "imageId":{ "type":"string" }, "clientName":{ "type":"string" }, "roles":{ "type":"array", "items":{ "type":"string" } }, "patches":{ "type":"array", "items":{ "type":"string" } }, "parentImage":{ "type":"string" }, "homePath":{ "type":"string" }, "imageState":{ "type":"string" }, "imageType":{ "type":"string" }, "imageSize":{ "type":"integer" }, "version":{ "type":"string" }, "owner":{ "type":"string" }, "complete":{ "type":"boolean" }, "platform":{ "type":"string" }, "containsNonRollingPatch":{ "type":"boolean" }, "groupsConfigured":{ "type":"string" }, "templateWithDataFiles":{ "type":"array", "items":{ "type":"string" } }, "templateWithoutDataFiles":{ "type":"array", "items":{ "type":"string" } }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/singleResourceLinks" } } } }, "seriesResource":{ "type":"object", "properties":{ "seriesId":{ "type":"string" }, "imageNames":{ "type":"array", "items":{ "type":"string" } }, "subscribedUsers":{ "type":"array", "items":{ "type":"string" } }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/singleResourceLinks" } } } }, "arrayOfItems":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/definitions/singleResource" } } } }, "singleResource":{ "type":"object", "properties":{ "resourceId":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/singleResourceLinks" } } } }, "singleResourceLinks":{ "type":"object", "properties":{ "rel":{ "type":"string", "description":"Specify the type of relationship the link has with the described resource.", "enum":[ "self", "collection", "up", "describedBy" ] }, "href":{ "type":"string", "description":"The referenced hyperlink element provided in an absolute format." } } }, "collectionResourceLinks":{ "type":"object", "properties":{ "rel":{ "type":"string", "description":"Specify the type of relationship the link has with the described resource.", "enum":[ "next", "prev", "first", "last" ] }, "href":{ "type":"string", "description":"The referenced hyperlink element provided in an absolute format with the correct URL parameters." } } } } }