Modify Backup Set Properties By Name

Select

SaaS

Customer Managed

This operation updates the properties associated with a backup set.

Path Parameters

ClientName string required
Name of the client computer
BackupsetName string required
Name of the backupset
AppName string required
Name of the application

application/json

Request Body

backupsetProperties object
backupsetSecurity object
clientOwners string[]
The name of the client owners.
associatedUserGroups object[]
userGroupName string
The name of the user group associated with the backup se
ownerCapabilities object
The capabilities of the client computer owners associated with the backup set
fsBackupSet object
useChangeJournal boolean
The option to backup all of the new or changed data since the last incremental or full backup, ignoring any differential backups performed prior to the current backup.
useArchiveBit boolean
The option to check whether files are considered modified and therefore backed up based on either the state of the archive bit or the file modification time.
flrRepSetName string
preserveFileAccessTimes boolean
The option to prevent the file access time from being changed as a result of running data protection operations.
netAppImageBackup boolean
useDCserviceForScan boolean
The option to maintain a separate database to track changes in the files. Use this option when scanning a large number of files and folders for the backup.
commonBackupSet object
dataMigratorILMCLASS boolean
newBackupSetName string
The new name of the backup set if it has to be u
onDemandBackupset boolean
The option to set the backup set as an on demand backup set.
isDeleted boolean
The option to delete the backup set.
isFanInBackupSet boolean
decompressData boolean
The option to decompress data that is in a compressed format on the backup media
isNasTurboBackupSet boolean
The option to use the backup set for a NAS turbo restore
isWildCardContentBackupSet boolean
The option for the backup set to support wildcards
cDRFSDMBackupset boolean
Internal
userDescription string
The description of the backup set.
isDedupBackupset boolean
isMyBackupSet boolean
The option to use the backup set for my backup set
siloCopyId integer
The system-generated ID assigned to the silo copy
isDefaultBackupSet boolean
The option to set the backup set as the default backup set.
isHidden boolean
The option to set the backup set storage policy as hidden
isMining boolean
associatedsubclientPolicyName string
isUSeDCForBackup boolean
backupSetEntity object required
clientName string required
The name of the client.
instanceName string required
The name of the instance, for example: DefaultInstanceName.
appName string required
Possible values: [DB2, DB2 on UNIX, Exchange Database, File System, MySQL, NAS, Notes Database, Oracle, Oracle RAC, PostgreSQL, SAP for MAX DB, SAP for Oracle, SQL Server, Sybase Database, Virtual Server]
The name of the application.
backupsetName string required
The name of the backup set.
planEntity object
Associate to plan
planId integer
Plan ID
planName string
Plan Name

Responses

application/json

Schema
Example (from schema)
P O S T Backup Set Properties - Setting the backupset name to default Backup Set

Schema

processinginstructioninfo object
attributes object[]
name string
value string
response object[]
errorCode integer
entity object
srmReportSet integer
type integer
applicationId integer
backupsetId integer
srmReportType integer
clientSidePackage boolean
clientId integer
_type_ integer
consumeLicense boolean

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0,
      "entity": {
        "srmReportSet": 0,
        "type": 0,
        "applicationId": 0,
        "backupsetId": 0,
        "srmReportType": 0,
        "clientSidePackage": true,
        "clientId": 0,
        "_type_": 0,
        "consumeLicense": true
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0,
      "entity": {
        "srmReportSet": 0,
        "type": 0,
        "applicationId": 33,
        "backupsetId": 3,
        "srmReportType": 0,
        "clientSidePackage": true,
        "clientId": 2,
        "_type_": 0,
        "consumeLicense": true
      }
    }
  ]
}

POST /Backupset/byName(clientName=':ClientName',appName=':AppName',backupsetName=':BackupsetName')

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

ClientName — path required

BackupsetName — path required

AppName — path required

Body

Default
Update Backup Set name
POST BackupSet Properties - Setting the backupset name to defaultBackupSet
Backup Set Properties - Associate To Plan

{
  "backupsetProperties": {
    "backupsetSecurity": {
      "clientOwners": [
        "string"
      ],
      "associatedUserGroups": [
        {
          "userGroupName": "string"
        }
      ],
      "ownerCapabilities": {}
    },
    "fsBackupSet": {
      "useChangeJournal": true,
      "useArchiveBit": true,
      "flrRepSetName": "string",
      "preserveFileAccessTimes": true,
      "netAppImageBackup": true,
      "useDCserviceForScan": true
    },
    "commonBackupSet": {
      "dataMigratorILMCLASS": true,
      "newBackupSetName": "string",
      "onDemandBackupset": true,
      "isDeleted": true,
      "isFanInBackupSet": true,
      "decompressData": true,
      "isNasTurboBackupSet": true,
      "isWildCardContentBackupSet": true,
      "cDRFSDMBackupset": true,
      "userDescription": "string",
      "isDedupBackupset": true,
      "isMyBackupSet": true,
      "siloCopyId": 0,
      "isDefaultBackupSet": true,
      "isHidden": true,
      "isMining": true,
      "associatedsubclientPolicyName": "string",
      "isUSeDCForBackup": true
    },
    "backupSetEntity": {
      "clientName": "string",
      "instanceName": "string",
      "appName": "DB2",
      "backupsetName": "string"
    },
    "planEntity": {
      "planId": 0,
      "planName": "string"
    }
  }
}

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

Modify Backup Set Properties By Name​

Authorization

Request

Modify Backup Set Properties By Name