Get Storage Array Details
Select
Getting Array Details
Path Parameters
- arrayId int32 required
- 200
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
labels object
Labels for array entities to be displayed on the CC page
name stringLabel for array name
controlHost stringLabel for array control host
userName stringLabel for array username
password stringLabel for array password
general object
Generic Details of the Engine Array. Region depicts the workload region which is only applicable to NetApp arrays as of now.
snapVendor object
id int32name stringarray object
id int32name stringcontrolHost stringControl Host name of the array
credential object
Template for options provided to user
userName stringUsername to access the array
password stringBase 64 encoded Password to access the array
savedCredential object
id int32name stringregion object
id int32name stringflags int32Possible values: [
0
,1
,2
,4
,8
,16
]0: default 1: Only selected arrays 2: Disable automatic cleanup 4: System created arrays 8: Auto created arrays 16: User created arrays
enableNetAppCloudAccount booleanSet as true for NetApp cloud target arrays
arrayType int32Used to differentiate between Primary, Secondary, and OCUM type of NetApp Array
cloudVendorId int32Id for cloud vendors associated to arrays
uniqueIdentifier stringUnique identifier pertaining to each array
description stringUser provided description of the array
company object
id int32name stringsecurity 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.
user object
id int32name stringuserGroup object
id int32name stringexternalUserGroup object
External User Group Entity
id int32User Group Id
name stringExternal Group Name
providerId int32Provider id
providerName stringProvider Name
isCreatorAssociation booleanrole object
id int32name stringpermissionList object[]
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES
,CATEGORY_ENTITY
,PERMISSION_ENTITY
]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
accessNodes object[]
id int32Id of the MediaAgent
name stringName of the MediaAgent
displayName stringThe display name of the corresponding Media Agent
pruning booleanEnable/Disable pruning of snapshots on the selected Media Agent
availableAccessNodes object[]
id int32name stringdisplayName stringsnapConfigurations object[]
masterConfigId int32This is the masterConfigId, which is available for each vendors configs
name stringThis is the name of the config which is displayed on the Command Center Console
type int32Possible 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 stringValues to be set for all types except 10 and 14
values object[]
Values to be set for type 10 and 14. Incase of HPE 3PAR StoreServ, name field will have the remote snap MA Id.
id int32name stringflags int32Flag regarding placement of config in the CC page
description stringDescription about the config that tells the user what it is for and the range of values it accepts
isEnabled booleanWhether the config is enabled or not
checkRange booleanWhether to check if the value is in range or not of accepted values
minValue int64This is the lower limit value to which the config can be set for numeric types
maxValue int64This is the higher limit value to which the config can be set for numeric types
capabilities object
enableUserName booleanSet to true if username is enabled for the vendor
enableArrayDeviceGroup booleanSet to true if the array belongs to a device group
enableHostDeviceGroup booleanSet to true if the host belongs to a device group
enableArrayType booleanSet to true if array type is enabled for the NetApp and AWS to establish subtypes of vendors
enablePassword booleanSet to true if password is enabled for the vendor
enableControlHost booleanSet to true if control host is enabled for the vendor
enableArrayNameChange booleanSet to true if name of the array can be changed
enableNetAppCloudAccount booleanSet to true if NetApp Cloud Account is enabled for the vendor
serverGroups object[]
id int32Id of server group
name stringName of server group
mediaAgentCount int32Count of servers where MediaAgent package is installed
{
"labels": {
"name": "string",
"controlHost": "string",
"userName": "string",
"password": "string"
},
"general": {
"snapVendor": {
"id": 0,
"name": "string"
},
"array": {
"id": 0,
"name": "string"
},
"controlHost": "string",
"credential": {
"userName": "string",
"password": "string"
},
"savedCredential": {
"id": 0,
"name": "string"
},
"region": {
"id": 0,
"name": "string"
},
"flags": 0,
"enableNetAppCloudAccount": true,
"arrayType": 0,
"cloudVendorId": 0,
"uniqueIdentifier": "string",
"description": "string",
"company": {
"id": 0,
"name": "string"
}
},
"security": {
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"externalUserGroup": {
"id": 0,
"name": "string",
"providerId": 0,
"providerName": "string"
},
"isCreatorAssociation": true,
"role": {
"id": 0,
"name": "string"
},
"permissionList": [
{
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
}
]
},
"accessNodes": [
{
"id": 0,
"name": "string",
"displayName": "string",
"pruning": true
}
],
"availableAccessNodes": [
{
"id": 0,
"name": "string",
"displayName": "string"
}
],
"snapConfigurations": [
{
"masterConfigId": 0,
"name": "string",
"type": 1,
"value": "string",
"values": [
{
"id": 0,
"name": "string"
}
],
"flags": 0,
"description": "string",
"isEnabled": true,
"checkRange": true,
"minValue": 0,
"maxValue": 0
}
],
"capabilities": {
"enableUserName": true,
"enableArrayDeviceGroup": true,
"enableHostDeviceGroup": true,
"enableArrayType": true,
"enablePassword": true,
"enableControlHost": true,
"enableArrayNameChange": true,
"enableNetAppCloudAccount": true
},
"serverGroups": [
{
"id": 0,
"name": "string",
"mediaAgentCount": 0
}
]
}
{
"labels": {
"name": "string",
"controlHost": "string",
"userName": "string",
"password": "string"
},
"general": {
"snapVendor": {
"id": 0,
"name": "string"
},
"array": {
"id": 0,
"name": "string"
},
"controlHost": "string",
"credential": {
"userName": "string",
"password": "string"
},
"savedCredential": {
"id": 0,
"name": "string"
},
"region": {
"id": 0,
"name": "string"
},
"flags": 0,
"enableNetAppCloudAccount": true,
"arrayType": 0,
"cloudVendorId": 0,
"uniqueIdentifier": "string",
"description": "string"
},
"security": {
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"externalUserGroup": {
"id": 0,
"name": "string",
"providerId": 0,
"providerName": "string"
},
"isCreatorAssociation": true,
"role": {
"id": 0,
"name": "string"
},
"permissionList": [
{
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
}
]
},
"accessNodes": [
{
"id": 0,
"name": "string",
"displayName": "string",
"pruning": true
}
],
"availableAccessNodes": [
{
"id": 0,
"name": "string",
"displayName": "string"
}
],
"snapConfigurations": [
{
"masterConfigId": 0,
"name": "string",
"type": 1,
"value": "string",
"values": [
{
"id": 0,
"name": "string"
}
],
"flags": 0,
"description": "string",
"isEnabled": true
}
],
"serverGroups": [
{
"id": 0,
"name": "string",
"mediaAgentCount": 0
}
]
}
Not Found
Internal Server Error