Jump to

• Request
• Response

Create Image Version

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/{goldImageId}/versions

Creates a new version for the existing image. This is an asynchronous operation, which submits a deployment procedure to perform this task.

Request

Path Parameters

• goldImageId(required): string
  ID of the image

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Match One Schema

Show Source

• object DatabaseGoldImageVersionInputDetails
  Input to create image version
• object ExapatchGoldImageVersionInputDetails
  Request details to create an Exapatch Gold Image Version

{
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionInputDetails"
        },
        {
            "$ref":"#/components/schemas/ExapatchGoldImageVersionInputDetails"
        }
    ]
}

Nested Schema : DatabaseGoldImageVersionInputDetails

Type: object

Input to create image version

Match All

Input to create image version

Show Source

• object DatabaseGoldImageVersionDetails
  Input to create image version

{
    "description":"Input to create image version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionDetails"
        }
    ]
}

Nested Schema : ExapatchGoldImageVersionInputDetails

Type: object

Request details to create an Exapatch Gold Image Version

Match All

Request details to create an Exapatch Gold Image Version

Show Source

• object ExapatchGoldImageVersionDetails
  Inputs to create an Exapatch Gold Image Version

{
    "description":"Request details to create an Exapatch Gold Image Version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ExapatchGoldImageVersionDetails"
        }
    ]
}

Nested Schema : DatabaseGoldImageVersionDetails

Type: object

Input to create image version

Match One Schema

Show Source

• object DatabaseGoldImageVersionReferenceHomeInput
  Input to create image from a reference Oracle home
• object DatabaseGoldImageVersionReferenceHomePatchingInput
  Input to create the image version by patching the reference Oracle Home
• object DatabaseGoldImageVersionNewReferenceHomePatchingInput
  Input to create the image version by patching and provisioning new Oracle Home
• object DatabaseGoldImageVersionDeployNewHomePatchingInput
  Request to create the image version by deploying image at a given destination Oracle Home with patching
• object DatabaseGoldImageVersionFPPInput
  Input to create image from software home specified, which can be an Oracle database, a grid infrastructure, or any other software home

{
    "description":"Input to create image version",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionReferenceHomeInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionReferenceHomePatchingInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionNewReferenceHomePatchingInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionDeployNewHomePatchingInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionFPPInput"
        }
    ]
}

Nested Schema : DatabaseGoldImageVersionReferenceHomeInput

Type: object

Input to create image from a reference Oracle home

Show Source

• referenceHostCredential: string
  Reference Oracle home host credential

  Example: TESTSUPERADMIN:ADMIN
• referenceTargetName(required): string
  Reference Oracle Home target

  Example: myoraclehome_4661

{
    "description":"Input to create image from a reference Oracle home",
    "required":[
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionInput"
        }
    ],
    "type":"object",
    "properties":{
        "referenceTargetName":{
            "description":"Reference Oracle Home target",
            "type":"string",
            "example":"myoraclehome_4661"
        },
        "referenceHostCredential":{
            "description":"Reference Oracle home host credential",
            "type":"string",
            "example":"TESTSUPERADMIN:ADMIN"
        }
    }
}

Match All

Input to create image from a reference Oracle home

Show Source

• object allOf DatabaseGoldImageVersionInput
  Common input to create new version of the image

{
    "description":"Input to create image from a reference Oracle home",
    "required":[
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionInput"
        }
    ],
    "type":"object",
    "properties":{
        "referenceTargetName":{
            "description":"Reference Oracle Home target",
            "type":"string",
            "example":"myoraclehome_4661"
        },
        "referenceHostCredential":{
            "description":"Reference Oracle home host credential",
            "type":"string",
            "example":"TESTSUPERADMIN:ADMIN"
        }
    }
}

Nested Schema : DatabaseGoldImageVersionReferenceHomePatchingInput

Type: object

Input to create the image version by patching the reference Oracle Home

Show Source

• isCleanupDestinationHome: boolean
  Flag to indicate cleanup destination home

  Example: false
• patchList(required): string
  Patches to be applied

  Example: 31504723
• referenceHostPrivilegeCredential: string
  Privilege host credential of the reference Oracle Home target

  Example: TESTPRIVADMIN:ADMIN

{
    "description":"Input to create the image version by patching the reference Oracle Home",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionReferenceHomeInput"
        }
    ],
    "type":"object",
    "required":[
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList"
    ],
    "properties":{
        "referenceHostPrivilegeCredential":{
            "description":"Privilege host credential of the reference Oracle Home target",
            "type":"string",
            "example":"TESTPRIVADMIN:ADMIN"
        },
        "isCleanupDestinationHome":{
            "description":"Flag to indicate cleanup destination home",
            "type":"boolean",
            "example":false
        },
        "patchList":{
            "description":"Patches to be applied",
            "type":"string",
            "example":"31504723"
        }
    }
}

Match All

Input to create the image version by patching the reference Oracle Home

Show Source

• object allOf DatabaseGoldImageVersionReferenceHomeInput
  Input to create image from a reference Oracle home

{
    "description":"Input to create the image version by patching the reference Oracle Home",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionReferenceHomeInput"
        }
    ],
    "type":"object",
    "required":[
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList"
    ],
    "properties":{
        "referenceHostPrivilegeCredential":{
            "description":"Privilege host credential of the reference Oracle Home target",
            "type":"string",
            "example":"TESTPRIVADMIN:ADMIN"
        },
        "isCleanupDestinationHome":{
            "description":"Flag to indicate cleanup destination home",
            "type":"boolean",
            "example":false
        },
        "patchList":{
            "description":"Patches to be applied",
            "type":"string",
            "example":"31504723"
        }
    }
}

Nested Schema : DatabaseGoldImageVersionNewReferenceHomePatchingInput

Type: object

Input to create the image version by patching and provisioning new Oracle Home

Show Source

• destinationOracleHomeLocation(required): string
  Location of the destination Oracle Home

  Example: /u01/oracle/newhome

{
    "description":"Input to create the image version by patching and provisioning new Oracle Home",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageReferenceHomePatchingInput"
        }
    ],
    "type":"object",
    "required":[
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList",
        "destinationOracleHomeLocation"
    ],
    "properties":{
        "destinationOracleHomeLocation":{
            "description":"Location of the destination Oracle Home",
            "type":"string",
            "example":"/u01/oracle/newhome"
        }
    }
}

Match All

Input to create the image version by patching and provisioning new Oracle Home

Show Source

• object allOf DatabaseGoldImageReferenceHomePatchingInput
  Input to create the image from the reference Oracle home with patching

{
    "description":"Input to create the image version by patching and provisioning new Oracle Home",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageReferenceHomePatchingInput"
        }
    ],
    "type":"object",
    "required":[
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList",
        "destinationOracleHomeLocation"
    ],
    "properties":{
        "destinationOracleHomeLocation":{
            "description":"Location of the destination Oracle Home",
            "type":"string",
            "example":"/u01/oracle/newhome"
        }
    }
}

Nested Schema : DatabaseGoldImageVersionDeployNewHomePatchingInput

Type: object

Request to create the image version by deploying image at a given destination Oracle Home with patching

Show Source

• asmDbaGroup: string
  ASM dba group
• databaseAdminGroup(required): string
  Database admin group
• databaseOperGroup: string
  Database oper group
• destinationHostName(required): string
  Host name of the destination
• destinationOracleHomeLocation(required): string
  Location of the Oracle Home
• imageId(required): string
  ID of the image to be deployed

  Example: E5B98897FE871AC1E05380FE4564F682
• inventoryGroup(required): string
  Inventory group
• oracleBaseLocation: string
  Base location
• osBackupDbaGroup: string
  OS backup dba group
• osDgDbaGroup: string
  OS dg dba group
• osKeyMgmtGroup: string
  OS key management group
• patchList(required): string
  Patches to be applied
• provisioningType(required): string
  Provisioning type
• referenceHostPrivilegeCredential: string
  Privilege host credential for the reference Oracle Home target

  Example: HOST_ROOT_CRED:ADMIN
• versionId: string
  ID of the version from which the new version to be created

  Example: E5v98897FE871AC1E05380FE4564F690

{
    "description":"Request to create the image version by deploying image at a given destination Oracle Home with patching",
    "required":[
        "imageId",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList",
        "destinationOracleHomeLocation",
        "destinationHostName",
        "provisioningType",
        "inventoryGroup",
        "databaseAdminGroup"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionInput"
        }
    ],
    "type":"object",
    "properties":{
        "imageId":{
            "description":"ID of the image to be deployed",
            "type":"string",
            "example":"E5B98897FE871AC1E05380FE4564F682"
        },
        "versionId":{
            "description":"ID of the version from which the new version to be created",
            "type":"string",
            "example":"E5v98897FE871AC1E05380FE4564F690"
        },
        "referenceHostPrivilegeCredential":{
            "description":"Privilege host credential for the reference Oracle Home target",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "destinationOracleHomeLocation":{
            "description":"Location of the Oracle Home",
            "type":"string"
        },
        "patchList":{
            "description":"Patches to be applied",
            "type":"string"
        },
        "oracleBaseLocation":{
            "description":"Base location",
            "type":"string"
        },
        "destinationHostName":{
            "description":"Host name of the destination",
            "type":"string"
        },
        "provisioningType":{
            "description":"Provisioning type",
            "type":"string"
        },
        "inventoryGroup":{
            "description":"Inventory group",
            "type":"string"
        },
        "databaseAdminGroup":{
            "description":"Database admin group",
            "type":"string"
        },
        "asmDbaGroup":{
            "description":"ASM dba group",
            "type":"string"
        },
        "osBackupDbaGroup":{
            "description":"OS backup dba group",
            "type":"string"
        },
        "databaseOperGroup":{
            "description":"Database oper group",
            "type":"string"
        },
        "osDgDbaGroup":{
            "description":"OS dg dba group",
            "type":"string"
        },
        "osKeyMgmtGroup":{
            "description":"OS key management group",
            "type":"string"
        }
    }
}

Match All

Request to create the image version by deploying image at a given destination Oracle Home with patching

Show Source

• object allOf DatabaseGoldImageVersionInput
  Common input to create new version of the image

{
    "description":"Request to create the image version by deploying image at a given destination Oracle Home with patching",
    "required":[
        "imageId",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList",
        "destinationOracleHomeLocation",
        "destinationHostName",
        "provisioningType",
        "inventoryGroup",
        "databaseAdminGroup"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionInput"
        }
    ],
    "type":"object",
    "properties":{
        "imageId":{
            "description":"ID of the image to be deployed",
            "type":"string",
            "example":"E5B98897FE871AC1E05380FE4564F682"
        },
        "versionId":{
            "description":"ID of the version from which the new version to be created",
            "type":"string",
            "example":"E5v98897FE871AC1E05380FE4564F690"
        },
        "referenceHostPrivilegeCredential":{
            "description":"Privilege host credential for the reference Oracle Home target",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "destinationOracleHomeLocation":{
            "description":"Location of the Oracle Home",
            "type":"string"
        },
        "patchList":{
            "description":"Patches to be applied",
            "type":"string"
        },
        "oracleBaseLocation":{
            "description":"Base location",
            "type":"string"
        },
        "destinationHostName":{
            "description":"Host name of the destination",
            "type":"string"
        },
        "provisioningType":{
            "description":"Provisioning type",
            "type":"string"
        },
        "inventoryGroup":{
            "description":"Inventory group",
            "type":"string"
        },
        "databaseAdminGroup":{
            "description":"Database admin group",
            "type":"string"
        },
        "asmDbaGroup":{
            "description":"ASM dba group",
            "type":"string"
        },
        "osBackupDbaGroup":{
            "description":"OS backup dba group",
            "type":"string"
        },
        "databaseOperGroup":{
            "description":"Database oper group",
            "type":"string"
        },
        "osDgDbaGroup":{
            "description":"OS dg dba group",
            "type":"string"
        },
        "osKeyMgmtGroup":{
            "description":"OS key management group",
            "type":"string"
        }
    }
}

Nested Schema : DatabaseGoldImageVersionFPPInput

Type: object

Input to create image from software home specified, which can be an Oracle database, a grid infrastructure, or any other software home

Match All

Input to create image from software home specified, which can be an Oracle database, a grid infrastructure, or any other software home

Show Source

• object DatabaseGoldImageFPPInput
  Input to create new series resource in FPP server with given series name and creates image from reference Oracle Home and associates series to it

{
    "description":"Input to create image from software home specified, which can be an Oracle database, a grid infrastructure, or any other software home",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageFPPInput"
        }
    ]
}

Nested Schema : DatabaseGoldImageVersionInput

Type: object

Common input to create new version of the image

Match All

Common input to create new version of the image

Show Source

• object DatabaseGoldImageCommonDetails
  Common input details to create the image

{
    "description":"Common input to create new version of the image",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageCommonDetails"
        }
    ]
}

Nested Schema : DatabaseGoldImageCommonDetails

Type: object

Common input details to create the image

Show Source

• excludeFileList: string
  List of files to be excluded
• externalId: string
  External ID for the image

  Example: oracle:defaultService:em:provisioning:1:cmp:COMP_Component:SUB_OracleDB:4BAFA861A7E96603E053057FB10A0588:0.1
• externalStageLocation: string
  External Stage Location for SAN

  Example: false
• imageDescription: string
  Description of the image
• imageNotes: string
  Notes about the image
• imageSoftwareLibraryPath: string
  Software library path for image

  Example: <path>/18.0/linux64
• isCreateImageLegacyWay: boolean
  Flag to indicate creation of the image in a legacy way

  Example: false
• isIgnoreActiveFileExecutionCheck: boolean
  Flag to ignore active files execution

  Example: false
• nfsLocalMountPoint: string
  Local directory path for NFS share to mount

  Example: /scratch/cuser/Nfs_mount_point
• softwareLibraryStorageName: string
  Software library storage name

  Example: swlib
• softwareLibraryStorageType: string
  Software Library storage type

  Example: OmsShared
• storageDestination: string
  Allowed Values: [ "SOFTWARE_LIBRARY", "FPP_SERVER" ]

  Image storage/creation is either in software library or in FPP server
• versionName: string
  Name for the Database Gold Image Version

  Example: fm_version_1
• versionStatus: string
  Allowed Values: [ "CURRENT" ]

  Enum for image version status
• windowsCredential: string
  Credential for the Windows platform
• workingDirectory: string
  Default Value: /u01/scratch/workDir

  Working directory

  Example: /scratch/workdir

{
    "description":"Common input details to create the image",
    "type":"object",
    "properties":{
        "storageDestination":{
            "description":"Image storage/creation is either in software library or in FPP server",
            "type":"string",
            "enum":[
                "SOFTWARE_LIBRARY",
                "FPP_SERVER"
            ]
        },
        "imageDescription":{
            "description":"Description of the image",
            "type":"string"
        },
        "imageSoftwareLibraryPath":{
            "description":"Software library path for image",
            "type":"string",
            "example":"<path>/18.0/linux64"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "default":"/u01/scratch/workDir",
            "example":"/scratch/workdir"
        },
        "softwareLibraryStorageName":{
            "description":"Software library storage name",
            "type":"string",
            "example":"swlib"
        },
        "softwareLibraryStorageType":{
            "description":"Software Library storage type",
            "type":"string",
            "example":"OmsShared"
        },
        "versionName":{
            "description":"Name for the Database Gold Image Version",
            "type":"string",
            "example":"fm_version_1"
        },
        "versionStatus":{
            "$ref":"#/components/schemas/VersionStatusEnum"
        },
        "nfsLocalMountPoint":{
            "description":"Local directory path for NFS share to mount",
            "type":"string",
            "example":"/scratch/cuser/Nfs_mount_point"
        },
        "imageNotes":{
            "description":"Notes about the image",
            "type":"string"
        },
        "externalId":{
            "description":"External ID for the image",
            "type":"string",
            "example":"oracle:defaultService:em:provisioning:1:cmp:COMP_Component:SUB_OracleDB:4BAFA861A7E96603E053057FB10A0588:0.1"
        },
        "excludeFileList":{
            "description":"List of files to be excluded",
            "type":"string"
        },
        "windowsCredential":{
            "description":"Credential for the Windows platform",
            "type":"string"
        },
        "isIgnoreActiveFileExecutionCheck":{
            "description":"Flag to ignore active files execution",
            "type":"boolean",
            "example":false
        },
        "isCreateImageLegacyWay":{
            "description":"Flag to indicate creation of the image in a legacy way",
            "type":"boolean",
            "example":false
        },
        "externalStageLocation":{
            "description":"External Stage Location for SAN",
            "type":"string",
            "example":false
        }
    }
}

Nested Schema : DatabaseGoldImageReferenceHomePatchingInput

Type: object

Input to create the image from the reference Oracle home with patching

Show Source

• isCleanupDestinationHome: boolean
  Flag to indicate cleanup destination home

  Example: false
• patchList(required): string
  Patches to be applied

  Example: 31504723
• referenceHostPrivilegeCredential: string
  Privilege host credential of the reference Oracle Home target

  Example: TESTPRIVADMIN:ADMIN

{
    "description":"Input to create the image from the reference Oracle home with patching",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageReferenceHomeInput"
        }
    ],
    "type":"object",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList"
    ],
    "properties":{
        "referenceHostPrivilegeCredential":{
            "description":"Privilege host credential of the reference Oracle Home target",
            "type":"string",
            "example":"TESTPRIVADMIN:ADMIN"
        },
        "isCleanupDestinationHome":{
            "description":"Flag to indicate cleanup destination home",
            "type":"boolean",
            "example":false
        },
        "patchList":{
            "description":"Patches to be applied",
            "type":"string",
            "example":"31504723"
        }
    }
}

Match All

Input to create the image from the reference Oracle home with patching

Show Source

• object allOf DatabaseGoldImageReferenceHomeInput
  Input to create image from a reference Oracle home

{
    "description":"Input to create the image from the reference Oracle home with patching",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageReferenceHomeInput"
        }
    ],
    "type":"object",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList"
    ],
    "properties":{
        "referenceHostPrivilegeCredential":{
            "description":"Privilege host credential of the reference Oracle Home target",
            "type":"string",
            "example":"TESTPRIVADMIN:ADMIN"
        },
        "isCleanupDestinationHome":{
            "description":"Flag to indicate cleanup destination home",
            "type":"boolean",
            "example":false
        },
        "patchList":{
            "description":"Patches to be applied",
            "type":"string",
            "example":"31504723"
        }
    }
}

Nested Schema : DatabaseGoldImageReferenceHomeInput

Type: object

Input to create image from a reference Oracle home

Show Source

• referenceHostCredential: string
  Reference Oracle Home host credential

  Example: TESTSUPERADMIN:ADMIN
• referenceTargetName(required): string
  Reference Oracle Home target

  Example: myoraclehome_4661

{
    "description":"Input to create image from a reference Oracle home",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageInput"
        }
    ],
    "type":"object",
    "properties":{
        "referenceTargetName":{
            "description":"Reference Oracle Home target",
            "type":"string",
            "example":"myoraclehome_4661"
        },
        "referenceHostCredential":{
            "description":"Reference Oracle Home host credential",
            "type":"string",
            "example":"TESTSUPERADMIN:ADMIN"
        }
    }
}

Match All

Input to create image from a reference Oracle home

Show Source

• object allOf DatabaseGoldImageInput
  Common input to create image or version

{
    "description":"Input to create image from a reference Oracle home",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageInput"
        }
    ],
    "type":"object",
    "properties":{
        "referenceTargetName":{
            "description":"Reference Oracle Home target",
            "type":"string",
            "example":"myoraclehome_4661"
        },
        "referenceHostCredential":{
            "description":"Reference Oracle Home host credential",
            "type":"string",
            "example":"TESTSUPERADMIN:ADMIN"
        }
    }
}

Nested Schema : DatabaseGoldImageInput

Type: object

Common input to create image or version

Show Source

• imageName: string
  Name of the image

{
    "description":"Common input to create image or version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageCommonDetails"
        }
    ],
    "properties":{
        "imageName":{
            "description":"Name of the image",
            "type":"string"
        }
    }
}

Match All

Common input to create image or version

Show Source

• object DatabaseGoldImageCommonDetails
  Common input details to create the image

{
    "description":"Common input to create image or version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageCommonDetails"
        }
    ],
    "properties":{
        "imageName":{
            "description":"Name of the image",
            "type":"string"
        }
    }
}

Nested Schema : DatabaseGoldImageFPPInput

Type: object

Input to create new series resource in FPP server with given series name and creates image from reference Oracle Home and associates series to it

Show Source

• fppOptions: string
  Additional options for FPP
• fppRestUser: string
  REST user to be used for an FPP REST call

  Example: rest_cuser
• imageDescription: string
  Description for the image

  Example: Gold image for DB19
• imageName: string
  Name of the FPP series

  Example: FPP_DB_19_Series_04_july_21
• referenceHostCredential: string
  Host credential of the reference host

  Example: SRC_HOST_CRED:ADMIN
• referenceTargetName(required): string
  Reference target name

  Example: myoraclehome_3917
• version: string
  Version of the image
• versionName(required): string
  Name of the image

  Example: Tier1_19_ver_Image_04_July_21
• workingDirectory(required): string
  Default Value: /u01/scratch/workDir

  Working directory

  Example: /scratch/cuser/agents/image

{
    "description":"Input to create new series resource in FPP server with given series name and creates image from reference Oracle Home and associates series to it",
    "type":"object",
    "required":[
        "versionName",
        "referenceTargetName",
        "workingDirectory"
    ],
    "properties":{
        "imageName":{
            "description":"Name of the FPP series",
            "type":"string",
            "example":"FPP_DB_19_Series_04_july_21"
        },
        "versionName":{
            "description":"Name of the image",
            "type":"string",
            "example":"Tier1_19_ver_Image_04_July_21"
        },
        "imageDescription":{
            "description":"Description for the image",
            "type":"string",
            "example":"Gold image for DB19"
        },
        "referenceTargetName":{
            "description":"Reference target name",
            "type":"string",
            "example":"myoraclehome_3917"
        },
        "referenceHostCredential":{
            "description":"Host credential of the reference host",
            "type":"string",
            "example":"SRC_HOST_CRED:ADMIN"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "default":"/u01/scratch/workDir",
            "example":"/scratch/cuser/agents/image"
        },
        "version":{
            "description":"Version of the image",
            "type":"string"
        },
        "fppOptions":{
            "description":"Additional options for FPP",
            "type":"string"
        },
        "fppRestUser":{
            "description":"REST user to be used for an FPP REST call",
            "type":"string",
            "example":"rest_cuser"
        }
    }
}

Nested Schema : ExapatchGoldImageVersionDetails

Type: object

Inputs to create an Exapatch Gold Image Version

Match One Schema

Show Source

• object ExapatchGoldImageVersionInput
  Common Request details to create a Exadata Gold Image or version

{
    "description":"Inputs to create an Exapatch Gold Image Version",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ExapatchGoldImageVersionInput"
        }
    ]
}

Nested Schema : ExapatchGoldImageVersionInput

Type: object

Common Request details to create a Exadata Gold Image or version

Match All

Common Request details to create a Exadata Gold Image or version

Show Source

• object ExapatchGoldImageVersionCommonDetails
  Creates a new image resource with the given image name and creates a Gold Image from patch location on given fpp server.

{
    "description":"Common Request details to create a Exadata Gold Image or version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ExapatchGoldImageVersionCommonDetails"
        }
    ],
    "required":[
        "versionName",
        "imageVersion",
        "fppServerHost",
        "imageLocation",
        "workingDirectory",
        "referenceHostCredential",
        "imageDescription",
        "targetType"
    ]
}

Nested Schema : ExapatchGoldImageVersionCommonDetails

Type: object

Creates a new image resource with the given image name and creates a Gold Image from patch location on given fpp server.

Show Source

• dbNodeFile: string
  File name of the dbnode patch.

  Example: p34568889_221000_Linux-x86-64.zip
• fppServerHost: string
  FPP host name

  Example: myFppServerHostName.mycompany.comom
• imageDescription: string
  Description of the Gold Image

  Example: Description of the Exapatch Gold Image
• imageLocation: string
  Location of the patch on the fpp server

  Example: /u01/staging/db_212
• imageVersion: string
  Image version

  Example: 19.13.0.0.0
• patchManagerLocation: string
  Folder name that contains patch manager files should be a relative path of given imageLocation.

  Example: dbserver_patch_220810
• referenceHostCredential: string
  Host Credentials for the reference fpp server host.

  Example: TEST_HOST_CREDENTIAL:SYSMAN
• storageFile: string
  File name of storage patch.

  Example: p34568888_221000_Linux-x86-64.zip
• switchFile: string
  File name of switch patch .

  Example: p34568890_221000_Linux-x86-64.zip
• targetType: string
  Allowed Values: [ "oracle_si_netswitch", "oracle_dbmachine", "oracle_exadata", "host" ]

  Exapatch creation type
• versionName: string
  Name of the image version

  Example: Tier1_ver_Image_31_July_22
• workingDirectory: string
  Working directory location

  Example: /u01/scratch/workDir

{
    "description":"Creates a new image resource with the given image name and creates a Gold Image from patch location on given fpp server.",
    "type":"object",
    "properties":{
        "versionName":{
            "description":"Name of the image version",
            "type":"string",
            "example":"Tier1_ver_Image_31_July_22"
        },
        "imageVersion":{
            "description":"Image version",
            "type":"string",
            "example":"19.13.0.0.0"
        },
        "fppServerHost":{
            "description":"FPP host name",
            "type":"string",
            "example":"myFppServerHostName.mycompany.comom"
        },
        "imageLocation":{
            "description":"Location of the patch on the fpp server",
            "type":"string",
            "example":"/u01/staging/db_212"
        },
        "workingDirectory":{
            "description":"Working directory location",
            "type":"string",
            "example":"/u01/scratch/workDir"
        },
        "referenceHostCredential":{
            "description":"Host Credentials for the reference fpp server host.",
            "type":"string",
            "example":"TEST_HOST_CREDENTIAL:SYSMAN"
        },
        "imageDescription":{
            "description":"Description of the Gold Image",
            "type":"string",
            "example":"Description of the Exapatch Gold Image"
        },
        "targetType":{
            "description":"Exapatch creation type",
            "type":"string",
            "enum":[
                "oracle_si_netswitch",
                "oracle_dbmachine",
                "oracle_exadata",
                "host"
            ]
        },
        "switchFile":{
            "description":"File name of switch patch .",
            "type":"string",
            "example":"p34568890_221000_Linux-x86-64.zip"
        },
        "storageFile":{
            "description":"File name of storage patch.",
            "type":"string",
            "example":"p34568888_221000_Linux-x86-64.zip"
        },
        "dbNodeFile":{
            "description":"File name of the dbnode patch.",
            "type":"string",
            "example":"p34568889_221000_Linux-x86-64.zip"
        },
        "patchManagerLocation":{
            "description":"Folder name that contains patch manager files should be a relative path of given imageLocation.",
            "type":"string",
            "example":"dbserver_patch_220810"
        }
    }
}

Examples

Select an example Payload for Create Image Version in Software Library from Reference Oracle Home Payload for Create Image Version in Software Library from Reference Oracle Home Patching Payload for Create Image Version in Software Library from New Reference Oracle Home Patching Payload for Create Image Version in Software Library from Deploy New Reference Oracle Home Patching Payload for Create Image Version in Software Library from an Existing version by Deploy New Reference Oracle Home Patching Payload for Create Image Version in FPP Server from Reference Oracle Home Payload for Create Image Version in FPP Server from Reference Oracle Home Patching Payload for Create Image Version in FPP Server from New Reference Oracle Home Patching Payload for Create Image Version in FPP Server from Deploy New Reference Oracle Home Patching Payload for Create Image Version in FPP Server from an Existing version by Deploy New Reference Oracle Home Patching Payload for Create Exadata Image Version of Storage type in FPP Server Payload for Create Exadata Image Version of Switch type in FPP Server Payload for Create Exadata Image Version of Host type in FPP Server

Back to Top

Response

202 Response

It is a long running/async API. It submits a deployment procedure.

Headers

• Location:
  URL link to track the status of the API for the deployment procedure

  Example:

  /deploymentProcedureInstances/{deploymentProcedureInstanceId}

Body ()

Root Schema : schema

Type: object

Show Source

• links: object links
  links
• message: string
  message

  Example: It is a long running/async API. It submits a deployment procedure.

{
    "type":"object",
    "properties":{
        "message":{
            "description":"message",
            "type":"string",
            "example":"It is a long running/async API. It submits a deployment procedure."
        },
        "links":{
            "description":"links",
            "type":"object",
            "properties":{
                "tracking":{
                    "type":"object",
                    "description":"Represents a link to the REST API to track the status of the submitted deployment procedure",
                    "properties":{
                        "href":{
                            "type":"string",
                            "description":"URL for the link",
                            "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : links

Type: object

links

Show Source

• tracking: object tracking
  Represents a link to the REST API to track the status of the submitted deployment procedure

{
    "description":"links",
    "type":"object",
    "properties":{
        "tracking":{
            "type":"object",
            "description":"Represents a link to the REST API to track the status of the submitted deployment procedure",
            "properties":{
                "href":{
                    "type":"string",
                    "description":"URL for the link",
                    "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
                }
            }
        }
    }
}

Nested Schema : tracking

Type: object

Represents a link to the REST API to track the status of the submitted deployment procedure

Show Source

• href: string
  URL for the link

  Example: /deploymentProcedureInstances/{deploymentProcedureInstanceId}

{
    "type":"object",
    "description":"Represents a link to the REST API to track the status of the submitted deployment procedure",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the link",
            "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
        }
    }
}

400 Response

Bad Request. The payload is null or missing some parameters

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

404 Response

Not Found. The requested REST API URL is not found.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503 Response

Service Unavailable. The server is unable to process the request.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

Back to Top