REST API - POST Install Client Associations

Updated

This operation installs a new Windows or Unix client with all necessary agents and packages, or installs packages with necessary agents on existing Windows or Unix clients. This API allows you to create a pseudoclient, associate a plan, add content, and install packages on a new client or an existing client.

Request

Syntax

POST <webservice>/InstallClient

Host: <host name>

Content-Type: application/json

Accept: application/json

Authtoken: <authentication token>

<install_client_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 Headers

Name

Description

Host

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

Accept

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

Authtoken

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

Content-type

The format of the body of the request. Valid values are: application/xml or application/json.

Request Body

Download the JSON file required for this request: install_client_template.json. The following table displays the parameters for the request body.

Parameters

Description

Elements

registerClient

The flag to register the client.

Valid values are:

  • True

  • False

createPseudoClientRequest

clientInfo

The information of the client.

createPseudoClientRequest

clientType

The type of the client.

Valid values are:

  • 0, Windows

  • 1, Unix

  • 2, NAS

  • 3, Oracle RAC

  • 4, DB2 MultiNode

  • 5, SRM NetWare Server

  • 6, SRM Oracle Database

  • 7, SRM NAS Filer

  • 8, Exchange DAG

  • 9, SAP Archive Link

  • 10, Windows Cluster Client

  • 11, Unix Cluster Client

  • 12, Virtualization

  • 13, OpenVMS

  • 14, Reference Copy

  • 15, Cloud Connector

  • 16, SAP HANA

  • 17, IBM i

  • 18, Non NDMP Filer

  • 19, Edge Drive

  • 20, MSSQL AG

  • 21, Remote Client

  • 22, Mobile Device

  • 23, Windows Tape Import

  • 24, Unix Tape Import

  • 25, Exchange Mailbox

  • 26, Note OnePass

  • 27, SharePoint Farm

  • 28, Distribution File System

  • 29, Distributed Ida

  • 30, User Centric client

  • 31, Exchange client

  • 32, Solr Backup client

  • 33, Oracle Dataguard

  • 35, DB Thin Client

  • 36, Case Manager Client

  • 37, Office 365 Client

  • 38, Azure AD Client

  • 39, VIRTUAL MACHINE CLIENT

  • 40, AZURE SQL CLIENT

  • 41, AMAZON SQL CLIENT

  • 42, DISTRIBUTED SYSTEM CLIENT

clientInfo

planId

The ID of the plan that you want to associate with the client.

plan

plan

The plan that that you want to associate with the client.

clientInfo

fsSubClientProp

The properties of the subclient.

subclientInfo

useGlobalFilters

Indicates whether global filters can be used.

Valid values are:

  • ON

  • OFF

  • USE_CELL_LEVEL_POLICY

fsSubClientProp

backupSystemState

Indicates whether system state backup can be used.

Valid values are:

  • ON

  • OFF

fsSubClientProp

useLocaContent

Indicates whether local content can be used.

Valid values are:

  • True

  • False

subclientInfo

contentOperationType

The type of operation to perform on the content.

Valid values are:

  • 1, ADD

  • 2, OVERRIDE

  • 3, DELETE

subclientInfo

content

The content that is available on the client.

subclientInfo

path

The location of the content.

content

excludePath

The path of the content to exclude from the operations, such as backup and restore.

content

includePath

The path of the content to include from the operations, such as backup and restore.

content

packageId

The ID of the software package.

Valid values are:

  • 1, File System Core

  • 2, Base Seed

  • 20, CommServe

  • 22, CommCell Explorer

  • 23, Workflow Engine

  • 24, CommServe Failover

  • 51, MediaAgent

  • 54, MediaAgent Core

  • 55, Index Store

  • 101, SharePoint iDataAgent

  • 102, Sharepoint Archiver

  • 151, Exchange

  • 152, iDA for Exchange Mailbox

  • 153, iDA for Exchange Public Server

  • 171, ContentStore Mail Server

  • 201, iDA for Domain Database

  • 251, Content Indexing Engine

  • 252, Web Server

  • 257, Search Engine

  • 263, Indexing Server

  • 351, iDA for DB2

  • 352, iDA for Oracle

  • 353, iDA for MSSQL Server

  • 354, SAP on Oracle

  • 355, SAP on MaxDB

  • 453, VSS Provider

  • 554, 1-Touch Recovery

  • 701, Commcell Console

  • 702, File System

  • 1101, UNIX File System

  • 703, iDA for Active Directory

  • 710, Media Explorer

  • 713, VirtualServer Agent

  • 719, Test Automation

  • 726, Command Center

  • 727, Metrics Reporting

  • 732, Cloud Service

  • 734, Office 365

  • 754, CommvaultSDKForPython

  • 801, Commserve DB

  • 808, Workflow Engine DB

  • 809, Metrics Reporting DB

  • 952, MongoDB

packages

packageName

The name of the software package.

packages

userName

The user name of the user who is authorized to run the job.

clientAuthForJob

password

The password for the user name.

clientAuthForJob

clientId

The ID of the client.

entities

clientName

The name of the client

entities

hostName

The host name of the client.

entities

Response

Response Parameters

Parameter

Description

jobId

The ID of the job.

taskId

The system-generated ID assigned for the task.

errorCode

The possible error code.

Valid values are:

  • 0, successful completion.

  • 2, a failure.

  • a specific error code.

Examples

Example Request

This request installs a new client.

POST <webservice>/InstallClient

Host: client.mydomain.com

Accept: application/json

Authtoken: QSDK 3c633bc300b7cbdcf31f918d4ce4934722d620774b81e87e543c517177302b23a0742c0b7e74bd7dc43731ca2b83fe44a43b5fcb24633fab54842eaeb8ddaa6d85674a17692ea6cd559b1d70a4f589552e59c10fc79701debf79d85cda

Content-Type: application/json

{

"rebootClient": false,

"createPseudoClientRequest": {

"registerClient": true,

"clientInfo": {

"clientType": 0,

"plan": {

"planId": 1

},

"subclientInfo": {

"fsSubClientProp": {

"useGlobalFilters": "USE_CELL_LEVEL_POLICY",

"backupSystemState": true

},

"useLocalContent": true,

"contentOperationType": 1,

"content": [

{

"path": "[file://%25Office%25]\\%Office%"

},

{

"path": "D:\\UpdateAdminConsole\\Webcontent"

},

{

"path": "[file://%25Desktop%25]\\%Desktop%"

},

{

"path": "[file://%25Documents%25]\\%Documents%"

},

{

"path": "[file://%25Music%25]\\%Music%"

},

{

"path": "[file://%25Pictures%25]\\%Pictures%"

},

{

"path": "[file://%25Videos%25]\\%Videos%"

},

{

"excludePath": "[file://%25Home%25]\\%Home%"

},

{

"excludePath": "[file://%25Archives%25]\\%Archives%"

},

{

"excludePath": "[file://%25Cloud%20app%25]\\%Cloud app%"

},

{

"excludePath": "C:\\excludeContent"

},

{

"includePath": "C:\\ExceptionContent"

}

]

}

}

},

"packages": [

{

"packageId": 702,

"packageName": "File System"

}

],

"clientAuthForJob": {

"userName": "manoj\\administrator",

"password": "cXE="

},

"entities": [

{

"clientId": 0,

"clientName": "TestInstallClient1",

"hostName": "TestInstallClient1.manoj.com"

},

{

"clientId": 0,

"clientName": "TestInstallClient2",

"hostName": "TestInstallClient2.manoj.com"

}

]

}

This request associates a new plan and additional content to an existing client.

POST <webservice>/InstallClient

Host: client.mydomain.com

Accept: application/json

Authtoken: QSDK 3c633bc300b7cbdcf31f918d4ce4934722d620774b81e87e543c517177302b23a0742c0b7e74bd7dc43731ca2b83fe44a43b5fcb24633fab54842eaeb8ddaa6d85674a17692ea6cd559b1d70a4f589552e59c10fc79701debf79d85cda

Content-Type: application/json

{

"rebootClient": false,

"createPseudoClientRequest": {

"registerClient": true,

"clientInfo": {

"clientType": 0,

"plan": {

"planId": 1

},

"subclientInfo": {

"fsSubClientProp": {

"useGlobalFilters": "USE_CELL_LEVEL_POLICY",

"backupSystemState": true

},

"useLocalContent": true,

"contentOperationType": 1,

"content": [

{

"path": "[file://%25Office%25]\\%Office%"

},

{

"path": "D:\\UpdateAdminConsole\\Webcontent"

},

{

"path": "[file://%25Desktop%25]\\%Desktop%"

},

{

"path": "[file://%25Documents%25]\\%Documents%"

},

{

"path": "[file://%25Music%25]\\%Music%"

},

{

"path": "[file://%25Pictures%25]\\%Pictures%"

},

{

"path": "[file://%25Videos%25]\\%Videos%"

},

{

"excludePath": "[file://%25Home%25]\\%Home%"

},

{

"excludePath": "[file://%25Archives%25]\\%Archives%"

},

{

"excludePath": "[file://%25Cloud%20app%25]\\%Cloud app%"

},

{

"excludePath": "C:\\excludeContent"

},

{

"includePath": "C:\\ExceptionContent"

}

]

}

}

},

"packages": [

{

"packageId": 702,

"packageName": "File System"

}

],

"clientAuthForJob": {

"userName": "manoj\\administrator",

"password": "cXE="

},

"entities": [

{

"clientId": 127,

"clientName": "Test3",

"hostName": "Test3.manoj.com"

},

{

"clientId": 128,

"clientName": "Test4",

"hostName": "Test4.manoj.com"

}

]

}

Example Response

{

"jobId": 14578,

"taskId": 248,

"response": {

"errorCode": 0

}

}