Create working copy
post
/rhp-restapi/rhp/workingcopies
Creates a new working copy using an existing gold image
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 : AddWorkingCopyBody
Type:
Show Source
object
-
agpath:
string
Read/write path for the persistent Oracle home path.
-
asmClientData:
string
File that contains the ASM client data.
-
aupath:
string
Read-only gold image path for the persistent Oracle home path.
-
auth:
string
Use an authentication plugin to access the remote node.
-
authArgs:
object authArgs
Additional Properties Allowed: additionalPropertiesAdditional properties for the selected authentication plugin.
-
cardinality:
string
Cardinality for new server pool.
-
cdb:
boolean
Default Value:
false
To create database as container database. -
client:
string
Client cluster name
-
clusterManifest:
string
Location of Cluster Manifest File.
-
clusterNameAlias:
string
Cluster name alias
-
clusterNodes:
string
Comma-separated list of node information on which Oracle Clusterware will be provisioned.
-
datafileDestination:
string
Data file destination location or ASM disk group name.
-
dbname:
string
Name of database (DB_UNIQUE_NAME) to be provisioned.
-
dbTemplate:
string
Absolute file path for the template file or relative path to the image home directory on Rapid Home Provisioning Server.
-
dbType:
string
Allowed Values:
[ "RAC", "RACONENODE", "SINGLE" ]
Type of database: Oracle RAC One Node or Oracle RAC or Single Instance. -
edition:
string
Allowed Values:
[ "ENTERPRISE", "STANDARD" ]
Type of the Oracle Home to be provisioned: 'ENTERPRISE' or 'STANDARD'. -
eval:
boolean
Default Value:
false
Evaluate without executing the command. -
fixup:
boolean
Default Value:
false
Execute fixup script. Valid only for Grid Infrastructure provisioning. -
gimr:
boolean
Default Value:
false
To perform the operations required for a Grid Infrastructure Management Repository (GIMR) database -
gnsClientData:
string
File that contains the GNS client data.
-
groups:
string
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.
-
ignorePrereq:
boolean
Default Value:
false
To ignore the CVU pre-requisite checks. -
imageName:
string
Name of the image.
-
inventory:
string
Location of Oracle Inventory.
-
localmount:
string
Provision from locally mounted compressed image file.
-
location:
string
Location of the compressed image file on the target.
-
newpool:
string
Server pool name for pool to be created.
-
newpqpool:
string
PQ pool name for pool to be created.
-
node:
string
Comma-separated list of nodes on which database will be created
-
numberOfPDBs:
integer(int32)
Number of PDBs to be created.
-
oracleBase:
string
ORACLE_BASE path for provisioning Oracle database home or Oracle Grid Infrastructure home.
-
path:
string
Absolute path location of the software home to be imported (For database images, this will be the ORACLE_HOME).
-
pdbname:
string
The pdbname prefix if one or more PDBs need to be created.
-
pqcardinality:
string
Cardinality for new PQ pool.
-
pqpool:
string
Existing PQ pool name.
-
readOnly:
boolean
Add database workingcopy as a read-only home
-
responsefile:
string
Response file to be used to perform Oracle Grid Infrastructure provisioning.
-
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.
-
serverpool:
string
Comma-separated list of existing server pool names.
-
setupSSH:
boolean
Default Value:
false
sets up passwordless SSH user equivalence on the remote nodes for the provisioning user. -
softwareOnly:
string
Default Value:
false
Perform Grid Infrastructure software-only provisioning. -
storagetype:
string
Allowed Values:
[ "LOCAL", "RHP_MANAGED" ]
Type of storage for the home. -
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
-
transferAsZip:
boolean
Default Value:
false
Transfer the software image as a zip file to remote node for provisioning. -
user:
string
Name of the user for whom the software home is being provisioned.
-
workingcopy:
string
Name of the working copy to be created.
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 create a working copy using an existing gold image specified on the request body body.json
, by submitting a POST request on the REST resource using cURL.
curlcurl -u restUser -X POST -H "Content-Type: application/json" -d "@body.json" "https://RHP_node_name:8894/rhp-restapi/rhp/workingcopies"
HTTP Status Code and Response Headers
The following shows an example of the response header.
HTTP/1.1 202
Location: https://RHP_node_name: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 GMT
Request Body (body.json)
{
"path" : "/oracle/database/home",
"oracleBase" : "/oracle/database/base",
"storagetype" : "LOCAL",
"imageName" : "DB_Image1",
"workingcopy" : "DB_Wcopy1"
}
Response Body
{
"links": [{
"uri": "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1",
"rel": "self"
}],
"jobId": "1",
"output": { }
}