REST API for Fleet Patching and Provisioning

Upgrade Grid Infrastructure Software home

put

/rhp-restapi/rhp/workingcopies/{workingCopyId}/gihome/{destWcId}

Upgrades 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 : UpgradeGihomeBody

Type: object

Show Source

abort: boolean

Default Value: false

Abort the ongoing operation.
auth: string

Use an authentication plugin to access the remote node.
authArgs: object authArgs

Additional Properties Allowed: additionalProperties

Additional properties for the selected authentication plugin.
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)".
continue: boolean

Default Value: false

Continue upgrading the next batch of nodes.
destwc: string

Name of the destination working copy to which the Oracle Grid Infrastructure needs to be upgraded.
eval: boolean

Default Value: false

Evaluate without executing the command.
gimrwc: string

Name of the destination working copy to which the Grid Infrastructure Management Repository database needs to be upgraded.
ignoreprereq: boolean

Default Value: false

To ignore the CVU pre-requisite checks.
imageName: string

Image name from the configured images.
path: string

The absolute path for the destination working copy.
revert: boolean

Default Value: false

Downgrade after a failed upgrade of Oracle Grid Infrastructure.
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.
sourceHome: string

Source Oracle home path.
sourcewc: string

Name of the source working copy from which the Oracle Grid Infrastructure needs to be upgraded.
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

Name of a node in a remote cluster with no Rapid Home Provisioning Client.

{
    "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."
        }
    }
}

Nested Schema : authArgs

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "description":"Additional properties for the selected authentication plugin.",
    "additionalProperties":{
        "type":"string"
    }
}

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: object

Show Source

jobId: string
links: array links
operation: string
output: object jobOutputResource
status: string

Allowed Values: [ "SCHEDULED", "UNKNOWN", "EXECUTING", "PAUSED", "ABORTED", "TERMINATED", "FAILED", "SUCCEEDED" ]

{
    "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"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object singleResourceLinks

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/singleResourceLinks"
    }
}

Nested Schema : jobOutputResource

Type: object

Show Source

hasMore: boolean

Default Value: false
limit: integer
links: array links
offset: integer
output: string

{
    "type":"object",
    "properties":{
        "output":{
            "type":"string"
        },
        "limit":{
            "type":"integer"
        },
        "offset":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/collectionResourceLinks"
            }
        }
    }
}

Nested Schema : singleResourceLinks

Type: object

Show Source

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.

{
    "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."
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object collectionResourceLinks

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/collectionResourceLinks"
    }
}

Nested Schema : collectionResourceLinks

Type: object

Show Source

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.

{
    "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."
        }
    }
}

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: object

Show Source

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.

{
    "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."
        }
    }
}

Nested Schema : errorDetails

Type: array

If multiple errors are reported they can be organized in a hierarchical structure in this array.

Show Source

Array of: object errorResource

{
    "type":"array",
    "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
    "items":{
        "$ref":"#/definitions/errorResource"
    }
}

Default Response

Unexpected error. A JSON object containing error details of the issue while executing the operation.

Root Schema : errorResource

Type: object

Show Source

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.

{
    "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."
        }
    }
}

Nested Schema : errorDetails

Type: array

If multiple errors are reported they can be organized in a hierarchical structure in this array.

Show Source

Array of: object errorResource

{
    "type":"array",
    "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
    "items":{
        "$ref":"#/definitions/errorResource"
    }
}

Examples

The following example shows how to upgrade the Oracle Grid Infrastructure software home from a source working copy to the destination working copy by submitting a PUT request on the REST resource using cURL.

curl -u restUser -X PUT -H "Content-Type: application/json" -d "@body.json" "https://RHP_node_name:8894/rhp-restapi/rhp/workingcopies/GI_WCopy122/gihome/GI_WCopy183"

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)

{
    "ignoreprereq" : true
}

Response Body

{
     "links": [{
         "uri": "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1",
         "rel": "self"
      }],
     "jobId": "1",
     "output": {  }
}