Patch Grid Infrastructure Software home
patch
/rhp-restapi/rhp/workingcopies/{workingCopyId}/gihome/{destWcId}
Moves the Oracle Grid Infrastructure from the source working copy to the destination working copy.
Request
Supported Media Types
- application/json
Path Parameters
-
destWcId(required): string
Name of the destination working copy to which the Oracle Software needs to be moved
-
workingCopyId(required): string
Name of the working copy.
Root Schema : MoveGihomeBody
Type:
Show Source
object
-
abort:
boolean
Default Value:
false
Abort the ongoing "move" operation. -
agpath:
string
Read/write path for the persistent Oracle home path.
-
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.
-
auto:
boolean
Default Value:
false
Automatically patch databases along with patching Grid Infrastructure. -
batches:
string
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:
boolean
Default Value:
false
Perform move operation on all user specified batches one after other without stopping after every batch -
checkDbPatching:
boolean
Default Value:
false
Ensure that there is not a "move database" operation in progress already in the target cluster -
cleanpids:
boolean
Default Value:
false
Cleans up processes during Oracle Grid Infrastructure move operation. -
continue:
boolean
Default Value:
false
Continue restarting CRS stack on the next batch of nodes. -
dbhomes:
string
Mapping of source and destination working copies in the format: "
= ,..., = ". -
dblist:
string
Patch only the specified databases.
-
disconnect:
boolean
Default Value:
false
Disconnect all sessions before stopping or relocating services. -
drainTimeout:
integer(int32)
Service drain timeout specified in seconds.
-
eval:
boolean
Default Value:
false
Evaluate without executing the command. -
excludedblist:
string
Patch all databases except the specified databases.
-
excludeDbs:
string
Path of a file containing a comma-separated list of names of databases (DB_UNIQUE_NAME) excluded from being started by FPP
-
firstnode:
string
Deprecated.
-
forceComplete:
boolean
Default Value:
false
force complete the ongoing move operation. -
ignoreCvuPostCheck:
boolean
Default Value:
false
Ignore the Oracle Grid Infrastructure post-patching CVU checks. -
ignoreCvuPreCheck:
boolean
Default Value:
false
Ignore the Oracle Grid Infrastructure pre-patching CVU checks. -
ignoreDBStartError:
boolean
Default Value:
false
Ignore any database startup errors during Oracle Grid Infrastructure patching. -
ignorewcpatches:
boolean
Default Value:
false
Ignores if the patched working copy is missing some patches which are present in the source path or working copy. -
imageName:
string
Name of the image.
-
isoRepo:
string
Specifies the ISO image name
-
keepplacement:
boolean
Default Value:
false
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. -
liveUpdate:
string
Allowed Values:
[ "highcvss", "allcvss", "full" ]
Perform Exadata Database node live update -
nodatapatch:
boolean
Default Value:
false
Indicates that "datapatch" should not be executed for databases being moved. -
noDataPatch:
boolean
Default Value:
false
Indicates that 'datapatch' should not be executed for databases being moved -
noDriverUpdate:
boolean
Default Value:
false
Skips the patching of the drivers if the patch contains a driver patch. -
nonrolling:
boolean
Default Value:
false
Move the Oracle home in non-rolling mode. -
noParallel:
string
Allowed Values:
[ "YES", "NO" ]
Process the nodes in the input batch serially and exit after all nodes in the batch are done -
patchMgrArgs:
string
Quoted string containing optional arguments for patch manager
-
patchMgrLoc:
string
Location of patch manager
-
path:
string
The absolute path for the destination working copy.
-
revert:
boolean
Default Value:
false
Revert to source Oracle home or working copy in case of batch-move or smartmove. -
root:
boolean
Default Value:
false
Use root credentials to access the remote node. -
saf:
string
Service availability factor, the minimum percentage of instances on which a service must remain running during the move.
-
schedule:
string
Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05.
-
skipCvuPostCheck:
boolean
Default Value:
false
Skip the Oracle Grid Infrastructure post-patching CVU checks. -
skipCvuPreCheck:
boolean
Default Value:
false
Skip the Oracle Grid Infrastructure pre-patching CVU checks. -
skipDatapatchChecks:
boolean
Default Value:
false
Do not execute datapatch sanity checks -
smartMove:
boolean
Default Value:
false
Auto-generate the list of batches of nodes and move databases by restarting instances batch after batch. -
smtpFrom:
string
The address from which patchmgr notifications are sent
-
smtpTo:
string
The addresses to which patchmgr notifications are sent
-
sourceHome:
string
Source Oracle home path
-
stopoption:
string
Allowed Values:
[ "ABORT", "IMMEDIATE", "NORMAL", "TRANSACTIONAL", "TRANSACTIONAL_LOCAL" ]
Stop option for databas -
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
-
tgip:
boolean
Default Value:
false
Performs a transparent move of the Oracle Grid Infrastructure home. -
userActionData:
string
Value to be passed to useractiondata parameter of useraction script.
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 patch an Oracle Grid Infrastructure software home from a working copy named GI_WCopy121
to the existing destination working copy named GI_WCopy1212
by submitting a PATCH request on the REST resource using cURL.
curl -u restUser -X PATCH -H "Content-Type: application/json" -d "@body.json "https://RHP_node_name:8894/rhp-restapi/rhp/workingcopies/GI_WCopy121/gihome/GI_WCopy1212"
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)
{
"nonrolling" : true
}
Response Body
{
"links": [{
"uri": "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1",
"rel": "self"
}],
"jobId": "1",
"output": { }
}