Skip to main content

Add Subclient to a DB2 MultiNode Backupset​

This operation is used to add a new subclient to a DB2 MultiNode Instance Backupset

Request Body
  • subClientProperties object required
  • subClientEntity object required
  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer required

    Id of the backupset under which subclient needs to be added

  • _type_ string
  • instanceId integer required

    ID of the instance under which backupset is present

  • backupsetGUID string
  • clientId integer required

    ID of the DB2 MultiNode Pseudo Client

  • appName string
  • backupsetName string
  • applicationId integer required

    Possible values: [103]

    Application ID of DB2 MultiNode is 103

  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • subclientId integer
  • subclientName string required

    Name of the subclient to be created

  • commonProperties object
  • planEntity object required
  • planId integer required

    Pass the ID of plan that needs to get associated to the subclient

  • contentOperationType integer required

    2 to add a subclient

  • db2SubclientProp object required

    pass the properties of subclient in this object

  • db2BackupData boolean required

    True if data backup is enabled for the subclient

  • db2BackupMode integer required

    0 for online database and 1 for offline database

  • db2BackupLogFiles boolean required

    True if log backup is enabled for the subclient

  • db2DeleteLogFilesAfter boolean required

    True if log files should be deleted from archive path post log backup

  • skipLogsInBackupImage integer required

    0 if you dont want to include logs in backup image , 1 to include logs in backup image

  • db2UseDedupeDevice boolean
  • numberOfBackupStreams integer required

    Total numbers of streams that should be used

  • db2DpfStreams string required

    Streams for each Node

  • db2BackupType integer

    1 in case of using subset option

  • content object[]

    pass this object if you want to create subclient with subset of tablespaces

  • db2Content object required

    pass the tablespace inside this object

  • db2TableSpace string required

    Table space name

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • subclientId integer
  • _type_ integer
POST /subclient

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "subClientProperties": {

    "subClientEntity": {

      "clientName": "string",

      "instanceName": "string",

      "displayName": "string",

      "backupsetId": 0,

      "_type_": "string",

      "instanceId": 0,

      "backupsetGUID": "string",

      "clientId": 0,

      "appName": "string",

      "backupsetName": "string",

      "applicationId": 103,

      "entityInfo": {

        "companyId": 0,

        "companyName": "string",

        "multiCommcellId": 0

      },

      "subclientId": 0,

      "subclientName": "string"

    },

    "commonProperties": {},

    "planEntity": {

      "planId": 0

    },

    "contentOperationType": 0,

    "db2SubclientProp": {

      "db2BackupData": true,

      "db2BackupMode": 0,

      "db2BackupLogFiles": true,

      "db2DeleteLogFilesAfter": true,

      "skipLogsInBackupImage": 0,

      "db2UseDedupeDevice": true,

      "numberOfBackupStreams": 0,

      "db2DpfStreams": "string",

      "db2BackupType": 0

    },

    "content": [

      {

        "db2Content": {

          "db2TableSpace": "string"

        }

      }

    ]

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Subclient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "subClientEntity": {
      "clientName": "string",
      "instanceName": "string",
      "displayName": "string",
      "backupsetId": 0,
      "_type_": "string",
      "instanceId": 0,
      "backupsetGUID": "string",
      "clientId": 0,
      "appName": "string",
      "backupsetName": "string",
      "applicationId": 103,
      "entityInfo": {
        "companyId": 0,
        "companyName": "string",
        "multiCommcellId": 0
      },
      "subclientId": 0,
      "subclientName": "string"
    },
    "commonProperties": {},
    "planEntity": {
      "planId": 0
    },
    "contentOperationType": 0,
    "db2SubclientProp": {
      "db2BackupData": true,
      "db2BackupMode": 0,
      "db2BackupLogFiles": true,
      "db2DeleteLogFilesAfter": true,
      "skipLogsInBackupImage": 0,
      "db2UseDedupeDevice": true,
      "numberOfBackupStreams": 0,
      "db2DpfStreams": "string",
      "db2BackupType": 0
    },
    "content": [
      {
        "db2Content": {
          "db2TableSpace": "string"
        }
      }
    ]
  }
}'