Skip to main content

Modify RAC subclient​

Select

SaaS
Customer Managed

This operation is used to modify RAC subclient properties

Path Parameters
  • subclientids string required
  • subclientid string required
Request Body
  • subClientProperties object

    Set oracleRAC subclient options

  • planEntity object
  • planName string

    Plan name

  • planId integer
  • oracleSubclientProp object
  • selectiveOnlineFull boolean

    Set to true to enable selective online full backups

  • data boolean

    Set to true if data is to be backed up

  • backupMode string

    Possible values: [ONLINE_DB, ONLINE_SUBSET_DB, OFFLINE_DB]

    Select backupmode for the subclient.

  • lightsOutScript boolean

    Set to true if the backupmode is OFFLINE_DB

  • enableTableBrowse boolean

    Enable this option to collect table metadata during backups

  • backupArchiveLog boolean

    Set this to true to backup Oracle archive logs

  • archiveDelete boolean

    Set this to true to delete backed up archivelogs

  • archiveDeleteAll boolean
  • dataFilesPerBFS integer

    Oracle Filesperset parameter for datafiles

  • maxBackupSetSizeInKB integer

    Oracle Maxset size parameter

  • archiveFilesPerBFS integer

    Oracle filesperset parameter for archivelogs

  • maxOpenFiles integer

    Number of files that can be read by a stream simultaneuously

  • dataThresholdStreams integer

    Number of data streams

  • sectionSizeInKB integer

    Oracle section size parameter to create multi-section backup

  • snapImageCopy boolean

    Set this to true to enable RMAN image copy

  • imageCopyDir string

    Enter directory to save image copy

  • oracleDataBackupStreams object[]

    Streams for oracle data backups

  • streamInstanceName string

    Instance name of the oracle RAC

  • streamNumber integer

    Number of streams for Data

  • priority integer
  • instanceId integer

    Instance id of the RAC instance

  • oracleLogBackupStreams object[]

    Streams for oracle log backups

  • streamInstanceName string

    Instance name of the oracle RAC

  • streamNumber integer

    Number of streams for log backup

  • priority integer
  • instanceId integer

    Instance id of the RAC instance

  • commonProperties object
  • snapCopyInfo object

    Use this object to enable and set snashop options

  • isSnapBackupEnabled boolean

    Set to true to enable Snap backups

  • snapToTapeSelectedEngine object
  • snapShotEngineId integer

    Select snapshot engine Id.

  • snapShotEngineName string

    Select Snapshot engine name.

  • snapToTapeProxyToUse object

    Select proxy for snap operations

  • clientId integer

    Proxy client Id for snap operations.

  • clientName string

    Proxy client name for snap operations

  • useSeparateProxyForSnapToTape boolean

    Set this to true this if you want to use a proxy for backup copy.

  • backupCopyInterface string

    Possible values: [RMAN, FILE_SYSTEM, VOLUME_COPY]

    Select backup copy interface

  • separateProxyForSnapToTape object

    This object is used to set proxy options for backup copy

  • clientId integer

    Client id of proxy to be used for backup copy

  • clientName string

    Client name of proxy to be used for backup copy

  • subClientEntity object
  • clientName string

    pseudo client name

  • instanceName string
  • displayName string
  • backupsetId integer
  • _type_ integer
  • commCellName string
  • instanceId integer
  • csGUID string
  • subclientGUID string
  • subclientId integer
  • clientId integer
  • appName string
  • backupsetName string
  • applicationId integer
  • subclientName string
  • entityInfo object
  • companyId integer
  • companyName string
Responses

OK

POST /subclient/:subclientid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/commandcenter/api
token
subclientids — path required
subclientid — path required
Body
{

  "subClientProperties": {

    "planEntity": {

      "planName": "string",

      "planId": 0

    },

    "oracleSubclientProp": {

      "selectiveOnlineFull": true,

      "data": true,

      "backupMode": "ONLINE_DB",

      "lightsOutScript": true,

      "enableTableBrowse": true,

      "backupArchiveLog": true,

      "archiveDelete": true,

      "archiveDeleteAll": true,

      "dataFilesPerBFS": 0,

      "maxBackupSetSizeInKB": 0,

      "archiveFilesPerBFS": 0,

      "maxOpenFiles": 0,

      "dataThresholdStreams": 0,

      "sectionSizeInKB": 0,

      "snapImageCopy": true,

      "imageCopyDir": "string",

      "oracleDataBackupStreams": [

        {

          "streamInstanceName": "string",

          "streamNumber": 0,

          "priority": 0,

          "instanceId": 0

        }

      ],

      "oracleLogBackupStreams": [

        {

          "streamInstanceName": "string",

          "streamNumber": 0,

          "priority": 0,

          "instanceId": 0

        }

      ]

    },

    "commonProperties": {

      "snapCopyInfo": {

        "isSnapBackupEnabled": true,

        "snapToTapeSelectedEngine": {

          "snapShotEngineId": 0,

          "snapShotEngineName": "string"

        },

        "snapToTapeProxyToUse": {

          "clientId": 0,

          "clientName": "string"

        },

        "useSeparateProxyForSnapToTape": true,

        "backupCopyInterface": "RMAN",

        "separateProxyForSnapToTape": {

          "clientId": 0,

          "clientName": "string"

        }

      },

      "subClientEntity": {

        "clientName": "string",

        "instanceName": "string",

        "displayName": "string",

        "backupsetId": 0,

        "_type_": 0,

        "commCellName": "string",

        "instanceId": 0,

        "csGUID": "string",

        "subclientGUID": "string",

        "subclientId": 0,

        "clientId": 0,

        "appName": "string",

        "backupsetName": "string",

        "applicationId": 0,

        "subclientName": "string",

        "entityInfo": {

          "companyId": 0,

          "companyName": "string"

        }

      }

    }

  }

}

curl -L -X POST 'https://localhost/commandcenter/api/subclient/:subclientid' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "planEntity": {
      "planName": "string",
      "planId": 0
    },
    "oracleSubclientProp": {
      "selectiveOnlineFull": true,
      "data": true,
      "backupMode": "ONLINE_DB",
      "lightsOutScript": true,
      "enableTableBrowse": true,
      "backupArchiveLog": true,
      "archiveDelete": true,
      "archiveDeleteAll": true,
      "dataFilesPerBFS": 0,
      "maxBackupSetSizeInKB": 0,
      "archiveFilesPerBFS": 0,
      "maxOpenFiles": 0,
      "dataThresholdStreams": 0,
      "sectionSizeInKB": 0,
      "snapImageCopy": true,
      "imageCopyDir": "string",
      "oracleDataBackupStreams": [
        {
          "streamInstanceName": "string",
          "streamNumber": 0,
          "priority": 0,
          "instanceId": 0
        }
      ],
      "oracleLogBackupStreams": [
        {
          "streamInstanceName": "string",
          "streamNumber": 0,
          "priority": 0,
          "instanceId": 0
        }
      ]
    },
    "commonProperties": {
      "snapCopyInfo": {
        "isSnapBackupEnabled": true,
        "snapToTapeSelectedEngine": {
          "snapShotEngineId": 0,
          "snapShotEngineName": "string"
        },
        "snapToTapeProxyToUse": {
          "clientId": 0,
          "clientName": "string"
        },
        "useSeparateProxyForSnapToTape": true,
        "backupCopyInterface": "RMAN",
        "separateProxyForSnapToTape": {
          "clientId": 0,
          "clientName": "string"
        }
      },
      "subClientEntity": {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string"
        }
      }
    }
  }
}'