Skip to main content

Add Storage Array​

Creating a Storage Array

Request Body

Request to create an Array

  • general object

    Details of the vendor being selected

  • snapVendor string required
  • name string required

    Name of the array

  • controlHost string

    Host Name of the array

  • description string

    Description of the array

  • credential object

    Template for options provided to user

  • userName string required

    Username to access the array

  • password string

    Base 64 encoded Password to access the array

  • savedCredential object
  • id int32
  • name string
  • accessNodes object[]

    MAs that can access the array

  • id int32

    Id of the MediaAgent

  • name string

    Name of the MediaAgent

  • displayName string

    The display name of the corresponding Media Agent

  • pruning boolean

    Enable/Disable pruning of snapshots on the selected Media Agent

  • snapConfigurations object[]

    Configurations related to a snap engine

  • masterConfigId int32 required

    This is the masterConfigId, which is available for each vendor's configs

  • name string required

    This is the name of the config which is displayed on the Command Center Console

  • type int32 required

    Possible values: [1, 2, 8, 10, 12, 13, 14]

    Type of the config value. type can accept 7 values [1,2,8,10,12,13,14], 1: boolean, 2: integer, 8: text, 10: array[string] are common configs, the rest three are special keys, 12 is for password type key for NetApp E-Series and HPE Nimble, 13 is Private Key for GCP, 14 is a config to select type of Disk for GCP

  • value string

    Takes a single value for all types except 10 and for type 14 it holds the id of the selected value from values

  • values object[]

    Values to be entered. for type 10 and 14

  • id int32
  • name string
Responses

OK

Schema
  • errorMessage string
  • errorCode int32
POST /v4/storagearrays

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
token
Body
{

  "general": {

    "snapVendor": "string",

    "name": "string",

    "controlHost": "string",

    "description": "string",

    "credential": {

      "userName": "string",

      "password": "string"

    },

    "savedCredential": {

      "id": 0,

      "name": "string"

    }

  },

  "accessNodes": [

    {

      "id": 0,

      "name": "string",

      "displayName": "string",

      "pruning": true

    }

  ],

  "snapConfigurations": [

    {

      "masterConfigId": 0,

      "name": "string",

      "type": 1,

      "value": "string",

      "values": [

        {

          "id": 0,

          "name": "string"

        }

      ]

    }

  ]

}

curl -L -X POST 'https://localhost/webconsole/api/V4/StorageArrays' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "general": {
    "snapVendor": "string",
    "name": "string",
    "controlHost": "string",
    "description": "string",
    "credential": {
      "userName": "string",
      "password": "string"
    },
    "savedCredential": {
      "id": 0,
      "name": "string"
    }
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "pruning": true
    }
  ],
  "snapConfigurations": [
    {
      "masterConfigId": 0,
      "name": "string",
      "type": 1,
      "value": "string",
      "values": [
        {
          "id": 0,
          "name": "string"
        }
      ]
    }
  ]
}'