Jump to

• Request
• Response

Create Image

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages

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

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match One Schema

Show Source

• object DatabaseGoldImageDetails
  Input to create the image
• object ExapatchGoldImageInputDetails
  Request details to create a Exapatch Gold Image

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageDetails"
        },
        {
            "$ref":"#/components/schemas/ExapatchGoldImageInputDetails"
        }
    ]
}

Nested Schema : DatabaseGoldImageDetails

Type: object

Input to create the image

Match One Schema

Show Source

• object DatabaseGoldImageReferenceHomeInput
  Input to create image from a reference Oracle home
• object DatabaseGoldImageReferenceHomePatchingInput
  Input to create the image from the reference Oracle home with patching
• object DatabaseGoldImageNewHomePatchingInput
  Input to create the image from new home with patching, which is to be used as the reference Oracle home
• object DatabaseGoldImageImportInput
  Input to create image from import
• 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
• object DatabaseGoldImageFPPReferenceHomeInput
  Input to create image in FPP server from a reference Oracle home
• object DatabaseGoldImageFPPReferenceHomePatchingInput
  Input to create the image in FPP server from the reference Oracle home with patching
• object DatabaseGoldImageFPPNewHomePatchingInput
  Input to create the image in FPP server from new home with patching, which is to be used as the reference Oracle home

{
    "description":"Input to create the image",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageReferenceHomeInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageReferenceHomePatchingInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageNewHomePatchingInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageImportInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageFPPInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageFPPReferenceHomeInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageFPPReferenceHomePatchingInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageFPPNewHomePatchingInput"
        }
    ]
}

Nested Schema : ExapatchGoldImageInputDetails

Type: object

Request details to create a Exapatch Gold Image

Match All

Request details to create a Exapatch Gold Image

Show Source

• object ExapatchGoldImageDetails
  Input details to create a Exapatch Gold Image

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

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

Type: object

Input to create the image from new home with patching, which is to be used as the reference Oracle home

Show Source

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

  Example: /u01/oracle/newhome

{
    "description":"Input to create the image from new home with patching, which is to be used as the reference Oracle home",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageReferenceHomePatchingInput"
        }
    ],
    "type":"object",
    "required":[
        "imageName",
        "imageDescription",
        "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 from new home with patching, which is to be used as the reference 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 from new home with patching, which is to be used as the reference Oracle home",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageReferenceHomePatchingInput"
        }
    ],
    "type":"object",
    "required":[
        "imageName",
        "imageDescription",
        "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 : DatabaseGoldImageImportInput

Type: object

Input to create image from import

Show Source

• externalStageLocation: string
  External stage location of the image

  Example: /scratch/sharedLoc/san_loc
• hostCredential(required): string
  Credential of the host

  Example: SRC_HOST_CRED:ADMIN
• hostName(required): string
  Name of the host

  Example: myhost.com
• imageBundleLocation(required): string
  Bundle location of the image

  Example: /scratch/images/exportedimages
• imageBundleName(required):
  Bundle name of image

  Example: exportedImage_18c.zip
• imageDescription: string
  Description of the image

  Example: importing image 18c
• imageName(required): string
  Name of the image

  Example: fm_18c_image1
• imageSoftwareLibraryLocation(required):
  Software library location for the image

  Example: Oracle Home Provisioning Profiles/18.3.0.0.0/linux_x64
• softwareLibraryStorageName(required): string
  Software library storage name

  Example: swlib
• softwareLibraryStorageType(required): string
  Software library storage type

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

  Example: Version1-18.3
• workingDirectory(required): string
  Default Value: /u01/scratch/workDir

  Working directory

  Example: /scratch/workdir

{
    "description":"Input to create image from import",
    "required":[
        "imageName",
        "hostName",
        "hostCredential",
        "imageBundleName",
        "imageBundleLocation",
        "imageSoftwareLibraryLocation",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "workingDirectory",
        "versionName"
    ],
    "properties":{
        "imageName":{
            "description":"Name of the image",
            "type":"string",
            "example":"fm_18c_image1"
        },
        "hostName":{
            "description":"Name of the host",
            "type":"string",
            "example":"myhost.com"
        },
        "hostCredential":{
            "description":"Credential of the host",
            "type":"string",
            "example":"SRC_HOST_CRED:ADMIN"
        },
        "imageBundleName":{
            "description":"Bundle name of image",
            "example":"exportedImage_18c.zip"
        },
        "imageBundleLocation":{
            "description":"Bundle location of the image",
            "type":"string",
            "example":"/scratch/images/exportedimages"
        },
        "imageDescription":{
            "description":"Description of the image",
            "type":"string",
            "example":"importing image 18c"
        },
        "imageSoftwareLibraryLocation":{
            "description":"Software library location for the image",
            "example":"Oracle Home Provisioning Profiles/18.3.0.0.0/linux_x64"
        },
        "softwareLibraryStorageName":{
            "description":"Software library storage name",
            "type":"string",
            "example":"swlib"
        },
        "softwareLibraryStorageType":{
            "description":"Software library storage type",
            "type":"string",
            "example":"OmsShared"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "default":"/u01/scratch/workDir",
            "example":"/scratch/workdir"
        },
        "versionName":{
            "description":"Name of the image version",
            "type":"string",
            "example":"Version1-18.3"
        },
        "externalStageLocation":{
            "description":"External stage location of the image",
            "type":"string",
            "example":"/scratch/sharedLoc/san_loc"
        }
    }
}

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

Type: object

Input to create image in FPP server 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 in FPP server from a reference Oracle home",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "workingDirectory",
        "versionName"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageFPPInput"
        }
    ],
    "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 in FPP server from a reference Oracle 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 in FPP server from a reference Oracle home",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "workingDirectory",
        "versionName"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageFPPInput"
        }
    ],
    "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 : DatabaseGoldImageFPPReferenceHomePatchingInput

Type: object

Input to create the image in FPP server 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 in FPP server from the reference Oracle home with patching",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageFPPReferenceHomeInput"
        }
    ],
    "type":"object",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "workingDirectory",
        "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 in FPP server from the reference Oracle home with patching

Show Source

• object allOf DatabaseGoldImageFPPReferenceHomeInput
  Input to create image in FPP server from a reference Oracle home

{
    "description":"Input to create the image in FPP server from the reference Oracle home with patching",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageFPPReferenceHomeInput"
        }
    ],
    "type":"object",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "workingDirectory",
        "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 : DatabaseGoldImageFPPNewHomePatchingInput

Type: object

Input to create the image in FPP server from new home with patching, which is to be used as the reference Oracle home

Show Source

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

  Example: /u01/oracle/newhome

{
    "description":"Input to create the image in FPP server from new home with patching, which is to be used as the reference Oracle home",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageFPPReferenceHomePatchingInput"
        }
    ],
    "type":"object",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "workingDirectory",
        "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 in FPP server from new home with patching, which is to be used as the reference Oracle home

Show Source

• object allOf DatabaseGoldImageFPPReferenceHomePatchingInput
  Input to create the image in FPP server from the reference Oracle home with patching

{
    "description":"Input to create the image in FPP server from new home with patching, which is to be used as the reference Oracle home",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageFPPReferenceHomePatchingInput"
        }
    ],
    "type":"object",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "workingDirectory",
        "versionName",
        "patchList",
        "destinationOracleHomeLocation"
    ],
    "properties":{
        "destinationOracleHomeLocation":{
            "description":"Location of the destination Oracle home",
            "type":"string",
            "example":"/u01/oracle/newhome"
        }
    }
}

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

Type: object

Input details to create a Exapatch Gold Image

Match One Schema

Show Source

• ExapatchGoldImageInput
  Common Request details to create a new Exadata Gold Image

{
    "description":"Input details to create a Exapatch Gold Image",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ExapatchGoldImageInput"
        }
    ]
}

Nested Schema : ExapatchGoldImageInput

Common Request details to create a new Exadata Gold Image

Match All

Common Request details to create a new Exadata Gold Image

Show Source

• object ExapatchGoldImageCommonDetails
  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 new Exadata Gold Image",
    "allOf":[
        {
            "$ref":"#/components/schemas/ExapatchGoldImageCommonDetails"
        }
    ],
    "required":[
        "imageName",
        "versionName",
        "imageVersion",
        "fppServerHost",
        "imageLocation",
        "workingDirectory",
        "referenceHostCredential",
        "imageDescription",
        "targetType"
    ]
}

Nested Schema : ExapatchGoldImageCommonDetails

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.com
• 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
• imageName: string
  Name of the images

  Example: FPP_Switch_31_Oct_22
• 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 Credential 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":{
        "imageName":{
            "description":"Name of the images",
            "type":"string",
            "example":"FPP_Switch_31_Oct_22"
        },
        "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.com"
        },
        "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 Credential 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 in Software library From Reference Oracle Home Payload for Create Image in Software Library From Reference Oracle Home Patching Payload for Create Image in Software Library from Import Payload for Create Image in Software Library from New Reference Oracle Home Patching Payload for Create Image in FPP Server from Reference Oracle Home Payload for Create Image in FPP Server from Reference Oracle Home Patching Payload for Create Image in FPP Server from New Reference Oracle Home Patching Payload for Create Image on SAN From Reference Oracle Home Payload for Create Exadata Image of Storage type in FPP Server Payload for Create Exadata Image of Switch type in FPP Server Payload for Create Exadata Image 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

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an Error

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top