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
Root Schema : schema
Match One Schema
Show Source
-
object
DatabaseGoldImageDetails
Input to create the image
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
Nested Schema : DatabaseGoldImageReferenceHomeInput
Type:
object
Input to create image from a reference Oracle home
Show Source
-
referenceHostCredential(required): string
Reference Oracle Home host credentialExample:
TESTSUPERADMIN:ADMIN
-
referenceTargetName(required): string
Reference Oracle Home targetExample:
myoraclehome_4661
Match All
Show Source
-
object
allOf
DatabaseGoldImageInput
Common input to create image or version
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 homeExample:
false
-
patchList(required): string
Patches to be appliedExample:
31504723
-
referenceHostPrivilegeCredential: string
Privilege host credential of the reference Oracle Home targetExample:
TESTPRIVADMIN:ADMIN
Match All
Show Source
-
object
allOf
DatabaseGoldImageReferenceHomeInput
Input to create image from a reference Oracle home
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 homeExample:
/u01/oracle/newhome
Match All
Show Source
-
object
allOf
DatabaseGoldImageReferenceHomePatchingInput
Input to create the image from the reference Oracle home with patching
Nested Schema : DatabaseGoldImageImportInput
Type:
object
Input to create image from import
Show Source
-
hostCredential(required): string
Credential of the hostExample:
SRC_HOST_CRED:ADMIN
-
hostName(required): string
Name of the hostExample:
myhost.com
-
imageBundleLocation(required): string
Bundle location of the imageExample:
/scratch/images/exportedimages
-
imageBundleName(required):
Bundle name of imageExample:
exportedImage_18c.zip
-
imageDescription: string
Description of the imageExample:
importing image 18c
-
imageName(required): string
Name of the imageExample:
fm_18c_image1
-
imageSoftwareLibraryLocation(required):
Software library location for the imageExample:
Oracle Home Provisioning Profiles/18.3.0.0.0/linux_x64
-
softwareLibraryStorageName(required): string
Software library storage nameExample:
swlib
-
softwareLibraryStorageType(required): string
Software library storage typeExample:
OmsShared
-
versionName(required): string
Name of the image versionExample:
Version1-18.3
-
workingDirectory(required): string
Default Value:
/tmp
Working directoryExample:/scratch/workdir
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 callExample:
rest_cuser
-
imageDescription: string
Description for the imageExample:
Gold image for DB19
-
imageName: string
Name of the FPP seriesExample:
FPP_DB_19_Series_04_july_21
-
referenceHostCredential(required): string
Host credential of the reference hostExample:
SRC_HOST_CRED:ADMIN
-
referenceTargetName(required): string
Reference target nameExample:
myoraclehome_3917
-
version: string
Version of the image
-
versionName(required): string
Name of the imageExample:
Tier1_19_ver_Image_04_July_21
-
workingDirectory(required): string
Default Value:
/tmp
Working directoryExample:/scratch/cuser/agents/image
Nested Schema : DatabaseGoldImageFPPReferenceHomeInput
Type:
object
Input to create image in FPP server from a reference Oracle home
Show Source
-
referenceHostCredential(required): string
Reference Oracle home host credentialExample:
TESTSUPERADMIN:ADMIN
-
referenceTargetName(required): string
Reference Oracle home targetExample:
myoraclehome_4661
Match All
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
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 homeExample:
false
-
patchList(required): string
Patches to be appliedExample:
31504723
-
referenceHostPrivilegeCredential: string
Privilege host credential of the reference Oracle home targetExample:
TESTPRIVADMIN:ADMIN
Match All
Show Source
-
object
allOf
DatabaseGoldImageFPPReferenceHomeInput
Input to create image in FPP server from a reference Oracle home
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 homeExample:
/u01/oracle/newhome
Match All
Show Source
-
object
allOf
DatabaseGoldImageFPPReferenceHomePatchingInput
Input to create the image in FPP server from the reference Oracle home with patching
Nested Schema : DatabaseGoldImageInput
Type:
object
Common input to create image or version
Show Source
-
imageName: string
Name of the image
Match All
Show Source
-
object
DatabaseGoldImageCommonDetails
Common input details to create the image
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 imageExample:
oracle:defaultService:em:provisioning:1:cmp:COMP_Component:SUB_OracleDB:4BAFA861A7E96603E053057FB10A0588:0.1
-
imageDescription: string
Description of the image
-
imageNotes: string
Notes about the image
-
imageSoftwareLibraryPath: string
Software library path for imageExample:
<path>/18.0/linux64
-
isCreateImageLegacyWay: boolean
Flag to indicate creation of the image in a legacy wayExample:
false
-
isIgnoreActiveFileExecutionCheck: boolean
Flag to ignore active files executionExample:
false
-
nfsLocalMountPoint: string
Local directory path for NFS share to mountExample:
/scratch/cuser/Nfs_mount_point
-
softwareLibraryStorageName: string
Software library storage nameExample:
swlib
-
softwareLibraryStorageType: string
Software Library storage typeExample:
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 VersionExample:
fm_version_1
-
versionStatus: string
Allowed Values:
[ "CURRENT" ]
Enum for image version status -
windowsCredential: string
Credential for the Windows platform
-
workingDirectory: string
Default Value:
/tmp
Working directoryExample:/scratch/workdir
Examples
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 procedureExample:
/deploymentProcedureInstances/{deploymentProcedureInstanceId}
Root Schema : schema
Type:
Show Source
object
-
links: object
links
links
-
message: string
messageExample:
It is a long running/async API. It submits a deployment procedure.
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
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 linkExample:
/deploymentProcedureInstances/{deploymentProcedureInstanceId}
400 Response
Bad Request. The payload is null or missing some parameters
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
401 Response
Unauthorized. The user does not have permissions to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
403 Response
Forbidden. The user is forbidden to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
404 Response
Not Found. The requested REST API URL is not found.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
500 Response
Internal Server Error. Exception in execution of REST API.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
503 Response
Service Unavailable. The server is unable to process the request.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string