Skip to main content

Edit Storage Array​

Select

SaaS
Customer Managed

Editing Array details

Path Parameters
  • arrayId int32 required
Request Body
  • general object

    Template for the editable generic information of an array. Region depicts the workload region which is only applicable to NetApp arrays as of now.

  • controlHost string

    Host name 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
  • description string

    Description about the Array

  • region object
  • id int32
  • name string
  • flags int32

    Flags to be set for array

  • accessNodes object[]
  • 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 hidden config to select type of Disk for GCP

  • value string

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

  • values object[]

    For type 10 and 14, it can take one or more value of idname type where id by default is 0 for 10. For HPE 3PAR StoreServ, pass MA Id in name field to configure that MA as remote snap MA.

  • id int32
  • name string
  • flags int32 required

    Flag regarding placement of config in the CC page

  • isUpdated boolean required

    Whether the config is updated/edited or not

  • security object

    A list of users or user groups each having a specific set of roles that determine the kind of operations they can perform on the entity. Either id/name of the user/usergroup/roles can be provided. If both id and name are provided, id will be taken into consideration.

  • user object
  • id int32
  • name string
  • userGroup object
  • id int32
  • name string
  • role object
  • id int32
  • name string
Responses

OK

Schema
  • errorMessage string
  • errorCode int32
PUT /v4/storagearrays/:arrayid

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "general": {

    "controlHost": "string",

    "credential": {

      "userName": "string",

      "password": "string"

    },

    "savedCredential": {

      "id": 0,

      "name": "string"

    },

    "description": "string",

    "region": {

      "id": 0,

      "name": "string"

    },

    "flags": 0

  },

  "accessNodes": [

    {

      "id": 0,

      "name": "string",

      "displayName": "string",

      "pruning": true

    }

  ],

  "snapConfigurations": [

    {

      "masterConfigId": 0,

      "name": "string",

      "type": 1,

      "value": "string",

      "values": [

        {

          "id": 0,

          "name": "string"

        }

      ],

      "flags": 0,

      "isUpdated": true

    }

  ],

  "security": {

    "user": {

      "id": 0,

      "name": "string"

    },

    "userGroup": {

      "id": 0,

      "name": "string"

    },

    "role": {

      "id": 0,

      "name": "string"

    }

  }

}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/StorageArrays/:arrayId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "general": {
    "controlHost": "string",
    "credential": {
      "userName": "string",
      "password": "string"
    },
    "savedCredential": {
      "id": 0,
      "name": "string"
    },
    "description": "string",
    "region": {
      "id": 0,
      "name": "string"
    },
    "flags": 0
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "pruning": true
    }
  ],
  "snapConfigurations": [
    {
      "masterConfigId": 0,
      "name": "string",
      "type": 1,
      "value": "string",
      "values": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "flags": 0,
      "isUpdated": true
    }
  ],
  "security": {
    "user": {
      "id": 0,
      "name": "string"
    },
    "userGroup": {
      "id": 0,
      "name": "string"
    },
    "role": {
      "id": 0,
      "name": "string"
    }
  }
}'