Loading...

REST API - POST Onboard Subclient

This operation onboards a subclient based on the subclient ID.

Onboarding includes the following operations:

  • Determines whether the client has a client owner. If the client already has an owner, you cannot onboard the client.
  • Assigns the specified role to the user and add the user as the owner of the client.
  • Searches for a server plan that matches the specified recovery point objectives (RPOs) and storage pool settings:
    • If a matching server plan is found, assigns the plan to the subclient.
    • If no matching server plan is found, creates a new server plan and assign the plan to the subclient.
  • Enables backup on the subclient. The subclient content is backed up based on the schedules that are defined in the server plan.

Request

Syntax

Send the request using either the ID or the name:

  • Name

    POST <webservice>/Subclient/byName(clientName='{clientName}',appName='{ApplicationName}',instanceName='{instanceName}',backupsetName='{backupsetName}',subclientName='{subclientName}')/Onboard HTTP/1.1
    Host: <host name>
    Accept: application/json
    Authtoken: <authentication token>
    Content-type: application/json

    <onboard subclient template json>

  • ID

    POST <webservice>/Subclient/{subclientId}/Onboard HTTP/1.1
    Host: <host name>
    Accept: application/json
    Authtoken: <authentication token>
    Content-type: application/json

    <onboard subclient template json>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

subclientId

The subclient ID for the subclient. If the subclient ID is not known, use the GET Subclient API to retrieve it.

Yes-for the request by ID

clientName

The client name for the subclient. If the client name is not known, use the GET Subclient API to retrieve it.

Yes-for the request by name

appName

The application name for the subclient. If the application name is not known, use the GET Subclient API to retrieve it.

Yes-for the request by name

instanceName

The instance name for the subclient. If the backup set name is not known, use the GET Subclient API to retrieve it.

Yes-for the request by name

backupsetName

The backup set name of the subclient. If the backup set name is not known, use the GET Subclient API to retrieve it.

Yes-for the request by name

subclientName

The subclient name of the subclient. If the subclient name is not known, use the GET Subclient API to retrieve it.

Yes-for the request by name

Request Headers

Name

Description

Host

The host name of the Web Server or the Web Console that is used in the API request.

Accept

The format of the response. Valid values are: application/xml.

Authtoken

The authentication token that is received after successfully logging on. For details on information about receiving an authentication token, see Authentication.

Content-type

The media type contained in the request body.

Request Body

Download the onboard_subclient_template.json file that is required for this request. The following table displays the parameters for the onboard_subclient_template.json file.

Parameter

Description

Parent Element

roleId

The system-generated ID of the role name that you want to assign to the user you plan to onboard.

role

roleName

The role name that you want to assign to the user you plan to onboard.

role

userId

The system-generated ID of the user you want to onboard.

To retrieve the ID of all the users, see REST API - GET User.

user

userName

The domain/username that you want to onboard. The user is assigned as the client owner on the client.

user

day

The value for the day when you want backups to run. You can have a value ranging from 0 to 6 that represents the days of the week.

cycleDay

startTime

The time when you want backups to start.

time

endTime

The end time for the backups.

time

StoragePool

The name of the storage pool that you want to assign to the subclient.

Api_OnboardSubclientReq

serviceLevel

The service level denotes the RPO in minutes. Valid values are:

  • Economy - 1440 minutes
  • Standard - 480 minutes
  • Premium - 240 minutes

    The server plan with RPO settings that match the service plan is assigned to the subclient.

Api_OnboardSubclientReq

ForceReplace

Mandatory tag that specifies if you can overwrite the settings for the subclient. Set the value to True to apply the settings.

Api_OnboardSubclientReq

Response

Response Parameters

Parameter

Description

Element

userId

The system-generated ID of the user who is assigned as the client owner.

entity

subclientName

The name of the file system subclient that you onboarded.

entity

userName

The domain/username of the user who is assigned as the client owner.

entity

Examples

Example Request

POST Subclient/byName(clientName='vsaqa.company.com',appName='Virtual Server',instanceName='VMware',backupsetName='vsphere.local',subclientName='Gold')/Onboard
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json

{  
   "StoragePool":"SPool2-cs",
   "serviceLevel":480,
   "ForceReplace":true,
   "role":{  
      "roleName":"Client Admins"
   },
   "CycleDay":[  
      {  
         "day":5,
         "time":[  
            {  
               "startTime":"12PM",
               "endTime":"12AM"
            }
         ]
      },
      {  
         "day":2,
         "time":[  
            {  
               "startTime":"3AM",
               "endTime":"5PM"
            }
         ]
      }
   ],
   "user":{  
      "userName":"TestOrg\\user1"
   }
}

Example Response

{  
   "errorMessage":"OnBoarding Subclient is successful",
   "errorCode":0,
   "entity":{  
      "subclientId":20,
      "userId":1,
      "subclientName":"Gold",
      "userName":"TestOrg\\user1"
   }
}

Last modified: 9/2/2020 9:06:37 PM