1. Cloud Control Database Lifecycle Management Administrator's Guide
  2. Database Maintenance: Updates (Patching) and Upgrades
  3. Database Updates and Upgrades Using Fleet Maintenance
  4. Fleet Maintenance Automation
  5. Database Fleet Maintenance Update REST APIs
  6. Fleet Maintenance Operations REST APIs

Fleet Maintenance Operations REST APIs

The following is a list of Database Fleet Maintenance operations that can be performed using REST APIs.

Deploy APIs

Feature Description

Request Method

POST

URI

/em/websvcs/restful/emws/db/fleetmaintenance/performOperation/deploy

Request Headers

Authorization: basic <generated credential value>

Content-Type: application/json

Payload

 
{
"name": "<Operation Name>",
"targetName" : "<target name>",
"targetType" : "<Target type>",
"normalCredString" : "USER:SYSMAN",
"privCredString" : "root_CREDENTIAL:SYSMAN",
"standbyAutoDeploy : "true/false",
"skipCVUChecks" : "true/false",
"skipPrereqs" : "true/false",
"newOracleHomeLoc" : "<Path to Oracle Home>"
}
Response 
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Deploy' created successfully.
Deploy operation for target blr123.example.com can be monitored using:
Browser:
https://blr123.example.com:11111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=4943D8E3626E420EE0530854F10A18A9

Description of the Input Variables

  • name: Name of the operation (DEPLOY_DB_SOFTWARE, DEPLOY_RAC_SOFTWARE, DEPLOY_GI_SOFTWARE, DEPLOY_SIHA_SOFTWARE, DEPLOY_GIMR_SOFTWARE).
  • targetName: Name of the target.
  • targetType: Refer to CLI Command Inputs Based on Entity Type table.
  • normalCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.
  • privCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.

    These credentials are used to run scripts as root.

  • standbyAutoDeploy: This is an optional parameter with default value as True. If the target is a primary database, a new Oracle home using the same gold image version as Primary is deployed automatically on the Standby host. This parameter disables the automatic deployment of software on standby host when specified as false. If this value is false, the Standby staging/deploy operation can be performed independently using the emcli command.
  • skipCVUChecks: true|false. Default value is false
  • skipPrereqs: true|false. Default value is false
  • WorkingDirectory: <Name of temp directory>
  • newOracleHomeLoc: <Location where Oracle Home will be created>

Deploy CDB

Feature Description

Request Method

POST

URI

em/websvcs/restful/emws/db/fleetmaintenance/performOperation/deploycdb

Request Headers

Authorization: basic <generated credential value>

Content-Type: application/json

Payload

 
{
"name": "<Operation name>",
"targetName": "<name of the target>",
"targetType": "<target type>",
"normalCredString": "<credential name>",
"privCredString": "<privileged credential name>",
"dbCredString":"<database credential name>",
"dbName":"<db name>",
"destinationOracleHomeLocation":"<destination home location>"  
"force" : "<true|false>" 
}
Response 
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Deploy CDB' created successfully.
Deploy CDB operation for target blr123.example.com can be monitored using:
 Browser: https://blr123.example.com:11111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=4943D8E3626E420EE0530854F10A18A8

Description of the Input Variables

  • name: Name of the operation.
  • targetName: Name of the target.
  • targetType: Refer to CLI Command Inputs Based on Entity Type table.
  • normalCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.
  • privCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.

    These credentials are used to run scripts as root.

  • dbcredstring: Database credential name.
  • destinationOracleHomeLocation: Location of the destination Oracle Home. This parameter is only for emergency patching.
  • force: Forces deploy operation to occur, this parameter is only for emergency patching.

Emergency Patching Deploy

Feature Description

Request Method

POST

URI

em/websvcs/restful/emws/db/fleetmaintenance/performOperation/deploy

Request Headers

Authorization: basic <generated credential value>

Content-Type: application/json

Payload

 
{
"name": “Emergency Deploy Home",
"targetName" : "newcdb21c.sample.com"
"targetType" : "oracle_database",
"normalCredString" : "CUSER:SYSMAN",
"privCredString" : "root:SYSMAN",
"skipCVUChecks" : "true",
"skipPrereqs" : "true",
"emergencyPatching” : “true”,
“patchList” : “30557433”,
"newOracleHomeLoc" : "/scratch/cuser/db_home/db_home213patch"
}
Response 
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Deploy CDB' created successfully.
Deploy CDB operation for target newcdb21c.sample.com can be monitored using:
 Browser: https://newcdb21c.sample.com:11111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=4943D8E3626E420EE0530854F10A18A8

Description of the Input Variables

  • name: Name of the operation.
  • targetName: Name of the target.
  • targetType: Refer to CLI Command Inputs Based on Entity Type table.
  • normalCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.
  • privCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.

    These credentials are used to run scripts as root.

  • skipCVUChecks: Skips Cluster checks, use true for emergency patching if cluster checks can be skipped.
  • skipPrereqs: Skips prerequisite checks, use true for emergency patching if prerequisite checks can be skipped.
  • emergencyPatching : Set to true to enable Emergency Patching.
  • patchList: List of patches to be applied.
  • newOracleHomeLoc: Path location of new Oracle Home.

Attach Home

Feature Description

Request Method

POST

URI

/em/websvcs/restful/emws/db/fleetmaintenance/performOperation/deploy

Request Headers

Authorization: basic <generated credential value>

Content-Type: application/json

Payload

 
{
"name": "Attach Home",
"targetName" : "<target name>",
"targetType" : "oracle_database",
"normalCredString" : "USER:SYSMAN",
"privCredString" : "root_USER:SYSMAN",
"skipCVUChecks" : "true",
"skipPrereqs" : "true",
"attachHome": "true",
"newOracleHomeLoc" : "/scratch/cuser/db_home/<location path>"
}
Response 
Processing target: newcdb21c.domain.example.com
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Oracle home target list is 98F04583B0F014C572ACA82606776D2B
Operation 'Attach Home' created successfully.
Deploy Oracle home software operation for  database newcdb21c.domain.example.com can be monitored using
Browser:
 https://newcdb21c.domain.example.com:24503/em/faces/core-jobs-procedureExecutionTracking?executionGUID=CA4D5A7FB0E555FBE0532D81456486C5
Status:Success

Description of the Input Variables

  • name: Name of the operation.
  • targetName: Name of the target.
  • targetType: Refer to CLI Command Inputs Based on Entity Type table.
  • normalCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.
  • privCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.

    These credentials are used to run scripts as root.

  • skipCVUChecks: true|false. Default value is false
  • skipPrereqs: true|false. Default value is false
  • newOracleHomeLoc: <Location where Oracle Home will be created

Attach CDB

Feature Description

Request Method

POST

URI

em/websvcs/restful/emws/db/fleetmaintenance/performOperation/attachcdb

Request Headers

Authorization: basic <generated credential value>

Content-Type: application/json

Payload

 
{
"name": "<Operation name>",
"targetName": "<name of the target>",
"targetType": "<target type>",
"normalCredString": "<credential name>",
"privCredString": "<privileged credential name>",
"dbCredString":"<database credential name>",
"destinationCdb":"<destination CDB name>"
}
Response 
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Attach CDB' created successfully.
Attach CDB operation for target blr123.example.com can be monitored using: 
Browser:
https://blr123.example.com:11111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=4943D8E3626E420EE0530854F10A18A8

Description of the Input Variables

  • name: Name of the operation.
  • targetName: Name of the target.
  • targetType: Refer to CLI Command Inputs Based on Entity Type table.
  • normalCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.
  • privCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.

    These credentials are used to run scripts as root.

  • dbcredstring: Database credential name.
  • destinationCDB: Name of the destination CDB.

Update REST API

Note:

Starting with Enterprise Manager 13.5 Release Update 18 AutoUpgrade will be the default tool used for database upgrades where the database source version is 12.2 or higher. To use AutoUpgrade with REST API it is recommended you use the REST API's located at: Database Maintenance- Updates (Patching) And Upgrades REST Endpoints.

To continue using the legacy REST API's below with AutoUpgrade ensure all AutoUpgrade prerequisites are met. For a complete list of all prerequisites see: Upgrading Databases using AutoUpgrade.

Feature Description

Request Method

POST

URI

em/websvcs/restful/emws/db/fleetmaintenance/performOperation/update

Request Headers

Authorization: basic <generated credential value>

Content-Type: application/json

Payload

 
{
"name": "<Operation name>",
"targetName": "<name of the target>",
"targetType": "<target type>",
"normalCredString": "<credential name>",
"privCredString": "<privileged credential name>"
"nodeList": "<list of nodes>""dgRole":"primary|standby""startupAfterSwitch":"true|false""startupDBAfterSwitch": "true|false"
"skipSwitchDatabase":"true|false""ignoreStandbyPrereq":"true|false"
"description": "<Operation description>",
"startSchedule": "",
"endSchedule": "",
"workingDirectory": "<working directory>",
"dispatcherLocation": "<dispatcher location>",
"skipRemoteHostValidations": "true/false",
"prereqsOnly": "true/false", 
"skipValidations": "<Skip Validations>",
"dpNamePrefix": "<DP name prefix>",
"customPreScriptURN": "<Custom pre script URN>",
"customPostScriptURN": "<Custom post script URN>",
"runPreScriptAsroot": "<Run pre script as root>",
"runPostScriptAsroot": "<Run post script as root>",
"metadataCheckCorrection": "<metadata check correction>",
"force": "true/false",
"skipCVUChecks" : "true/false", 
"skipPrereqs" : "true/false",
"newOracleHomeLoc" : "/scratch/<PATH>/oh19300",
"srcWalletPassword": "<src wallet password>",
"destWalletPassword": "<dest wallet password>",
"windowsCredString": "<Windows credential>",
"isVirtualAccount": "true/false",
"isBuiltinAccount": "true/false",
"skipWinCreds": "true/false",
}
Response 
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Update RAC' created successfully.
Update operation for target blr123.example.com can be monitored using:
Browser:
https://blr123.example.com:11111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=4943D8E3626E420EE0530854F10A18A9

Description of the Input Variables

  • name: Name of the operation
  • targetName: Name of the target
  • targetType: Refer to CLI Command Inputs Based on Entity Type table.
  • normalCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.
  • privCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.

    Note:

    These credentials are used to run scripts as root.
  • nodeList: comma separated list of nodes
  • dgRole: primary|standby
  • startupDBAfterSwitch: The default value is true. It is used for node-wise patching. To leave a database instance down after a cluster instance is patched
  • skipSwitchDatabase: It should be set to ‘true’. It skips the switching of database to patched home since it is already performed in earlier steps.

  • ignoreStandbyPrereq: The default value is false. This disables verification check if the Standby is on the same image version where the Primary is being moved to

  • startupAfterSwitch: For non-rolling patches, it is necessary to bring up the Primary database first from the patched home. It will ensure that Standby is left in shutdown state during the Update operation. Standby will be started in a separate step after Primary is patched and started.

  • description
  • startSchedule
  • endSchedule
  • workingDirectory: Working directory.
  • dispatcherLocation: Location of dispatcher.
  • skipRemoteHostValidations: Skips remote host validations, default value is false
  • prereqsOnly: Prerequisites only, default value is false.
  • skipValidations: Skips validations, default value is false.
  • dpNamePrefix: Deployment procedure name prefix.
  • customPreScriptURN: Custom pre script URN.
  • customPostScriptURN: Custom post script URN.
  • runPreScriptAsroot: Runs pre script as root, default value is false.
  • runPostScriptAsroot: Runs post script as root, default value is false.
  • metadataCheckCorrection: Performs metadata check correction, true or false.
  • force: Forces execution, deafult value is false.
  • skipCVUChecks : Skips performing cluster validation checks, default value is false.
  • skipPrereqs : Skips performing prerequisites, default value is false.
  • newOracleHomeLoc: Path for new Oracle Home.
  • srcWalletPassword: Source database wallet password, only for TDE enabled databases.
  • destWalletPassword: Destination database wallet password, onle for TDE enabled databases.
  • windowsCredString: Windows credential, only for Windows deployments.
  • isVirtualAccount: Virtual account, default value is false, only for Windows deployments.
  • isBuiltinAccount: Built in account, default value is false, only for Windows deployments.
  • skipWinCreds: Skips windows credentials, default value is false, only for Windows deployments.
  • migrateDatabase: True, required for Non-CDB to PDB migration.
  • nonCdbToPdb: Required true for Non-CDB to PDB migration.
  • migrateType: Value DBCLONE is required for Non-CDB to PDB migration. Default value is dblink.
  • srcWorkDir: Location of source database work directory, required for Non-CDB to PDB migration.
  • destPdbName: Destination PDB name, required for Non-CDB to PDB migration.
  • destCdbCred: Destination CDB credential, required for Non-CDB to PDB migration.
  • destHostCred: Destination Host credential, required for Non-CDB to PDB migration.
  • parallelism: Required for Non-CDB to PDB migration. Acceptable values are true or false.

Update PDB

Feature Description

Request Method

POST

URI

em/websvcs/restful/emws/db/fleetmaintenance/performOperation/updatepdb

Request Headers

Authorization: basic <generated credential value>

Content-Type: application/json

Payload

 
{
"name": "<Operation name>",
"targetName": "<name of the PDB target>",
"targetType": "oracle_pdb"
"normalCredString ": "<credential name>",
"privCredString": "<privileged credential name>",
"dbCredString":"<database credential name>",
"destinationCDBName":"<destination CDB name>"
"force" : "<true|false>" 
}
Response 
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Update PDB' created successfully.
Update PDB operation for target blr123.example.com can be monitored using: 
Browser:
https://blr123.example.com:11111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=4943D8E3626E420EE0530854F10A18A8

Description of the Input Variables

  • name: Name of the operation.
  • targetName: Name of the target.
  • targetType: Refer to CLI Command Inputs Based on Entity Type table.
  • normalCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.
  • privCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.

    These credentials are used to run scripts as root.

  • dbcredString: Database credential name.
  • destinationCDB: Name of the destination CDB. Required only for emergency patching.
  • force: Forces deploy operation to occur, this parameter is only for emergency patching.

Upgrade PDB

Feature Description

Request Method

POST

URI

em/websvcs/restful/emws/db/fleetmaintenance/performOperation/upgradepdb

Request Headers

Authorization: basic <generated credential value>

Content-Type: application/json

Payload

 
{
"name": "<Operation name>",
"targetList": "<list of PDB targets>",
"targetType": "oracle_pdb"
"normalCredString": "<credential name>",
"privCredString": "<privileged credential name>",
"dbCredString":"<database credential name>"
}
Response 
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Upgrade PDB' created successfully.
Upgrade PDB operation for target blr123.example.com can be monitored using: 
Browser:
https://blr123.example.com:11111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=4943D8E3626E420EE0530854F10A18A8

Description of the Input Variables

  • name: Name of the operation.
  • targetList: List of PDB targets to be upgraded.
  • targetType: Refer to CLI Command Inputs Based on Entity Type table.
  • normalCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.
  • privCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.

    These credentials are used to run scripts as root.

  • dbcredstring: Database credential name.

Rollback

Feature Description

Request Method

POST

URI

em/websvcs/restful/emws/db/fleetmaintenance/performOperation/rollback

Request Headers

Authorization: basic <generated credential value>

Content-Type: application/json

Payload

 
{
"name": "<Operation name>",
"targetName": "<name of the target>",
"targetType": "<target type>",
"normalCredString": "<credential name>",
"privCredString": "<privileged credential name>"
"nodeList": "<list of nodes>"
"dgRole":"primary|standby"
"startupAfterSwitch":"true|false"
"startupDBAfterSwitch": "true|false"
"skipSwitchDatabase":"true|false"
"ignoreStandbyPrereq":"true|false"
}
Response 
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Rollback' created successfully.
Rollback operation for target blr123.example.com can be monitored using:
Browser:
https://blr123.example.com:11111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=4943D8E3626E420EE0530854F10A18A9

Description of the Input Variables

  • name: Name of the operation
  • targetName: Name of the target
  • targetType: Refer to CLI Command Inputs Based on Entity Type table.
  • normalCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.
  • privCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.

    Note:

    These credentials are used to run scripts as root.
  • nodeList: comma separated list of nodes
  • dgRole: primary|standby
  • startupDBAfterSwitch: The default value is true. It is used for node-wise patching. To leave a database instance down after a cluster instance is patched
  • skipSwitchDatabase: It should be set to ‘true’. It skips the switching of database to patched home since it is already performed in earlier steps.

  • ignoreStandbyPrereq: The default value is false. This disables verification check if the Standby is on the same image version where the Primary is being moved to

  • startupAfterSwitch: For non-rolling patches, it is necessary to bring up the Primary database first from the patched home. It will ensure that Standby is left in shutdown state during the Update operation. Standby will be started in a separate step after Primary is patched and started.

Rollback PDB

Feature Description

Request Method

POST

URI

em/websvcs/restful/emws/db/fleetmaintenance/performOperation/rollbackpdb

Request Headers

Authorization: basic <generated credential value>

Content-Type: application/json

Payload

 
{
"name": "<Operation name>",
"targetName": "<name of the PDB target>",
"targetType": "oracle_pdb"
"normalCredString": "<credential name>",
"privCredString": "<privileged credential name>",
"dbCredString":"<database credential name>",
}
Response 
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Rollback PDB' created successfully.
Rollback PDB operation for target blr123.example.com can be monitored using: 
Browser:
https://blr123.example.com:11111/em/faces/core-jobs-procedureExecutionTracking?executionGUID=4943D8E3626E420EE0530854F10A18A8

Description of the Input Variables

  • name: Name of the operation.
  • targetName: Name of the target.
  • targetType: Refer to CLI Command Inputs Based on Entity Type table.
  • normalCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.
  • privCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.

    These credentials are used to run scripts as root.

  • dbcredString: Database credential name.

Cleanup CDB and Home

Feature Description

Request Method

POST

URI

em/websvcs/restful/emws/db/fleetmaintenance/performOperation/cleanup

Request Headers

Authorization: basic <generated credential value>

Content-Type: application/json

Payload

 
{
"name": "Cleanup CDB and Homes",
"targetName" : "<PDB name or CDB name>",
"targetType" : "oracle_pdb or oracle_database/rac_database",
"normalCredString" : "<cred_name:cred_owner>",
"privCredString" : "<root_cred_name:cred_owner>",
“dbCredString”: ”<db_cred_name:cred_owner>”,
“reportOnly”:”false”,
“workDir”:”<working directory>”
}
Response 
{   
       "reportOnly":"false",  
      "cleanupCdbStatus":null,   "cdbCleanupInformation":null,  
      "noOfIneligibleCdbs":0,   "noOfEligibleCdbs":1,  
      "ineligibelCdbList":null,   "eligibelCdbList":
      [     
      {        
      "cdbGuid":"1C4326CE633CF0E43162510F17046ABA",        
      "cdbName":"database",         
      "hostName":"example580.subnetsample.example.com",        
      "homeLocation":"/scratch/<Oracle Home location>/obase/dbhome",        
      "noOfAssociatedPdbs":"0"     
      }   
       ],  
      "homeCleanupInformation":"The given ineligible Oracle homes CANNOT BE  DELETED Because of
      the below reason(s).\n One or more instances are  running on the Oracle home. In that case, it
      is strongly recommended to  update the databases to the newer version before
      Cleanup.",   
      "noOfIneligibleOracleHomes":1,  
      "noOfEligibleOracleHomes":0,   
       "ineligibelOracleHomeList":[     
      {         
        "hostName":"example580.subnetsample.example.com",        
      "homeLocation":"/scratch/<Oracle Home Location>/obase/dbhome",        
      "targetName":"OraDB18Home1_example580.subnetsample.example.com_9550",        
      "noOfAssociatedTargets":"1"      }   ],  
      "eligibeOracleHomeList":null,   "dpSubmissionStatus":"Submitted",  
      "dpName":null,   "executionGuid":"CBFADE41EE556DC1E053651A4B640588",  
      "procedureExecutionUrl":
    "Browser:\n  https://example580.subnetsample.example.com:6023/em/faces/core-jobs-procedureExecutionTracking?executionGUID=CBFADE41EE556DC1E053651A4B640588\n"}

Description of the Input Variables

  • name: Name of the operation.
  • targetName: Name of the target.
  • targetType: Refer to CLI Command Inputs Based on Entity Type table.
  • normalCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.
  • privCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.

    These credentials are used to run scripts as root.

  • reportOnly: If set to true, it will print a report of CDB's and Homes available for cleanup. Set to false to execute cleanup.
  • workDir: Working directory for CDB or Home to be cleaned up.

Redeploy Oracle Home

Feature Description
Request Method POST
URI em/websvcs/restful/emws/db/fleetmaintenance/performOperation/cleanup_software
Request Header Authorization: basic <generated credential value>

Content-Type: application/json
Payload 
{   
"name": "<Operation name>", 
"targetList": "<List of targets to be cleaned up>",
"targetType": "<target type>", 
"normalCredString": "<credentialname>", 
"privCredString": "<privileged credential name>"
"reportOnly":"<true/false>",   
"workdir":"<Working directory of use>",  
"force":"true/false" 
}
Response 
No. 1 Host host1.example.com 
Oracle Home /home/user/app/oracle/product/19.0.0 
Target List OraDB19Home2_2_6303 
No. of associated targets 0
Checking image subscription... Check image subscription passed. 
Checking if target is in non-default location inside the Oracle Home... 
Operation 'cleanup_software' created successfully. Cleanup Operation can be monitored

Description of Input Variables

  • name: Name of the operation
  • targetName: Name of the target
  • targetType: Refer to CLI Command Inputs Based on Entity Type table.
  • normalCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed.
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential.
  • privCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential

    Note:

    These credentials are used to run scripts as root.
  • reportOnly: Will only report whether the detected Oracle Homes can be cleaned up and the number of active targets associated
  • workdir: The working directory to use for the operation
  • force: Forces the cleanup in case an extra non-discovered target is found running in the Oracle Home

Cleanup

Feature Description
Request Method POST
URI em/websvcs/restful/emws/db/fleetmaintenance/performOperation/cleanup_software
Request Header Authorization: basic <generated credential value>

Content-Type: application/json
Payload 
{   
"name": "<Operation name>", 
"targetList": "<List of targets to be cleaned up>",
"targetType": "<target type>", 
"normalCredString": "<credentialname>", 
"privCredString": "<privileged credential name>"  
"workdir":"<Working directory of use>", 
"isRedeploy":"true" 
}
Response 
No. 1 Host host1.example.com 
Oracle Home /home/user/app/oracle/product/19.0.0 
Target List OraDB19Home2_2_6303 
No. of associated targets 0
Checking image subscription... Check image subscription passed. 
Checking if target is in non-default location inside the Oracle Home... 
Operation 'Redeploy_home' created successfully. Redeploy Operation can be monitored

Description of Input Variables

  • name: Name of the operation
  • targetName: Name of the target
  • targetType: Refer to CLI Command Inputs Based on Entity Type table
  • normalCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential
  • privCredString: This must be entered in the format <Named Credential: Credential Owner> where:
    • <Named Credential>: Named credential for the host where new Oracle home will be deployed
    • <Credential Owner>: The Enterprise Manager user who owns this Named Credential

    Note:

    These credentials are used to run scripts as root.
  • isRedeploy: Allows corrupt Oracle Homes to be redeployed
  • workdir: The working directory to use for the operation