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. Dataguard REST APIs

Dataguard REST APIs

REST API for Enterprise Manager environments using Dataguard

Dataguard Patching Rolling Mode

Table 18-3 Dataguard Patching Standby in Rolling Mode

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

Content-Type: application/json
Payload 
{
"name" : "standby_db_update",
"targetName" : "<STANDBYDB_NAME>",
"targetType":"<TARGET_TYPE>",
"normalCredString":"<NORMAL_CRED>",
"privCredString" : "<PRIV_CRED>",
"databaseCredString": "<DB_CRED>",
"dgRole":"standby",
"disableDG":"true", 
"standbyStartOption":"<MOUNT|READ ONLY WITH APPLY>",
"workingDirectory":"<WORK_DIR>"
}

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.

  • databaseCredString: 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.
  • dgRole: Dataguard role, for this sample it is set to "standby".
  • disableDG: Disable Dataguard, for this sample it is set to "true".
  • standbyStartOption: Instructs the type of standby start option, values can be "MOUNT" or "READ ONLY WITH APPLY".
  • workingDirectory: Name of temporary directory.

Table 18-4 Dataguard Patching Primary in Rolling Mode

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

Content-Type: application/json
Payload 
{
"name": "primary_db_update",
"targetName": “<PRIMARYDB_NAME>",
"targetType": "<TARGET_TYPE>",
"normalCredString": "<NORMAL_CRED>",
"privCredString": "<PRIV_CRED>",
"databaseCredString": "<DB_CRED>",
"dgRole":"primary",
"enableDG":"true",
"enableFSFO":"<true/false>"
"workingDirectory":"<WORK_DIR>"
}

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.

  • databaseCredString: 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.
  • dgRole: Dataguard role, for this sample it is set to "standby".
  • enableDG: Enables Dataguard, for this sample it is set to "true".
  • enableFSFO: Enables Fast Start Failover.
  • workingDirectory: Name of temporary directory.

Dataguard Patching Non Rolling Mode

Table 18-5 Dataguard Patching Standby in Non Rolling Mode

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

Content-Type: application/json
Payload 
{
"name": "standby_db_update",
"targetName" : "<STANDBYDB_NAME>",
"targetType":"<TARGET_TYPE>",
"normalCredString":"<NORMAL_CRED>",
"privCredString" : "<PRIV_CRED>",
"dbCredString":"<DB_CRED>",
"dgRole":"standby", 
"disableDG":"true", 
"startupAfterSwitch":"false", 
"workingDirectory":"<WORK_DIR>"
}

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.

  • databaseCredString: 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.
  • dgRole: Dataguard role, for this sample it is set to "standby".
  • disableDG: Disables Dataguard, for this sample it is set to "true".
  • startupAfterSwitch: Enables Fast Start Failover.
  • workingDirectory: Name of temporary directory.

Table 18-6 Dataguard Patching Primary in Non Rolling Mode

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

Content-Type: application/json
Payload 
{
"name" :"primary_db_update",
"targetName" : “<PRIMARYDB_NAME>",
"targetType":"<TARGET_TYPE>",
"normalCredString":<$NORMAL_CRED>",
"privCredString": "<PRIV_CRED>",
"dbCredString": "<DB_CRED>",
"dgRole":"primary",
 "rolling":"false",  
"workingDirectory":"<WORK_DIR>"
}

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.

  • databaseCredString: 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.
  • dgRole: Dataguard role, for this sample it is set to "standby".
  • rolling: Whether rolling patches are applied or not.
  • workingDirectory: Name of temporary directory.

Table 18-7 Dataguard Patching Starting Standby Database Non Rolling Mode

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

Content-Type: application/json
Payload 
{"name" : "standby_db_update",
"targetName" : "<STANDBYDB_NAME>",
"targetType":"<TARGET_TYPE>",
"normalCredString":"<NORMAL_CRED>",
"privCredString" : "<PRIV_CRED>",
"dbCredString":"<DB_CRED>",
"dgRole":"standby", 
"enableDG":"true", 
"enableFSFO":"<true/false>"
"startupDatabase":"true", 
"skipSwitchDatabase":"true",
"primaryDbHostCreds":"<PRIMARY_DB_CRED>", 
"standbyStartOption":"<MOUNT|READ ONLY WITH
    APPLY>",
"workingDirectory":"<WORK_DIR>"
}

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.

  • databaseCredString: 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.
  • primaryDbHostCreds: 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.
  • dgRole: Dataguard role, for this sample it is set to "standby".
  • enableDG: Enable Dataguard, for this sample it is set to "true".
  • enableFSFO: Enables Fast Start Failover.
  • standbyStartOption: Instructs the type of standby start option, values can be "MOUNT" or "READ ONLY WITH APPLY".
  • skipSwitchDatabase: Select whether to skip database switching.
  • workingDirectory: Name of temporary directory.