Skip to main content

Add controller for mountpath​

Select

SaaS
Customer Managed

This operation adds a controller for mountpath.

Query Parameters
  • Action string required

    addController

Request Body
  • deviceEntity object
  • deviceName string required

    Name of device, please use GET /storagepool/:storagepoolid to obtain deviceName (consider name from deviceInfo obj).

  • mountpathId integer

    Id of mountpath, please use GET /storagepool/:storagepoolid to obtain mountPathId. Note : If mountpathId is not passed default mountpathId is used.

  • infoList object[] required
  • numWriters integer

    Default value: -1

    Number of allowed writers (-1 denotes max allowed writers) allowed range : 1 - 999, should be used only for write access type.

  • opType integer required

    Operation type : 1 (represents add).

  • accessType integer required

    Device controller access type. Sum the following bits to decide accesstype - 2(read), 4(write), 8(set preferred), 16(Dataserver IP), 32(Dataserver SAN), 128(Dataserver ISCSI). Note : Device controllers with data server transport type cannot be set as preferred controller and should not be used for cloud mountpaths. for example : 14(read/write/preferred), 12(read/preferred).

  • path string

    Shared network path of mountpath location. Note : please use double slash in place of single slash.

  • userName string

    User name to access network path. Not required if credentialName is used. Note : please use double slash in place of single slash.

  • password password

    Base64 encoded password of the user to access network path. Not required if credentialName is used.

  • autoPickTransportType boolean

    Default value: false

    To identify the best fit transport type for the given mountpath using the info from existing controllers. Please use this for disk mountpath only.

  • mediaAgent object
  • name string required

    Name of the media agent, please use GET /v4/mediaagent to obtain name.

  • savedCredential object
  • credentialName string

    Name of credential, please use GET /v4/credential to obtain credentialName. Note : used in adding controller for both disk mountpath (in case of network share path) and for cloud mountpath (to change credentials for new MA access, before using, please refer the "Update cloud library credential to selected device controller only setting" - here).

Responses

OK

POST /drivecontroller

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "deviceEntity": {

    "deviceName": "string"

  },

  "mountpathId": 0,

  "infoList": [

    {

      "numWriters": -1,

      "opType": 0,

      "accessType": 14,

      "path": "\\\\my_machine\\share_name",

      "userName": "domain\\user",

      "password": "string",

      "autoPickTransportType": false,

      "mediaAgent": {

        "name": "string"

      },

      "savedCredential": {

        "credentialName": "string"

      }

    }

  ]

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/DriveController' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "deviceEntity": {
    "deviceName": "string"
  },
  "mountpathId": 0,
  "infoList": [
    {
      "numWriters": -1,
      "opType": 0,
      "accessType": 14,
      "path": "\\\\my_machine\\share_name",
      "userName": "domain\\user",
      "password": "string",
      "autoPickTransportType": false,
      "mediaAgent": {
        "name": "string"
      },
      "savedCredential": {
        "credentialName": "string"
      }
    }
  ]
}'