Jump to

• Request
• Response

Patch Exadata system.

post

/rhp-restapi/rhp/exadatas/actions/update

Updates software for Oracle Exadata Database Machine

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.

Body ()

Root Schema : UpdateExadataBody

Type: object

Show Source

• abort: boolean
  Default Value: false

  Abort the ongoing 'update exadata' operation
• backup: boolean
  Default Value: false

  Perform backup for the Exadata database servers
• batches: string
  List of batches of nodes in the format: "(Ba),...,(Bz)"
• cells: string
  Comma-separated list of cell nodes
• client: string
  Client cluster name
• continue: boolean
  Default Value: false

  Continue update exadata on the next batch of nodes when using -batches option
• dbNodes: string
  Comma-separated list of db nodes/empty value for auto discovery of the db nodes (active nodes in the cluster
• downgrade: boolean
  Default Value: false

  Downgrade the InfiniBand Network Fabric switches
• drainTimeout: integer(int32)
  Service drain timeout specified in seconds.
• eval: boolean
  Default Value: false

  Evaluate without executing the command
• fromNode: string
  Node name from where the patchmgr is to be run
• ibSwitches: string
  Comma-separated list of switch nodes
• imageName: string
  Name of the exadata image
• isoRepo: string
  Specifies the ISO image name
• liveupdate: string
  Allowed Values: [ "HIGHCVSS", "ALLCVSS", "FULL" ]

  Perform Exadata Database node live update
• patchMgrArgs: string
  Quoted string containing optional arguments for patch manager
• patchMgrDrivingSystem: string
  Patch manager driving system node
• patchMgrLoc: string
  Location of patch manager
• path: string
  The absolute path for deploying image for upgrading/downgrading IB switches in VM environment
• roceSwitches: string
  Comma-separated list of ROCE switches or file containing the list of RoCE switches, one siwtch name in each line
• rollback: boolean
  Default Value: false

  Rolls back the patch
• schedule: string
  Preferred time to execute the operation, in ISO-8601 format.

  Example: 2016-12-21T19:13:17+05
• server: boolean
  Default Value: false

  Patch Exadata from FPP server
• smtpFrom: string
  The address from which patchmgr notifications are sent
• smtpTo: string
  The addresses to which patchmgr notifications are sent
• user: string
  Name of the user for whom the software home is being provisioned

{
    "type":"object",
    "properties":{
        "abort":{
            "type":"boolean",
            "default":false,
            "description":"Abort the ongoing 'update exadata' operation"
        },
        "backup":{
            "type":"boolean",
            "default":false,
            "description":"Perform backup for the Exadata database servers"
        },
        "batches":{
            "type":"string",
            "description":"List of batches of nodes in the format: \"(Ba),...,(Bz)\""
        },
        "cells":{
            "type":"string",
            "description":"Comma-separated list of cell nodes"
        },
        "client":{
            "type":"string",
            "description":"Client cluster name"
        },
        "continue":{
            "type":"boolean",
            "default":false,
            "description":"Continue update exadata on the next batch of nodes when using -batches option"
        },
        "dbNodes":{
            "type":"string",
            "description":"Comma-separated list of db nodes/empty value for auto discovery of the db nodes (active nodes in the cluster"
        },
        "downgrade":{
            "type":"boolean",
            "default":false,
            "description":"Downgrade the InfiniBand Network Fabric switches"
        },
        "drainTimeout":{
            "type":"integer",
            "format":"int32",
            "description":"Service drain timeout specified in seconds."
        },
        "eval":{
            "type":"boolean",
            "default":false,
            "description":"Evaluate without executing the command"
        },
        "fromNode":{
            "type":"string",
            "description":"Node name from where the patchmgr is to be run"
        },
        "ibSwitches":{
            "type":"string",
            "description":"Comma-separated list of switch nodes"
        },
        "imageName":{
            "type":"string",
            "description":"Name of the exadata image"
        },
        "isoRepo":{
            "type":"string",
            "description":"Specifies the ISO image name"
        },
        "patchMgrArgs":{
            "type":"string",
            "description":"Quoted string containing optional arguments for patch manager"
        },
        "patchMgrDrivingSystem":{
            "type":"string",
            "description":"Patch manager driving system node"
        },
        "patchMgrLoc":{
            "type":"string",
            "description":"Location of patch manager"
        },
        "path":{
            "type":"string",
            "description":"The absolute path for deploying image for upgrading/downgrading IB switches in VM environment"
        },
        "roceSwitches":{
            "type":"string",
            "description":"Comma-separated list of ROCE switches or file containing the list of RoCE switches, one siwtch name in each line"
        },
        "rollback":{
            "type":"boolean",
            "default":false,
            "description":"Rolls back the patch"
        },
        "schedule":{
            "type":"string",
            "description":"Preferred time to execute the operation, in ISO-8601 format.",
            "example":"2016-12-21T19:13:17+05"
        },
        "server":{
            "type":"boolean",
            "default":false,
            "description":"Patch Exadata from FPP server"
        },
        "smtpFrom":{
            "type":"string",
            "description":"The address from which patchmgr notifications are sent"
        },
        "smtpTo":{
            "type":"string",
            "description":"The addresses to which patchmgr notifications are sent <address1 address2 ..>"
        },
        "user":{
            "type":"string",
            "description":"Name of the user for whom the software home is being provisioned"
        },
        "liveupdate":{
            "type":"string",
            "enum":[
                "HIGHCVSS",
                "ALLCVSS",
                "FULL"
            ],
            "description":"Perform Exadata Database node live update"
        }
    }
}

Security

• basicAuthentication: basic
  Type: basic

Back to Top

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

Body ()

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.

Body ()

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.

Body ()

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

Back to Top