Skip to main content

Install new File Server​

Select

SaaS
Customer Managed

Create a new file server.

Request Body
  • rebootClient boolean

    Reboot the client after installation

  • createPseudoClientRequest object required

    Client Object

  • registerClient boolean required

    Register to the commcell after installation

  • clientInfo object required
  • clientType integer required

    Client Machine OS Type 0 - windows and 1 - Unix

  • plan object

    Associate plan to the file server optional

  • planId integer

    Plan ID

  • planName string

    Plan Name

  • subclientInfo object

    Configure content using subclient (Override plan content)

  • fsSubClientProp object
  • useGlobalFilters string

    Possible values: [USE_CELL_LEVEL_POLICY, ON, OFF]

    ON - Enables global exceptions, OFF - Disableglobal exceptions, USE_CELL_LEVEL_POLICY - Inherit exclusions from commcell, company or client group

  • backupSystemState boolean

    Default value: true

  • useLocalContent boolean

    True to override plan's backup content.

  • contentOperationType integer

    Default value: 1

  • content object[]

    List of contents to backup

  • path string

    Path of the content

  • packages object[] required

    Packages to be installed

  • packageId integer required

    File system package ID 702 for WINDOWS 1101 for UNIX

  • packageName string required

    File System

  • clientAuthForJob object required

    Client machine credentials

  • userName string required

    Username of the machine

  • password string required

    Base 64 encoded password of the user

  • entities object[] required

    Client inputs

  • clientName string required

    Provide client name

  • hostName string required

    Provide hostname FQDN or IP of the client

  • displayName string required

    DisplayName of the client

Responses

OK

Schema
  • jobId integer

    Install Job ID

  • taskId integer

    Task ID

  • clients object[]

    Client Object

  • clientId integer

    ID of the client c

  • clientName string

    Client Name

  • _type_ integer
  • response object
  • errorCode integer
POST /installclient

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "rebootClient": true,

  "createPseudoClientRequest": {

    "registerClient": true,

    "clientInfo": {

      "clientType": 0,

      "plan": {

        "planId": 0,

        "planName": "string"

      },

      "subclientInfo": {

        "fsSubClientProp": {

          "useGlobalFilters": "USE_CELL_LEVEL_POLICY",

          "backupSystemState": true

        },

        "useLocalContent": true,

        "contentOperationType": 1,

        "content": [

          {

            "path": "string"

          }

        ]

      }

    }

  },

  "packages": [

    {

      "packageId": 0,

      "packageName": "string"

    }

  ],

  "clientAuthForJob": {

    "userName": "string",

    "password": "string"

  },

  "entities": [

    {

      "clientName": "string",

      "hostName": "string",

      "displayName": "string"

    }

  ]

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InstallClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "rebootClient": true,
  "createPseudoClientRequest": {
    "registerClient": true,
    "clientInfo": {
      "clientType": 0,
      "plan": {
        "planId": 0,
        "planName": "string"
      },
      "subclientInfo": {
        "fsSubClientProp": {
          "useGlobalFilters": "USE_CELL_LEVEL_POLICY",
          "backupSystemState": true
        },
        "useLocalContent": true,
        "contentOperationType": 1,
        "content": [
          {
            "path": "string"
          }
        ]
      }
    }
  },
  "packages": [
    {
      "packageId": 0,
      "packageName": "string"
    }
  ],
  "clientAuthForJob": {
    "userName": "string",
    "password": "string"
  },
  "entities": [
    {
      "clientName": "string",
      "hostName": "string",
      "displayName": "string"
    }
  ]
}'