Patch Grid Infrastructure Software home
patch
/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: string
Name of the destination working copy to which the Oracle Software needs to be moved
-
workingCopyId: string
Name of the working copy.
Root Schema : MoveGihomeBody
Type:
Show Source
object
-
abort(optional):
boolean
Default Value:
false
Abort the ongoing "move" operation. -
agpath(optional):
string
Read/write path for the persistent Oracle home path.
-
aupath(optional):
string
Read-only gold image path for the persistent Oracle home path.
-
auth(optional):
string
Use an authentication plugin to access the remote node.
-
authArgs(optional):
object authArgs
Additional Properties Allowed: additionalPropertiesAdditional properties for the selected authentication plugin.
-
auto(optional):
boolean
Default Value:
false
Automatically patch databases along with patching Grid Infrastructure. -
batches(optional):
string
List of batches of nodes in the format: "(Ba),...,(Bz)".
-
cleanpids(optional):
boolean
Default Value:
false
Cleans up processes during Oracle Grid Infrastructure move operation. -
continue(optional):
boolean
Default Value:
false
Continue restarting CRS stack on the next batch of nodes. -
dbhomes(optional):
string
Mapping of source and destination working copies in the format: "
= ,..., = ". -
dblist(optional):
string
Patch only the specified databases.
-
disconnect(optional):
boolean
Default Value:
false
Disconnect all sessions before stopping or relocating services. -
draintimeout(optional):
integer(int32)
Service drain timeout specified in seconds.
-
eval(optional):
boolean
Default Value:
false
Evaluate without executing the command. -
excludedblist(optional):
string
Patch all databases except the specified databases.
-
firstnode(optional):
string
Deprecated.
-
ignoreDBStartError(optional):
boolean
Default Value:
false
Ignore any database startup errors during Oracle Grid Infrastructure patching. -
ignorewcpatches(optional):
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(optional):
string
Name of the image.
-
keepplacement(optional):
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. -
nodatapatch(optional):
boolean
Default Value:
false
Indicates that "datapatch" should not be executed for databases being moved. -
nonrolling(optional):
boolean
Default Value:
false
Move the Oracle home in non-rolling mode. -
path(optional):
string
The absolute path for the destination working copy.
-
revert(optional):
boolean
Default Value:
false
Revert to source Oracle home or working copy in case of batch-move or smartmove. -
root(optional):
boolean
Default Value:
false
Use root credentials to access the remote node. -
saf(optional):
string
Service availability factor, the minimum percentage of instances on which a service must remain running during the move.
-
schedule(optional):
string
Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05.
-
smartmove(optional):
boolean
Default Value:
false
Auto-generate the list of batches of nodes and move databases by restarting instances batch after batch. -
sourceHome(optional):
string
Source Oracle home path
-
stopoption(optional):
string
Allowed Values:
[ "ABORT", "IMMEDIATE", "NORMAL", "TRANSACTIONAL", "TRANSACTIONAL_LOCAL" ]
Stop option for database: ABORT, IMMEDIATE, NORMAL, TRANSACTIONAL, TRANSACTIONAL_LOCAL. -
sudoPath(optional):
string
Location of sudo binary.
-
sudoUser(optional):
string
Perform super user operations as sudo user name.
-
superUserPasswd(optional):
string
The password for the super user account.
-
targetNode(optional):
string
Node on which operation needs to be executed
-
userActionData(optional):
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
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
Nested Schema : singleResourceLinks
Type:
Show Source
object
-
href(optional):
string
The referenced hyperlink element provided in an absolute format.
-
rel(optional):
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(optional):
string
The referenced hyperlink element provided in an absolute format with the correct URL parameters.
-
rel(optional):
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(optional):
string
Application specific error code, related to the error message shown at title.
-
errorDetails(optional):
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
status(optional):
integer
HTTP status code.
-
title(optional):
string
Summary error message.
-
type(optional):
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(optional):
string
Application specific error code, related to the error message shown at title.
-
errorDetails(optional):
array errorDetails
If multiple errors are reported they can be organized in a hierarchical structure in this array.
-
errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
instance(optional):
string
URI to the link that provides more detail about the error.
-
status(optional):
integer
HTTP status code.
-
title(optional):
string
Summary error message.
-
type(optional):
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": { }
}