Skip to main content

Modify Sybase Subclient​

Select

SaaS
Customer Managed

This operation modifies the subclient properties for a given subclient

Path Parameters
  • subclientId string required

    ID of the subclient

Request Body
  • subClientProperties object
  • planEntity object
  • entityInfo object
  • companyId string

    ID of the company being used

  • companyName string

    Name of the company being used

  • planId string

    ID of the plan to be assigned

  • planName string

    Name of the plan to be assigned

  • commonProperties object
  • snapCopyInfo object
  • snapToTapeProxyToUse object
  • clientId integer

    ID of the client to be used as access node for Backup copy

  • clientName string

    Name of the client to be used as access node for backup copy

  • snapToTapeSelectedEngine object
  • snapShotEngineId integer

    ID of the snapshot engine to be used

  • snapShotEngineName string

    Name of the snapshot engine to be used

  • isSnapBackupEnabled boolean
  • useSeparateProxyForSnapToTape boolean
  • prepostProcess object
  • preBackupCommand string

    path for the command to run before backup

  • postBackupCommand string

    path for the command to run post backup is completed

  • runPostScan string
  • runPostBackup string
  • runAs string

    Run command as "USE_LOCAL_SYS_ADMIN" or "USE_IMPERSONATION"

  • prepostUserName object
  • userName string

    username to run the command as

  • password string

    password for the user

  • content object[]
  • sybaseContent object
  • databaseName string

    name of the database to be included in the subclient backup

  • contentOperationType string

    Default value: OVERWRITE

  • association object
  • entity object[]
  • subclientId integer

    ID of the subclient

  • clientId integer

    ID of the client

  • applicationId integer

    Default value: 5

    Application ID

  • instanceId integer

    ID of the Instance

  • subclientName string

    Name of the subclient

  • entityInfo object
  • companyId integer

    ID of the company

  • companyName string

    Name of the company

  • multiCommcellId integer
  • instanceName string

    Name of the Instance

  • appName string

    Default value: Sybase

    Application Name

  • clientName string

    Name of the Client

  • excludeFromSLA boolean

    True if subclient is to be excluded from SLA

  • excludedReason string

    Reason for excluding subclient

Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object[]
  • warningCode integer
  • errorCode integer
  • warningMessage string
POST /subclient/:subclientid

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "subClientProperties": {

    "planEntity": {

      "entityInfo": {

        "companyId": "string",

        "companyName": "string"

      },

      "planId": "string",

      "planName": "string"

    },

    "commonProperties": {

      "snapCopyInfo": {

        "snapToTapeProxyToUse": {

          "clientId": 0,

          "clientName": "string"

        },

        "snapToTapeSelectedEngine": {

          "snapShotEngineId": 0,

          "snapShotEngineName": "string"

        },

        "isSnapBackupEnabled": true,

        "useSeparateProxyForSnapToTape": true

      },

      "prepostProcess": {

        "preBackupCommand": "string",

        "postBackupCommand": "string",

        "runPostScan": "string",

        "runPostBackup": "string",

        "runAs": "string",

        "prepostUserName": {

          "userName": "string",

          "password": "string"

        }

      }

    },

    "content": [

      {

        "sybaseContent": {

          "databaseName": "string"

        }

      }

    ],

    "contentOperationType": "OVERWRITE"

  },

  "association": {

    "entity": [

      {

        "subclientId": 0,

        "clientId": 0,

        "applicationId": 5,

        "instanceId": 0,

        "subclientName": "string",

        "entityInfo": {

          "companyId": 0,

          "companyName": "string",

          "multiCommcellId": 0

        },

        "instanceName": "string",

        "appName": "Sybase",

        "clientName": "string"

      }

    ]

  },

  "excludeFromSLA": true,

  "excludedReason": "string"

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/subclient/:subclientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "subClientProperties": {
    "planEntity": {
      "entityInfo": {
        "companyId": "string",
        "companyName": "string"
      },
      "planId": "string",
      "planName": "string"
    },
    "commonProperties": {
      "snapCopyInfo": {
        "snapToTapeProxyToUse": {
          "clientId": 0,
          "clientName": "string"
        },
        "snapToTapeSelectedEngine": {
          "snapShotEngineId": 0,
          "snapShotEngineName": "string"
        },
        "isSnapBackupEnabled": true,
        "useSeparateProxyForSnapToTape": true
      },
      "prepostProcess": {
        "preBackupCommand": "string",
        "postBackupCommand": "string",
        "runPostScan": "string",
        "runPostBackup": "string",
        "runAs": "string",
        "prepostUserName": {
          "userName": "string",
          "password": "string"
        }
      }
    },
    "content": [
      {
        "sybaseContent": {
          "databaseName": "string"
        }
      }
    ],
    "contentOperationType": "OVERWRITE"
  },
  "association": {
    "entity": [
      {
        "subclientId": 0,
        "clientId": 0,
        "applicationId": 5,
        "instanceId": 0,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        },
        "instanceName": "string",
        "appName": "Sybase",
        "clientName": "string"
      }
    ]
  },
  "excludeFromSLA": true,
  "excludedReason": "string"
}'