Schedules an import image operation
post
/rhp-restapi/rhp/images
Create a gold image from the Software home specified in the body of this request, can be of Oracle Database, Grid Infrastructure or any other Software home.
Request
Supported Media Types
- application/json
Header Parameters
-
Authorization(required): string
Base64 encoding of the user name and password of the user making the request. For more information, see Authentication for Fleet Patching and Provisioning.
Root Schema : ImportImageBody
Type:
Show Source
object
-
auth:
string
Use an authentication plugin to access the remote node.
-
authArgs:
object authArgs
Additional Properties Allowed: additionalPropertiesAdditional properties for the selected authentication plugin.
-
cc:
string
List of users to whom email notifications will be sent, in addition to owner of working copy.
-
client:
string
Client cluster name.
-
host:
string
GIAAS host name.
-
imageName:
string
Name of the image.
-
imageType:
string
The software type. ("ORACLEDBSOFTWARE" (default) for Oracle 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.)
-
location:
string
Location of the compressed image file on the target
-
notify:
boolean
Default Value:
false
Send email notification. -
patches:
string
Comma separated bug numbers or NFS downloaded zip location or combination of both.
-
path:
string
Absolute path location of the software home to be imported (For database images, this will be the ORACLE_HOME).
-
pathOwner:
string
User with read access to files under the specified path.
-
port:
string
Port number in the range of 1024-65536.
-
psu:
string
Bug number or downloaded zip location or released PSU/BP.
-
root:
boolean
Default Value:
false
Use root credentials to access the remote node. -
schedule:
string
Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05.
-
state:
string
Allowed Values:
[ "TESTABLE", "RESTRICTED", "PUBLISHED" ]
State name. -
sudoPath:
string
location of sudo binary.
-
sudoUser:
string
perform super user operations as sudo user name.
-
superUserPasswd:
string
The password for the super user account.
-
targetNode:
string
Node on which operation needs to be executed.
-
userActionData:
string
Value to be passed to useractiondata parameter of useraction script.
-
version:
string
Oracle database version for GIAAS, ODA patchbundle version for ODAPATCHSOFTWARE.
-
zip:
string
Absolute path of the compressed software home to be imported (a ZIP or TAR file).
Nested Schema : authArgs
Type:
object
Additional Properties Allowed
Show Source
Additional properties for the selected authentication plugin.
Security
-
basicAuthentication: basic
Type:
basic
Response
Supported Media Types
- application/json
- text/html
202 Response
Accepted. A JSON object containing job resource details of the accepted operation to obtain status and output of the progress.
Headers
-
Location: string
URL to the job that will execute the operation
Root Schema : jobResource
Type:
Show Source
object
-
jobId:
string
-
links:
array links
-
operation:
string
-
output:
object jobOutputResource
-
status:
string
Allowed Values:
[ "SCHEDULED", "UNKNOWN", "EXECUTING", "PAUSED", "ABORTED", "TERMINATED", "FAILED", "SUCCEEDED" ]
Nested Schema : jobOutputResource
Type:
Show Source
object
-
hasMore:
boolean
Default Value:
false
-
limit:
integer
-
links:
array links
-
offset:
integer
-
output:
string
Nested Schema : singleResourceLinks
Type:
Show Source
object
-
href:
string
The referenced hyperlink element provided in an absolute format.
-
rel:
string
Allowed Values:
[ "self", "collection", "up", "describedBy" ]
Specify the type of relationship the link has with the described resource.
Nested Schema : collectionResourceLinks
Type:
Show Source
object
-
href:
string
The referenced hyperlink element provided in an absolute format with the correct URL parameters.
-
rel:
string
Allowed Values:
[ "next", "prev", "first", "last" ]
Specify the type of relationship the link has with the described resource.
400 Response
Bad Request. A JSON object containing error details of the issue found while parsing a parameter value or name.
Root Schema : errorResource
Type:
Show Source
object
-
errorCode:
string
Application specific error code, related to the error message shown at tittle.
-
errorDetails:
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath:
string
XPath or JSON path to indicate where the error occurs.
-
instance:
string
URI to the link that provides more detail about the error.
-
status:
integer
HTTP status code.
-
title:
string
Summary error message.
-
type:
string
Link to HTTP error code page.
Nested Schema : errorDetails
Type:
array
If multiple errors are reported they can be organized in a hierarchical structure in this array.
Show Source
Default Response
Unexpected error. A JSON object containing error details of the issue while executing the operation.
Root Schema : errorResource
Type:
Show Source
object
-
errorCode:
string
Application specific error code, related to the error message shown at tittle.
-
errorDetails:
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath:
string
XPath or JSON path to indicate where the error occurs.
-
instance:
string
URI to the link that provides more detail about the error.
-
status:
integer
HTTP status code.
-
title:
string
Summary error message.
-
type:
string
Link to HTTP error code page.
Nested Schema : errorDetails
Type:
array
If multiple errors are reported they can be organized in a hierarchical structure in this array.
Show Source
Examples
The following example shows how to import a gold image from a software home in the specified path
in the request body body.json
, by submitting a POST request on the REST resource using cURL.
curl -u restUser -X POST -H "Content-Type: application/json" -d "@body.json" "https://RHP_node_name:8894/rhp-restapi/rhp/images"
HTTP Status Code and Response Headers
The following shows an example of the response header.
HTTP/1.1 202
Location: https://rhpNodeName:8894/rhp-restapi/rhp/jobs/1
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET,PUT,POST,DELETE,PATCH,OPTIONS
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Content-Length, Authorization
Connection: keep-alive
Content-Type: application/json
Content-Length: 159
Date: Tue, 19 Jun 2018 14:03:23 GM
Request Body (body.json)
{
"imageName": "DB_Image1",
"path": "/oracle/dbwc1"
}
Response Body
{
"links": [{
"uri": "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1",
"rel": "self"
}],
"jobId": "1",
"output": { }
}