Documentation Powered by Redocly

Data Services Cloud Console API (1.7.0)

Data Services Cloud Console API

alarms

The Alarms API allows the management of alarms

Get all alarms of Nimble / Alletra 6K

Get all alarms of Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter Alarms by Key.

sort
string
Example: sort=name desc

Data query to sort Alarm resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/alarms",
  • "total": 1
}

Get all alarms of Nimble / Alletra 6K identified by {alarmId}

Get all alarms of Nimble / Alletra 6K identified by {alarmId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

alarmId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the Alarm. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/alarms/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "ack_time": 3400,
  • "activity": "Created snapshot % of volume %",
  • "alarm_type": 10,
  • "array": "AC-109084",
  • "category": "unknown",
  • "curr_onset_event_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "object_id": "volumes in performance policy default",
  • "object_type": "group",
  • "onset_time": 3400,
  • "severity": "info",
  • "status": "open",
  • "user_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "customerId": "string",
  • "generation": 0,
  • "next_notification_time": 1234,
  • "object_name": "volumes in performance policy default",
  • "remind_every": 10,
  • "remind_every_unit": "minutes",
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "summary": "string",
  • "type": "string",
  • "user_full_name": "User-13 Peterson",
  • "user_name": "user1, companydomain\\user"
}

audit

Audit APIs

GET audit-events

returns the audit events

Authorizations:
JWTAuth
query Parameters
filter
string

Filter criteria - e.g. state eq Failure and occurredAt gt 2020-09-08T16:51:33Z

limit
integer

The number of results to return

offset
integer

The number of results to skip

sort
string

A comma separated list of properties to sort by, followed by a direction indicator ("asc" or "desc"). If no direction indicator is specified the default order is ascending. - e.g. state,version desc. Currently only support sorting by 1 property per request

select
string

A list of properties to include in the response. Currently only support returning of all fields.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 100,
  • "pageOffset": 0,
  • "total": 123456
}

audit-event

The Audit Events API allows the the management of audit-events

Get all events of Nimble / Alletra 6K Deprecated

Get all events of Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter Events by Key.

sort
string
Example: sort=name desc

oData query to sort Event resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/events",
  • "total": 1
}

Get all events of Nimble / Alletra 6K identified by {eventId} Deprecated

Get all events of Nimble / Alletra 6K indentified by {eventId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

eventId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the Event. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/events/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "alarm_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "category": "hardware",
  • "event_type": 10,
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "scope": "AC-109084",
  • "severity": "info",
  • "target": "volumes in performance policy default",
  • "target_type": "array",
  • "timestamp": 3400,
  • "activity": "Created snapshot % of volume %",
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "customerId": "string",
  • "generation": 0,
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "summary": "string",
  • "type": "string"
}

authz

Authorization API

Get User Accessible Resources

Retun a list of user permissions. The returned list of permissions will be based upon the supplied filter. If no filter was supplied, all user permissions will be returned. It is also possible to request all resource type with certain permission type (ex. ALL.read)

Authorizations:
JWTAuth
query Parameters
permission
Array of strings (Resource type permissions)
Example: permission=volume.create&permission=port.read&permission=audit.read

List of permissions, each of which, has the form "resource type.permission" (ex. volume.read,volume.write). The word "ANY" can be used as a wild card for the resource type (ex. ANY.read). Omitting the permission parameters is equivalent to asking for all user permissions.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get resource types with read permissions

Return resource types on which the user has a read permission. The returned list will be based upon the supplied filter. If no filter was provided, all resource types for which the user has a read permission on will be returned

Authorizations:
JWTAuth

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

controllers

The controllers API allows the management of controller fleet.

Get details of Primera / Alletra 9K Nodes

Get details of Primera / Alletra 9K Nodes

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemUid eq 7CE751P312

oData query to filter nodes resource by key.

sort
string
Example: sort=systemId desc

oData query to sort nodes resource by key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes",
  • "total": 1
}

Get details of Primera / Alletra 9K Node identified by {id}

Get details of Primera / Alletra 9K Node identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "NodeId": 0,
  • "associatedLinks": [
    ],
  • "biosVersion": "6.1.18",
  • "cacheAvailablePct": 100,
  • "cacheEnabled": 100,
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "controlMemoryMiB": 208576,
  • "customerId": "string",
  • "dataMemoryMiB": 53248,
  • "displayname": "Controller Node 0",
  • "domain": null,
  • "generation": 0,
  • "id": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "inCluster": true,
  • "kernelVersion": "4.2.1",
  • "locateEnabled": false,
  • "manufacturing": {
    },
  • "master": true,
  • "name": "4UW0002941-0",
  • "online": true,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "safeToRemove": false,
  • "serviceLED": "LED_UNKNOWN",
  • "state": {
    },
  • "stateDescription": "OK",
  • "systemId": "7CE751P312",
  • "systemLED": "LED_UNKNOWN",
  • "type": "string",
  • "uptime": {
    }
}

Locate node of Primera / Alletra 9K identified by {id}

Locate node of Primera / Alletra 9K identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

Request Body schema: application/json
locate
boolean

Indicates if the locate beacon should be enabled or not

Responses

Request samples

Content type
application/json
{
  • "locate": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get component performance statistics details of Primera / Alletra 9K node idenfified by {nodeId}

Get component performance statistics details of Primera / Alletra 9K node idenfified by {nodeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "cachePercentage": {
    },
  • "commonResourceAttributes": {
    },
  • "cpuPercentage": {
    },
  • "customerId": "string",
  • "requestUri": "v1/storage-systems/device-type1/7CE751P312/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/component-performance-statistics"
}

Get details of Primera / Alletra 9K Node Cards identified by {nodeId}

Get details of Primera / Alletra 9K Node Cards identified by {nodeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemUid eq 7CE751P312

oData query to filter nodes resource by key.

sort
string
Example: sort=systemId desc

oData query to sort nodes resource by key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC01F0FF/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-cards",
  • "total": 2
}

Get details of Primera / Alletra 9K Node Card identified by {nodeId} and {id}

Get details of Primera / Alletra 9K Node Card identified by {nodeId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

id
required
string
Example: 9aeec8a12315995e1efc340a79b6b5bd

UID of the node Card

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-cards/60c3831bf1e682693d0319c10333af92",
  • "customerId": "string",
  • "displayname": "NODE_CARD_NAME",
  • "domain": null,
  • "fwVersion": "10.10.03.00",
  • "generation": 0,
  • "id": "9aeec8a12315995e1efc340a79b6b5bd",
  • "locateEnabled": false,
  • "manufacturing": {
    },
  • "name": "0:1",
  • "nodeCardType": "pcicard_type-5",
  • "nodeDeviceId": 0,
  • "nodeId": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-cards/9aeec8a12315995e1efc340a79b6b5bd",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-cards/9aeec8a12315995e1efc340a79b6b5bd",
  • "revision": "02",
  • "safeToRemove": false,
  • "serviceLed": "LED_UNKNOWN",
  • "slot": 1,
  • "systemId": "7CE751P312",
  • "type": "string"
}

Get details of Primera / Alletra 9K Node Cpus identified by {nodeId}

Get details of Primera / Alletra 9K Node Cpus identified by {nodeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemUid eq 7CE751P312

oData query to filter nodes resource by key.

sort
string
Example: sort=systemId desc

oData query to sort nodes resource by key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC01F0FF/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-cpus",
  • "total": 2
}

Get details of Primera / Alletra 9K Node Cpu identified by {nodeId} and {id}

Get details of Primera / Alletra 9K Node Cpu identified by {nodeId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

id
required
string
Example: 60c3831bf1e682693d0319c10333af92

UID of the node Cpu

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "busSpeed": 100,
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-cpus/60c3831bf1e682693d0319c10333af92",
  • "customerId": "string",
  • "displayname": "NODE_CPU_NAME",
  • "domain": null,
  • "family": "0",
  • "generation": 0,
  • "id": "60c3831bf1e682693d0319c10333af92",
  • "manufacturing": {
    },
  • "name": "CPU 0",
  • "nodeCpuId": 0,
  • "nodeDeviceId": 1,
  • "nodeId": "41af9ebf50bd94d27972f9faf39318af",
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-cpus/60c3831bf1e682693d0319c10333af92",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-cpus/60c3831bf1e682693d0319c10333af92",
  • "speed": 2194,
  • "stepping": "4",
  • "systemId": "7CE751P312",
  • "type": "string"
}

Get details of Primera / Alletra 9K Node Drives identified by {nodeId}

Get details of Primera / Alletra 9K Node Drives identified by {nodeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemUid eq 7CE751P312

oData query to filter nodes resource by key.

sort
string
Example: sort=systemId desc

oData query to sort nodes resource by key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC01F0FF/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-drives",
  • "total": 2
}

Get details of Primera / Alletra 9K Node Drive identified by {nodeId} and {id}

Get details of Primera / Alletra 9K Node Drive identified by {nodeId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

id
required
string
Example: b7b233212d3ed5608da55539a7008b5b

UID of the node drive

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-drives/b7b233212d3ed5608da55539a7008b5b",
  • "customerId": "string",
  • "displayname": "NODE_IDE_NAME",
  • "domain": null,
  • "fwVersion": "X2200400",
  • "generation": 0,
  • "id": "b7b233212d3ed5608da55539a7008b5b",
  • "manufacturing": {
    },
  • "maxLBA": "EE7C2B0",
  • "name": "Internal Drive 0",
  • "nodeDeviceId": 0,
  • "nodeDriveId": 0,
  • "nodeDriveType": "drive_type-2",
  • "nodeId": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-drives/b7b233212d3ed5608da55539a7008b5b",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-drives/b7b233212d3ed5608da55539a7008b5b",
  • "sedState": "Capable",
  • "sizeMiB": 122104,
  • "systemId": "7CE751P312",
  • "type": "string",
  • "wwn": "5001B444A99566ED"
}

Get details of Primera / Alletra 9K Node Mcus identified by {nodeId}

Get details of Primera / Alletra 9K Node Mcus identified by {nodeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemUid eq 7CE751P312

oData query to filter nodes resource by key.

sort
string
Example: sort=systemId desc

oData query to sort nodes resource by key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC01F0FF/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-mcus",
  • "total": 2
}

Get details of Primera / Alletra 9K Node Mcu identified by {nodeId} and {id}

Get details of Primera / Alletra 9K Node Mcu identified by {nodeId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

id
required
string
Example: be97ad7351f8562440c909460061d0cb

UID of the node Mcu

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-mcus/60c3831bf1e682693d0319c10333af92",
  • "customerId": "string",
  • "domain": null,
  • "fwVersion": "4.9.20",
  • "generation": 0,
  • "id": "be97ad7351f8562440c909460061d0cb",
  • "model": "NEMOE",
  • "name": "Controller Node 1 MCU",
  • "nodeDeviceId": 1,
  • "nodeId": "624fc670a5bc9a6e6e5c7833da4bab13",
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-mcus/be97ad7351f8562440c909460061d0cb",
  • "resetReason": "Cold Power-on",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-mcus/be97ad7351f8562440c909460061d0cb",
  • "state": {
    },
  • "systemId": "7CE751P312",
  • "type": "string",
  • "upSince": {
    }
}

Get details of Primera / Alletra 9K Node Memories identified by {nodeId}

Get details of Primera / Alletra 9K Node Memories identified by {nodeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemUid eq 7CE751P312

oData query to filter nodes resource by key.

sort
string
Example: sort=systemId desc

oData query to sort nodes resource by key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC01F0FF/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-mems",
  • "total": 2
}

Get details of Primera / Alletra 9K Node Memory identified by {nodeId} and {id}

Get details of Primera / Alletra 9K Node Memory identified by {nodeId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

id
required
string
Example: cc43b7fdca33ea82d84e0ca260940483

UID of the node Memory

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "cacheType": "CACHE_DATA",
  • "casLatency": "CL11.0/1.1",
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-mems/60c3831bf1e682693d0319c10333af92",
  • "customerId": "string",
  • "displayname": "NODE_MEM_NAME",
  • "domain": null,
  • "generation": 0,
  • "id": "cc43b7fdca33ea82d84e0ca260940483",
  • "jedecId": "80AD000000000000",
  • "manufacturing": {
    },
  • "name": "DIMM0.0",
  • "nodeDeviceId": 0,
  • "nodeId": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "nodeMemoryType": "dimm_type-2",
  • "partNumber": "HMT41GV7DFR4A-PB T4",
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-mems/cc43b7fdca33ea82d84e0ca260940483",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/node-mems/cc43b7fdca33ea82d84e0ca260940483",
  • "revision": "17",
  • "riser": "n/a",
  • "sizeMiB": 8192,
  • "slot": -1,
  • "slotId": "J-16768283",
  • "systemId": "7CE751P312",
  • "type": "string"
}

Get details of Primera / Alletra 9K Node Power Supplies identified by {nodeId}

Get details of Primera / Alletra 9K Node Power Supplies identified by {nodeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

Primary ID of the node

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemUid eq 7CE751P312

oData query to filter nodes resource by key.

sort
string
Example: sort=systemId desc

oData query to sort nodes resource by key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC01F0FF/nodes/0/node-powers",
  • "total": 2
}

Get details of Primera / Alletra 9K Node Power Supply identified by {nodeId} and {id}

Get details of Primera / Alletra 9K Node Power Supply identified by {nodeId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

Primary ID of the node

id
required
string
Example: 1f9624301fd2f5ecef723c6ecd17c377

UID of the node Power Supply

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/2FF70002AC018D94/nodes/8621946048c1cb24bdfc57e9b3b460ac/node-powers/1f9624301fd2f5ecef723c6ecd17c377",
  • "customerId": "string",
  • "displayname": "NODE_PS_NAME",
  • "domain": null,
  • "fanspeed": "Low",
  • "fanstate": {
    },
  • "generation": 0,
  • "id": "1f9624301fd2f5ecef723c6ecd17c377",
  • "locateEnabled": false,
  • "manufacturing": {
    },
  • "name": "Power Supply 1",
  • "nodePowerId": 1,
  • "primaryNodeId": 0,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/8621946048c1cb24bdfc57e9b3b460ac/node-powers/1f9624301fd2f5ecef723c6ecd17c377",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/0/node-powers/1f9624301fd2f5ecef723c6ecd17c377",
  • "safeToRemove": false,
  • "secondaryNodeId": 2,
  • "serviceLED": "LED_UNKNOWN",
  • "state": {
    },
  • "systemId": "7CE751P312",
  • "type": "string"
}

Locate PCBM of Primera / Alletra 9K identified by {id}

Locate PCBM of Primera / Alletra 9K identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

Primary ID of the node

id
required
string
Example: 1f9624301fd2f5ecef723c6ecd17c377

UID of the node Power Supply

Request Body schema: application/json
locate
boolean

Indicates if the locate beacon should be enabled or not

Responses

Request samples

Content type
application/json
{
  • "locate": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Primera / Alletra 9K Node Batteries identified by {nodeId}

Get details of Primera / Alletra 9K Node Batteries identified by {nodeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

Primary ID of the node

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemUid eq 7CE751P312

oData query to filter nodes resource by key.

sort
string
Example: sort=systemId desc

oData query to sort nodes resource by key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC01F0FF/nodes/0/nodes-batteries",
  • "total": 2
}

Get details of Primera / Alletra 9K Node Battery identified by {nodeId} and {id}

Get details of Primera / Alletra 9K Node Battery identified by {nodeId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

Primary ID of the node

id
required
string
Example: 8621946048c1cb24bdfc57e9b3b460ac

UID of the node battery

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "chargeLevel": 0,
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/nodes-batteries/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "dischargeLED": "LED_UNKNOWN",
  • "displayname": "Controller Node - 0",
  • "domain": null,
  • "expirationDate": {
    },
  • "faultLED": "LED_UNKNOWN",
  • "fullyCharged": false,
  • "generation": 0,
  • "id": "8621946048c1cb24bdfc57e9b3b460ac",
  • "life": 0,
  • "locateEnabled": false,
  • "manufacturing": {
    },
  • "maxLife": 16,
  • "name": "Battery",
  • "nodeBatteryId": 0,
  • "powerSupplyId": 0,
  • "primaryNodeId": 0,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/nodes-batteries/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/nodes/0/nodes-batteries/8621946048c1cb24bdfc57e9b3b460ac",
  • "safeToRemove": false,
  • "secondaryNodeId": 1,
  • "serviceLED": "LED_UNKNOWN",
  • "state": {
    },
  • "statusLED": "LED_UNKNOWN",
  • "systemId": "7CE751P312",
  • "testInProgress": false,
  • "timeToCharge": -1,
  • "type": "string"
}

Get all controllers details by Nimble / Alletra 6K

Get all controllers details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter controllers by Key.

sort
string
Example: sort=name desc

oData query to sort controllers resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/controllers",
  • "total": 1
}

Get details of Nimble / Alletra 6K Controller identified by {controllerId}

Get details of Nimble / Alletra 6K Controller identified by {controllerId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

controllerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the controller. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/devicetype2/2a0df0fe6f7dc7bb16000000000000000000004817/controllers/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "array_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "array_name": "myobject-5",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "name": "A",
  • "serial": "AC-109084",
  • "associated_links": [
    ],
  • "asup_time": 0,
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "ctrlr_side": "A",
  • "customerId": "string",
  • "fan_status": "fan_okay",
  • "fans": [
    ],
  • "generation": 0,
  • "hostname": "myobject-5-A",
  • "nvme_cards": [
    ],
  • "nvme_cards_enabled": 0,
  • "partial_response_ok": true,
  • "partition_status": [
    ],
  • "power_status": "ps_okay",
  • "power_supplies": [
    ],
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "state": "active",
  • "support_address": "128.0.0.1",
  • "support_netmask": "255.255.248.0",
  • "support_nic": "eth1",
  • "temperature_sensors": [
    ],
  • "temperature_status": "temperature_okay",
  • "type": "string",
  • "update_end_time": 3400,
  • "update_error_code": "SM_ok",
  • "update_progress_msg": "example progress message",
  • "update_start_time": 3400,
  • "update_state": "normal",
  • "version_current": "5.3.0.0-746508-opt",
  • "version_rollback": "v1",
  • "version_target": "v1"
}

Perform halt of Nimble / Alletra 6K controller identified by {controllerId}

Perform halt of Nimble / Alletra 6K controller identified by {controllerId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

controllerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the controller. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of HPE Alletra Storage MP Nodes

Get details of HPE Alletra Storage MP Nodes

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemUid eq 7CE751P312

oData query to filter nodes resource by key.

sort
string
Example: sort=systemId desc

oData query to sort nodes resource by key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/nodes",
  • "total": 1
}

Get details of HPE Alletra Storage MP Node identified by {id}

Get details of HPE Alletra Storage MP Node identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "customerId": "string",
  • "displayname": "Controller Node 0",
  • "domain": null,
  • "enclosureCardId": 0,
  • "enclosureCardUid": "string",
  • "enclosureId": 0,
  • "enclosureUid": "string",
  • "generation": 0,
  • "id": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "inCluster": true,
  • "kernelVersion": "4.2.1",
  • "master": true,
  • "memoryMiB": 5,
  • "name": "4UW0002941-0",
  • "online": true,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "resourceUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "safeToRemove": false,
  • "state": {
    },
  • "systemId": "7CE751P312",
  • "type": "string",
  • "uptime": {
    }
}

Locate node of HPE Alletra Storage MP identified by {id}

Locate node of HPE Alletra Storage MP identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

Request Body schema: application/json
locate
boolean

Indicates if the locate beacon should be enabled or not

Responses

Request samples

Content type
application/json
{
  • "locate": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get component performance statistics details of HPE Alletra Storage MP node idenfified by {nodeId}

Get component performance statistics details of HPE Alletra Storage MP node idenfified by {nodeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the node

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "cachePercentage": {
    },
  • "cpuPercentage": {
    },
  • "customerId": "string",
  • "requestUri": "v1/storage-systems/device-type4/7CE751P312/nodes/e9d353bf98fc1a6bdb90b824e3ca14b5/component-performance-statistics"
}

disks

The disks API allows the management of disks

Get all disks details by Nimble / Alletra 6K

Get all disks details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter disks by Key.

sort
string
Example: sort=name desc

oData query to sort disks resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/disks",
  • "total": 1
}

Get details of Nimble / Alletra 6K disk identified by {diskId}

Get details of Nimble / Alletra 6K disk identified by {diskId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

diskId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of disk. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/disks/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "array_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "array_name": "c12-array5",
  • "disk_type": "ssd",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "model": "WDC WD1003FBYX-01Y7B0",
  • "serial": "/dev/sdj",
  • "shelf_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "shelf_serial": "AA-100373",
  • "state": "in use",
  • "associated_links": [
    ],
  • "bank": 0,
  • "block_type": "block_none",
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "customerId": "string",
  • "disk_internal_stat1": "00cf9d220c",
  • "disk_op": "string",
  • "firmware_version": "01.01V01",
  • "force": true,
  • "generation": 0,
  • "hba": 2,
  • "is_dfc": true,
  • "partial_response_ok": true,
  • "path": "/dev/sdj",
  • "port": 15,
  • "raid_id": 10,
  • "raid_resync_average_speed": 0,
  • "raid_resync_current_speed": 0,
  • "raid_resync_percent": 100,
  • "raid_state": "okay",
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "shelf_location": "A.0",
  • "shelf_location_id": 0,
  • "size": 1000204886016,
  • "slot": 2,
  • "smart_attribute_list": [
    ],
  • "type": "string",
  • "vendor": "OEM",
  • "vshelf_id": 0
}

Edit details of Nimble / Alletra 6K disk identified by {diskId}

Edit details of Nimble / Alletra 6K disk identified by {diskId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

diskId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of disk. A 42 digit hexadecimal number.

Request Body schema: application/json
disk_op
string

The intended operation to be performed on the specified disk. Disk operation. Possible values: 'add', 'remove'.

force
boolean or null

Forcibly add a disk. Possible values: 'true', 'false'.

Responses

Request samples

Content type
application/json
{
  • "disk_op": "add",
  • "force": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

encryption

The encryption API allows the actions on encryption

Encryption Backup Action on storage system Primera / Alletra 9K identified by {systemId}

Encryption Backup Action on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object (EncryptionParams)

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "response": "Encryption Key"
}

Check EKM configuration on storage system Primera / Alletra 9K identified by {systemId}

Check EKM configuration on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Responses

Response samples

Content type
application/json
{
  • "response": "EKM settings are correct"
}

Encryption Enable Action on storage system Primera / Alletra 9K identified by {systemId}

Encryption Enable Action on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object (EncryptionParams)

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "response": "Encryption Key"
}

Encryption Rekey Action on storage system Primera / Alletra 9K identified by {systemId}

Encryption Rekey Action on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object (EncryptionParams)

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "response": "Encryption Key"
}

Encryption Restore Action on storage system Primera / Alletra 9K identified by {systemId}

Encryption Restore Action on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
key
string

Encryption key.

object (EncryptionParams)

Responses

Request samples

Content type
application/json
{
  • "key": "key",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Set EKM configuration on storage system Primera / Alletra 9K identified by {systemId}

Set EKM configuration on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object (SetEKMConfigParams)

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Set EKM configuration and Encryption Backup Action on storage system Primera / Alletra 9K identified by {systemId}

Set EKM configuration and Encryption Backup Action on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object (EncryptionParams)

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "response": "Encryption Key"
}

Encryption Backup Action on HPE Alletra Storage MP identified by {systemId}

Encryption Backup Action on HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object (DeviceType4EncryptionBackupRekeyRestoreParams)

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "response": "Encryption Key"
}

Check EKM configuration on HPE Alletra Storage MP identified by {systemId}

Check EKM configuration on HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Responses

Response samples

Content type
application/json
{
  • "response": "EKM settings are correct"
}

Encryption Enable Action on HPE Alletra Storage MP identified by {systemId}

Encryption Enable Action on HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object (DeviceType4EncryptionParams)

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "response": "Encryption Key"
}

Encryption Rekey Action on HPE Alletra Storage MP identified by {systemId}

Encryption Rekey Action on HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object (DeviceType4EncryptionBackupRekeyRestoreParams)

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "response": "Encryption Key"
}

Encryption Restore Action on HPE Alletra Storage MP identified by {systemId}

Encryption Restore Action on HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
key
string

Encryption key.

object (DeviceType4EncryptionBackupRekeyRestoreParams)

Responses

Request samples

Content type
application/json
{
  • "key": "key",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Set EKM configuration on HPE Alletra Storage MP identified by {systemId}

Set EKM configuration on HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object (DeviceType4SetEKMConfigParams)

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Set EKM configuration and Encryption Backup Action on HPE Alletra Storage MP identified by {systemId}

Set EKM configuration and Encryption Backup Action on HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object (DeviceType4SetEKMBackupConfigParams)

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "response": "Encryption Key"
}

external-key-manager

The External Key Manager API allows the management of external key manager

Get details of Nimble / Alletra 6K external-key-manager

Get details of Nimble / Alletra 6K external-key-manager

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/external-key-manager",
  • "total": 1
}

Create external key manager for a Nimble / Alletra 6K storage system

Create external key manager for a Nimble / Alletra 6K storage system

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
description
string or null

String of up to 255 printable ASCII characters. Example: '99.9999% availability'.

hostname
required
string

Hostname or IP Address for the External Key Manager. Plain string.

name
required
string

Name of external key manager. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

password
required
string

External Key Manager user password. String up to 255 printable characters. String of 8 to 255 printable characters excluding ampersand and ;[]

port
required
integer

Positive integer value up to 65535 representing External key manager port.

protocol
required
string

Possible values: 'KMIP1_0', 'KMIP1_1', 'KMIP1_2', 'KMIP1_3'.

username
required
string

External key manager username. String of up to 255 printable ASCII characters.

Responses

Request samples

Content type
application/json
{
  • "description": "1234",
  • "hostname": "ext.key.manager.com",
  • "name": "myobject-5",
  • "password": "abc123",
  • "port": 1234,
  • "protocol": "KMIP1_0",
  • "username": "user1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete Nimble / Alletra 6K external key manager identified by {externalKeyManagerId} Deprecated

Delete Nimble / Alletra 6K external key manager identified by {externalKeyManagerId}. This API is deprecated, use Remove external key manager API for delete functionality.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

externalKeyManagerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of external key manager. A 42 digit hexadecimal number.

Request Body schema: application/json
passphrase
string

Passphrase for local key manager used to protect the master key, required during deletion of external key manager (EKM). Encryption passphrase. Required only when it is an active EKM. String with size from 8 to 64 printable characters.

Responses

Request samples

Content type
application/json
{
  • "passphrase": "passphrase-91"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K external-key-manager identified by {externalKeyManagerId}

Get details of Nimble / Alletra 6K external-key-manager identified by {externalKeyManagerId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

externalKeyManagerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of external key manager. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/external-key-manager/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "name": "default",
  • "systemId": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "active": true,
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "customerId": "fzzf41652a53497e88cdcebc715cc1cf",
  • "description": "1234",
  • "generation": 1733129533,
  • "hostname": "ext.key.manager.com",
  • "port": 1234,
  • "protocol": "KMIP1_0",
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "status": "OK",
  • "type": "external-key-manager",
  • "username": "user1",
  • "vendor": "Utimaco"
}

Edit external key manager for a Nimble / Alletra 6K identified by {externalKeyManagerId}

Edit external key manager for a Nimble / Alletra 6K identified by {externalKeyManagerId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

externalKeyManagerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of external key manager. A 42 digit hexadecimal number.

Request Body schema: application/json
description
string

String of up to 255 printable ASCII characters. Example: '99.9999% availability'.

hostname
string

Hostname or IP Address for the External Key Manager. Plain string.

id
string

Identifier for the External key manager. A 42 digit hexadecimal number.

name
string

Name of external key manager. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

password
required
string

"External Key Manager user password. String up to 255 printable characters. String of 8 to 255 printable characters excluding ampersand and ;[]"

port
integer

Positive integer value up to 65535 representing External key manager port.

protocol
string

Possible values: 'KMIP1_0', 'KMIP1_1', 'KMIP1_2', 'KMIP1_3'.

username
required
string

External key manager username. String of up to 255 printable ASCII characters.

Responses

Request samples

Content type
application/json
{
  • "description": "1234",
  • "hostname": "ext.key.manager.com",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "name": "myobject-5",
  • "password": "abc123",
  • "port": 1234,
  • "protocol": "KMIP1_0",
  • "username": "user1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Migrate external key manager for a Nimble / Alletra 6K identified by {externalKeyManagerId}

Migrate external key manager for a Nimble / Alletra 6K identified by {externalKeyManagerId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

externalKeyManagerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of external key manager. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove Nimble / Alletra 6K external key manager identified by {externalKeyManagerId}

Remove Nimble / Alletra 6K external key manager identified by {externalKeyManagerId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

externalKeyManagerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of external key manager. A 42 digit hexadecimal number.

Request Body schema: application/json
passphrase
string

Passphrase for local key manager used to protect the master key, required during deletion of external key manager (EKM). Encryption passphrase. Required only when it is an active EKM. String with size from 8 to 64 printable characters.

Responses

Request samples

Content type
application/json
{
  • "passphrase": "passphrase-91"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

folders

The folders API allows the management of folders

Create Nimble / Alletra 6K folder in system identified by {systemId}

Create Nimble / Alletra 6K folder in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
access_protocol
string or null

Access protocol of the folder. This attribute is used by the VASA Provider to determine the access protocol of the bind request. If not specified in the creation request, it will be the access protocol supported by the group. If the group supports multiple protocols, the default will be Fibre Channel. This field is meaningful only to VVol folder. Possible values: 'iscsi', 'fc'.

agent_type
string or null

External management agent type. Possible values: 'none', 'smis', 'vvol', 'openstack'.

appserver_id
string or null

Identifier of the application server associated with the folder.

description
string or null

Text description of folder.

hostInitiatorGroupIDs
Array of strings or null

List of Host Initiator group IDs

hostInitiatorsIDs
Array of strings or null

List of Host Initiator IDs

inherited_vol_perfpol_id
string or null

Identifier of the default performance policy for a newly created volume.

limit_iops
integer or null <int64>

IOPS limit for this folder. If limit_iops is not specified when a folder is created, or if limit_iops is set to -1, then the folder has no IOPS limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited.

limit_mbps
integer or null <int64>

Throughput limit for this folder in MB/s. If limit_mbps is not specified when a folder is created, or if limit_mbps is set to -1, then the folder has no throughput limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited.

limit_size_bytes
integer or null <int64>

Folder size limit in bytes. If limit_size_bytes is not specified when a folder is created, or if limit_size_bytes is set to -1, then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. Folders with an agent_type of 'smis' or 'vvol' must have a size limit.

name
required
string

Name of the folder.

overdraft_limit_pct
integer or null <int64>

Amount of space to consider as overdraft range for this folder as a percentage of folder used limit. Valid values are from 0% - 200%. This is the limit above the folder usage limit beyond which enforcement action(volume offline/non-writable) is issued.

pool_id
required
string

ID of the pool where the folder resides.

provisioned_limit_size_bytes
integer or null <int64>

Limit on the provisioned size of volumes in a folder. If provisioned_limit_size_bytes is not specified when a folder is created, or if provisioned_limit_size_bytes is set to -1, then the folder has no provisioned size limit.

Responses

Request samples

Content type
application/json
{
  • "access_protocol": "iscsi",
  • "agent_type": "openstack",
  • "appserver_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "description": "99.9999% availability",
  • "hostInitiatorGroupIDs": [
    ],
  • "hostInitiatorsIDs": [
    ],
  • "inherited_vol_perfpol_id": "030a259996ae869835000000000000000000000001",
  • "limit_iops": -1,
  • "limit_mbps": -1,
  • "limit_size_bytes": -1,
  • "name": "myobject-5",
  • "overdraft_limit_pct": 0,
  • "pool_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "provisioned_limit_size_bytes": -1
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove Nimble / Alletra 6K folder identified by {folderId}

Remove Nimble / Alletra 6K folder identified by {folderId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

folderId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the folder. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K Folders identified by {folderId}

Get details of Nimble / Alletra 6K Folders identified by {folderId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

folderId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the folder. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/folders/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "name": "myobject-5",
  • "pool_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "pool_name": "myobject-5",
  • "access_protocol": "iscsi",
  • "agent_type": "openstack",
  • "app_uuid": "00000002000040008a259996ae869835",
  • "appserver_id": "string",
  • "appserver_name": "string",
  • "associated_links": [
    ],
  • "capacity_bytes": 244695092429,
  • "commonResourceAttributes": {
    },
  • "compressed_snap_usage_bytes": 0,
  • "compressed_vol_usage_bytes": 0,
  • "compression_ratio": 1,
  • "consoleUri": "null",
  • "creation_time": 1600169692,
  • "customerId": "string",
  • "description": "99.9999% availability",
  • "folset_id": "string",
  • "folset_name": "string",
  • "fqn": "/path/to/folder",
  • "free_space_bytes": 244695092429,
  • "full_name": "default:/folder1",
  • "generation": 0,
  • "inherited_vol_perfpol_id": "030a259996ae869835000000000000000000000001",
  • "inherited_vol_perfpol_name": "default",
  • "last_modified": 1600169692,
  • "limit_bytes": 244695092429,
  • "limit_bytes_specified": false,
  • "limit_iops": -1,
  • "limit_mbps": -1,
  • "limit_size_bytes": -1,
  • "num_snapcolls": 0,
  • "num_snaps": 0,
  • "overdraft_limit_pct": 0,
  • "provisioned_bytes": 0,
  • "provisioned_limit_size_bytes": -1,
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "search_name": "vol:1",
  • "snap_compression_ratio": 1,
  • "tenant_id": "2f0a259996ae869835000000000000000000000002",
  • "type": "string",
  • "uncompressed_snap_usage_bytes": 0,
  • "uncompressed_vol_usage_bytes": 0,
  • "unused_reserve_bytes": 0,
  • "unused_snap_reserve_bytes": 0,
  • "usage_bytes": 0,
  • "usage_valid": true,
  • "vol_compression_ratio": 1,
  • "volume_list": [
    ],
  • "volume_mapped_bytes": 0
}

Edit details of Nimble / Alletra 6K folder identified by {folderId}

Edit details of Nimble / Alletra 6K folder identified by {folderId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

folderId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the folder. A 42 digit hexadecimal number.

Request Body schema: application/json
appserver_id
string or null

Identifier of the application server associated with the folder.

description
string or null

Text description of folder.

inherited_vol_perfpol_id
string or null

Identifier of the default performance policy for a newly created volume.

limit_iops
integer or null <int64>

IOPS limit for this folder. If limit_iops is not specified when a folder is created, or if limit_iops is set to -1, then the folder has no IOPS limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited.

limit_mbps
integer or null <int64>

Throughput limit for this folder in MB/s. If limit_mbps is not specified when a folder is created, or if limit_mbps is set to -1, then the folder has no throughput limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited.

limit_size_bytes
integer or null <int64>

Folder size limit in bytes. If limit_size_bytes is not specified when a folder is created, or if limit_size_bytes is set to -1, then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. Folders with an agent_type of 'smis' or 'vvol' must have a size limit.

name
string or null

Name of the folder.

overdraft_limit_pct
integer or null <int64>

Amount of space to consider as overdraft range for this folder as a percentage of folder used limit. Valid values are from 0% - 200%. This is the limit above the folder usage limit beyond which enforcement action(volume offline/non-writable) is issued.

provisioned_limit_size_bytes
integer or null <int64>

Limit on the provisioned size of volumes in a folder. If provisioned_limit_size_bytes is not specified when a folder is created, or if provisioned_limit_size_bytes is set to -1, then the folder has no provisioned size limit.

Responses

Request samples

Content type
application/json
{
  • "appserver_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "description": "99.9999% availability",
  • "inherited_vol_perfpol_id": "030a259996ae869835000000000000000000000001",
  • "limit_iops": -1,
  • "limit_mbps": -1,
  • "limit_size_bytes": -1,
  • "name": "myobject-5",
  • "overdraft_limit_pct": 0,
  • "provisioned_limit_size_bytes": -1
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Attach hosts to Storage container identified by {folderId} from Nimble / Alletra 6K

Attach hosts to Storage container identified by {folderId} from Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

folderId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the folder. A 42 digit hexadecimal number.

Request Body schema: application/json
action
string
Value: "ATTACH_VVOLSC"

Attach action name

hostInitiatorGroupIDs
Array of strings or null

List of Host Initiator group IDs

hostInitiatorsIDs
Array of strings or null

List of Host Initiator IDs

Responses

Request samples

Content type
application/json
{
  • "action": "ATTACH_VVOLSC",
  • "hostInitiatorGroupIDs": [
    ],
  • "hostInitiatorsIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

health-status

The Health status API allows the monitoring of devices

Get details of Nimble / Alletra 6K health status

Get details of Nimble / Alletra 6K health status

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter health status by Key.

sort
string
Example: sort=scope desc

oData query to sort health status resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/health-status",
  • "total": 1
}

Get details of Nimble / Alletra 6K health status identified by {healthStatusId}

Get details of Nimble / Alletra 6K health status identified by {healthStatusId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

healthStatusId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of health status. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/devicetype2/2a0df0fe6f7dc7bb16000000000000000000004817/health-status/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "array_id": "1300000000000004d30000000000000001",
  • "context": "all",
  • "ctrlr_id": "1300000000000004d30000000000000001",
  • "id": "1300000000000004d30000000000000001",
  • "scope": "array",
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "customerId": "string",
  • "element_result": {
    },
  • "generation": 0,
  • "on_demand": false,
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "type": "health-check"
}

host-initiator-groups

The Host service API allows the management of Host Group

Get the list of host groups

Get the list of host groups

Authorizations:
JWTAuth
query Parameters
filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

oData query to filter hostservice by Key.

sort
string
Example: sort=name desc

oData query to sort hostservice by Key.

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 0,
  • "requestUri": "/api/v1/host-initiator-groups",
  • "total": 1
}

Create a host group

Create a host group with hosts having same protocol initiators

Authorizations:
JWTAuth
Request Body schema: application/json
comment
string or null

Comment

hostIds
Array of strings or null

List of host ids of existing hosts

Array of objects or null (CreateHostInput)

List of hosts to be created and added to this hostGroup

name
required
string or null

Name of the host group. The maximum supported length is 251 characters. Host Group name length greater than 27 characters is supported only for HPE Alletra Storage MP systems with OS version 10.4.2 and above.

userCreated
boolean or null
Deprecated

Indicates whether user created host group or discovered host group. value should always be set as "true". API will internally override the passed value to set it as "true".

Responses

Request samples

Content type
application/json
{
  • "comment": "host-group-comment",
  • "hostIds": [
    ],
  • "hostsToCreate": [
    ],
  • "name": "host-group1",
  • "userCreated": true
}

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "associatedSystems": [
    ],
  • "comment": "host-group-comment",
  • "consoleUri": "/data-ops-manager/host-initiator-groups/a8c087fa6e95dd22cdf402c64e4bbe61",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "editStatus": "Delete_Failed",
  • "generation": 1627534116,
  • "hosts": [
    ],
  • "id": "d548ef683c27403e96caa51816ddc72c",
  • "isMergable": true,
  • "markedForDelete": true,
  • "name": "host-group1",
  • "systems": [
    ],
  • "type": "host-initiator-group",
  • "userCreated": true
}

Delete a host group by {hostGroupId}

Delete a host group by {hostGroupId}

Authorizations:
JWTAuth
path Parameters
hostGroupId
required
string
Example: e789e756496246859fde6c132b2091d3

Id of the host Group.

query Parameters
force
boolean
Example: force=true

Forceful delete option

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get the host group details by {hostGroupId}

Get the host group details by {hostGroupId}

Authorizations:
JWTAuth
path Parameters
hostGroupId
required
string
Example: e789e756496246859fde6c132b2091d3

Id of the host Group.

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "associatedSystems": [
    ],
  • "comment": "host-group-comment",
  • "consoleUri": "/data-ops-manager/host-initiator-groups/a8c087fa6e95dd22cdf402c64e4bbe61",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "editStatus": "Delete_Failed",
  • "generation": 1627534116,
  • "hosts": [
    ],
  • "id": "e987ef683c27403e96caa51816ddc72c",
  • "markedForDelete": true,
  • "name": "host-group1",
  • "requestUri": "/api/v1/host-initiator-groups/1",
  • "systems": [
    ],
  • "type": "host-initiator-groups",
  • "userCreated": true
}

Update host group by {hostGroupId}

Update host group details by {hostGroupId}. Hostgroup can be updated with hosts containing same protocol initiators

Authorizations:
JWTAuth
path Parameters
hostGroupId
required
string
Example: e789e756496246859fde6c132b2091d3

Id of the host Group.

Request Body schema: application/json
Array of objects or null (HostProximityValue)

Change Proximity for list of hosts

Array of objects or null (CreateHostInput)

List of hosts to be replaced to the group

name
string or null

Name of the host group. The maximum supported length is 251 characters. Host Group name length greater than 27 characters is supported only for HPE Alletra Storage MP systems with OS version 10.4.2 and above.

removedHosts
Array of strings or null

List of host IDs to be removed from the group

updatedHosts
Array of strings or null

List of host IDs to be added to the group

Responses

Request samples

Content type
application/json
{
  • "hostProximityValues": [
    ],
  • "hostsToCreate": [
    ],
  • "name": "host-group1",
  • "removedHosts": [
    ],
  • "updatedHosts": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of a host group identified by {hostGroupId} across its associated systems

Get details of a host group identified by {hostGroupId} across its associated systems

Authorizations:
JWTAuth
path Parameters
hostGroupId
required
string
Example: e789e756496246859fde6c132b2091d3

Id of the host Group.

Responses

Response samples

Content type
application/json
{
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "id": "d548ef683c27403e96caa51816ddc72c",
  • "mappedDevices": [
    ],
  • "name": "init1"
}

Get the list of host groups which have duplicates

Get the list of host groups which have identical duplicates or are unique across different systems.

Authorizations:
JWTAuth

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "requestUri": "/api/v1/host-initiator-groups/bulkmerge",
  • "total": 1
}

Bulk merge hosts into user created host

Bulk Merge hosts into user created host

Authorizations:
JWTAuth
Request Body schema: application/json
Array of objects (CreateBulkMergeCandidatesObject)

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Merge a host group

Merge a host group

Authorizations:
JWTAuth
Request Body schema: application/json
hostGroupIds
required
Array of strings or null

Array of host group ids

name
required
string or null

Name of the host Group. The maximum supported length is 251 characters. Host Group name length greater than 27 characters is supported only for HPE Alletra Storage MP systems with OS version 10.4.2 and above.

Responses

Request samples

Content type
application/json
{
  • "hostGroupIds": [
    ],
  • "name": "host1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get all nimble host initiator groups details by Nimble / Alletra 6K

Get all nimble host initiator groups details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter initiator groups by Key.

sort
string
Example: sort=name desc

oData query to sort initiator groups resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/host-groups",
  • "total": 1
}

Create Nimble / Alletra 6K initiator group in system identified by {systemId} Deprecated

Create Nimble / Alletra 6K initiator group in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
access_protocol
required
string

Initiator group access protocol.

app_uuid
string or null

Application identifier of initiator group. String of up to 255 alphanumeric characters, hyphen, colon, dot and underscore are allowed

description
string or null

Text description of initiator group. String of up to 255 printable ASCII characters.

Array of objects or null or null (NimbleFCInitiator)

List of FC initiators. When create/update fc_initiators, wwpn is required. List of Fibre Channel initiators.

Array of objects or null or null (NimbleFCTdzPorts)

List of target Fibre Channel ports with Target Driven Zoning configured on this initiator group. List of target ports.

host_type
string or null

Initiator group host type. Available options are auto and hpux. The default option is auto. This attribute will be applied to all the initiators in the initiator group. Initiators with different host OSes should not be kept in the same initiator group having a non-default host type attribute. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

Array of objects or null or null (NimbleISCSIInitiator)

List of iSCSI initiators. When create/update iscsi_initiators, either iqn or ip_address is always required with label.

Array of objects or null or null (NimbleMetadata)

Key-value pairs that augment an initiator group's attributes.

name
required
string

Name of initiator group. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

Array of objects or null or null (NimbleTargetSubnets)

List of target subnet labels. If specified, discovery and access to volumes will be restricted to

Responses

Request samples

Content type
application/json
{
  • "access_protocol": "iscsi",
  • "app_uuid": "rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18",
  • "description": "99.9999% availability",
  • "fc_initiators": [
    ],
  • "fc_tdz_ports": [
    ],
  • "host_type": "myobject-5",
  • "iscsi_initiators": [
    ],
  • "metadata": [
    ],
  • "name": "myobject-5",
  • "target_subnets": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove initiator-groups identified by {hostInitiatorGroupId} from Nimble / Alletra 6K Deprecated

Remove initiator-groups identified by {hostInitiatorGroupId} from Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

hostInitiatorGroupId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of initiator group. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K Nimble Initiators identified by {hostInitiatorGroupId}

Get details of Nimble / Alletra 6K Nimble Initiators identified by {hostInitiatorGroupId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

hostInitiatorGroupId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of initiator group. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/devicetype2/2a0df0fe6f7dc7bb16000000000000000000004817/host-groups/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "access_protocol": "iscsi",
  • "app_uuid": "rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18",
  • "host_type": "myobject-5",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "name": "myobject-5",
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "creation_time": 3400,
  • "customerId": "string",
  • "description": "99.9999% availability",
  • "fc_initiators": [
    ],
  • "fc_sessions": [
    ],
  • "fc_tdz_ports": [
    ],
  • "full_name": "myobject-5",
  • "generation": 0,
  • "iscsi_initiators": [
    ],
  • "last_modified": 3400,
  • "metadata": [
    ],
  • "num_connections": 1234,
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "sc_HostId": "132b493352ca3141456333edf403be0c",
  • "search_name": "vol:1",
  • "target_subnets": [
    ],
  • "type": "string",
  • "volume_count": 1234,
  • "volume_list": [
    ]
}

Update initiator-groups identified by {hostInitiatorGroupId} Deprecated

Update initiator-groups identified by {hostInitiatorGroupId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

hostInitiatorGroupId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of initiator group. A 42 digit hexadecimal number.

Request Body schema: application/json
app_uuid
string or null

Application identifier of initiator group. String of up to 255 alphanumeric characters, hyphen, colon, dot and underscore are allowed.

description
string or null

Text description of initiator group. String of up to 255 printable ASCII characters.

Array of objects or null or null (NimbleFCInitiator)

List of FC initiators. When create/update fc_initiators, wwpn is required. List of Fibre Channel initiators.

Array of objects or null or null (NimbleFCTdzPorts)

List of target Fibre Channel ports with Target Driven Zoning configured on this initiator group. List of target ports.

host_type
string or null

Initiator group host type. Available options are auto and hpux. The default option is auto. This attribute will be applied to all the initiators in the initiator group. Initiators with different host OSes should not be kept in the same initiator group having a non-default host type attribute. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

Array of objects or null or null (NimbleISCSIInitiator)

List of iSCSI initiators. When create/update iscsi_initiators, either iqn or ip_address is always required with label.

Array of objects or null or null (NimbleMetadata)

Key-value pairs that augment an initiator group's attributes.

name
string

Name of initiator group. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

Array of objects or null or null (NimbleTargetSubnets)

List of target subnet labels. If specified, discovery and access to volumes will be restricted to to the specified subnets. List of target subnet tables.

Responses

Request samples

Content type
application/json
{
  • "app_uuid": "rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18",
  • "description": "99.9999% availability",
  • "fc_initiators": [
    ],
  • "fc_tdz_ports": [
    ],
  • "host_type": "myobject-5",
  • "iscsi_initiators": [
    ],
  • "metadata": [
    ],
  • "name": "myobject-5",
  • "target_subnets": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

host-initiators

The Host service API allows the management of Host, initiators

Get the list of hosts

Get the list of hosts

Authorizations:
JWTAuth
query Parameters
filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

oData query to filter hostservice by Key.

sort
string
Example: sort=name desc

oData query to sort hostservice by Key.

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 0,
  • "requestUri": "/api/v1/host-initiators",
  • "total": 1
}

Create a host

Create a host with same protocol initiators

Authorizations:
JWTAuth
Request Body schema: application/json
comment
string or null

Comment

contact
string or null

Contact information

fqdn
string or null

Fully qualified domain name of the host.

hostGroupIds
Array of strings or null

List of hostgroup IDs

initiatorIds
Array of strings or null

List of ids of existing initiators

Array of objects or null (InitiatorInput)

List of initiators to be created and added to this host

ipAddress
string or null

IP address of the host.

isVvolHost
boolean or null
Deprecated

Set this value to true if you want to use this host to export the VASA vVOLs using NVMe protocol.

location
string or null

location.

model
string or null

Model

name
required
string or null

Name of the host.

operatingSystem
required
string or null
Enum: "AIX" "Apple" "Citrix Hypervisor(XenServer)" "HP-UX" "IBM VIO Server" "InForm" "NetApp/ONTAP" "OE Linux UEK" "OpenVMS" "Oracle VM x86" "RHE Linux" "RHE Virtualization" "Solaris" "SuSE Linux" "SuSE Virtualization" "Ubuntu" "VMware (ESXi)" "Windows Server"

Host operating system. Possible Values are: - AIX - Apple - Citrix Hypervisor(XenServer) - HP-UX - IBM VIO Server - InForm - NetApp/ONTAP - OE Linux UEK - OpenVMS - Oracle VM x86 - RHE Linux - RHE Virtualization - Solaris - SuSE Linux - SuSE Virtualization - Ubuntu - VMware (ESXi) - Windows Server

persona
string or null

Host persona details.

protocol
string or null

protocol

subnet
string or null

subnet.

userCreated
boolean or null
Deprecated

Indicates whether user created host or discovered host. value should always be set as "true". API will internally override the passed value to set it as "true".

Responses

Request samples

Content type
application/json
{
  • "comment": "comment1",
  • "contact": "sanjay@hpe.com",
  • "fqdn": "host1.hpe.com",
  • "hostGroupIds": [
    ],
  • "initiatorIds": [
    ],
  • "initiatorsToCreate": [
    ],
  • "ipAddress": "15.212.100.100",
  • "isVvolHost": true,
  • "location": "India",
  • "model": "model1",
  • "name": "host1",
  • "operatingSystem": "Windows Server",
  • "persona": "AIX-Legacy",
  • "protocol": "protocol1",
  • "subnet": "255.255.255.0",
  • "userCreated": true
}

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "associatedSystems": [
    ],
  • "comment": "a sample host comment",
  • "consoleUri": "/data-ops-manager/host-initiators/0951b6508ec9f8747f08daf68925d81d",
  • "contact": "sanjay@hpe.com",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "editStatus": "Delete_Failed",
  • "fqdn": "host1.hpe.com",
  • "generation": 1627534116,
  • "hostGroups": [
    ],
  • "id": "6848ef683c27403e96caa51816ddc72c",
  • "initiators": [
    ],
  • "ipAddress": "15.212.100.100",
  • "isMergable": true,
  • "isVvolHost": true,
  • "location": "India",
  • "markedForDelete": true,
  • "model": "model1",
  • "name": "host1",
  • "operatingSystem": "Windows",
  • "persona": "AIX-Legacy",
  • "protocol": "FC",
  • "subnet": "255.255.255.0",
  • "systems": [
    ],
  • "type": "host-initiator",
  • "userCreated": true
}

Delete a host by {hostId}

Delete a host by {hostId}

Authorizations:
JWTAuth
path Parameters
hostId
required
string
Example: 2b09e744496246859fde6c132b2091d3

Id of the Host.

query Parameters
force
boolean
Example: force=true

Forceful delete option

deleteAssociatedEmptyHostGroup
boolean
Example: deleteAssociatedEmptyHostGroup=true

Delete the resulting empty host group associated to this host option

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get the host details by {hostId}

Get the host details by {hostId}

Authorizations:
JWTAuth
path Parameters
hostId
required
string
Example: 2b09e744496246859fde6c132b2091d3

Id of the Host.

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "associatedSystems": [
    ],
  • "comment": "comment1",
  • "consoleUri": "/data-ops-manager/host-initiators/0951b6508ec9f8747f08daf68925d81d",
  • "contact": "sanjay@hpe.com",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "editStatus": "Delete_Failed",
  • "fqdn": "host1.hpe.com",
  • "generation": 1627534116,
  • "hostGroups": [
    ],
  • "id": "d548ef683c27403e96caa51816ddc72c",
  • "initiators": [
    ],
  • "ipAddress": "15.212.100.100",
  • "isMergable": true,
  • "isVvolHost": true,
  • "location": "India",
  • "markedForDelete": true,
  • "model": "model1",
  • "name": "host1",
  • "operatingSystem": "Windows",
  • "persona": "AIX-Legacy",
  • "protocol": "FC",
  • "requestUri": "/api/v1/host-initiators/1",
  • "subnet": "255.255.255.0",
  • "systems": [
    ],
  • "type": "host-initiator",
  • "userCreated": true
}

Update Host by {hostId}

Update host details by {hostId}. Host can only be updated with the same protocol initiators

Authorizations:
JWTAuth
path Parameters
hostId
required
string
Example: 2b09e744496246859fde6c132b2091d3

Id of the Host.

Request Body schema: application/json
Array of objects or null (InitiatorInput)

List of initiators to be created and added to this host

name
string or null

Name of the host.

updatedInitiators
Array of strings or null

List of existing initiator IDs to be replaced to the host

Responses

Request samples

Content type
application/json
{
  • "initiatorsToCreate": [
    ],
  • "name": "host1",
  • "updatedInitiators": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get Host CHAP details by {hostId}

Get Host CHAP details by {hostId}

Authorizations:
JWTAuth
path Parameters
hostId
required
string
Example: 2b09e744496246859fde6c132b2091d3

Id of the Host.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "requestUri": "/api/v1/host-initiators",
  • "total": 1
}

Update Host CHAP by {hostId}

Update Host CHAP details by {hostId}. Only iSCSI Host can be updated.

Authorizations:
JWTAuth
path Parameters
hostId
required
string
Example: 2b09e744496246859fde6c132b2091d3

Id of the Host.

Request Body schema: application/json
Array of objects or null or null (HostChapInputObject)

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of a host identified by {hostId} across its associated systems

Get details of a host identified by {hostId} across its associated systems

Authorizations:
JWTAuth
path Parameters
hostId
required
string
Example: 2b09e744496246859fde6c132b2091d3

Id of the Host.

Responses

Response samples

Content type
application/json
{
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "id": "d548ef683c27403e96caa51816ddc72c",
  • "mappedDevices": [
    ],
  • "name": "init1"
}

Get the volume performance history data associated with a host identified by {uid}

Get the volume performance history data associated with a host identified by {uid}

Authorizations:
JWTAuth
path Parameters
hostId
required
string
Example: 2b09e744496246859fde6c132b2091d3

Id of the Host.

query Parameters
select
string
Example: select=latencyMetricsDataMs

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Value: 1440
Example: timeIntervalMin=1440

It defines granularity in minutes.

topVolumesCount
integer
Example: topVolumesCount=5

The number of top volumes to be returned, by default it will be 5

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "hostVolumePerfTrendData": {
    },
  • "requestURI": "/v1/host-initiators/2b09e744496246859fde6c132b2091d3/storage-performance-history"
}

Get details of volumes associated with a host identified by {uid}

Get details of volumes associated with a host identified by {uid}

Authorizations:
JWTAuth
path Parameters
hostId
required
string
Example: 2b09e744496246859fde6c132b2091d3

Id of the Host.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/host-initiators/2b09e744496246859fde6c132b2091d3/volumes",
  • "total": 1
}

Get the list of hosts which have duplicates

Get the list of hosts which have identical duplicates or are unique across different systems.

Authorizations:
JWTAuth

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "requestUri": "/api/v1/host-initiators/bulkmerge",
  • "total": 1
}

Bulk merge hosts into user created host

Bulk Merge hosts into user created host

Authorizations:
JWTAuth
Request Body schema: application/json
Array of objects (CreateBulkMergeCandidatesObject)

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Merge hosts into user created host

Merge hosts into user created host

Authorizations:
JWTAuth
Request Body schema: application/json
hostIds
required
Array of strings or null

host IDs of hosts which are needed to be merged.

name
required
string or null

Name of the host being created.

operatingSystem
required
string or null

Host operating system. Possible Values are: - AIX - Apple - Citrix Hypervisor(XenServer) - HP-UX - IBM VIO Server - InForm - NetApp/ONTAP - OE Linux UEK - OpenVMS - Oracle VM x86 - RHE Linux - RHE Virtualization - Solaris - SuSE Linux - SuSE Virtualization - Ubuntu - VMware (ESXi) - Windows Server

Responses

Request samples

Content type
application/json
{
  • "hostIds": [
    ],
  • "name": "host1",
  • "operatingSystem": "Windows Server"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get the list of initiators

Get the list of initiators

Authorizations:
JWTAuth
query Parameters
filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

oData query to filter hostservice by Key.

sort
string
Example: sort=name desc

oData query to sort hostservice by Key.

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 0,
  • "requestUri": "/api/v1/initiators",
  • "total": 1
}

Create initiator

Create initiator

Authorizations:
JWTAuth
Request Body schema: application/json
address
required
string or null

Address of the initiator.

driverVersion
string or null

Driver version of the host initiator.

firmwareVersion
string or null

Firmware version of the host initiator.

hbaModel
string or null

Host bus adaptor model of the host initiator

hostSpeed
integer or null <int64>

Host speed

ipAddress
string or null

IP address of the initiator.

name
string or null

Name of the initiator.

protocol
required
string or null

protocol supported are : FC, iSCSI or NVMe

vendor
string or null

Vendor of the host initiator

Responses

Request samples

Content type
application/json
{
  • "address": "iqn.1998-01.com.vmware:61f7c688-3e93-d360-8043-70106f7a7e18-0cba0054",
  • "driverVersion": "4.1",
  • "firmwareVersion": "10.0",
  • "hbaModel": "model-5",
  • "hostSpeed": 1000,
  • "ipAddress": "15.212.100.100",
  • "name": "init1",
  • "protocol": "iSCSI",
  • "vendor": "hpe"
}

Response samples

Content type
application/json
{
  • "address": "100008F1EABFE61C",
  • "associatedLinks": [
    ],
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "driverVersion": "4.1",
  • "firmwareVersion": "10.0",
  • "generation": 1627534116,
  • "hbaModel": "myobject-5",
  • "hostSpeed": 1000,
  • "hosts": [
    ],
  • "id": "d548ef683c27403e96caa51816ddc72c",
  • "ipAddress": "15.212.100.100",
  • "name": "init1",
  • "protocol": "FC",
  • "systems": [
    ],
  • "type": "initiator",
  • "vendor": "hpe"
}

Delete initiator by {initiatorId}

Delete initiator by {initiatorId}

Authorizations:
JWTAuth
path Parameters
initiatorId
required
string
Example: e789e756496246859fde6c132b2091d3

UID of Initiator.

Responses

Response samples

Content type
application/json
{
  • "deleteInitiator": true
}

Get the initiator details by {initiatorId}

Get the initiator details by {initiatorId}

Authorizations:
JWTAuth
path Parameters
initiatorId
required
string
Example: e789e756496246859fde6c132b2091d3

UID of Initiator.

Responses

Response samples

Content type
application/json
{
  • "address": "100008F1EABFE61C",
  • "associatedLinks": [
    ],
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "driverVersion": "4.1",
  • "firmwareVersion": "10.0",
  • "generation": 1627534116,
  • "hbaModel": "myobject-5",
  • "hostSpeed": 1000,
  • "hosts": [
    ],
  • "id": "e748ef683c27403e96caa51816ddc72c",
  • "ipAddress": "15.212.100.100",
  • "name": "init1",
  • "pathType": "FC",
  • "protocol": "FC",
  • "requestUri": "/api/v1/initiators/1",
  • "systems": [
    ],
  • "type": "initiator",
  • "vendor": "hpe"
}

Get all nimble initiators details by Nimble / Alletra 6K

Get all nimble initiators details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter initiators by Key.

sort
string
Example: sort=initiator_group_name desc

oData query to sort initiators resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/host-initiators",
  • "total": 1
}

Create Nimble / Alletra 6K nimble initiator in system identified by {systemId} Deprecated

Get all nimble initiators details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
access_protocol
required
string

Access protocol used by the initiator. Possible values: 'iscsi', 'fc'.

alias
string or null

Alias of the Fibre Channel initiator. Maximum alias length is 32 characters. Each initiator alias must have an associated WWPN specified using the 'wwpn' attribute.You can choose not to enter the WWPN for an initiator when using previously saved initiator alias.String of up to 32 alphanumeric characters, or one of $^-_.: cannot begin with non-alphanumeric character.Filter, Sort

chapuser_id
string or null

Identifier for the CHAP user.

initiator_group_id
required
string

Identifier of the initiator group that this initiator is assigned to. A 42 digit hexadecimal number.

ip_address
string or null

IP address of the iSCSI initiator. Each initiator IP address must have an associated name specified using 'name' attribute.You can choose not to enter the name for an initiator if you prefer not to authenticate using both name and IP address, in this case the IQN name will be returned as ''. Alphanumeric, hyphenated, colon or period separated string of up to 255 characters or ''

iqn
string or null

IQN name of the iSCSI initiator. Each initiator IQN name must have an associated IP address specified using the 'ip_address' attribute.You can choose not to enter the IP address for an initiator if you prefer not to authenticate using both name and IP address,in this case the IP address will be returned as '*'.

label
string or null

Unique Identifier of the iSCSI initiator. Label is required when creating iSCSI initiator. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

override_existing_alias
boolean or null

Forcibly add Fibre Channel initiator to initiator group by updating or removing conflicting Fibre Channel initiator aliases.

wwpn
string or null

WWPN (World Wide Port Name) of the Fibre Channel initiator. WWPN is required when creating a Fibre Channel initiator. Each initiator WWPN can have an associated alias specified using the 'alias' attribute. You can choose not to enter the alias for an initiator if you prefer not to assign an initiator alias. Eight bytes expressed in hex separated by colons.

Responses

Request samples

Content type
application/json
{
  • "access_protocol": "iscsi",
  • "alias": "my_initiator-4",
  • "chapuser_id": "011c9973433673c3db000000000000000000000000",
  • "initiator_group_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "ip_address": "iqn.2007-11.com.storage:zmytestvol1-v0df0fe6f7dc7bb16.0000016b.70374579",
  • "iqn": "iqn.2007-11.com.storage:zmytestvol1-v0df0fe6f7dc7bb16.0000016b.70374579",
  • "label": "myobject-5",
  • "override_existing_alias": true,
  • "wwpn": "af:32:f1:20:bc:ba:43:1a"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove Nimble Initiator identified by {hostInitiatorId} from Nimble / Alletra 6K Deprecated

Remove Nimble Initiator identified by {hostInitiatorId} from Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

hostInitiatorId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of Host Initiator. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K Nimble Initiators identified by {hostInitiatorId}

Get details of Nimble / Alletra 6K Nimble Initiators identified by {hostInitiatorId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

hostInitiatorId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the nimble initiator. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "access_protocol": "string",
  • "alias": "my_initiator-4",
  • "associated_links": [
    ],
  • "chapuser_id": "011c9973433673c3db000000000000000000000000",
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "creation_time": 3400,
  • "customerId": "string",
  • "generation": 0,
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "initiator_group_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "initiator_group_name": "myobject-5",
  • "ip_address": "iqn.2007-11.com.storage:zmytestvol1-v0df0fe6f7dc7bb16.0000016b.70374579",
  • "iqn": null,
  • "label": "myobject-5",
  • "last_modified": 3400,
  • "override_existing_alias": null,
  • "requestUri": "api/v1/storage-systems/devicetype2/2a0df0fe6f7dc7bb16000000000000000000004817/host-initiators/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "sc_HostInitiatorId": "1223f5s",
  • "type": "string",
  • "wwpn": "af:32:f1:20:bc:ba:43:1a"
}

host-paths

The ports API allows the management of host-paths

Get details of Primera / Alletra 9K Host Paths

Get details of Primera / Alletra 9K Host Paths

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter host path by Key.

sort
string
Example: sort=HostSpeed desc

oData query to sort host path resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/host-paths",
  • "total": 1
}

Get details of Primera / Alletra 9K Host Path identified by {HostPathId}

Get details of Primera / Alletra 9K Host Path identified by {HostPathId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

hostPathId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the primera Host Path. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "IPAddr": "1.1.1.1",
  • "address": "810009440c9ce5824",
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "displayname": "Drive 0.SIDE_NONE.2.0",
  • "domain": "-",
  • "driverVersion": "v1.0.0",
  • "firmwareVersion": "v1.0.0",
  • "generation": 1652172206,
  • "hostId": 101780,
  • "hostName": "test-host",
  • "hostSpeed": 100,
  • "id": "1223f5s",
  • "model": "model_1",
  • "pathType": "FC",
  • "portPos": {
    },
  • "resourceUri": "/v1/storage-systems/host-paths/dbce79b2612cde02a6e0be8934c330ec",
  • "sc_HostInitiatorId": "1223f5s",
  • "switchPortWWN": "5001438026e98a60",
  • "systemUid": "7CE727P35M",
  • "systemWWN": "swK21",
  • "uri": "/api/v3/hostpaths/dbce79b2612cde02a6e0be8934c330ec",
  • "vendor": "-"
}

Get details of HPE Alletra Storage MP Host Paths

Get details of HPE Alletra Storage MP Host Paths

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter host path by Key.

sort
string
Example: sort=HostSpeed desc

oData query to sort host path resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/host-paths",
  • "total": 1
}

Get details of HPE Alletra Storage MP Host Path identified by {HostPathId}

Get details of HPE Alletra Storage MP Host Path identified by {HostPathId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

hostPathId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the HPE Alletra Storage MP Host Path. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "IPAddr": "1.1.1.1",
  • "address": "810009440c9ce5824",
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "displayname": "Drive 0.SIDE_NONE.2.0",
  • "domain": "-",
  • "driverVersion": "v1.0.0",
  • "firmwareVersion": "v1.0.0",
  • "generation": 1652172206,
  • "hostId": 101780,
  • "hostName": "test-host",
  • "hostSpeed": 100,
  • "id": "1223f5s",
  • "model": "model_1",
  • "pathType": "FC",
  • "portPos": {
    },
  • "resourceUri": "/v1/storage-systems/host-paths/dbce79b2612cde02a6e0be8934c330ec",
  • "sc_HostInitiatorId": "1223f5s",
  • "switchPortWWN": "5001438026e98a60",
  • "systemUid": "7CE727P35M",
  • "systemWWN": "swK21",
  • "uri": "/api/v3/hostpaths/dbce79b2612cde02a6e0be8934c330ec",
  • "vendor": "-"
}

host-sets

The ports API allows the management of host-sets

Get details of Primera / Alletra 9K Host Sets

Get details of Primera / Alletra 9K Host Sets

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter host set by Key.

sort
string
Example: sort=HostSpeed desc

oData query to sort host set resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1/host-paths",
  • "total": 1
}

Get details of Primera / Alletra 9K Host Set identified by {HostSetId}

Get details of Primera / Alletra 9K Host Set identified by {HostSetId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

hostSetId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the primera Host Set. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "comment": "hostset comment",
  • "commonResourceAttributes": {
    },
  • "displayname": "Drive 0.SIDE_NONE.2.0",
  • "domain": "slt",
  • "generation": 101780,
  • "hostSetId": 101780,
  • "id": "1223f5s",
  • "members": [
    ],
  • "name": "test-host-set",
  • "resourceUri": "/v1/storage-systems/host-setss/dbce79b2612cde02a6e0be8934c330ec",
  • "sc_HostGroupId": "1223f5s",
  • "systemUid": "swK21",
  • "systemWWN": "swK21",
  • "uri": "/api/v3/hostsets/dbce79b2612cde02a6e0be8934c330ec",
  • "uuid": "1223f5s"
}

Get details of HPE Alletra Storage MP Host Sets

Get details of HPE Alletra Storage MP Host Sets

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter host set by Key.

sort
string
Example: sort=HostSpeed desc

oData query to sort host set resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type4/host-paths",
  • "total": 1
}

Get details of HPE Alletra Storage MP Host Set identified by {HostSetId}

Get details of HPE Alletra Storage MP Host Set identified by {HostSetId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

hostSetId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the HPE Alletra Storage MP Host Set. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "comment": "hostset comment",
  • "commonResourceAttributes": {
    },
  • "displayname": "Drive 0.SIDE_NONE.2.0",
  • "domain": "slt",
  • "generation": 101780,
  • "hostSetId": 101780,
  • "id": "1223f5s",
  • "members": [
    ],
  • "name": "test-host-set",
  • "resourceUri": "/v1/storage-systems/host-setss/dbce79b2612cde02a6e0be8934c330ec",
  • "sc_HostGroupId": "1223f5s",
  • "systemUid": "swK21",
  • "systemWWN": "swK21",
  • "uri": "/api/v3/hostsets/dbce79b2612cde02a6e0be8934c330ec",
  • "uuid": "1223f5s"
}

hosts

The ports API allows the management of hosts

Get details of Primera / Alletra 9K Hosts

Get details of Primera / Alletra 9K Hosts

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter host by Key.

sort
string
Example: sort=HostSpeed desc

oData query to sort host resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1/host-paths",
  • "total": 1
}

Get details of Primera / Alletra 9K Host identified by {HostId}

Get details of Primera / Alletra 9K Host identified by {HostId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

hostId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the primera Host Set. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "agent": {
    },
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "descriptors": {
    },
  • "displayname": "Drive 0.SIDE_NONE.2.0",
  • "domain": "slt",
  • "generation": 1652172502,
  • "hostId": 101780,
  • "hostpaths": [
    ],
  • "id": "132b493352ca3141456333edf403be0c",
  • "initiatorChapEnabled": true,
  • "initiatorChapName": "chapName",
  • "initiatorEncryptedChapSecret": "secret",
  • "minLunId": 10,
  • "name": "test-host",
  • "persona": {
    },
  • "resourceUri": "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a",
  • "sc_HostId": "132b493352ca3141456333edf403be0c",
  • "state": {
    },
  • "stateDescription": [
    ],
  • "stateVal": 1,
  • "systemUid": "swK21",
  • "systemWWN": "swK21",
  • "targetChapEnabled": true,
  • "targetChapName": "sltest1",
  • "targetEncryptedChapSecret": "Target Encrypted Chap Secret",
  • "uaRepLun": true,
  • "uri": "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a"
}

Get details of HPE Alletra Storage MP Hosts

Get details of HPE Alletra Storage MP Hosts

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter host by Key.

sort
string
Example: sort=HostSpeed desc

oData query to sort host resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type4/host-paths",
  • "total": 1
}

Get details of HPE Alletra Storage MP Host identified by {HostId}

Get details of HPE Alletra Storage MP Host identified by {HostId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

hostId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the HPE Alletra Storage MP Host Set. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "agent": {
    },
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "descriptors": {
    },
  • "displayname": "Drive 0.SIDE_NONE.2.0",
  • "domain": "slt",
  • "generation": 1652172502,
  • "hostId": 101780,
  • "hostpaths": [
    ],
  • "id": "132b493352ca3141456333edf403be0c",
  • "initiatorChapEnabled": true,
  • "initiatorChapName": "chapName",
  • "initiatorEncryptedChapSecret": "secret",
  • "isVvolHost": true,
  • "minLunId": 10,
  • "name": "test-host",
  • "persona": {
    },
  • "resourceUri": "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a",
  • "sc_HostId": "132b493352ca3141456333edf403be0c",
  • "state": {
    },
  • "stateDescription": [
    ],
  • "stateVal": 1,
  • "systemUid": "swK21",
  • "systemWWN": "swK21",
  • "targetChapEnabled": true,
  • "targetChapName": "sltest1",
  • "targetEncryptedChapSecret": "Target Encrypted Chap Secret",
  • "uaRepLun": true,
  • "uri": "/api/v3/hosts/2492b4e84f7536577a38be78f0da0c1a"
}

issues

Issues API

Returns a list of active issues associated with the account, scoped by the user's permissions

Returns the active (state="CREATED") issues for the account, which are associated with the resource-types for which the user has access. The user should also have the permission to view issues. Eg: if there are issues associated with 50 resources (of different resource-types) for a customer (obtained from the request header), and the user (obtained from the request headers), who has correct permissions to view the issues but has acceess to only 20 of those resources (ie access to their resource types), this API will return only the issues associated with those 20 resources. The grouped issues are places next to each other. The client will have to process them for any desired grouping

Authorizations:
JWTAuth
query Parameters
offset
integer

The number of items to skip before starting to collect the result set

limit
integer

The numbers of items to return

filter
string

The filter query parameter is used to filter the set of resources returned in the response. The returned set of resources must match the criteria in the filter query parameter A comparision compares a property name to a literal. The comparisons supported are the following: “eq” : Is a property equal to value. Valid for number, boolean and string properties. “gt” : Is a property greater than a value. Valid for number or string timestamp properties. “lt” : Is a property less than a value. Valid for number or string timestamp properties “in” : Is a value in a property (that is an array of strings) Syntax: “eq” : filter= eq {host:port}/api/v1/issues?filter= eq “gt” : filter= gt {host:port}/api/v1/issues?filter= gt “lt” : filter= lt {host:port}/api/v1/issues?filter= lt “in” : filter= in {host:port}/api/v1/issues?filter= in

  • Can use and to add more filter inputs {host:port}/api/v1/issues?filter= eq and lt
  • To filter multiple values on one property e.g. filter=severity in ('CRITICAL','WARNING') {host:port}/api/v1/issues?filter=severity%20in%20CRITICAL%2CWARNING Examples: GET /api/v1/issues?filter=issueType eq 'ISSUE' GET /api/v1/issues?filter=issueType eq 'ISSUE' and state eq 'CREATED' GET /api/v1/issues?filter=relatedObjectType in ('NIMBLE-VOLUME') Filters are supported on following attributes: issueType, severity, category, state, relatedObject (relatedObject.resourceUri), relatedObjectType (relatedObject.type), relatedObjectOwner (relatedObjectOwner.resourceUri), relatedObjectOwnerType (relatedObjectOwner.type), ruleId, createdAt
sort
string
Example: sort=/issues?sort=id desc

resource property to sort, with an order appended Order may only be either “asc” (ascending) or “desc” (descending)

select
string

The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client. The property “select” is the name of the select query parameter; its value is the list of properties to return separated by commas.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 0,
  • "pageOffset": 0,
  • "total": 0
}

Returns the active issue with the given Id

Returns the active issue (state="CREATED") associated with the account (retrieved from the request headers) and with given Id

Authorizations:
JWTAuth
path Parameters
id
required
string <uuid>

The UUID of the issue

query Parameters
select
string

The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client. The property “select” is the name of the select query parameter; its value is the list of properties to return separated by commas.

Responses

Response samples

Content type
application/json
{
  • "additionalDetails": {
    },
  • "body": "string",
  • "category": "string",
  • "clearedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "generation": "string",
  • "id": "string",
  • "issueType": "string",
  • "lastOccurredAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "occurrenceCount": 0,
  • "relatedResource": {
    },
  • "relatedResourceOwner": {
    },
  • "resourceUri": "string",
  • "ruleId": "string",
  • "severity": "string",
  • "state": "string",
  • "title": "string",
  • "type": "string"
}

local-key-manager

The Local Key Manager API allows the management of local key manager

Get details of Nimble / Alletra 6K local-key-manager

Get details of Nimble / Alletra 6K local-key-manager

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/local-key-manager",
  • "total": 1
}

Create local key manager for a Nimble / Alletra 6K storage system

Create local key manager for a Nimble / Alletra 6K storage system

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
passphrase
required
string

Passphrase for local key manager. String with size from 8 to 64 printable characters.

Responses

Request samples

Content type
application/json
{
  • "passphrase": "passphrase-91"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete Nimble / Alletra 6K local key manager identified by {localKeyManagerId}

Delete Nimble / Alletra 6K local key manager identified by {localKeyManagerId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

localKeyManagerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of local key manager. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K local-key-manager identified by {localKeyManagerId}

Get details of Nimble / Alletra 6K local-key-manager identified by {localKeyManagerId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

localKeyManagerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of local key manager. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/local-key-manager/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "name": "default",
  • "active": true,
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "generation": 0,
  • "purgeAge": 1234,
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "type": "string"
}

Edit local key manager for a Nimble / Alletra 6K identified by {localKeyManagerId}

Edit local key manager for a Nimble / Alletra 6K identified by {localKeyManagerId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

localKeyManagerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of local key manager. A 42 digit hexadecimal number.

Request Body schema: application/json
active
boolean
Deprecated

Whether the master key is active or not. Possible values: 'true', 'false'.

new_passphrase
required
string

New passphrase for local key manager. String with size from 8 to 64 printable characters.

passphrase
required
string

Existing passphrase for local key manager. String with size from 8 to 64 printable characters.

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "new_passphrase": "passphrase-new",
  • "passphrase": "passphrase-91"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

performance-templates

The Performance templates API allows the the management of performance policies

Get all performance-policies details by Nimble / Alletra 6K

Get all performance-policies details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter performance Policy by Key.

sort
string
Example: sort=name desc

oData query to sort performance Policy resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/performance-policies",
  • "total": 1
}

Create Nimble / Alletra 6K performance policy in a system identified by {systemId}

Create Nimble / Alletra 6K performance policy in a system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
app_category
string or null

Specifies the application category of the associated volume. Plain string. Defaults to 'Unassigned'.

block_size
integer or null <int64>

Block Size in bytes to be used by the volumes created with this specific performance policy. Supported block sizes are 4096 bytes (4 KB), 8192 bytes (8 KB), 16384 bytes(16 KB), and 32768 bytes (32 KB). Block size of a performance policy cannot be changed once the performance policy is created. Defaults to 4096.

cache
boolean or null

Flag denoting if data in the associated volume should be cached. Defaults to 'true'.

cache_policy
string or null

Specifies how data of associated volume should be cached. Supports two policies, 'normal' and 'aggressive'. 'normal' policy caches data but skips in certain conditions such as sequential I/O. 'aggressive' policy will accelerate caching of all data belonging to this volume, regardless of sequentiality. Possible values:'normal', 'no_write', 'aggressive_read_no_write', 'disabled', 'aggressive'. Defaults to 'normal'.

compress
boolean or null

Flag denoting if data in the associated volume should be compressed. Defaults to 'true'.

dedupe_enabled
boolean or null

Specifies if dedupe is enabled for volumes created with this performance policy.

description
string or null

Description of a performance policy. String of up to 255 printable ASCII characters.

name
required
string

Name of the Performance Policy. String of up to 64 alphanumeric characters, - and . and : and space are allowed after first character.

space_policy
string or null

Specifies the state of the volume upon space constraint violation such as volume limit violation or volumes above their volume reserve, if the pool free space is exhausted. Supports two policies, 'offline' and 'non_writable'. Possible values:'offline', 'login_only', 'non_writable', 'read_only', 'invalid'. Defaults to 'offline'.

Responses

Request samples

Content type
application/json
{
  • "app_category": "Unassigned",
  • "block_size": 4096,
  • "cache": true,
  • "cache_policy": "normal",
  • "compress": true,
  • "dedupe_enabled": false,
  • "description": "99.9999% availability",
  • "name": "SQL Server Logs",
  • "space_policy": "offline"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove performance-policies identified by {performancePolicyId} from Nimble / Alletra 6K

Remove performance-policies identified by {performancePolicyId} from Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

performancePolicyId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the performance Policy. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K performance-policy identified by {performancePolicyId}

Get details of Nimble / Alletra 6K performance-policy identified by {performancePolicyId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

performancePolicyId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the performance Policy. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/performance-policies/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "app_category": "Backup",
  • "cache": false,
  • "cache_policy": "normal",
  • "compress": true,
  • "creation_time": 1600169692,
  • "dedupe_enabled": true,
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "last_modified": 1600169692,
  • "name": "Backup Repository",
  • "predefined": true,
  • "space_policy": "non_writable",
  • "associated_links": [
    ],
  • "block_size": 4096,
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "customerId": "string",
  • "dedupe_override_pools": [
    ],
  • "description": "Performance policy suitable for use with Nimble Secondary Flash Array",
  • "full_name": "Backup Repository",
  • "generation": 0,
  • "perfpolicy_creator_id": "0600000000000004d3000000000044000000000002",
  • "perfpolicy_creator_name": "AF-123456",
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "search_name": "Backup Repository",
  • "type": "string",
  • "volume_count": 0
}

Edit details of Nimble / Alletra 6K performance policy identified by {performancePolicyId}

Edit details of Nimble / Alletra 6K performance policy identified by {performancePolicyId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

performancePolicyId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the performance Policy. A 42 digit hexadecimal number.

Request Body schema: application/json
app_category
string or null

Specifies the application category of the associated volume. Plain string. Defaults to 'Unassigned'.

cache
boolean or null

Flag denoting if data in the associated volume should be cached. Defaults to 'true'.

cache_policy
string or null

Specifies how data of associated volume should be cached. Supports two policies, 'normal' and 'aggressive'. 'normal' policy caches data but skips in certain conditions such as sequential I/O. 'aggressive' policy will accelerate caching of all data belonging to this volume, regardless of sequentiality. Possible values:'normal', 'no_write', 'aggressive_read_no_write', 'disabled', 'aggressive'. Defaults to 'normal'.

compress
boolean or null

Flag denoting if data in the associated volume should be compressed. Defaults to 'true'.

dedupe_enabled
boolean or null

Specifies if dedupe is enabled for volumes created with this performance policy.

description
string or null

Description of a performance policy. String of up to 255 printable ASCII characters.

name
string or null

Name of the Performance Policy. String of up to 64 alphanumeric characters, - and . and : and space are allowed after first character.

space_policy
string or null

Specifies the state of the volume upon space constraint violation such as volume limit violation or volumes above their volume reserve, if the pool free space is exhausted. Supports two policies, 'offline' and 'non_writable'. Possible values:'offline', 'login_only', 'non_writable', 'read_only', 'invalid'. Defaults to 'offline'.

Responses

Request samples

Content type
application/json
{
  • "app_category": "Unassigned",
  • "cache": true,
  • "cache_policy": "normal",
  • "compress": true,
  • "dedupe_enabled": false,
  • "description": "99.9999% availability",
  • "name": "SQL Server Logs",
  • "space_policy": "offline"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

ports

The ports API allows the management of ports

Get details of Primera / Alletra 9K Ports

Get details of Primera / Alletra 9K Ports

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq 1:0:1 and systemWWN eq 2FF70002AC018D94

oData query to filter ports by Key.

sort
string
Example: sort=name desc

oData query to sort ports by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/7CE751P312/ports",
  • "total": 1
}

Get details of performance metrics of Primera/ Alletra 9K host ports on storage system identified by {systemid}

Get details of performance metrics of Primera/ Alletra 9K host ports on storage system identified by {systemid}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
reportType
string
Example: reportType=Canned,Custom,Def,ApiUser

parameter will be set to report type requested. For api users, set parameter as ApiUser

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

compareBy
string
Example: compareBy=top eq 5 and metrics eq readIops

compareBy will define top and compare metrics for which query has to be made. Allowed values: readIops, writeIops, totalIops, readThroughput, writeThroughput, totalThroughput, readLatency, writeLatency, totalLatency, readIosize, writeIosize, totalIosize, totalQlen, avgBusy

groupBy
string
Example: groupBy=port_type,nsp

groupBy will define comma separated groupBy parameters. By default, groupBy will be set to nsp. If groupBy is used along with filter query parameter, only following combination are allowed:

  • filter: port_type eq host then groupBy should be port_type
  • filter: port_type eq peer then groupBy should be port_type
  • filter: nsp eq 0:3:1 then groupBy should be nsp
  • filter: port_type eq host and nsp eq 0:3:1 then groupBy should be port_type, nsp
  • filter: port_type eq peer and nsp eq 0:3:1 then groupBy should be port_type, nsp
metricType
string
Example: metricType=IOPS,LATENCY,THROUGHPUT,IOSIZE,QLEN,AVG_BUSY

metricType will define comma separated metrics

filter
string
Example: filter=port_type eq host and nsp in (0:3:1,0:4:1)

filter will define objects to be filtered. Filterable columns are: * port_type - type of the port * nsp - node, slot and port of the port

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 162564271,
  • "historyData": {
    },
  • "requestUri": "/v1/storage-systems/device-type1/SGH014XGSP/volumes/performance-history",
  • "startTime": 1625556314
}

Get details of Primera / Alletra 9K Port identified by {id}

Get details of Primera / Alletra 9K Port identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "cardType": {
    },
  • "class": 0,
  • "class2": "string",
  • "commonResourceAttributes": {
    },
  • "config": "valid",
  • "configMode": "string",
  • "connectionType": "string",
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/7CE751P312/ports/220fcd48857f63c0f354c6723ec5d5cb",
  • "customerId": "string",
  • "devices": [
    ],
  • "displayname": "string",
  • "domain": "string",
  • "failoverStatus": "string",
  • "fcData": {
    },
  • "fwVersion": "12.2.396.1",
  • "generation": 0,
  • "id": "9d765763116c20a508e8996f2a10821d",
  • "initiatorPorts": {
    },
  • "interruptCoalesce": "string",
  • "ipData": {
    },
  • "iscsiData": {
    },
  • "label": "IP0",
  • "manufacturing": {
    },
  • "mode": "string",
  • "modeChange": "string",
  • "name": "string",
  • "nodeCardId": "string",
  • "nodeId": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "partner": {
    },
  • "portSfp": {
    },
  • "portType": "string",
  • "position": {
    },
  • "protocol": "string",
  • "requestUri": "/v1/storage-systems/device-type1/7CE751P312/ports/220fcd48857f63c0f354c6723ec5d5cb",
  • "resourceUri": "/v1/storage-systems/device-type1/7CE751P312/ports/220fcd48857f63c0f354c6723ec5d5cb",
  • "revision": "string",
  • "smartSAN": "string",
  • "speedActual": "string",
  • "speedConfigured": "string",
  • "speedMax": "string",
  • "speedMin": "string",
  • "state": {
    },
  • "stateDescription": [
    ],
  • "systemId": "7CE751P312",
  • "tgtModeWriteOpt": "string",
  • "type": "string",
  • "uniqueWWN": "string",
  • "vlans": [
    ]
}

Port enable disable identified by {id} from Primera / Alletra 9K identified by {systemId}

Port enable disable identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
portEnable
boolean

Port enable true or false

Responses

Request samples

Content type
application/json
{
  • "portEnable": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Clear the details of the ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Clear the details of the ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
ipType
string or null

For RCIP ports, the IP version of the address that needs to be cleared from the port. Either the IPv4 address or IPv6 address or both addresses can be cleared. Possible values: v4,v6,both

Responses

Request samples

Content type
application/json
{
  • "ipType": "v6"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit iscsi ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Edit iscsi ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
gatewayAddress
string or null <ipv4>

Gateway address to edit to

ipAddress
string <ipv4>

IP address to edit to

label
string or null

label of the port to edit to

mtu
string

MTU to edit to. Possible Values: "1500", "9000"

netMask
string <ipv4>

NetMask address to edit to

sendTargetGroupTag
integer or null <Uint32>

Responses

Request samples

Content type
application/json
{
  • "gatewayAddress": "255.255.255.0",
  • "ipAddress": "192.168.193.21",
  • "label": "port_123",
  • "mtu": "1500",
  • "netMask": "255.255.255.0",
  • "sendTargetGroupTag": 13
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit rcip ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Edit rcip ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
gatewayAddress
string or null <ipv4>

Gateway address to edit to for IPv4 address

gatewayAddressV6
string or null

Gateway address to edit to for IPv6 address

ipAddress
string or null <ipv4>

IPv4 address to edit to

ipAddressV6
string or null

IPv6 address to edit to

label
string or null
Deprecated

label of the port to edit to

mtu
string

MTU to edit to. Possible Values: "1500", "9000"

netMask
string or null <ipv4>

NetMask address to edit to for IPv4 address

netMaskV6
string or null

NetMask address to edit to for IPv6 address

speedConfigured
string or null

Configured speed. Possible Values: auto, "1", "2", "4", "8", "16", "32"

Responses

Request samples

Content type
application/json
{
  • "gatewayAddress": "255.255.255.0",
  • "gatewayAddressV6": "FE80::1",
  • "ipAddress": "192.168.193.21",
  • "ipAddressV6": "2001:db8:abcd:12:ffff:ffff:ffff:ff16",
  • "label": "port_123",
  • "mtu": "1500",
  • "netMask": "255.255.255.0",
  • "netMaskV6": "64",
  • "speedConfigured": "1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Edit ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
configMode
string or null

Configuration of Port. Possible Values: Disk, Host, RCFC, Peer

connectionType
string or null

Port connection Type. Possible Values: Point, Loop

interuptCoalesce
boolean or null

Port interuptCoalesce enabled or not

label
string

Port name

speedConfigured
string or null

Port speed. Possible Values: auto, "4", "8", "16", "32"

uniqueWWN
boolean or null

Port uniquewwn enabled or not

vcn
boolean or null

VLUN change notification enabled or not

Responses

Request samples

Content type
application/json
{
  • "configMode": "Host",
  • "connectionType": "Loop",
  • "interuptCoalesce": true,
  • "label": "FCPort1",
  • "speedConfigured": "8",
  • "uniqueWWN": true,
  • "vcn": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Initialize the details of the ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Initialize the details of the ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Ping iscsi ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Ping iscsi ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
ipAddress
string <ipv4>

IP Address to ping

ipAddressv6
string <ipv6>

IP Address to ping

pingCount
integer

ping count

Responses

Request samples

Content type
application/json
{
  • "ipAddress": "192.168.193.32",
  • "ipAddressv6": "2001:db8:abcd:12:ffff:ffff:ffff:ff16",
  • "pingCount": 4
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Ping rcip ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Ping rcip ports identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
PacketSize
integer

Packet size of the ping

WaitTime
integer

Wait time

ipAddress
string <ipv4>

IP Address to ping

ipAddressv6
string <ipv6>

IP Address to ping

pingCount
integer

ping count

Responses

Request samples

Content type
application/json
{
  • "PacketSize": 4,
  • "WaitTime": 100,
  • "ipAddress": "192.168.193.32",
  • "ipAddressv6": "2001:db8:abcd:12:ffff:ffff:ffff:ff16",
  • "pingCount": 4
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get all fibre channel configs details of Nimble / Alletra 6K

Get all fibre channel configs details of Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter Fibre Channel Configs by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/fibre-channel-configs",
  • "total": 1
}

Get fibre channel configs details of Nimble / Alletra 6K identified by {fcConfigId}.

Get fibre channel configs details of Nimble / Alletra 6K identified by {fcConfigId}.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

fcConfigId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of fibre channel config. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/fibre-channel-configs/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "group_leader_array": "myobject-5",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "array_list": [
    ],
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "controller_name": "myobject-5",
  • "customerId": "string",
  • "generation": 0,
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "type": "string"
}

Get all fibre channel sessions details of Nimble / Alletra 6K

Get all fibre channel sessions details of Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter Fibre Channel Sessions by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/fibre-channel-sessions",
  • "total": 1
}

Get fibre channel session details of Nimble / Alletra 6K identified by {fcSessionId}.

Get fibre channel session details of Nimble / Alletra 6K identified by {fcSessionId}.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

fcSessionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the Fibre Channel Session. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/fibre-channel-sessions/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "associated_links": [
    ],
  • "consoleUri": "null",
  • "customerId": "string",
  • "generation": 0,
  • "initiator_info": {
    },
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "sc_HostInitiatorId": "1223f5s",
  • "target_info": {
    },
  • "type": "string"
}

Get all network interfaces details by Nimble / Alletra 6K

Get all network interfaces details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter Network Interface by Key.

sort
string
Example: sort=name desc

oData query to sort Network Interface resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/network-interfaces",
  • "total": 1
}

Get all network interfaces details by Nimble / Alletra 6K identified by {networkInterfaceId}

Get all network interfaces details by Nimble / Alletra 6K identified by {networkInterfaceId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

networkInterfaceId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the Network Interface. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/network-interfaces/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "array_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "array_name_or_serial": "myobject-5",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "mac": "11:33:55:77:99:BB",
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "controller_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "controller_name": "myobject-5",
  • "customerId": "string",
  • "generation": 0,
  • "ip_list": [
    ],
  • "is_present": true,
  • "link_speed": "link_speed_1000M",
  • "link_status": "link_status_up",
  • "max_link_speed": "link_speed_1000M",
  • "mtu": 1234,
  • "name": "myobject-5",
  • "nic_type": "nic_type_tp",
  • "partial_response_ok": false,
  • "port": 1234,
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "slot": 1234,
  • "type": "string"
}

Get all ports details of Nimble / Alletra 6K

Get all ports details of Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter fibre channel interface ports by Key.

sort
string
Example: sort=name desc

oData query to sort fibre channel interface ports resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associated_links": [
    ],
  • "fibre_channel_interface": {
    },
  • "network_interface": {
    },
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/ports",
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "total": 4
}

Get details of Nimble / Alletra 6K Port identified by {portId}. Fibre_channel_interfaces attributes will be shown for Fibre_channel_interface ports. Network_interfaces attributes will be shown for Network_interface ports.

Get details of Nimble / Alletra 6K Port identified by {portId}.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

portId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of port. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "array_id": "0900000000000004d3000000000000000000000004",
  • "array_name_or_serial": "g1a1",
  • "bus_location": "0000:81:00.0",
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "controller_id": "c300000000000004d3000000000000000400000000",
  • "controller_name": "A",
  • "fabric_info": {
    },
  • "fc_port_id": "1f01167316131",
  • "fc_port_name": "fc1",
  • "firmware_version": "1.1.59.0",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "ip_list": {
    },
  • "is_present": true,
  • "link_info": {
    },
  • "link_speed": "link_speed_1000M",
  • "link_status": "link_status_up",
  • "logical_port_number": 0,
  • "mac": "11:33:55:77:99:BB",
  • "max_link_speed": "link_speed_1000M",
  • "mtu": 1500,
  • "name": "interface1.1",
  • "nic_type": "nic_type_tp",
  • "online": true,
  • "orientation": "left_to_right",
  • "partial_response_ok": true,
  • "peerzone": null,
  • "port": 0,
  • "slot": 0,
  • "wwnn": "56:c9:ce:90:9b:84:c9:00",
  • "wwpn": "56:c9:ce:90:9b:84:c9:01"
}

Edit Nimble FC Port of Nimble / Alletra 6K

Edit Nimble FC Port of Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

portId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of port. A 42 digit hexadecimal number.

Request Body schema: application/json
online
boolean or null

Identify whether the Fibre Channel interface is online.

Responses

Request samples

Content type
application/json
{
  • "online": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of HPE Alletra Storage MP Ports

Get details of HPE Alletra Storage MP Ports

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq 1:0:1 and systemWWN eq 2FF70002AC018D94

oData query to filter ports by Key.

sort
string
Example: sort=name desc

oData query to sort ports by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/7CE751P312/ports",
  • "total": 1
}

Get details of performance metrics of host ports on storage system identified by {systemid}

Get details of performance metrics of host ports on storage system identified by {systemid}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
reportType
string
Example: reportType=Canned,Custom,Def,ApiUser

parameter will be set to report type requested. For api users, set parameter as ApiUser

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

compareBy
string
Example: compareBy=top eq 5 and metrics eq readIops

compareBy will define top and compare metrics for which query has to be made. Allowed values: readIops, writeIops, totalIops, readThroughput, writeThroughput, totalThroughput, readLatency, writeLatency, totalLatency, readIosize, writeIosize, totalIosize, totalQlen, avgBusy

groupBy
string
Example: groupBy=port_type,nsp

groupBy will define comma separated groupBy parameters. By default, groupBy will be set to nsp. If groupBy is used along with filter query parameter, only following combination are allowed:

  • filter: port_type eq host then groupBy should be port_type
  • filter: port_type eq peer then groupBy should be port_type
  • filter: nsp eq 0:3:1 then groupBy should be nsp
  • filter: port_type eq host and nsp eq 0:3:1 then groupBy should be port_type, nsp
  • filter: port_type eq peer and nsp eq 0:3:1 then groupBy should be port_type, nsp
metricType
string
Example: metricType=IOPS,LATENCY,THROUGHPUT,IOSIZE,QLEN,AVG_BUSY

metricType will define comma separated metrics

filter
string
Example: filter=port_type eq host and nsp in (0:3:1,0:4:1)

filter will define objects to be filtered. Filterable columns are: * port_type - type of the port * nsp - node, slot and port of the port

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 162564271,
  • "historyData": {
    },
  • "requestUri": "/v1/storage-systems/device-type4/SGH014XGSP/volumes/performance-history",
  • "startTime": 1625556314
}

Get details of HPE Alletra Storage MP Port identified by {id}

Get details of HPE Alletra Storage MP Port identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "cardType": {
    },
  • "class": 0,
  • "class2": "string",
  • "commonResourceAttributes": {
    },
  • "config": "valid",
  • "configMode": "string",
  • "connectionType": "string",
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/7CE751P312/ports/220fcd48857f63c0f354c6723ec5d5cb",
  • "customerId": "string",
  • "devices": [
    ],
  • "displayname": "string",
  • "domain": "string",
  • "enclosureCardId": 0,
  • "enclosureCardPCIUid": "string",
  • "enclosureCardPCId": 0,
  • "enclosureCardUid": "string",
  • "enclosureId": 0,
  • "enclosureUid": "string",
  • "failoverStatus": "string",
  • "fcData": {
    },
  • "fwVersion": "12.2.396.1",
  • "generation": 0,
  • "id": "9d765763116c20a508e8996f2a10821d",
  • "initiatorPorts": {
    },
  • "interruptCoalesce": "string",
  • "ipData": {
    },
  • "iscsiData": {
    },
  • "label": "IP0",
  • "manufacturing": {
    },
  • "mode": "string",
  • "modeChange": "string",
  • "name": "string",
  • "nodeCardId": "string",
  • "nodeId": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "nvmeData": {
    },
  • "partner": {
    },
  • "portSfp": {
    },
  • "portType": "string",
  • "position": {
    },
  • "protocol": "string",
  • "requestUri": "/v1/storage-systems/device-type4/7CE751P312/ports/220fcd48857f63c0f354c6723ec5d5cb",
  • "resourceUri": "/v1/storage-systems/device-type4/7CE751P312/ports/220fcd48857f63c0f354c6723ec5d5cb",
  • "revision": "string",
  • "smartSAN": "string",
  • "speedActual": "string",
  • "speedConfigured": "string",
  • "speedMax": "string",
  • "speedMin": "string",
  • "state": {
    },
  • "stateDescription": [
    ],
  • "systemId": "7CE751P312",
  • "tgtModeWriteOpt": "string",
  • "type": "string",
  • "uniqueWWN": "string",
  • "virtualPorts": [
    ],
  • "vlans": [
    ]
}

Port enable disable identified by {id} from HPE Alletra Storage MP identified by {systemId}

Port enable disable identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
portEnable
boolean

Port enable true or false

Responses

Request samples

Content type
application/json
{
  • "portEnable": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Clear the details of the ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Clear the details of the ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
ipType
string or null

For RCIP ports, the IP version of the address that needs to be cleared from the port. Either the IPv4 address or IPv6 address or both addresses can be cleared. Possible values: v4,v6,both

Responses

Request samples

Content type
application/json
{
  • "ipType": "v6"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit iscsi ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Edit iscsi ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
enablePeer
boolean or null

Make the iSCSI port peer enabled. This is supported from OS version 10.4.0.

label
string or null

label of the port to edit to

mtu
string

Maximum transmission unit (MTU) size

targetProtocol
string or null
Enum: "iSCSI" null

Ports configured with NVMe/TCP can be changed to iSCSI. If you are editing a port with iSCSI protocol, no value is required for this parameter. This parameter is supported from OS version 10.5.0 onwards.

Array of objects or null or null

Port VLANs information. Specifying VLAN id is mandatory to configure VLAN.

Responses

Request samples

Content type
application/json
{
  • "enablePeer": true,
  • "label": "port_123",
  • "mtu": "1500",
  • "targetProtocol": "iSCSI",
  • "vlans": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit nvme ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Edit nvme ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
label
string

Label of the port to edit to

mtu
string

Maximum transmission unit (MTU) size

targetProtocol
string or null
Enum: "NVMe" null

Ports configured with iSCSI can be changed to NVMe/TCP. If you are editing a port with NVMe/TCP protocol, no value is required for this parameter. This parameter is supported from OS version 10.5.0 onwards.

Array of objects or null or null

Port VLANs information. Specifying VLAN id is mandatory to configure VLAN.

Responses

Request samples

Content type
application/json
{
  • "label": "port_123",
  • "mtu": "1500",
  • "targetProtocol": "NVMe",
  • "vlans": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit rcip ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Edit rcip ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
gatewayAddress
string or null <ipv4>

Gateway address to edit to for IPv4 address

gatewayAddressV6
string or null

Gateway address to edit to for IPv6 address

ipAddress
string or null <ipv4>

IPv4 address to edit to

ipAddressV6
string or null

IPv6 address to edit to

label
string or null
Deprecated

label of the port to edit to

mtu
string

MTU to edit to. Possible Values: "1500", "9000"

netMask
string or null <ipv4>

NetMask address to edit to for IPv4 address

netMaskV6
string or null

NetMask address to edit to for IPv6 address

speedConfigured
string or null

Configured speed. Possible Values: auto, "1", "2", "4", "8", "16", "32"

Responses

Request samples

Content type
application/json
{
  • "gatewayAddress": "255.255.255.0",
  • "gatewayAddressV6": "FE80::1",
  • "ipAddress": "192.168.193.21",
  • "ipAddressV6": "2001:db8:abcd:12:ffff:ffff:ffff:ff16",
  • "label": "port_123",
  • "mtu": "1500",
  • "netMask": "255.255.255.0",
  • "netMaskV6": "64",
  • "speedConfigured": "1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Edit ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
configMode
string or null

Configuration of Port. Possible Values: Disk, Host, RCFC, Peer

connectionType
string or null

Port connection Type. Possible Values: Point, Loop

interuptCoalesce
boolean or null

Port interuptCoalesce enabled or not

label
string

Port name

speedConfigured
string or null

Port speed. Possible Values: auto, "4", "8", "16", "32"

uniqueWWN
boolean or null

Port uniquewwn enabled or not

vcn
boolean or null

VLUN change notification enabled or not

Responses

Request samples

Content type
application/json
{
  • "configMode": "Host",
  • "connectionType": "Loop",
  • "interuptCoalesce": true,
  • "label": "FCPort1",
  • "speedConfigured": "8",
  • "uniqueWWN": true,
  • "vcn": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Initialize the details of the ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Initialize the details of the ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Ping iscsi ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Ping iscsi ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
ipAddress
string <ipv4>

IP Address to ping

ipAddressv6
string <ipv6>

IP Address to ping

pingCount
integer

ping count

vlanId
string

VLAN ID

Responses

Request samples

Content type
application/json
{
  • "ipAddress": "192.168.193.32",
  • "ipAddressv6": "2001:db8:abcd:12:ffff:ffff:ffff:ff16",
  • "pingCount": 4,
  • "vlanId": "4"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Ping nvme ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Ping nvme ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
PacketSize
integer

Packet size for the NVMe ping operation

WaitTime
integer

Wait time for the NVMe ping operation

ipAddress
string <ipv4>

IP address of NVMe port

ipAddressv6
string <ipv6>

IP address of NVMe port

pingCount
integer

Count for the NVMe ping operation

Responses

Request samples

Content type
application/json
{
  • "PacketSize": 4,
  • "WaitTime": 100,
  • "ipAddress": "192.168.193.32",
  • "ipAddressv6": "2001:db8:abcd:12:ffff:ffff:ffff:ff16",
  • "pingCount": 4
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Ping rcip ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Ping rcip ports identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: d0fcfe2ff572f44e5beb0a9712c76d5d

UID of the port

Request Body schema: application/json
PacketSize
integer

Packet size of the ping

WaitTime
integer

Wait time

ipAddress
string <ipv4>

IP Address to ping

ipAddressv6
string <ipv6>

IP Address to ping

pingCount
integer

ping count

Responses

Request samples

Content type
application/json
{
  • "PacketSize": 4,
  • "WaitTime": 100,
  • "ipAddress": "192.168.193.32",
  • "ipAddressv6": "2001:db8:abcd:12:ffff:ffff:ffff:ff16",
  • "pingCount": 4
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

protection-templates

The protection-templates API allows the management of protection-templates

Get all protection-templates details by Nimble / Alletra 6K

Get all protection-templates details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter Protection Template by Key.

sort
string
Example: sort=name desc

oData query to sort Protection Template resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/protection-templates",
  • "total": 1
}

Create protection template on Nimble / Alletra 6K in system identified by {systemId}

Create protection template on Nimble / Alletra 6K in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
app_cluster_name
string or null

If the application is running within a Windows cluster environment then this is the cluster name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_id
string or null

Application ID running on the server. Application ID can only be specified if application synchronization is VSS. Possible values: 'inval', 'exchange', 'exchange_dag', 'hyperv', 'sql2005', 'sql2008', 'sql2012', 'sql2014', 'sql2016', 'sql2017'.

app_server
string or null

Application server hostname. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_service_name
string or null

If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_sync
string or null

Application synchronization. Possible values: 'none', 'vss'.

description
string or null

Text description of protection template. String of up to 255 printable ASCII characters.

name
string

Name of the protection template. User provided identifier. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

Array of objects (ProtectionScheduleInput)

List of protection schedules.

Responses

Request samples

Content type
application/json
{
  • "app_cluster_name": "xyz.net",
  • "app_id": "sql2005",
  • "app_server": "abc.com",
  • "app_service_name": "Service1",
  • "app_sync": "none",
  • "description": "Every day",
  • "name": "string",
  • "schedules": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K protection-templates identified by {protectionTemplateId}

Get details of Nimble / Alletra 6K protection-templates identified by {protectionTemplateId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

protectionTemplateId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the Protection Template. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/protection-templates/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "agent_hostname": "myobject-5",
  • "app_cluster_name": "myobject-5",
  • "app_id": "exchange_dag",
  • "app_server": "myobject-5",
  • "app_service_name": "myobject-5",
  • "app_sync": "vss",
  • "creation_time": 1604387561,
  • "id": "1200000000000004d3000000000000000000000011",
  • "last_modified": 1604387561,
  • "name": "Retain-48Hourly-30Daily-52Weekly",
  • "vcenter_hostname": "myobject-5",
  • "agent_username": "myobject-5",
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "customerId": "string",
  • "description": "Provides hourly snapshots retained for 2 days, daily snapshots retained for 30 days, and weekly snapshots retained for 52 weeks.",
  • "full_name": "Retain-48Hourly-30Daily-52Weekly",
  • "generation": 0,
  • "repl_priority": "normal",
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "schedule_list": [
    ],
  • "search_name": "Retain-48Hourly-30Daily-52Weekly",
  • "type": "string",
  • "vcenter_username": "myobject-5"
}

Edit details of Nimble / Alletra 6K Protection-templates identified by {protectionTemplateId}

Edit details of Nimble / Alletra 6K Protection-templates identified by {protectionTemplateId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

protectionTemplateId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the Protection Template. A 42 digit hexadecimal number.

Request Body schema: application/json
Array of objects or null (ProtectionScheduleInput)

List of protection schedules to be added.

app_cluster_name
string or null

If the application is running within a Windows cluster environment then this is the cluster name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_id
string or null

Application ID running on the server. Application ID can only be specified if application synchronization is VSS. Possible values: 'inval', 'exchange', 'exchange_dag', 'hyperv', 'sql2005', 'sql2008', 'sql2012', 'sql2014', 'sql2016', 'sql2017'.

app_server
string or null

Application server hostname. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_service_name
string or null

If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_sync
string or null

Application synchronization. Possible values: 'none', 'vss'.

description
string or null

Text description of protection template. String of up to 255 printable ASCII characters.

Array of objects or null or null (NimbleNsSchedule)

List of protection schedules to be edited.

name
string

Name of the protection template. User provided identifier. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

Array of objects or null (ProtectionScheduleActionNimble)

List of protection schedules to be removed.

Responses

Request samples

Content type
application/json
{
  • "addSchedules": [
    ],
  • "app_cluster_name": "xyz.net",
  • "app_id": "sql2005",
  • "app_server": "abc.com",
  • "app_service_name": "Service1",
  • "app_sync": "none",
  • "description": "Every day",
  • "editSchedules": [
    ],
  • "name": "string",
  • "removeSchedules": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove protection templates for Nimble / Alletra 6K

Remove protection templates for Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
required
Array of objects (ProtectionTemplateAction)

List of protection templates to be deleted

Responses

Request samples

Content type
application/json
{
  • "protectionTemplates": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

restore-points

The Restore Points API allows the management of restore-points

Perform action clone Nimble / Alletra 6K on a snapshot collection identified by {snapshotCollectionId} in system identified by {systemId}

Perform action clone Nimble / Alletra 6K on a snapshot collection identified by {snapshotCollectionId} in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

snapshotCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of snapshot Collection. A 42 digit hexadecimal number.

Request Body schema: application/json
required
Array of objects (CloneVolumesInput)

List of clone volumes.

Responses

Request samples

Content type
application/json
{
  • "clone_volumes": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

shelves

The shelves API allows the management of shelves

Get details of Primera / Alletra 9K Enclosures

Get details of Primera / Alletra 9K Enclosures

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/7CE751P312/enclosures",
  • "total": 1
}

Get details of Primera / Alletra 9K disks identified by {cageId}

Get details of Primera / Alletra 9K disks identified by {cageId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

cageId
required
string <int64>
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

cage ID

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemId eq 7CE751P312

oData query to filter Disk by Key.

sort
string
Example: sort=name asc

oData query to sort Disk by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/7CE751P312/enclosures/0/disks",
  • "total": 1
}

Get details of Primera / Alletra 9K disk identified by {cageId} and {id}

Get details of Primera / Alletra 9K disk identified by {cageId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

cageId
required
string <int64>
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

cage ID

id
required
string
Example: d4b13e70924d29afdb77d932f7563ea6

UID of the disk

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "admitTime": {
    },
  • "associatedLinks": [
    ],
  • "capacity": {
    },
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/disks/d4b13e70924d29afdb77d932f7563ea6",
  • "consumableSizeMiB": 1829888,
  • "customerId": "string",
  • "devType": "DEVTYPE_SSD",
  • "diskId": 1,
  • "displayname": "Drive 0.SIDE_NONE.2.0",
  • "domain": null,
  • "fwStatus": "--",
  • "fwVersion": "3P00",
  • "generation": 0,
  • "id": "d4b13e70924d29afdb77d932f7563ea6",
  • "lifeLeftPCT": 100,
  • "loopA0": {
    },
  • "loopA1": {
    },
  • "loopB0": {
    },
  • "loopB1": {
    },
  • "manufacturing": {
    },
  • "mediaType": "MLC",
  • "mfgCapacityGB": 1920,
  • "positionLast": {
    },
  • "positionNow": {
    },
  • "protocol": "SAS",
  • "rawSizeMiB": 1831420,
  • "readErrors": {
    },
  • "requestUri": "/v1/storage-systems/device-type1/7CE751P312/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/disks/d4b13e70924d29afdb77d932f7563ea6",
  • "resourceUri": "/v1/storage-systems/device-type1/7CE751P312/enclosures/0/disks/d4b13e70924d29afdb77d932f7563ea6",
  • "sedStatus": "FIPS Capable",
  • "speed": -1,
  • "state": {
    },
  • "systemId": "7CE751P312",
  • "tempMax": 35,
  • "tempMin": 31,
  • "tempNow": 34,
  • "type": "string",
  • "writeErrors": {
    },
  • "wwn": "5002538B10249591"
}

Get details of Primera / Alletra 9K Enclosure Card Ports identified by {enclosureId}

Get details of Primera / Alletra 9K Enclosure Card Ports identified by {enclosureId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-card-ports",
  • "total": 1
}

Get details of Primera / Alletra 9K Enclosure Card Port identified by {enclosureId} and {id}

Get details of Primera / Alletra 9K Enclosure Card Port identified by {enclosureId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure card port

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-card-ports/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "dc4data": {
    },
  • "dcsdata": {
    },
  • "disabled": true,
  • "displayname": "Drive Enclosure - 0, IO Module - 0, Port - DP-1",
  • "domain": null,
  • "elementStatusCode": "string",
  • "enclosureCardDeviceId": 1,
  • "enclosureCardId": "4c592313a65224f9dc804ca4ced2b88b",
  • "enclosureCardPortId": 0,
  • "enclosureCardPortType": "External",
  • "enclosureDeviceId": 1,
  • "enclosureId": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "enclosureName": "string",
  • "enclosureType": "ENCLOSURE_DCS8",
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "linkSpeed": "string",
  • "locateEnabled": false,
  • "loopA": false,
  • "loopIndex": 2,
  • "nodePort": {
    },
  • "osDisplayName": "DP-3",
  • "portWwn": "50050CC111510A3E",
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-card-ports/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-card-ports/8621946048c1cb24bdfc57e9b3b460ac",
  • "sfp": {
    },
  • "systemId": "7CE751P312",
  • "type": "string"
}

Get details of Primera / Alletra 9K Enclosure Cards identified by {enclosureId}

Get details of Primera / Alletra 9K Enclosure Cards identified by {enclosureId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-cards",
  • "total": 1
}

Get details of Primera / Alletra 9K Enclosure Card identified by {enclosureId} and {id}

Get details of Primera / Alletra 9K Enclosure Card identified by {enclosureId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure card

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-cards/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "dc4data": {
    },
  • "dcsdata": {
    },
  • "displayname": "string",
  • "domain": null,
  • "elementStatusCode": "string",
  • "enclosureCardId": 0,
  • "enclosureDeviceId": 1,
  • "enclosureId": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "enclosureName": "string",
  • "enclosureType": "ENCLOSURE_DCS8",
  • "failIndicator": false,
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "locateEnabled": false,
  • "loopA": false,
  • "loopB": false,
  • "manufacturing": {
    },
  • "name": "SASB",
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-cards/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-cards/8621946048c1cb24bdfc57e9b3b460ac",
  • "safeToRemove": false,
  • "systemId": "7CE751P312",
  • "type": "string"
}

Locate IO Module of Primera / Alletra 9K identified by {id} Deprecated

Locate IO Module of Primera / Alletra 9K identified by {id}. This API endpoint is deprecated.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure card

Request Body schema: application/json
locate
boolean

Indicates if the locate beacon should be enabled or not

Responses

Request samples

Content type
application/json
{
  • "locate": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Primera / Alletra 9K Enclosure Disks identified by {enclosureId}

Get details of Primera / Alletra 9K Enclosure Disks identified by {enclosureId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-disks",
  • "total": 1
}

Get details of Primera / Alletra 9K Enclosure Disk identified by {enclosureId} and {id}

Get details of Primera / Alletra 9K Enclosure Disk identified by {enclosureId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure disk

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-disks/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "dc4data": {
    },
  • "dcsdata": {
    },
  • "displayname": "string",
  • "domain": null,
  • "enclosureDeviceId": 1,
  • "enclosureId": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "enclosureName": "string",
  • "enclosureType": "ENCLOSURE_DCS8",
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "loopA": {
    },
  • "loopB": {
    },
  • "manufacturing": {
    },
  • "name": "SASB",
  • "position": {
    },
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-disks/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-disks/8621946048c1cb24bdfc57e9b3b460ac",
  • "systemId": "7CE751P312",
  • "temperature": 0,
  • "type": "string",
  • "wwn": "5000C500997AB7B0"
}

Get details of Primera / Alletra 9K Enclosure Expanders identified by {enclosureId}

Get details of Primera / Alletra 9K Enclosure Expanders identified by {enclosureId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-fans",
  • "total": 1
}

Get details of Primera / Alletra 9K Enclosure Expander identified by {enclosureId} and {id}

Get details of Primera / Alletra 9K Enclosure Expander identified by {enclosureId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure expander

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "address": "string",
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-expanders/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "domain": null,
  • "elementStatusCode": "string",
  • "enclosureDeviceId": 1,
  • "enclosureExpanderId": 0,
  • "enclosureId": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "enclosureName": "string",
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "name": "string",
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-expanders/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-expanders/8621946048c1cb24bdfc57e9b3b460ac",
  • "systemId": "7CE751P312",
  • "type": "string"
}

Get details of Primera / Alletra 9K Enclosure Fans identified by {enclosureId}

Get details of Primera / Alletra 9K Enclosure Fans identified by {enclosureId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-fans",
  • "total": 1
}

Get details of Primera / Alletra 9K Enclosure Fan identified by {enclosureId} and {id}

Get details of Primera / Alletra 9K Enclosure Fan identified by {enclosureId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure fan

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-fans/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "displayname": "string",
  • "domain": null,
  • "elementStatusCode": "string",
  • "enclosureCoolingFanId": 0,
  • "enclosureDeviceId": 1,
  • "enclosureId": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "enclosureName": "string",
  • "enclosureType": "ENCLOSURE_DCS8",
  • "failIndicator": false,
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "locateEnabled": false,
  • "manufacturing": {
    },
  • "name": "SASB",
  • "partNumber": "string",
  • "protocol": "SAS",
  • "psId": 0,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-fans/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-fans/8621946048c1cb24bdfc57e9b3b460ac",
  • "safeToRemove": false,
  • "speed": "string",
  • "speedRpm": 0,
  • "state": {
    },
  • "systemId": "7CE751P312",
  • "type": "string",
  • "wwn": "5000C500997AB7B0"
}

Get details of Primera / Alletra 9K Enclosure Powers identified by {enclosureId}

Get details of Primera / Alletra 9K Enclosure Powers identified by {enclosureId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-powers",
  • "total": 1
}

Get details of Primera / Alletra 9K Enclosure Power identified by {enclosureId} and {id}

Get details of Primera / Alletra 9K Enclosure Power identified by {enclosureId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure power

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "acStatus": "string",
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-powers/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "dcStatus": "string",
  • "displayname": "string",
  • "domain": null,
  • "elementStatusCode": "string",
  • "enclosureDeviceId": 1,
  • "enclosureId": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "enclosureName": "string",
  • "enclosurePowerId": 0,
  • "enclosureType": "ENCLOSURE_DCS8",
  • "failIndicator": false,
  • "failInput": false,
  • "failOutput": false,
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "locateEnabled": false,
  • "manufacturing": {
    },
  • "modelReadOnly": false,
  • "name": "SASB",
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-powers/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-powers/8621946048c1cb24bdfc57e9b3b460ac",
  • "safeToRemove": false,
  • "state": {
    },
  • "systemId": "7CE751P312",
  • "type": "string"
}

Locate PCM of Primera / Alletra 9K identified by {id}

Locate PCM of Primera / Alletra 9K identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure power

Request Body schema: application/json
locate
boolean

Indicates if the locate beacon should be enabled or not

Responses

Request samples

Content type
application/json
{
  • "locate": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Primera / Alletra 9K Enclosure Sleds identified by {enclosureId}

Get details of Primera / Alletra 9K Enclosure Sleds identified by {enclosureId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-sleds",
  • "total": 1
}

Get details of Primera / Alletra 9K Enclosure Sled identified by {enclosureId} and {id}

Get details of Primera / Alletra 9K Enclosure Sled identified by {enclosureId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure sled

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-sleds/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "dc4data": {
    },
  • "diskCount": 1,
  • "displayname": "string",
  • "domain": null,
  • "elementStatusCode": "string",
  • "enclosureDeviceId": 1,
  • "enclosureId": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "enclosureName": "string",
  • "enclosureType": "ENCLOSURE_DCS8",
  • "failIndicator": false,
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "locateEnabled": false,
  • "manufacturing": {
    },
  • "name": "SASB",
  • "okIndicator": false,
  • "portBypassA": false,
  • "portBypassB": false,
  • "power": false,
  • "predFailIndicator": false,
  • "protocol": "SAS",
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-sleds/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-sleds/8621946048c1cb24bdfc57e9b3b460ac",
  • "safeToRemove": false,
  • "sledId": 0,
  • "stateLoopA": {
    },
  • "stateLoopB": {
    },
  • "systemId": "7CE751P312",
  • "temperature": 30,
  • "type": "string",
  • "wwn": "5000C500997AB7B0"
}

Locate drive of Primera / Alletra 9K identified by {id}

Locate drive of Primera / Alletra 9K identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure sled

Request Body schema: application/json
locate
boolean

Indicates if the locate beacon should be enabled or not

Responses

Request samples

Content type
application/json
{
  • "locate": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Primera / Alletra 9K Enclosure identified by {id}

Get details of Primera / Alletra 9K Enclosure identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "chainPosLoopA": 0,
  • "chainPosLoopB": 0,
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f",
  • "customerId": "string",
  • "dc4data": {
    },
  • "dcsdata": {
    },
  • "detailedState": null,
  • "displayname": "string",
  • "domain": null,
  • "enclosureId": 0,
  • "enclosureType": "ENCLOSURE_DCS8",
  • "errors": [
    ],
  • "failIndicator": false,
  • "failRequested": false,
  • "formFactor": "SFF",
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "locateEnabled": false,
  • "location": "string",
  • "loopSplit": true,
  • "manufacturing": {
    },
  • "name": "cage1",
  • "nodeWwn": "50050CC106233428",
  • "requestUri": "/v1/storage-systems/device-type1/7CE751P312/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f",
  • "resourceUri": "/v1/storage-systems/device-type1/7CE751P312/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f",
  • "state": {
    },
  • "subType": "string",
  • "systemId": "7CE751P312",
  • "type": "string",
  • "warnIndicator": false,
  • "warnRequested": false
}

Locate enclosure drive of Primera / Alletra 9K identified by {id}

Locate enclosure drive of Primera / Alletra 9K identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

Request Body schema: application/json
locate
boolean

Indicates if the locate beacon should be enabled or not

Responses

Request samples

Content type
application/json
{
  • "locate": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit details of Primera / Alletra 9K Enclosure identified by {id}

Edit details of Primera / Alletra 9K Enclosure identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

Request Body schema: application/json
id
string or null

New Id of the enclosure

location
string or null

Location of the enclosure in the datacenter

Responses

Request samples

Content type
application/json
{
  • "id": "5",
  • "location": "MIP-01 H29 36-38"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of performance metrics of Primera/ Alletra 9K physicalDrives on storage system identified by {systemid}

Get details of performance metrics of Primera/ Alletra 9K physicalDrives on storage system identified by {systemid}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
reportType
string
Example: reportType=Canned,Custom,Def,ApiUser

parameter will be set to report type requested. For api users, set parameter as ApiUser

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

compareBy
string
Example: compareBy=top eq 5 and metrics eq readIops

compareBy will define top and compare metrics for which query has to be made. Allowed values: readIops, writeIops, totalIops, readThroughput, writeThroughput, totalThroughput, readLatency, writeLatency, totalLatency, readIosize, writeIosize, totalIosize, totalQlen, avgBusy

groupBy
string
Example: groupBy=pdId

groupBy will define comma separated groupBy parameters. Allowed value: pdId. By default, groupBy will be set to pdId.

metricType
string
Example: metricType=IOPS,LATENCY,THROUGHPUT,IOSIZE,QLEN,AVG_BUSY

metricType will define comma separated metrics

filter
string
Example: filter=pdId in (1,2)

filter will define objects to be filtered. Filterable columns are: * pdId - id of the physical drive

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 162564271,
  • "historyData": {
    },
  • "requestUri": "/v1/storage-systems/device-type1/SGH014XGSP/volumes/performance-history",
  • "startTime": 1625556314
}

Get all shelves details by Nimble / Alletra 6K

Get all shelves details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter shelves by Key.

sort
string
Example: sort=name desc

oData query to sort shelves resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/shelves",
  • "total": 1
}

Get details of Nimble / Alletra 6K Shelf identified by {shelfId}

Get details of Nimble / Alletra 6K Shelf identified by {shelfId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

shelfId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of shelf. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/shelves/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "array_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "array_name": "myobject-5",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "model": "CS210",
  • "serial": "AA-100373",
  • "associated_links": [
    ],
  • "chassis_sensors": [
    ],
  • "chassis_type": "chassis_4u24",
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "ctrlrs": [
    ],
  • "customerId": "string",
  • "disk_sets": [
    ],
  • "fan_overall_status": "Failed",
  • "generation": 0,
  • "model_ext": "CS210-8T-160F",
  • "psu_overall_status": "Failed",
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "temp_overall_status": "Failed",
  • "type": "string"
}

Locate chassis of Nimble / Alletra 6K shelf identified by {shelfId}

Locate chassis of Nimble / Alletra 6K shelf identified by {shelfId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

shelfId
required
string
Example: 001df0fe6f7dc7bb16000000000000000000004817

ID of the shelf.

Request Body schema: application/json
cid
required
string

Which controller this sensor applies to. Possible values:'A', 'B'.

status
required
boolean

Status value of identifier to set. Possible values: 'true', 'false'.

Responses

Request samples

Content type
application/json
{
  • "cid": "A",
  • "status": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Activate shelves of a Nimble / Alletra 6K storage system identified by {systemId}

Activate shelves of a Nimble / Alletra 6K storage system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
required
Array of objects (NimbleShelfListDetails)

List of shelves details.

Responses

Request samples

Content type
application/json
{
  • "shelf_list": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of HPE Alletra Storage MP Enclosure Cards identified by {systemId}

Get details of HPE Alletra Storage MP Enclosure Cards identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-cards",
  • "total": 1
}

Get details of HPE Alletra Storage MP Enclosure Connectors

Get details of HPE Alletra Storage MP Enclosure Connectors

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-connectors",
  • "total": 1
}

Get details of HPE Alletra Storage MP Enclosures

Get details of HPE Alletra Storage MP Enclosures

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/7CE751P312/enclosures",
  • "total": 1
}

Get details of HPE Alletra Storage MP disks identified by {cageId}

Get details of HPE Alletra Storage MP disks identified by {cageId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

cageId
required
string <int64>
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

cage ID

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemId eq 7CE751P312

oData query to filter Disk by Key.

sort
string
Example: sort=name asc

oData query to sort Disk by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/7CE751P312/enclosures/0/disks",
  • "total": 1
}

Get details of HPE Alletra Storage MP disk identified by {cageId} and {id}

Get details of HPE Alletra Storage MP disk identified by {cageId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

cageId
required
string <int64>
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

cage ID

id
required
string
Example: d4b13e70924d29afdb77d932f7563ea6

UID of the disk

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "admitTime": {
    },
  • "associatedLinks": [
    ],
  • "capacity": {
    },
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/disks/d4b13e70924d29afdb77d932f7563ea6",
  • "consumableSizeMiB": 1829888,
  • "customerId": "string",
  • "devType": "DEVTYPE_SSD",
  • "diskId": 1,
  • "displayname": "Drive 0.SIDE_NONE.2.0",
  • "domain": null,
  • "enclosureUid": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "fwStatus": "--",
  • "fwVersion": "3P00",
  • "generation": 0,
  • "id": "d4b13e70924d29afdb77d932f7563ea6",
  • "insertTime": {
    },
  • "lifeLeftPCT": 100,
  • "manufacturing": {
    },
  • "mediaType": "MLC",
  • "mfgCapacityGB": 1920,
  • "paths": [
    ],
  • "positionLast": {
    },
  • "positionNow": {
    },
  • "protocol": "SAS",
  • "rawSizeMiB": 1831420,
  • "readErrors": {
    },
  • "requestUri": "/v1/storage-systems/device-type4/7CE751P312/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/disks/d4b13e70924d29afdb77d932f7563ea6",
  • "resourceUri": "/v1/storage-systems/device-type4/7CE751P312/enclosures/0/disks/d4b13e70924d29afdb77d932f7563ea6",
  • "sedStatus": "FIPS Capable",
  • "state": {
    },
  • "systemId": "7CE751P312",
  • "type": "string",
  • "writeErrors": {
    },
  • "wwn": "5002538B10249591"
}

Get details of HPE Alletra Storage MP Enclosure Cards identified by {enclosureId}

Get details of HPE Alletra Storage MP Enclosure Cards identified by {enclosureId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-cards",
  • "total": 1
}

Get details of HPE Alletra Storage MP Enclosure Card identified by {enclosureId} and {id}

Get details of HPE Alletra Storage MP Enclosure Card identified by {enclosureId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure card

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-cards/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "dcsdata": {
    },
  • "displayname": "string",
  • "domain": null,
  • "elementStatusCode": "string",
  • "enclosureCardBootDrives": {
    },
  • "enclosureCardCpu": {
    },
  • "enclosureCardFan": {
    },
  • "enclosureCardId": 0,
  • "enclosureCardMem": {
    },
  • "enclosureCardPci": {
    },
  • "enclosureCardTpm": {
    },
  • "enclosureId": 1,
  • "enclosureName": "string",
  • "enclosureType": "ENCLOSURE_DCS8",
  • "enclosureUid": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "failIndicator": false,
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "isNodeCard": false,
  • "locateEnabled": false,
  • "locateSevenSegDisplay": "string",
  • "loopA": false,
  • "loopB": false,
  • "manufacturing": {
    },
  • "name": "SASB",
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-cards/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-cards/8621946048c1cb24bdfc57e9b3b460ac",
  • "safeToRemove": false,
  • "sevenSegDisplay": "string",
  • "state": {
    },
  • "systemId": "7CE751P312",
  • "type": "string"
}

Locate IO Module of HPE Alletra Storage MP identified by {id}

Locate IO Module of HPE Alletra Storage MP identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure card

Request Body schema: application/json
locate
boolean

Indicates if the locate beacon should be enabled or not

Responses

Request samples

Content type
application/json
{
  • "locate": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of HPE Alletra Storage MP Enclosure Connectors identified by {enclosureId}

Get details of HPE Alletra Storage MP Enclosure Connectors identified by {enclosureId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-connectors",
  • "total": 1
}

Get details of HPE Alletra Storage MP Enclosure Connector identified by {enclosureId} and {enclosureConnectorId}

Get details of HPE Alletra Storage MP Enclosure Connector identified by {enclosureId} and {enclosureConnectorId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

enclosureConnectorId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure connector

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "connector": 0,
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-connectors/8621946048c1cb24bdfc57e9b3b460ac",
  • "currentSpeed": "currentSpeed",
  • "customerId": "string",
  • "disabled": "disabled",
  • "displayname": "display name",
  • "domain": "string",
  • "elementStatusCode": {
    },
  • "enclosureCardId": 0,
  • "enclosureCardPCIUid": "PCIUID",
  • "enclosureCardUid": "CardUID",
  • "enclosureId": 0,
  • "enclosureName": "name",
  • "enclosureUid": "uid",
  • "generation": 0,
  • "id": "uid",
  • "ipv4Address": "ipv4",
  • "ipv6Address": "ipv6",
  • "label": "label",
  • "linkSpeed": "speed",
  • "locate": "locate",
  • "macAddress": "mac",
  • "nodePort": {
    },
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-connectors/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-connectors/8621946048c1cb24bdfc57e9b3b460ac",
  • "slot": 0,
  • "systemId": "4UW0004156",
  • "type": "type1"
}

Get details of HPE Alletra Storage MP Enclosure Disks identified by {enclosureId}

Get details of HPE Alletra Storage MP Enclosure Disks identified by {enclosureId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-disks",
  • "total": 1
}

Get details of HPE Alletra Storage MP Enclosure Disk identified by {enclosureId} and {id}

Get details of HPE Alletra Storage MP Enclosure Disk identified by {enclosureId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure disk

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-disks/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "dc4data": {
    },
  • "dcsdata": {
    },
  • "displayname": "string",
  • "domain": null,
  • "enclosureId": 1,
  • "enclosureName": "string",
  • "enclosureType": "ENCLOSURE_DCS8",
  • "enclosureUid": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "loopA": {
    },
  • "loopB": {
    },
  • "manufacturing": {
    },
  • "name": "SASB",
  • "position": {
    },
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-disks/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-disks/8621946048c1cb24bdfc57e9b3b460ac",
  • "systemId": "7CE751P312",
  • "temperature": 0,
  • "type": "string",
  • "wwn": "5000C500997AB7B0"
}

Get details of HPE Alletra Storage MP Enclosure Powers identified by {enclosureId}

Get details of HPE Alletra Storage MP Enclosure Powers identified by {enclosureId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-powers",
  • "total": 1
}

Get details of HPE Alletra Storage MP Enclosure Power identified by {enclosureId} and {id}

Get details of HPE Alletra Storage MP Enclosure Power identified by {enclosureId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure power

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "acStatus": "string",
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-powers/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "dcStatus": "string",
  • "displayname": "string",
  • "domain": null,
  • "elementStatusCode": "string",
  • "enclosureId": 1,
  • "enclosureName": "string",
  • "enclosurePowerId": 0,
  • "enclosurePowerSupplyId": 0,
  • "enclosureType": "ENCLOSURE_DCS8",
  • "enclosureUid": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "failIndicator": false,
  • "failInput": false,
  • "failOutput": false,
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "locateEnabled": false,
  • "manufacturing": {
    },
  • "modelReadOnly": false,
  • "name": "SASB",
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-powers/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-powers/8621946048c1cb24bdfc57e9b3b460ac",
  • "safeToRemove": false,
  • "state": {
    },
  • "systemId": "7CE751P312",
  • "type": "string"
}

Get details of HPE Alletra Storage MP Enclosure Sleds identified by {enclosureId}

Get details of HPE Alletra Storage MP Enclosure Sleds identified by {enclosureId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter enclosure resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort enclosure resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-sleds",
  • "total": 1
}

Get details of HPE Alletra Storage MP Enclosure Sled identified by {enclosureId} and {id}

Get details of HPE Alletra Storage MP Enclosure Sled identified by {enclosureId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure sled

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-sleds/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "dc4data": {
    },
  • "diskCount": 1,
  • "displayname": "string",
  • "domain": null,
  • "elementStatusCode": "string",
  • "enclosureId": 1,
  • "enclosureName": "string",
  • "enclosureType": "ENCLOSURE_DCS8",
  • "enclosureUid": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "failIndicator": false,
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "locateEnabled": false,
  • "manufacturing": {
    },
  • "name": "SASB",
  • "okIndicator": false,
  • "portBypassA": false,
  • "portBypassB": false,
  • "power": false,
  • "predFailIndicator": false,
  • "protocol": "SAS",
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-sleds/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-sleds/8621946048c1cb24bdfc57e9b3b460ac",
  • "safeToRemove": false,
  • "sledId": 0,
  • "stateLoopA": {
    },
  • "stateLoopB": {
    },
  • "systemId": "7CE751P312",
  • "temperature": 30,
  • "type": "string",
  • "wwn": "5000C500997AB7B0"
}

Locate drive of HPE Alletra Storage MP identified by {id}

Locate drive of HPE Alletra Storage MP identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

enclosureId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure sled

Request Body schema: application/json
locate
boolean

Indicates if the locate beacon should be enabled or not

Responses

Request samples

Content type
application/json
{
  • "locate": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of HPE Alletra Storage MP Enclosure identified by {id}

Get details of HPE Alletra Storage MP Enclosure identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "chainPosLoopA": 0,
  • "chainPosLoopB": 0,
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f",
  • "customerId": "string",
  • "dcsdata": {
    },
  • "detailedState": null,
  • "disks": {
    },
  • "displayname": "string",
  • "domain": null,
  • "enclosureCards": {
    },
  • "enclosureCdms": {
    },
  • "enclosureDisks": {
    },
  • "enclosureId": 0,
  • "enclosurePowerSupplies": {
    },
  • "enclosureSleds": {
    },
  • "enclosureType": "ENCLOSURE_DCS8",
  • "errors": [
    ],
  • "failIndicator": false,
  • "failRequested": false,
  • "formFactor": "SFF",
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "locateEnabled": false,
  • "location": "string",
  • "loopSplit": true,
  • "manufacturing": {
    },
  • "name": "cage1",
  • "nodeWwn": "50050CC106233428",
  • "nodes": {
    },
  • "requestUri": "/v1/storage-systems/device-type4/7CE751P312/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f",
  • "resourceUri": "/v1/storage-systems/device-type4/7CE751P312/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f",
  • "state": {
    },
  • "subType": "string",
  • "systemId": "7CE751P312",
  • "type": "string",
  • "warnIndicator": false,
  • "warnRequested": false
}

Locate enclosure drive of HPE Alletra Storage MP identified by {id}

Locate enclosure drive of HPE Alletra Storage MP identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

Request Body schema: application/json
locate
boolean

Indicates if the locate beacon should be enabled or not

Responses

Request samples

Content type
application/json
{
  • "locate": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit details of HPE Alletra Storage MP Enclosure identified by {id}

Edit details of HPE Alletra Storage MP Enclosure identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the enclosure

Request Body schema: application/json
id
string or null

New Id of the enclosure

location
string or null

Location of the enclosure in the datacenter

Responses

Request samples

Content type
application/json
{
  • "id": "5",
  • "location": "MIP-01 H29 36-38"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of performance metrics of physical drives on storage system identified by {systemid}

Get details of performance metrics of physical drives on storage system identified by {systemid}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
reportType
string
Example: reportType=Canned,Custom,Def,ApiUser

parameter will be set to report type requested. For api users, set parameter as ApiUser

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

compareBy
string
Example: compareBy=top eq 5 and metrics eq readIops

compareBy will define top and compare metrics for which query has to be made. Allowed values: readIops, writeIops, totalIops, readThroughput, writeThroughput, totalThroughput, readLatency, writeLatency, totalLatency, readIosize, writeIosize, totalIosize, totalQlen, avgBusy

groupBy
string
Example: groupBy=pdId

groupBy will define comma separated groupBy parameters. Allowed value: pdId. By default, groupBy will be set to pdId.

metricType
string
Example: metricType=IOPS,LATENCY,THROUGHPUT,IOSIZE,QLEN,AVG_BUSY

metricType will define comma separated metrics

filter
string
Example: filter=pdId in (1,2)

filter will define objects to be filtered. Filterable columns are: * pdId - id of the physical drive

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 162564271,
  • "historyData": {
    },
  • "requestUri": "/v1/storage-systems/device-type4/SGH014XGSP/volumes/performance-history",
  • "startTime": 1625556314
}

storage-pools

The pools API allows the management of storage pools

Get all storage pools for a device {systemId}

Get all storage pools for a device {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq CPG_1

oData query to filter pools by Key.

sort
string
Example: sort=name desc

oData query to sort pools by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 0,
  • "requestUri": "/api/v1/storage-systems/7CE809P009/storage-pools",
  • "total": 1
}

Get details of storage pools identified by {id}

Get details of storage pools identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: 147c439db3ecb34d1ccccc932d14fd60

Identifier of pool. A 32 digit number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "capacityUsed": 56446,
  • "customerId": "string",
  • "generation": 0,
  • "id": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "name": "Vega_7_test",
  • "resourceUri": "/api/storage-systems/device-type1/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178",
  • "systemId": "7CE809P009",
  • "type": "string"
}

Get all volumes for storage-pool identified by {id}

Get all volumes for storage-pool identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: 147c439db3ecb34d1ccccc932d14fd60

Identifier of pool. A 32 digit number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/volumes",
  • "total": 1
}

Get all storage-pools details by Primera / Alletra 9K

Get all storage-pools details by Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq CPG_1

oData query to filter pools by Key.

sort
string
Example: sort=name desc

oData query to sort pools by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE809P009/storage-pools",
  • "total": 1
}

Get details of Primera / Alletra 9K storage-pool identified by {id}

Get details of Primera / Alletra 9K storage-pool identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: 147c439db3ecb34d1ccccc932d14fd60

Identifier of pool. A 32 digit number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "alert": {
    },
  • "allocationSettings": {
    },
  • "aoConfigID": 1,
  • "associatedLinks": [
    ],
  • "baseSizeMiB": 67584,
  • "baseSizePrivateMiB": 1215872,
  • "baseSizeRawMiB": 90111,
  • "commonResourceAttributes": {
    },
  • "compactRatio": 5.722643930878938,
  • "compressRatio": 4.233684210526316,
  • "customerId": "string",
  • "dataReduceRatio": 2.25,
  • "dedupCapable": true,
  • "dedupRatio": 2.2464644143676713,
  • "dedupVersion": {
    },
  • "displayname": "CPG Vega_7_test",
  • "domain": "testdomain",
  • "freeForAllocationMiB": 4141056,
  • "freeSizeMiB": 44672,
  • "freeSizeRawMiB": 16896,
  • "generation": 0,
  • "id": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "name": "Vega_7_test",
  • "numberOfSnapRC": 5,
  • "numberOfTDVV": 14,
  • "numberOfTPVV": 1062,
  • "numberOfUserRC": 5,
  • "overProvRatio": 0.58,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178",
  • "resourceUri": "/api/v1/storage-systems/device-type1/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178",
  • "saGrow": {
    },
  • "sdGrow": {
    },
  • "sharedSizeMiB": 512,
  • "snapSizePrivateMiB": 526848,
  • "snapSizeRawMiB": 56831,
  • "snapSpaceAdmin": {
    },
  • "snapSpaceData": {
    },
  • "state": {
    },
  • "storagePoolId": 4,
  • "systemId": "7CE809P009",
  • "totalReservedMiB": 1806336,
  • "totalSizeMiB": 122880,
  • "totalSizeRawMiB": 163839,
  • "type": "string",
  • "userSpace": {
    },
  • "warnPercent": 5
}

Get all volumes for storage-pool identified by {uuid} of Primera / Alletra 9K

Get all volumes for storage-pool identified by {uuid} of Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: 147c439db3ecb34d1ccccc932d14fd60

Identifier of pool. A 32 digit number.

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/primea/2FF70002AC018D94/volumes",
  • "total": 1
}

Get performance history of Nimble / Alletra 6K Pools

Get performance history of Nimble / Alletra 6K Pools

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

compareBy
string
Example: compareBy=top eq 5 and metrics eq readIops

compareBy will define top and compare metrics for which query has to be made. Allowed values: readIops, writeIops, totalIops, readThroughput, writeThroughput, totalThroughput, readLatency, writeLatency, totalLatency, readIosize, writeIosize, totalIosize, totalQlen, avgBusy

filter
string
Example: filter=vvname in (vvname1,vvname2,vvname3) ,deviceName in (cage1)

filter will define objects to be filtered

metricType
string
Example: metricType=IOPS,LATENCY,THROUGHPUT

metricTypes will define comma separated metrics

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 162564271,
  • "historyData": {
    },
  • "requestUri": "/v1/storage-systems/device-type2/0000000110000000/volumes/volume-performance",
  • "startTime": 1625556314
}

Get all pools details by Nimble / Alletra 6K

Get all pools details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter pools by Key.

sort
string
Example: sort=name desc

oData query to sort pools resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/storage-pools",
  • "total": 1
}

Create storage pool from Nimble / Alletra 6K system identified by {systemId}

Create storage pool from Nimble / Alletra 6K system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
required
Array of objects (CreatePoolNimbleArrayDetail)

List of arrays identified by their IDs, in the pool.

dedupe_all_volumes
boolean or null

Indicates if dedupe is enabled by default for new volumes on this pool. Defaults to false.

description
string or null

Text description of pool. String of up to 255 printable ASCII characters. Defaults to empty string.

name
required
string

Name of pool. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

Responses

Request samples

Content type
application/json
{
  • "array_list": [
    ],
  • "dedupe_all_volumes": false,
  • "description": "99.9999% availability",
  • "name": "pool-1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete pool identified by {storagePoolId} from Nimble / Alletra 6K

Delete pool identified by {storagePoolId} from Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

storagePoolId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of pool. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K pool identified by {storagePoolId}

Get details of Nimble / Alletra 6K pool identified by {storagePoolId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

storagePoolId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of pool. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/storage-pools/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "name": "pool0.0645689306120438",
  • "all_flash": true,
  • "array_count": 2,
  • "array_list": [
    ],
  • "associated_links": [
    ],
  • "cache_capacity": 256,
  • "capacity": 1024,
  • "clone_ratio": 9.18,
  • "commonResourceAttributes": {
    },
  • "compression_ratio": 9.18,
  • "consoleUri": "null",
  • "creation_time": 343200,
  • "customerId": "string",
  • "data_reduction_ratio": 9.18,
  • "dedupe_all_volumes": false,
  • "dedupe_all_volumes_capable": false,
  • "dedupe_capable": true,
  • "dedupe_capacity_bytes": 10,
  • "dedupe_ratio": 9.18,
  • "dedupe_usage_bytes": 0,
  • "description": "HA pool",
  • "folder_list": [
    ],
  • "free_space": 1024,
  • "full_name": "pool0.0645689306120438",
  • "generation": 0,
  • "is_default": true,
  • "last_modified": 343200,
  • "pinnable_cache_capacity": 128,
  • "pinned_cache_capacity": 128,
  • "pinned_vol_list": [
    ],
  • "reserve": 165432,
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "savings": 54,
  • "savings_clone": 64,
  • "savings_compression": 48,
  • "savings_data_reduction": 107,
  • "savings_dedupe": 58,
  • "savings_ratio": 9.18,
  • "savings_vol_thin_provisioning": 1073,
  • "search_name": "pool0.0645689306120438",
  • "snap_count": 8,
  • "snapcoll_count": 0,
  • "type": "string",
  • "unassigned_array_list": [
    ],
  • "uncompressed_snap_usage_bytes": 165432,
  • "uncompressed_vol_usage_bytes": 165432,
  • "unused_reserve": 15,
  • "usage": 256,
  • "usage_valid": true,
  • "vol_count": 5,
  • "vol_list": [
    ],
  • "vol_thin_provisioning_ratio": 9.18
}

Edit details of Nimble / Alletra 6K pool identified by {storagePoolId}

Edit details of Nimble / Alletra 6K pool identified by {storagePoolId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

storagePoolId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of pool. A 42 digit hexadecimal number.

Request Body schema: application/json
Array of objects or null (EditPoolNimbleArrayDetail)

List of arrays identified by their IDs, in the pool.

dedupe_all_volumes
boolean or null

Indicates if dedupe is enabled by default for new volumes on this pool.

dedupe_capable
boolean or null

Indicates whether the pool is capable of hosting deduped volumes.

description
string or null

Text description of pool. String of up to 255 printable ASCII characters.

force
boolean or null

Forcibly delete the specified pool even if it contains deleted volumes whose space is being reclaimed. Forcibly remove an array from array_list via an update operation even if the array is not reachable. There should no volumes currently in the pool for the forced update operation to succeed.

is_default
boolean or null

Indicates if this is the default pool.

name
required
string or null

Name of pool. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

Responses

Request samples

Content type
application/json
{
  • "array_list": [
    ],
  • "dedupe_all_volumes": false,
  • "dedupe_capable": false,
  • "description": "99.9999% availability",
  • "force": false,
  • "is_default": false,
  • "name": "pool-1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Merge pool identified by {storagePoolId} from Nimble / Alletra 6K

Merge pool identified by {storagePoolId} from Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

storagePoolId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of pool. A 42 digit hexadecimal number.

Request Body schema: application/json
force
boolean or null

Forcibly merge the specified pool into target pool. Defaults to false.

target_pool_id
required
string

ID of the target pool. A 42 digit hexadecimal number.

Responses

Request samples

Content type
application/json
{
  • "force": false,
  • "target_pool_id": "2a0df0fe6f7dc7bb16000000000000000000004801"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get storage pool capacity trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}

Get storage pool capacity trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

storagePoolId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of storage pool. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "count": 127,
  • "requestUri": "/api/v1/storage-systems/device-type2/00473102de2f5f39d8000000000000000000000001/storage-pools/37473102de2f5f39d8000000000000000000000027/capacity-history",
  • "series_data": [
    ],
  • "total": 127
}

Get performance trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}

Get performance trend data of Nimble / Alletra 6K storage pool identified by {storagePoolId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

storagePoolId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of storage pool. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "iops_metrics_data": {
    },
  • "latency_metrics_data": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type2/00473102de2f5f39d8000000000000000000000001/storage-pools/37473102de2f5f39d8000000000000000000000027/performance-history",
  • "throughput_metrics_data": {
    }
}

Get performance statistics of Nimble / Alletra 6K storage pool identified by {storagePoolId}

Get performance statistics of Nimble / Alletra 6K storage pool identified by {storagePoolId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

storagePoolId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of storage pool. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "iops": {
    },
  • "latency": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type2/00473102de2f5f39d8000000000000000000000001/storage-pools/37473102de2f5f39d8000000000000000000000027/performance-statistics",
  • "throughput": {
    }
}

Get all storage-pools details by HPE Alletra Storage MP

Get all storage-pools details by HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq CPG_1

oData query to filter pools by Key.

sort
string
Example: sort=name desc

oData query to sort pools by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE809P009/storage-pools",
  • "total": 1
}

Get details of HPE Alletra Storage MP storage-pool identified by {id}

Get details of HPE Alletra Storage MP storage-pool identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: 147c439db3ecb34d1ccccc932d14fd60

Identifier of pool. A 32 digit number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "alert": {
    },
  • "allocationSettings": {
    },
  • "aoConfigID": 1,
  • "associatedLinks": [
    ],
  • "baseSizeMiB": 67584,
  • "baseSizePrivateMiB": 1215872,
  • "baseSizeRawMiB": 90111,
  • "commonResourceAttributes": {
    },
  • "compactRatio": 5.722643930878938,
  • "compressRatio": 4.233684210526316,
  • "customerId": "string",
  • "dataReduceRatio": 2.25,
  • "dedupCapable": true,
  • "dedupRatio": 2.2464644143676713,
  • "dedupVersion": {
    },
  • "displayname": "CPG Vega_7_test",
  • "domain": "testdomain",
  • "freeForAllocationMiB": 4141056,
  • "freeSizeMiB": 44672,
  • "freeSizeRawMiB": 16896,
  • "generation": 0,
  • "id": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  • "name": "Vega_7_test",
  • "numberOfSnapRC": 5,
  • "numberOfTDVV": 14,
  • "numberOfTPVV": 1062,
  • "numberOfUserRC": 5,
  • "overProvRatio": 0.58,
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178",
  • "resourceUri": "/api/v1/storage-systems/device-type4/7CE809P009/storage-pools/8fdba044f8d90c7922c17b9340b65178",
  • "saGrow": {
    },
  • "sdGrow": {
    },
  • "sharedSizeMiB": 512,
  • "snapSizePrivateMiB": 526848,
  • "snapSizeRawMiB": 56831,
  • "snapSpaceAdmin": {
    },
  • "snapSpaceData": {
    },
  • "state": {
    },
  • "storagePoolId": 4,
  • "systemId": "7CE809P009",
  • "totalReservedMiB": 1806336,
  • "totalSizeMiB": 122880,
  • "totalSizeRawMiB": 163839,
  • "type": "string",
  • "userSpace": {
    },
  • "warnPercent": 5
}

Get all volumes for storage-pool identified by {uuid} of HPE Alletra Storage MP

Get all volumes for storage-pool identified by {uuid} of HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: 147c439db3ecb34d1ccccc932d14fd60

Identifier of pool. A 32 digit number.

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/primea/2FF70002AC018D94/volumes",
  • "total": 1
}

storage-systems

The storage-systems API allows the management of storage device.

Get all storage systems

Get all storage systems

Authorizations:
JWTAuth
query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq VEGA_CB1507_8400_2N_150

oData query to filter systems by Key.

sort
string
Example: sort=id asc,name desc

Query to sort the response with specified key and order

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/",
  • "total": 1
}

Get storage system object identified by {id}

Get storage system object identified by {id}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: SGH029VBHV

Serial number of the device-type1 storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "arrayList": [
    ],
  • "associatedLinks": [
    ],
  • "callhomeStatus": "ENABLED_NORMAL",
  • "collectionStatus": {
    },
  • "commonResourceAttributes": {
    },
  • "connectionStatus": "CONNECTED",
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "description": "string",
  • "fqdn": "s9.in.hpecorp.net",
  • "generation": 0,
  • "id": "7CE751P312",
  • "lastConnectedTime": 1600084190299,
  • "mgmtIp": "192.168.0.1",
  • "model": "string",
  • "name": "DeviceType1Billing",
  • "productFamily": "deviceType1",
  • "requestUri": "/api/v1/storage-systems/7CE751P312",
  • "resourceUri": "/api/v1/storage-systems/7CE751P312",
  • "softwareVersion": "string",
  • "state": "NORMAL",
  • "systemWWN": "2FF70002AC018D94",
  • "tierType": "STORAGE_TIER_UNKNOWN",
  • "type": "string",
  • "upSince": 1600084190299
}

Get all Primera / Alletra 9K storage systems

Get all Primera / Alletra 9K storage systems

Authorizations:
JWTAuth
query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq VEGA_CB1507_8400_2N_150

oData query to filter systems by Key.

sort
string
Example: sort=id asc,name desc

Query to sort the response with specified key and order

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1",
  • "total": 1
}

Get Primera / Alletra 9K object identified by {id}

Get Primera / Alletra 9K object identified by {id}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: SGH029VBHV

Serial number of the device-type1 storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "centerplaneType": "4 Node Centerplane",
  • "chunkletSizeMiB": 1024,
  • "clusterLED": "LED_UNKNOWN",
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP",
  • "customerId": "string",
  • "descriptors": {
    },
  • "deviceId": 101780,
  • "deviceType": {
    },
  • "displayname": "System VEGA_CB1507_8400_2N_150",
  • "domain": "string",
  • "fqdn": "s9.in.hpecorp.net",
  • "generation": 0,
  • "id": "7CE751P312",
  • "inClusterNodes": [
    ],
  • "isFIPSEnabled": true,
  • "locateEnabled": true,
  • "maintenanceMode": [
    ],
  • "manufacturing": {
    },
  • "masterNode": 4,
  • "minimumPasswordLength": 6,
  • "name": "VEGA_CB1507_8400_2N_150",
  • "networkMasterNode": 1,
  • "nodeMemory": "16",
  • "nodesCount": 2,
  • "nodesPresent": [
    ],
  • "onlineNodes": [
    ],
  • "parameters": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312",
  • "resourceUri": "/api/v1/storage-systems/device-type1/7CE751P312",
  • "safeToRemove": true,
  • "softwareVersions": {
    },
  • "state": {
    },
  • "sysLogStatus": {
    },
  • "systemDate": 1597918380,
  • "systemHeadroom": {
    },
  • "systemWWN": "2FF70002AC018D94",
  • "timezone": "Asia/Calcutta",
  • "type": "string",
  • "uptime": {
    },
  • "version": {
    }
}

Locate system of Primera / Alletra 9K

Locate system of Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: SGH029VBHV

Serial number of the device-type1 storage system

Request Body schema: application/json
locateEnabled
boolean

Indicates if the locate beacon should be enabled or not

Responses

Request samples

Content type
application/json
{
  • "locateEnabled": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get Application Summary for a storage system Primera / Alletra 9K

Get Application Summary for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "string",
  • "items": [
    ],
  • "requestUri": "/v1/storage-systems/device-type1/SGH014XGSP/application-summary",
  • "total": 2
}

Get capacity trend data for a storage system Primera / Alletra 9K

Get capacity trend data for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 1440 10080
Example: timeIntervalMin=1440

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "capacityData": {
    },
  • "commonResourceAttributes": {
    },
  • "endTime": 1625209133,
  • "requestUri": "/v1/storage-systems/device-type1/SGH014XGSP/capacity-history",
  • "startTime": 1625122733
}

Get system capacity for a storage system Primera / Alletra 9K

Get system capacity for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "capacityByTier": {
    },
  • "capacityDetail": {
    },
  • "capacitySummary": {
    },
  • "commonResourceAttributes": {
    },
  • "customerId": "string",
  • "fcCapacitySummary": {
    },
  • "id": "string",
  • "nlCapacitySummary": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/capacity-summary",
  • "resourceUri": "/api/v1/storage-systems/device-type1/7CE751P312/capacity-summary",
  • "ssdCapacitySummary": {
    },
  • "systemId": "7CE751P312",
  • "utilizationSummary": {
    }
}

Get component performance statistics details for a storage system Primera / Alletra 9K idenfified by {systemId}

Get component performance statistics details for a storage system Primera / Alletra 9K idenfified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "cachePercentage": {
    },
  • "commonResourceAttributes": {
    },
  • "cpuPercentage": {
    },
  • "customerId": "string",
  • "requestUri": "v1/storage-systems/device-type1/7CE751P312/component-performance-statistics"
}

Get system level saturation details

Get system level saturation details of system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
required
integer
Enum: 5 60 1440
Example: timeIntervalMin=60

Time interval granularity in minutes

Responses

Response samples

Content type
application/json
{
  • "averageHeadroomUtilizationData": {
    },
  • "customerId": "string",
  • "endTime": 1669880791,
  • "granularityInMin": 60,
  • "headroomUtilizationData": [
    ],
  • "requestUri": "/api/v1/storage-systems/device-type1/ABC239XFZ9/headroom-utilization",
  • "startTime": 1669794391
}

Get system level latency factors

Get system level latency factors of system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
required
integer
Enum: 5 60 1440
Example: timeIntervalMin=60

Time interval granularity in minutes

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "endTime": 1669880791,
  • "latencyBands": {
    },
  • "startTime": 1669794391,
  • "systemFactorsMetrics": [
    ],
  • "systemId": "string"
}

Get performance trend data for a storage system Primera / Alletra 9K

Get performance trend data for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "string",
  • "endTime": 1625642714,
  • "historyData": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type1/SGH014XGSP/performance-history",
  • "startTime": 1625556314
}

Get performance statistics for a storage system Primera / Alletra 9K

Get performance statistics for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "string",
  • "iops": {
    },
  • "latency": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type1/SGH014XGSP/performance-statistics",
  • "resourceUri": "/api/v1/storage-systems/device-type1/SGH014XGSP/performance-statistics",
  • "throughput": {
    }
}

Get QoS policy data for a storage system Primera / Alletra 9K identified by {systemId}

Get QoS policy data for a storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

targetName
string
Example: targetName=targetName eq volume1

targetName will define the QoS target name in which query has to be made.

targetType
string
Example: targetType=targetType eq vv

targetType will define the QoS target type in which query has to be made.

Responses

Response samples

Content type
application/json
{
  • "qospolicyDetails": {
    },
  • "requestURI": "/api/v1/storage-systems/device-type1/SGH014XGSP/qos-policy"
}

Get recommendations for a storage system Primera / Alletra 9K

Get recommendations for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "checkTime": {
    },
  • "displayname": "HPE 3par",
  • "domain": "string",
  • "id": "string",
  • "patches": [
    ],
  • "releases": [
    ],
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/recommendations",
  • "resourceUri": "/api/v1/storage-systems/device-type1/7CE751P312/recommendations",
  • "systemId": "7CE751P312",
  • "updateTime": {
    }
}

Get QoS performance trend data of Primera / Alletra 9K target identified by {targetName}

Get QoS performance trend data of Primera / Alletra 9K target identified by {targetName}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

targetName
required
string
Example: targetName eq volume1

targetName will define the QoS target name in which query has to be made.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "qosMetricsData": {
    },
  • "requestURI": "/v1/storage-systems/device-type1/SGH014XGSP/targets/testtarget/performance-history"
}

Get all storage systems by Nimble / Alletra 6K

Get all storage systems by Nimble / Alletra 6K

Authorizations:
JWTAuth
query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=NAME eq g1a1

Lucene query to filter systems by Key.

sort
string
Example: sort=name desc

Lucene query to sort systems by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2",
  • "total": 1
}

Get Nimble / Alletra 6K object identified by {systemId}

Get Nimble / Alletra 6K object identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "name": "g1a1",
  • "access_protocol_list": [
    ],
  • "alarms_enabled": true,
  • "alert_from_email_addr": "bob@example.com",
  • "alert_min_level": "critical",
  • "alert_to_email_addrs": "john-doe@example.com",
  • "allow_analytics_gui": true,
  • "allow_support_tunnel": false,
  • "array_unassign_migration_status": [
    ],
  • "arrays": {
    },
  • "associated_links": [
    ],
  • "auto_switchover_enabled": true,
  • "auto_switchover_messages": [
    ],
  • "autoclean_unmanaged_snapshots_enabled": false,
  • "autoclean_unmanaged_snapshots_ttl_unit": 0,
  • "autosupport_enabled": true,
  • "cc_mode_enabled": false,
  • "clone_ratio": 9.18,
  • "cloud_management": "read_only",
  • "commonResourceAttributes": {
    },
  • "compressed_snap_usage_bytes": 0,
  • "compressed_vol_usage_bytes": 0,
  • "compression_ratio": 9.18,
  • "consoleUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "customerId": "string",
  • "data_rebalance_status": [
    ],
  • "data_reduction_ratio": 9.18,
  • "date": 1598267193,
  • "dedupe_ratio": 9.18,
  • "default_iscsi_target_scope": "group",
  • "default_snap_limit_percent": -1,
  • "default_snap_reserve": 0,
  • "default_snap_warn_level": 0,
  • "default_volume_limit": 100,
  • "default_volume_reserve": 0,
  • "default_volume_warn_level": 80,
  • "dns_servers": [
    ],
  • "domain_name": "example-1.com",
  • "encryption_config": {
    },
  • "failover_mode": "Manual",
  • "fc_enabled": false,
  • "free_space": 244695092429,
  • "generation": 0,
  • "group_snapshot_ttl": 0,
  • "group_target_enabled": true,
  • "group_target_name": "iqn.2007-11.com.abc:g1a1-g00000000000004d3",
  • "iscsi_automatic_connection_method": false,
  • "iscsi_connection_rebalancing": false,
  • "iscsi_enabled": true,
  • "isns_enabled": true,
  • "isns_port": 3205,
  • "isns_server": "example-1.com",
  • "last_login": "admin @ 2020-08-06T17:26:01-0700",
  • "leader_array_name": "arr1",
  • "leader_array_serial": "AC-109084",
  • "management_service_backup_array_name": "nimbleArray",
  • "management_service_backup_status": "setup_in_progress",
  • "max_lock_period": 1209600,
  • "member_list": [
    ],
  • "merge_group_name": "g1a2",
  • "merge_state": "none",
  • "ntp_server": "0.abc.pool.ntp.org",
  • "num_connections": 0,
  • "num_snapcolls": 0,
  • "num_snaps": 0,
  • "pending_deletes": 0,
  • "proxy_port": 1234,
  • "proxy_server": "example-1.com",
  • "proxy_username": "usr1",
  • "raw_cache_capacity": 17179869184,
  • "raw_capacity": 476741369856,
  • "repl_throttle_list": [
    ],
  • "repl_throttled_bandwidth": -1,
  • "repl_throttled_bandwidth_kbps": -1,
  • "replication_enabled": false,
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "savings": 1073741824,
  • "savings_clone": 0,
  • "savings_compression": 0,
  • "savings_data_reduction": 0,
  • "savings_dedupe": 0,
  • "savings_ratio": 9.18,
  • "savings_vol_thin_provisioning": 1073741824,
  • "scsi_vendor_id": "Nimble",
  • "send_alert_to_support": true,
  • "smtp_auth_enabled": false,
  • "smtp_port": 25,
  • "smtp_server": "string",
  • "snap_compression_ratio": 9.18,
  • "snap_retn_meter_high": 0,
  • "snap_retn_meter_very_high": 0,
  • "snap_usage_populated": 0,
  • "snmp_community": "public",
  • "snmp_get_enabled": false,
  • "snmp_get_port": 161,
  • "snmp_sys_contact": "JD",
  • "snmp_sys_location": "example-location",
  • "snmp_trap_enabled": true,
  • "snmp_trap_host": "example-1.com",
  • "snmp_trap_port": 162,
  • "space_info_valid": false,
  • "syslogd_enabled": true,
  • "syslogd_port": 514,
  • "syslogd_server": "example-1.com",
  • "syslogd_servers": [
    ],
  • "systemHeadroom": {
    },
  • "tdz_enabled": false,
  • "tdz_prefix": "peerzone",
  • "timezone": "America/Los_Angeles",
  • "tlsv1_enabled": false,
  • "type": "string",
  • "uncompressed_snap_usage_bytes": 0,
  • "uncompressed_vol_usage_bytes": 0,
  • "unique_name_enabled": false,
  • "unused_reserve_bytes": 0,
  • "update_array_names": "name,app_id",
  • "update_download_end_time": 1460477575,
  • "update_download_error_code": "SM_ok",
  • "update_download_start_time": 1460477565,
  • "update_downloading": false,
  • "update_end_time": 3400,
  • "update_error_code": "SM_ok",
  • "update_progress_msg": "example progress message",
  • "update_start_time": 3400,
  • "update_state": "normal",
  • "usable_cache_capacity": 13432258560,
  • "usable_capacity_bytes": 244695092429,
  • "usage": 0,
  • "usage_valid": true,
  • "user_inactivity_timeout": 1800,
  • "version_current": "5.3.0.0-746508-opt",
  • "version_rollback": "v1",
  • "version_target": "v1",
  • "vol_compression_ratio": 9.18,
  • "vol_thin_provisioning_ratio": 9.18,
  • "volume_migration_status": [
    ],
  • "vss_validation_timeout": 60,
  • "vvol_enabled": true,
  • "witness_status": [
    ]
}

Edit settings of Nimble / Alletra 6K system identified by {systemId}

Edit settings of Nimble / Alletra 6K system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
auto_switchover_enabled
boolean or null

Whether automatic switchover of Group management services feature is enabled.

autoclean_unmanaged_snapshots_enabled
boolean or null

Whether auto-clean unmanaged snapshots feature is enabled.

autoclean_unmanaged_snapshots_ttl_unit
integer or null <int64>

Unit for unmanaged snapshot time to live.

cc_mode_enabled
boolean or null

Enable or disable Common Criteria mode.

date
integer or null <int64>

Unix epoch time local to the group. Seconds since last epoch i.e. 00:00 January 1, 1970. Setting this along with ntp_server causes ntp_server to be reset.

default_iscsi_target_scope
string or null

Newly created volumes are exported under iSCSI Group Target or iSCSI Volume Target.

group_snapshot_ttl
integer or null <int64>

Snapshot Time-to-live(TTL) configured at group level for automatic deletion of unmanaged snapshots. Value 0 indicates unlimited TTL.

group_target_name
string or null

Iscsi target name for this group. Plain string.

max_lock_period
integer or null <int64>

Maximum seconds to keep any snapshot as immutable within a Nimble group. Default value would be 1209600 seconds.

name
string or null

Name of the group. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

ntp_server
string or null

Either IP address or hostname of the NTP server for this group.

tdz_enabled
boolean or null

Is Target Driven Zoning (TDZ) enabled on this group.

tdz_prefix
string or null

Target Driven Zoning (TDZ) prefix for peer zones created by TDZ.

timezone
string or null

Timezone in which this group is located. Plain string.

tlsv1_enabled
boolean or null

Enable or disable TLSv1.0 and TLSv1.1.

Responses

Request samples

Content type
application/json
{
  • "auto_switchover_enabled": true,
  • "autoclean_unmanaged_snapshots_enabled": false,
  • "autoclean_unmanaged_snapshots_ttl_unit": 0,
  • "cc_mode_enabled": false,
  • "date": 1598267193,
  • "default_iscsi_target_scope": "group",
  • "group_snapshot_ttl": 0,
  • "group_target_name": "iqn.2007-11.com.abc:g1a1-g00000000000004d3",
  • "max_lock_period": 1209600,
  • "name": "myobject-5",
  • "ntp_server": "0.abc.pool.ntp.org",
  • "tdz_enabled": false,
  • "tdz_prefix": "peerzone",
  • "timezone": "America/Los_Angeles",
  • "tlsv1_enabled": false
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Perform group merge with the specified group.

Perform group merge with the specified group.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
force
boolean

Ignore warnings and forcibly merge specified group with this group. Possible values: 'true', 'false'.

skip_secondary_mgmt_ip
boolean

Skip check for secondary management IP address. Possible values: 'true', 'false'.

src_group_ip
required
string or null

IP address of the source group. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'.

src_group_name
required
string or null

Name of the source group. String of up to 64 alphanumeric characters, - is allowed after first character. Example: 'g1-exchange'.

src_passphrase
string

Source group encryption passphrase. Encryption passphrase. String with size from 8 to 64 printable characters. Example: 'passphrase-91'.

src_password
required
string or null

Password of the source group. String of 8 to 255 printable characters excluding ampersand and ;[]`. Example: 'password-91'.

src_username
required
string or null

Username of the source group. String of up to 80 alphanumeric characters, beginning with a letter. For Active Directory users, it can include backslash (), dash (-), period (.), underscore (_) and space. Example: 'user1', 'companydomain\user1'.

Responses

Request samples

Content type
application/json
{
  • "force": true,
  • "skip_secondary_mgmt_ip": true,
  • "src_group_ip": "123.12.12.32",
  • "src_group_name": "group1",
  • "src_passphrase": "passphrase-91",
  • "src_password": "password1",
  • "src_username": "admin"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get Application Summary for Nimble / Alletra 6K

Get Application Summary for Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "ab1c23645d67891e11abcdec222cc1ab",
  • "items": [
    ],
  • "requestUri": "/api/v1/storage-systems/device-type2/00123456ab7f5f39d8000000000000000000000001/application-summary",
  • "total": 2
}

Get capacity stats of Application identified by {id} for a storage system Nimble / Alletra 6K

Get capacity stats of Application identified by {id} for a storage system Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

id
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the application-summery. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/applications/00473102de2f5f39d8000000000000000000000001/capacity-stats",
  • "app_category_id": "360000000000000000000000000000000000000006",
  • "app_category_name": "Virtual Server",
  • "block_size": 4096,
  • "clone_ratio": 1,
  • "compressed_usage_bytes": 878976,
  • "compression_ratio": 40.3879423328965,
  • "dedupe_ratio": 1,
  • "deduped": true,
  • "encrypted": false,
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "logical_dedupe_usage": 0,
  • "physical_dedupe_usage": 0,
  • "pool_id": "0a473102de2f5f39d8000000000000000000000001",
  • "pool_name": "default",
  • "savings_clone": 0,
  • "savings_compression": 34621056,
  • "savings_dedupe": 0,
  • "snap_logical_usage": 0,
  • "uncompressed_usage_bytes": 35500032,
  • "usage": 878976,
  • "vol_logical_usage": 35500032,
  • "vol_mapped_usage": 35500032,
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type2/001491cb6652a03a6b000000000000000000000001/storage-pools/071491cb6652a03a6b000000000000000000000006",
  • "customerId": "string",
  • "deduped_volume_count": 0,
  • "generation": 0,
  • "perf_policy_names": [
    ],
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "sample_rate": 255,
  • "type": "string",
  • "volume_count": 3,
  • "volumes": [
    ]
}

Get capacity stats of Applications for a storage system Nimble / Alletra 6K

Get capacity stats of Applications for a storage system Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter application summery by Key.

sort
string
Example: sort=name desc

oData query to sort application summery resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/applications/capacity-stats",
  • "total": 1
}

Get all arrays details by Nimble / Alletra 6K

Get all arrays details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter array by Key.

sort
string
Example: sort=name desc

oData query to sort array resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "total": 1
}

Create Nimble / Alletra 6K array identified by {systemId}

Create Nimble / Alletra 6K array identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
allow_lower_limits
boolean or null

Whether to create associated pool during array create. Possible values: 'true', 'false'.

create_pool
boolean or null

Whether to create associated pool during array create. Possible values: 'true', 'false'.

ctrlr_a_support_ip
required
string

Controller A Support IP address.

ctrlr_b_support_ip
required
string

Controller B Support IP address.

dedupe_disabled
boolean or null

Is data deduplication disabled for this array. Possible values: 'true', 'false'.

name
required
string

The user provided name of the array. It is also the array's hostname. String of up to 63 alphanumeric and can include hyphens characters but cannot start with hyphen.

required
Array of objects or null (NICDetails)

List of NICs information. Used while creating an array.

pool_description
string or null

Text description of the pool to be created during array creation. String of up to 255 printable ASCII characters.

pool_name
required
string

Name of pool to which this is a member. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

secondary_mgmt_ip
string

Secondary management IP address for the Group.

serial
required
string

Serial number of the array.

Responses

Request samples

Content type
application/json
{
  • "allow_lower_limits": false,
  • "create_pool": false,
  • "ctrlr_a_support_ip": "128.0.0.1",
  • "ctrlr_b_support_ip": "128.0.0.1",
  • "dedupe_disabled": false,
  • "name": "NimbleArray",
  • "nic_list": [
    ],
  • "pool_description": "99.9999% availability",
  • "pool_name": "myobject-5",
  • "secondary_mgmt_ip": "128.0.0.1",
  • "serial": "AC-109084"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete Nimble / Alletra 6K array identified by {arrayId}

Delete Nimble / Alletra 6K array identified by {arrayId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

arrayId
required
string
Example: 001df0fe6f7dc7bb16000000000000000000004817

ID of the array.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K array identified by {arrayId}

Get details of Nimble / Alletra 6K array identified by {arrayId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

arrayId
required
string
Example: 001df0fe6f7dc7bb16000000000000000000004817

ID of the array.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/arrays",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "model": "myobject-5",
  • "name": "NimbleArray",
  • "pool_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "serial": "AC-109084",
  • "all_flash": false,
  • "allow_lower_limits": true,
  • "available_bytes": 1234,
  • "brand": "myobject-5",
  • "commonResourceAttributes": {
    },
  • "create_pool": true,
  • "creation_time": 3400,
  • "ctrlr_a_support_ip": "128.0.0.1",
  • "ctrlr_b_support_ip": "128.0.0.1",
  • "customerId": "string",
  • "dedupe_capacity_bytes": 1234,
  • "dedupe_usage_bytes": 1234,
  • "extended_model": "myobject-5",
  • "fc_port_count": 1234,
  • "force": false,
  • "full_name": "myobject-5",
  • "generation": 0,
  • "gig_nic_port_count": 1234,
  • "group_state": "initialized",
  • "is_fully_dedupe_capable": false,
  • "is_sfa": false,
  • "is_supported_hw_config": true,
  • "last_modified": 3400,
  • "model_sub_type": "VMWare",
  • "nic_list": [
    ],
  • "oem": "myobject-5",
  • "pending_delete_bytes": 1234,
  • "pool_description": "99.9999% availability",
  • "pool_name": "myobject-5",
  • "public_key": {
    },
  • "raw_capacity_bytes": 1234,
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "role": "leader",
  • "search_name": "vol:1",
  • "secondary_mgmt_ip": "128.0.0.1",
  • "snap_compression": 9.18,
  • "snap_saved_bytes": 1234,
  • "snap_space_reduction": 9.18,
  • "snap_usage_bytes": 1234,
  • "snap_usage_uncompressed_bytes": 1234,
  • "status": "reachable",
  • "ten_gig_sfp_nic_port_count": 1234,
  • "ten_gig_t_nic_port_count": 1234,
  • "type": "string",
  • "upgrade": {
    },
  • "usable_cache_capacity_bytes": 1234,
  • "usable_capacity_bytes": 1234,
  • "usage": 1234,
  • "usage_valid": true,
  • "version": "myobject-5",
  • "vol_compression": 9.18,
  • "vol_saved_bytes": 1234,
  • "vol_usage_bytes": 1234,
  • "vol_usage_uncompressed_bytes": 1234,
  • "zconf_ipaddrs": [
    ]
}

Edit details of Nimble / Alletra 6K array identified by {arrayId}

Edit details of Nimble / Alletra 6K array identified by {arrayId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

arrayId
required
string
Example: 001df0fe6f7dc7bb16000000000000000000004817

ID of the array.

Request Body schema: application/json
name
required
string

The user provided name of the array. It is also the array's hostname. String of up to 63 alphanumeric and can include hyphens characters but cannot start with hyphen.

Responses

Request samples

Content type
application/json
{
  • "name": "NimbleArray"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Perform failover of Nimble / Alletra 6K array identified by {arrayId}

Perform failover of Nimble / Alletra 6K array identified by {arrayId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

arrayId
required
string
Example: 001df0fe6f7dc7bb16000000000000000000004817

ID of the array.

Request Body schema: application/json
force
boolean

Initiate failover without performing any precheck.

Responses

Request samples

Content type
application/json
{
  • "force": false
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get capacity trend data for a storage system Nimble / Alletra 6K

Get capacity trend data for a storage system Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "count": 127,
  • "requestUri": "/api/v1/storage-systems/nimble/00473102de2f5f39d8000000000000000000000001/capacity-history",
  • "series_data": [
    ],
  • "total": 127
}

Get performance trend data for a storage system Nimble / Alletra 6K

Get performance trend data for a storage system Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "iops_metrics_data": {
    },
  • "latency_metrics_data": {
    },
  • "requestUri": "/api/v1/storage-systems/nimble/00473102de2f5f39d8000000000000000000000001/performance-history",
  • "throughput_metrics_data": {
    }
}

Get all uninitialized arrays details by Nimble / Alletra 6K

Get all uninitialized arrays details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "total": 1
}

Get uninitialized arrays details by Nimble / Alletra 6K identified by {uninitializedArrayId}

Get uninitialized arrays details by Nimble / Alletra 6K identified by {uninitializedArrayId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

uninitializedArrayId
required
string
Example: c463732d6436306437370000000000000000000000

ID of the uninitialized Array.A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Request Body schema: application/json
id
required
string or null

Identifier for the uninitialized array. A 42 digit hexadecimal number

Responses

Request samples

Content type
application/json
{
  • "id": "c463732d6436306437370000000000000000000000"
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get all HPE Alletra Storage MP storage systems

Get all HPE Alletra Storage MP storage systems

Authorizations:
JWTAuth
query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq VEGA_CB1507_8400_2N_150

oData query to filter systems by Key.

sort
string
Example: sort=id asc,name desc

Query to sort the response with specified key and order

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type4",
  • "total": 1
}

Get HPE Alletra Storage MP object identified by {id}

Get HPE Alletra Storage MP object identified by {id}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: SGH029VBHV

Serial number of the device-type1 storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "centerplaneType": "4 Node Centerplane",
  • "chunkletSizeMiB": 1024,
  • "clusterLED": "LED_UNKNOWN",
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP",
  • "customerId": "string",
  • "descriptors": {
    },
  • "deviceId": 101780,
  • "deviceType": {
    },
  • "displayname": "System VEGA_CB1507_8400_2N_150",
  • "domain": "string",
  • "fqdn": "s9.in.hpecorp.net",
  • "generation": 0,
  • "id": "7CE751P312",
  • "inClusterNodes": [
    ],
  • "isFIPSEnabled": true,
  • "locateEnabled": true,
  • "maintenanceMode": [
    ],
  • "manufacturing": {
    },
  • "masterNode": 4,
  • "minimumPasswordLength": 6,
  • "name": "VEGA_CB1507_8400_2N_150",
  • "networkMasterNode": 1,
  • "nodeMemory": "16",
  • "nodesCount": 2,
  • "nodesPresent": [
    ],
  • "onlineNodes": [
    ],
  • "parameters": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312",
  • "resourceUri": "/api/v1/storage-systems/device-type4/7CE751P312",
  • "safeToRemove": true,
  • "softwareVersions": {
    },
  • "state": {
    },
  • "sysLogStatus": {
    },
  • "systemDate": 1597918380,
  • "systemHeadroom": {
    },
  • "systemWWN": "2FF70002AC018D94",
  • "timezone": "Asia/Calcutta",
  • "type": "string",
  • "uptime": {
    },
  • "version": {
    }
}

Locate system of HPE Alletra Storage MP

Locate system of HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: SGH029VBHV

Serial number of the device-type1 storage system

Request Body schema: application/json
locateEnabled
boolean

Indicates if the locate beacon should be enabled or not

Responses

Request samples

Content type
application/json
{
  • "locateEnabled": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get Application Summary for a storage system HPE Alletra Storage MP

Get Application Summary for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "string",
  • "items": [
    ],
  • "requestUri": "/v1/storage-systems/device-type4/SGH014XGSP/application-summary",
  • "total": 2
}

Get latest capacity trend data and forecasted data

Get latest capacity trend data and forecasted data

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
startTime
integer
Example: startTime=1591601529000

Start time from which forecasted data is needed

Responses

Response samples

Content type
application/json
{
  • "confidenceLevel": 90,
  • "customerId": "string",
  • "forecasted": [
    ],
  • "historic": [
    ],
  • "message": "No data available",
  • "requestUri": "/v1/storage-systems/device-type4/SGH014XGSP/capacity-forecast"
}

Get capacity trend data for a storage system HPE Alletra Storage MP

Get capacity trend data for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 1440 10080
Example: timeIntervalMin=1440

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "capacityData": {
    },
  • "commonResourceAttributes": {
    },
  • "endTime": 1625209133,
  • "requestUri": "/v1/storage-systems/device-type4/SGH014XGSP/capacity-history",
  • "startTime": 1625122733
}

Get system capacity for a storage system HPE Alletra Storage MP

Get system capacity for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "capacityByTier": {
    },
  • "capacityDetail": {
    },
  • "capacitySummary": {
    },
  • "customerId": "string",
  • "fcCapacitySummary": {
    },
  • "id": "string",
  • "nlCapacitySummary": {
    },
  • "qlcCapacitySummary": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312/capacity-summary",
  • "resourceUri": "/api/v1/storage-systems/device-type4/7CE751P312/capacity-summary",
  • "ssdCapacitySummary": {
    },
  • "systemId": "7CE751P312",
  • "utilizationSummary": {
    }
}

Get capacity time until full data for a storage system HPE Alletra Storage MP

Get capacity time until full data for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Responses

Response samples

Content type
application/json
{
  • "customerId": null,
  • "deviceType": "deviceType4",
  • "requestUri": "/api/v1/storage-systems/device-type4/4UW0004226/capacity-timeuntilfull",
  • "systemId": "4UW0004226",
  • "timeUntilFull": 1605063600000
}

Get component performance statistics details for a storage system HPE Alletra Storage MP idenfified by {systemId}

Get component performance statistics details for a storage system HPE Alletra Storage MP idenfified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "cachePercentage": {
    },
  • "cpuPercentage": {
    },
  • "customerId": "string",
  • "requestUri": "v1/storage-systems/device-type4/7CE751P312/component-performance-statistics"
}

Get Top headroom contribution by volumes/Apps for device-type4

Get Top headroom contribution by volumes/Apps for device-type4

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: ABC239XFZ9

SystemId of the HPE Alletra Storage MP storage system

query Parameters
resourceType
string
Default: "VOLUMES"
Enum: "VOLUMES" "VOLUME-SET"
Example: resourceType=VOLUMES

Query to select resource (volumes, volume-set) for getting Headroom Contributors

timeIntervalMin
required
integer
Enum: 5 60 1440

Time interval granularity in minutes

range
required
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

Specifies the time period for which hotspot metrics are to be calculated. Both startTime and endTime should be specified

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "averageHeadroomUtilization": {
    },
  • "customerId": "string",
  • "endTime": 1669880791,
  • "headroomContribution": {
    },
  • "remaining": [
    ],
  • "requestUri": "/api/v1/storage-systems/device-type4/7CEFVC12/headroom-contribution",
  • "resourceType": "string",
  • "startTime": 1669794391,
  • "system": [
    ],
  • "systemId": "7CEFVC12"
}

Get hotspots for HPE Alletra Storage MP storage system based on resourceType `VOLUMES or VOLUME-SET` and metricType `LATENCY`

Get the top hotspots segregated into read and write categories

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: ABC239XFZ9

SystemId of the HPE Alletra Storage MP storage system

query Parameters
timeIntervalMin
required
integer
Enum: 5 60 1440

Time interval granularity in minutes

range
required
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

Specifies the time period for which hotspot metrics are to be calculated. Both startTime and endTime should be specified

operationType
string
Enum: "READ" "WRITE" "ALL"
Example: operationType=READ

Indicates if hotspots metrics to be calculated for read, write or both operations. If this field is not provided, hotspots are calculated for both operations

resourceType
string
Default: "VOLUMES"
Enum: "VOLUMES" "VOLUME-SET"
Example: resourceType=VOLUMES

Query to select resource (volumes, volume-set) for analytics

metricType
string
Default: "LATENCY"
Value: "LATENCY"
Example: metricType=LATENCY

Query to select metric for which hotspot is to calculated

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "customerId": "string",
  • "endTime": 1669880791,
  • "hotspots": {
    },
  • "metricType": "latency",
  • "requestUri": "/api/v1/storage-systems/device-type4/ABC239XFZ9/insights/hotspots",
  • "resourceType": "volumes",
  • "startTime": 1669794391,
  • "systemId": "ABC239XFZ9"
}

Get system level latency factors

Get system level latency factors of system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
required
integer
Enum: 5 60 1440

Time interval granularity in minutes

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "endTime": 1669880791,
  • "latencyBands": {
    },
  • "startTime": 1669794391,
  • "systemFactorsMetrics": [
    ],
  • "systemId": "string"
}

Get resource contention data for resources `DISK and CPU` for device-type4

Get the top volume contributors and timeseries data for disk and cpu resource contention

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: ABC239XFZ9

SystemId of the HPE Alletra Storage MP storage system

query Parameters
timeIntervalMin
required
integer
Enum: 5 60 1440

Time interval granularity in minutes

range
required
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

Specifies the time period for which hotspot metrics are to be calculated. Both startTime and endTime should be specified

resourceContentionType
string
Enum: "DISK" "CPU" "ALL"
Example: resourceContentionType=DISK

Indicates if resource contention has to be calculated for disk, cpu or both resources. If this field is not provided, resource contention is calculated for both resources

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "cpuContention": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "diskContention": {
    },
  • "endTime": 1669880791,
  • "iomRecommended": true,
  • "requestUri": "/api/v1/storage-systems/device-type4/ABC239XFZ9/insights/resource-contention",
  • "startTime": 1669794391,
  • "systemId": "ABC239XFZ9"
}

Get licenses of the storage system identified by {systemId}

Get licenses of the storage system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "string",
  • "customerId": "string",
  • "diskCount": "2",
  • "features": {
    },
  • "issueDate": {
    },
  • "requestUri": "/v1/storage-systems/device-type4/7CE751P312/licenses",
  • "resourceUri": "string",
  • "type": "string",
  • "version": 1
}

Get performance trend data for a storage system HPE Alletra Storage MP

Get performance trend data for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "string",
  • "endTime": 1625642714,
  • "historyData": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type4/SGH014XGSP/performance-history",
  • "startTime": 1625556314
}

Get performance statistics for a storage system HPE Alletra Storage MP

Get performance statistics for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "iops": {
    },
  • "latency": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type4/SGH014XGSP/performance-statistics",
  • "resourceUri": "/api/v1/storage-systems/device-type4/SGH014XGSP/performance-statistics",
  • "throughput": {
    }
}

Get recommendations for a storage system HPE Alletra Storage MP

Get recommendations for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "checkTime": {
    },
  • "displayname": "HPE 3par",
  • "domain": "string",
  • "id": "string",
  • "patches": [
    ],
  • "releases": [
    ],
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312/recommendations",
  • "resourceUri": "/api/v1/storage-systems/device-type4/7CE751P312/recommendations",
  • "systemId": "7CE751P312",
  • "updateTime": {
    }
}

Get all insights.

List all insights.

Authorizations:
JWTAuth
query Parameters
filter
string

GET /api/v1/insights?filter=type eq 'TIME_UNTIL_FULL' GET /api/v1/insights?filter=score lt 3 GET /api/v1/insights?filter=value gt 60 GET /api/v1/insights?filter=date eq '2024-05-12'

Responses

Response samples

Content type
application/json
{
  • "members": [
    ]
}

provisioning recommendations

provisioning recommendations

Authorizations:
JWTAuth
Request Body schema: application/json
hostGroupId
string or null

host group id

productFamily
string or null

Storage device type

sizeMib
required
integer

volume size requirement

Responses

Request samples

Content type
application/json
{
  • "hostGroupId": "a7c4e6593f51d0b98f0e40d7e6df04fd",
  • "productFamily": "string",
  • "sizeMib": 16384
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "requestUri": "/api/v1/storage-systems/recommendations",
  • "total": 1
}

Get all device types

Get all device types

Authorizations:
JWTAuth

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "total": 0
}

switches

The switches API allows the management of switches

Get details of HPE Alletra Storage MP Switch ports

Get details of HPE Alletra Storage MP Switch ports

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter switch resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort switch resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/switch-port",
  • "total": 1
}

Get details of HPE Alletra Storage MP Switches

Get details of HPE Alletra Storage MP Switches

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter switch resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort switch resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/switches",
  • "total": 1
}

Get details of HPE Alletra Storage MP Switch identified by {id}

Get details of HPE Alletra Storage MP Switch identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the switch

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "activeIPAddress": "16.1.9.251",
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/switches/9c3c4f29a82fd8d632ff379116fa0b8f",
  • "customerId": "string",
  • "dhcpServers": [
    ],
  • "displayname": "Switch sw2",
  • "domain": "switch",
  • "fanState": {
    },
  • "fwVersion": "GL.10.11.0001",
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "locateEnabled": false,
  • "macAddress": "90:20:c2:c2:35:00",
  • "manufacturing": {
    },
  • "mode": "online",
  • "name": "sw1",
  • "primaryPath": "Active",
  • "ps1State": {
    },
  • "ps2State": {
    },
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/switches/9c3c4f29a82fd8d632ff379116fa0b8f",
  • "resourceUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/enclosures/9c3c4f29a82fd8d632ff379116fa0b8f/enclosure-cards/8621946048c1cb24bdfc57e9b3b460ac",
  • "secondaryPath": "Inactive",
  • "state": {
    },
  • "switchFans": {
    },
  • "switchId": 1,
  • "switchPort": {
    },
  • "switchPowerSupplies": {
    },
  • "systemId": "7CE751P312",
  • "temperatureDetail": "online",
  • "temperatureState": {
    },
  • "type": "string",
  • "vlans": [
    ]
}

Locate switch of HPE Alletra Storage MP identified by {id}

Locate switch of HPE Alletra Storage MP identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the switch

Request Body schema: application/json
locate
boolean

Indicates if the locate beacon should be enabled or not

Responses

Request samples

Content type
application/json
{
  • "locate": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of HPE Alletra Storage MP Switch Fans identified by switch id

Get details of HPE Alletra Storage MP Switch Fans identified by switch id

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

switchId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the switch

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter switch resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort switch resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/switches/8621946048c1cb24bdfc57e9b3b460ac/switch-fans",
  • "total": 1
}

Get details of HPE Alletra Storage MP Switch Fan identified by switchId} and Fan id

Get details of HPE Alletra Storage MP Switch Fan identified by switchId and Fan id

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

switchId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the switch

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the switch fan

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-fans/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "displayname": "Fan 5",
  • "domain": "switch",
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "manufacturing": {
    },
  • "name": "Tray-1/5/1",
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-fans/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-fans/8621946048c1cb24bdfc57e9b3b460ac",
  • "speedA": "normal",
  • "speedB": "normal",
  • "state": {
    },
  • "stateA": {
    },
  • "stateB": {
    },
  • "switchFanId": 1,
  • "switchName": "sw1",
  • "switchUid": "2bc9220b01fae89ef88f10994394b180",
  • "systemId": "7CE751P312",
  • "type": "string"
}

Get details of HPE Alletra Storage MP Switch ports identified by {switchId}

Get details of HPE Alletra Storage MP Switch ports identified by {switchId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

switchId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the switch

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter switch resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort switch resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/switch-port",
  • "total": 1
}

Get details of HPE Alletra Storage MP Switch Port identified by {switchId} and {id}

Get details of HPE Alletra Storage MP Switch identified by {switchId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

switchId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the switch

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the switch fan

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-port/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "device": "node1",
  • "devicePort": "2:2",
  • "displayname": "Switch sw1 port 14",
  • "domain": "switch",
  • "enclosure": "cage1",
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "ipAddress": "16.1.9.2",
  • "macAddress": "90:20:c2:c2:35:00",
  • "portDescription": "eth14",
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-port/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-port/8621946048c1cb24bdfc57e9b3b460ac",
  • "state": {
    },
  • "switchName": "sw1",
  • "switchPortId": 1,
  • "switchUid": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "systemId": "7CE751P312",
  • "type": "string"
}

Get details of HPE Alletra Storage MP Switch power supplies identified by {switchId}

Get details of HPE Alletra Storage MP Switch power supplies identified by {switchId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

switchId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the switch

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter switch resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort switch resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/switches/8621946048c1cb24bdfc57e9b3b460ac/switch-ps",
  • "total": 1
}

Get details of HPE Alletra Storage MP Switch Power Supplies identified by {switchId} and {id}

Get details of HPE Alletra Storage MP Switch Power Supplies identified by {switchId} and {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

switchId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the switch

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the switch fan

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-ps/8621946048c1cb24bdfc57e9b3b460ac",
  • "customerId": "string",
  • "displayname": "Fan 5",
  • "domain": "switch",
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "manufacturing": {
    },
  • "name": "Tray-1/5/1",
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-ps/8621946048c1cb24bdfc57e9b3b460ac",
  • "resourceUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/switches/9c3c4f29a82fd8d632ff379116fa0b8f/switch-ps/8621946048c1cb24bdfc57e9b3b460ac",
  • "state": {
    },
  • "switchName": "sw1",
  • "switchPSId": 1,
  • "switchUid": "2bc9220b01fae89ef88f10994394b180",
  • "systemId": "7CE751P312",
  • "type": "string"
}

system-settings

The System Settings API allows the monitoring of System settings for the device

Get alert-contact details for a storage system Primera / Alletra 9K

Get alert-contact details for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE809P009/alert-contacts",
  • "systemId": "4UW0001540",
  • "total": 1
}

Add Alert/Mail contact details

Add Alert/Mail contact details

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
company
string or null

Company

companyCode
string or null

Company code

country
string or null

Country

fax
string or null

Fax number

firstName
string or null

First name

includeSvcAlerts
boolean or null

Email sent to contact shall include service alert

lastName
string or null

Last name

notificationSeverities
Array of integers or null

Severities of notifications the contact will be notificated. An array of number: 0 - Fatal, 1 - Critical, 2 - Major, 3 - Minor, 4 - Degraded, 5 - Info, 6 - Debug

preferredLanguage
string or null

Preferred language when being contacted or emailed

primaryEmail
string or null

Primary email address

primaryPhone
string or null

Primary phone

receiveEmail
boolean or null

Contact will receive email notifications. This is a deprecated field and will always pass true to be inline with UI.

receiveGrouped
boolean or null

Contact will receive grouped low urgency email notifications

secondaryEmail
string or null

Secondary email address

secondaryPhone
string or null

Secondary phone

Responses

Request samples

Content type
application/json
{
  • "company": "HPE",
  • "companyCode": "HPE",
  • "country": "US",
  • "fax": "fax_id",
  • "firstName": "john",
  • "includeSvcAlerts": false,
  • "lastName": "kevin",
  • "notificationSeverities": [
    ],
  • "preferredLanguage": "en",
  • "primaryEmail": "kevin.john@hpe.com",
  • "primaryPhone": "98783456",
  • "receiveEmail": true,
  • "receiveGrouped": true,
  • "secondaryEmail": "winny.pooh@hpe.com",
  • "secondaryPhone": "23456789"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete Alert/Email contact of storage system Primera / Alletra 9K identified by {id}

Delete Alert/Email contact of storage system Primera / Alletra 9K identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a4c78226-69cd-b9e7-af3e-445ca8f8a655

Unique Identifier of the alert contact

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get alert-contact details for a storage system Primera / Alletra 9K identified by {id}

Get alert-contact details for a storage system Primera / Alletra 9K identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a4c78226-69cd-b9e7-af3e-445ca8f8a655

Unique Identifier of the alert contact

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "company": "HPE",
  • "companyCode": "HPE",
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/settings/system-settings",
  • "country": "US",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1sd",
  • "fax": "+1 323 555 1234",
  • "firstName": "john",
  • "generation": 1627540907421,
  • "id": "67d09515-8526-9b02-c0c4-c1f443a39402",
  • "includeSvcAlerts": false,
  • "lastName": "kevin",
  • "notificationSeverities": [
    ],
  • "preferredLanguage": "en",
  • "primaryEmail": "kevin.john@hpe.com",
  • "primaryPhone": "98783456",
  • "receiveEmail": true,
  • "receiveGrouped": true,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE809P009/alert-contacts",
  • "secondaryEmail": "winny.pooh@hpe.com",
  • "secondaryPhone": "23456789",
  • "systemId": "7CE751P312",
  • "systemSupportContact": false,
  • "type": "alert-contacts"
}

Edit Alert/Email contact details of storage system Primera / Alletra 9K identified by {id}

Edit Alert/Email contact details of storage system Primera / Alletra 9K identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a4c78226-69cd-b9e7-af3e-445ca8f8a655

Unique Identifier of the alert contact

Request Body schema: application/json
company
string or null

Company

companyCode
string or null

Company code

country
string or null

Country

fax
string or null

Fax number

firstName
string or null

First name

includeSvcAlerts
boolean or null

Email sent to contact shall include service alert

lastName
string or null

Last name

notificationSeverities
Array of integers or null

Severities of notifications the contact will be notificated. An array of number: 0 - Fatal, 1 - Critical, 2 - Major, 3 - Minor, 4 - Degraded, 5 - Info, 6 - Debug

preferredLanguage
string or null

Preferred language when being contacted or emailed

primaryEmail
string or null

Primary email address

primaryPhone
string or null

Primary phone

receiveEmail
boolean or null

Contact will receive email notifications. This is a deprecated field and will always pass true to be inline with UI.

receiveGrouped
boolean or null

Contact will receive grouped low urgency email notifications

secondaryEmail
string or null

Secondary email address

secondaryPhone
string or null

Secondary phone

Responses

Request samples

Content type
application/json
{
  • "company": "HPE",
  • "companyCode": "HPE",
  • "country": "US",
  • "fax": "fax_id",
  • "firstName": "john",
  • "includeSvcAlerts": false,
  • "lastName": "kevin",
  • "notificationSeverities": [
    ],
  • "preferredLanguage": "en",
  • "primaryEmail": "kevin.john@hpe.com",
  • "primaryPhone": "98783456",
  • "receiveEmail": true,
  • "receiveGrouped": true,
  • "secondaryEmail": "winny.pooh@hpe.com",
  • "secondaryPhone": "23456789"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get array certificates by Primera / Alletra 9K

Get array certificates by Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=service eq qw-client

Lucene query to filter Certificates by Key.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 0,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE809P009/certificates",
  • "total": 1
}

Create certificate on storage system Primera / Alletra 9K identified by {systemId}

Create certificate on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
authorityChain
string

The authority chain for Quorum Witness server certificate.

commonName
string

CommonName for the certificate.

country
string

Two-letter code for the country where organization is located.

days
integer <int64>

Number of days valid for the certificate.

keyLength
integer <int64>

Key length for the certificate.

locality
string

Locality where organization is located.

organization
string

Organization for the certificate

organizationUnit
string

Division of organization handling the certificate.

province
string

Province where organization is located.

service
required
string
Enum: "QW_CLIENT" "QW_SERVER" "WSAPI" "CLI" "CIM" "VASA" "EKM_CLIENT" "SYSLOG_GEN_CLIENT" "SYSLOG_SEC_CLIENT" "UNIFIED_SERVER"

Name of service the certificate is for.

object (certSubjectAltName)

Subject Alternative Name for the certificate.

type
required
string

Type of certificate to create.

Responses

Request samples

Content type
application/json
{
  • "authorityChain": "-----BEGIN CERTIFICATE REQUEST-----abc----END CERTIFICATE REQUEST-----",
  • "commonName": "hpe.com CA - Intermediate",
  • "country": "IN",
  • "days": 365,
  • "keyLength": 2048,
  • "locality": "BLR",
  • "organization": "HPE",
  • "organizationUnit": "HPE Primera",
  • "province": "Karnataka",
  • "service": "QW_CLIENT",
  • "subjectAltName": {
    },
  • "type": "csr"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get array certificates by Primera / Alletra 9K identified by {id}

Get array certificates by Primera / Alletra 9K identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: 99691e493067b2b2acf1774fc0ccc011

ID of the certificate

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "certType": "cert",
  • "commonResourceAttributes": {
    },
  • "commonname": "HPE_3PAR C630-4UW0002940\"",
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/settings/system-settings",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "displayname": "Certificate HPE_3PAR C630-4UW0002940",
  • "domain": "hpe.com",
  • "enddate": {
    },
  • "fingerprint": "string",
  • "generation": 1627533096726,
  • "id": "99691e493067b2b2acf1774fc0ccc011",
  • "issuer": "CN=HPE_3PAR C630-4UW0002940",
  • "pem": "string",
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE809P009/certificates/99691e493067b2b2acf1774fc0ccc011",
  • "serial": "1",
  • "service": "unified-server",
  • "signaturetype": "self-signed",
  • "startdate": {
    },
  • "subject": "CN=HPE_3PAR C630-4UW0002940",
  • "subjectaltname": "DNS:HPE_3PAR C630-4UW0002940",
  • "systemId": "7CE809P009",
  • "text": "string",
  • "type": "certificates",
  • "uri": "/api/v3/certificates/99691e493067b2b2acf1774fc0ccc011"
}

Import certificate identified by {id} on storage system Primera / Alletra 9K identified by {systemId}

Import certificate identified by {id} on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: 99691e493067b2b2acf1774fc0ccc011

ID of the certificate

Request Body schema: application/json
authorityChain
required
string

The authority chain for the new certificate.

certificate
required
string

The certificate that results from the Certificate Signing Request (CSR).

Responses

Request samples

Content type
application/json
{
  • "authorityChain": "-----BEGIN CERTIFICATE REQUEST-----abc----END CERTIFICATE REQUEST----- \\n-----BEGIN CERTIFICATE REQUEST-----pqr----END CERTIFICATE REQUEST-----",
  • "certificate": "-----BEGIN CERTIFICATE REQUEST-----abc----END CERTIFICATE REQUEST-----"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete certificates from storage system Primera / Alletra 9K identified by {systemId}

Delete certificates from storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
required
Array of objects (RemoveCertificateInput)

List of certificate IDs to be deleted

Responses

Request samples

Content type
application/json
{
  • "certificates": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Trigger a collection on the storage system Primera / Alletra 9K

Trigger a collection on the storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
Array
action
string or null
Enum: "PERFCOLLECTION" "INSPLORECOLLECTION" "APPDUMPCOLLECTION" "CRASHDUMPCOLLECTION" "SPLORCOLLECTION" "WEEKLYCOLLECTION"

Type of a collection.

options
Array of strings or null

Options needed for the collection. If options are not specified, default values will be used.

INSPLORECOLLECTION can have any or all of "clidata", "nodedata" and "tocdata"

 Default options - ["clidata","nodedata","tocdata"]

PERFCOLLECTION should have 3 options,

  • Iteration - a number between 1 to 1000 as a string,

  • Interval - a number in seconds between 1 to 172800 as a string

  • Type of collection -default or -comprehensive

 Default options - ["60","10","-default"]

Other collection types won't require any options, if provided will be ignored.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete SMTP/mail server settings

Delete SMTP/mail server settings

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get the system's SMTP/Mail server settigs

Get the system's SMTP/Mail server settigs

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "authenticationRequired": "enabled",
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/settings/system-settings",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cq",
  • "friendlyCert": {
    },
  • "generation": 1627540911681,
  • "mailHostDomain": "hpe.com",
  • "mailHostServer": "example.hpe.com",
  • "port": 25,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/mailsettings",
  • "senderEmailId": "someone@maildomain.com",
  • "type": "mail-settings",
  • "username": "username"
}

Add SMTP/Mail server settigs

Add SMTP/Mail server settigs

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
mailHostDomain
string or null

SMTP server's Host Domain

mailHostServer
string or null

SMTP server address/IP

port
integer or null <int64>
Enum: 25 465 587 2525

SMTP server's port number

senderEmailId
string or null

Sender email address

Responses

Request samples

Content type
application/json
{
  • "mailHostDomain": "hpe.com",
  • "mailHostServer": "example.hpe.com",
  • "port": 25,
  • "senderEmailId": "string"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit SMTP/Mail server settigs

Edit SMTP/Mail server settigs

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
mailHostDomain
string or null

SMTP server's Host Domain

mailHostServer
string or null

SMTP server address/IP

port
integer or null <int64>
Enum: 25 465 587 2525

SMTP server's port number

senderEmailId
string or null

Sender email address

Responses

Request samples

Content type
application/json
{
  • "mailHostDomain": "hpe.com",
  • "mailHostServer": "example.hpe.com",
  • "port": 25,
  • "senderEmailId": "string"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get CIM Network-Service details for a storage system Primera / Alletra 9K

Get CIM Network-Service details for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/network-services/cim"
}

Edit CIM network service configuration

Edit CIM network service configuration

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object or null

Responses

Request samples

Content type
application/json
{
  • "cim": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get SNMP-Manager Network-Service details for a storage system Primera / Alletra 9K

Get SNMP-Manager Network-Service details for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/network-services/snmp-mgr"
}

Add SNMP Manager settings

Add SNMP Manager settings

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
Array of objects or null (SnmpConfigParams)

Specify the SNMP params

Responses

Request samples

Content type
application/json
{
  • "snmpConfig": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete SNMP manager settings identified by {id}

Delete SNMP manager settings identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the SNMP manager

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get a specific SNMP-Manager Network-Service details for a storage system Primera / Alletra 9K

Get a specific SNMP-Manager Network-Service details for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the SNMP manager

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/network-services/snmp-mgr"
}

Edit SNMP Manager settings for the specified Id

Edit SNMP Manager settings for the specified Id

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the SNMP manager

Request Body schema: application/json
managerIP
string

Specify the IP address of the host from which the manager runs

notify
string or null
Enum: "ALL" "NODUP" "STANDARD"

Indicates the trap notification types defined by the HPE deviceType1 MIB

port
integer or null <int64>

Specify the port number where the SNMP manager receives traps

retry
integer or null <int64>

Specify the number of times to send a trap (retry) if the SNMP manager is not available.

timeoutSecs
integer or null <int64>

Specify the number of seconds to wait before sending a trap (timeout).

user
string or null

Specify the SNMPv3 user name

version
integer or null

Specify the SNMP version supported

Responses

Request samples

Content type
application/json
{
  • "managerIP": "15.218.169.163",
  • "notify": "STANDARD",
  • "port": 162,
  • "retry": 2,
  • "timeoutSecs": 162,
  • "user": "user1",
  • "version": 2
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get VASA Network-Service details for a storage system Primera / Alletra 9K

Get VASA Network-Service details for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/network-services/vasa"
}

Configures vasa service for the specified id.

Enables, disable or reset vasa service on a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vasaId
required
string
Example: a9c455bf98fc1a6bdb90b824e3ac20b8

ID of the VASA service

Request Body schema: application/json
action
string

Specify the action on vasa service. Either START, STOP or RESET

Responses

Request samples

Content type
application/json
{
  • "action": "START"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Configures vasa service for the specified id.

Enables, disable and updates the cert management mode for vasa services on a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vasaId
required
string
Example: a9c455bf98fc1a6bdb90b824e3ac20b8

ID of the VASA service

Request Body schema: application/json
certMgmt
string or null

Specify the cert mode for vasa provider, supports values either server or locked_client

vasaStateEnabled
boolean or null

Specify the status of vasa service.

Responses

Request samples

Content type
application/json
{
  • "certMgmt": "server",
  • "vasaStateEnabled": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get Network-Settings details for a storage system Primera / Alletra 9K

Get Network-Settings details for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "portManagement": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE809P009/network-settings"
}

Post Network-Settings details for a storage system Primera / Alletra 9K

Post Network-Settings details for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
dnsAddresses
Array of strings or null

Dns address of the system

ipv4Address
string or null

ipv4 address of the system

ipv4Gateway
string or null

ipv4 gateway of the system

ipv4SubnetMask
string or null

NetMask for IPV4 address

ipv6Address
string or null

IPV6 address of the system

ipv6Gateway
string or null

IPV6 address of the system

ipv6PrefixLen
string or null

IPV6 Prefix length

object or null

Proxy Setting details for a device

Responses

Request samples

Content type
application/json
{
  • "dnsAddresses": [
    ],
  • "ipv4Address": "string",
  • "ipv4Gateway": "string",
  • "ipv4SubnetMask": "string",
  • "ipv6Address": "string",
  • "ipv6Gateway": "string",
  • "ipv6PrefixLen": "string",
  • "proxyParams": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get service ports for nodes of all storage systems of Primera / Alletra 9K identified by {systemId} and {nodeId }

Get service ports for nodes of all storage systems of Primera / Alletra 9K identified by {systemId} and {nodeId }

Authorizations:
JWTAuth
path Parameters
nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

Primary ID of the node

systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=ipv4address eq "169.254.77.160"

oData query to filter systems by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/{systemUid}/nodes/serviceports",
  • "total": 2
}

Get service ports for nodes of all storage systems of Primera / Alletra 9K identified by {systemId}

Get service ports for nodes of all storage systems of Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=ipv4address eq "169.254.77.160"

oData query to filter systems by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/{systemUid}/nodes/serviceports",
  • "total": 2
}

Get details of performance metrics of Primera/ Alletra 9K remote copy links on storage system identified by {systemid}

Get details of performance metrics of Primera/ Alletra 9K remote copy links on storage system identified by {systemid}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
reportType
string
Example: reportType=Canned,Custom,Def,ApiUser

parameter will be set to report type requested. For api users, set parameter as ApiUser

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

compareBy
string
Example: compareBy=top eq 5 and metrics eq linkRoundTripTime

compareBy will define top and compare metrics for which query has to be made. Allowed values: linkThroughput, linkRoundTripTime, transmittedData

groupBy
string
Example: groupBy=replicationPartnerName,portNsp

groupBy will define comma separated groupBy parameters. Allowed value: replicationPartnerName, portNsp

metricType
string
Example: metricType=linkThroughput,linkRoundTripTime,transmittedData

metricType will define comma separated metrics

filter
string
Example: filter=remoteCopyLinkId in (57f2dc8c75144e21dbfc09705e499580,a8e2c8d70f5a97074e72935af10d9926)

filter will define objects to be filtered. Filterable columns are: * remoteCopyLinkId - id of the remote copy link

Responses

Response samples

Content type
application/json
{
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 162564271,
  • "historyData": {
    },
  • "requestUri": "/v1/storage-systems/device-type1/SGH014XGSP/remotecopylinks-performance",
  • "startTime": 1625556314
}

Get support settings for a storage system Primera / Alletra 9K

Get support settings for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "connectToHPE": "disabled",
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/settings/system-settings",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1az",
  • "emailNotifications": "enabled",
  • "enterpriseServerURL": "server.com/collect",
  • "generation": 1627540915530,
  • "id": "7CE726P1VX",
  • "miniInsploreEnabled": "disabled",
  • "rapForwarding": "enabled",
  • "remoteAccess": "ENABLE_NONROOT",
  • "remoteRequest": [
    ],
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/supportsettings",
  • "resourceUri": "/api/v1/storage-systems/device-type1/7CE751P312/supportsettings",
  • "rtsEnabled": "disabled",
  • "type": "support-settings"
}

Add support settings for a storage system Primera / Alletra 9K

Add support settings for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
connectToHPE
required
string

Enable remote support by allowing sending of files from device to HPE. Allowed values: enabled or disabled. It is mandatory.

deviceId
string

Id of the array. User can get Id info from GET response and this can not be changed.

enterpriseServerURL
string or null

Callhome collection server URL

miniInsploreEnabled
string or null

Enables/Disable scheduled Mini-Insplore collection. Allowed values: enabled or disabled.

rapForwarding
required
string

Enable/Disable RAP forwarding. Allowed values: enabled or disabled. It is mandatory.

remoteAccess
required
string
Enum: "DISABLE" "ENABLE_NONROOT" "ENABLE_ROOT"

Allow HPE Support to access the device remotely. Allowed values: ENABLE_ROOT or DISABLE or ENABLE_NONROOT. It is mandatory.

object or null (remoteRequestAcknowledge)

Accept/Deny/Close the Remote Access request.

rtsEnabled
required
string

Enable/Disable Real time data scrubbing. Allowed values: enabled or disabled. It is mandatory.

Responses

Request samples

Content type
application/json
{
  • "connectToHPE": "string",
  • "deviceId": "string",
  • "enterpriseServerURL": "string",
  • "miniInsploreEnabled": "string",
  • "rapForwarding": "string",
  • "remoteAccess": "DISABLE",
  • "remoteRequestAcknowledge": {
    },
  • "rtsEnabled": "string"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit support settings for a storage system Primera / Alletra 9K

Edit support settings for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
connectToHPE
required
string

Enable remote support by allowing sending of files from device to HPE. Allowed values: enabled or disabled. It is mandatory.

deviceId
string

Id of the array. User can get Id info from GET response and this can not be changed.

enterpriseServerURL
string or null

Callhome collection server URL

miniInsploreEnabled
string or null

Enables/Disable scheduled Mini-Insplore collection. Allowed values: enabled or disabled.

rapForwarding
required
string

Enable/Disable RAP forwarding. Allowed values: enabled or disabled. It is mandatory.

remoteAccess
required
string
Enum: "DISABLE" "ENABLE_NONROOT" "ENABLE_ROOT"

Allow HPE Support to access the device remotely. Allowed values: ENABLE_ROOT or DISABLE or ENABLE_NONROOT. It is mandatory.

object or null (remoteRequestAcknowledge)

Accept/Deny/Close the Remote Access request.

rtsEnabled
required
string

Enable/Disable Real time data scrubbing. Allowed values: enabled or disabled. It is mandatory.

Responses

Request samples

Content type
application/json
{
  • "connectToHPE": "string",
  • "deviceId": "string",
  • "enterpriseServerURL": "string",
  • "miniInsploreEnabled": "string",
  • "rapForwarding": "string",
  • "remoteAccess": "DISABLE",
  • "remoteRequestAcknowledge": {
    },
  • "rtsEnabled": "string"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get the system settings configuration details

Get the system settings configuration details

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE809P009/system-settings"
}

Edit system settings configuration

Edit system settings configuration

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object or null
dateTime
string or null

system date time

object or null
name
string or null

system name

ntpAddresses
Array of strings or null or null

system ntp addresses

object or null
object or null
object or null (ContactsEditDetails)

Contacts details set to receive alerts

object or null
timezone
string or null

system time zone

Responses

Request samples

Content type
application/json
{
  • "authMode": {
    },
  • "dateTime": "01/15/2020 10:00:00",
  • "installationSites": {
    },
  • "name": "Array1",
  • "ntpAddresses": [
    ],
  • "remoteSyslogSettings": {
    },
  • "srinfo": {
    },
  • "supportContact": {
    },
  • "systemParameters": {
    },
  • "timezone": "Asia/Calcutta"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit system settings configuration

Edit system settings configuration

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object or null
dateTime
string or null

system date time

object or null
name
string or null

system name

ntpAddresses
Array of strings or null or null

system ntp addresses

object or null
object or null
object or null (ContactsEditDetails)

Contacts details set to receive alerts

object or null
timezone
string or null

system time zone

Responses

Request samples

Content type
application/json
{
  • "authMode": {
    },
  • "dateTime": "01/15/2020 10:00:00",
  • "installationSites": {
    },
  • "name": "Array1",
  • "ntpAddresses": [
    ],
  • "remoteSyslogSettings": {
    },
  • "srinfo": {
    },
  • "supportContact": {
    },
  • "systemParameters": {
    },
  • "timezone": "Asia/Calcutta"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get Storage Container details for a storage system Primera / Alletra 9K

Get Storage Container details for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/network-services/vvolscs",
  • "total": 1
}

Delete storage container of storage system Primera / Alletra 9K identified by {id}

Delete storage container of storage system Primera / Alletra 9K identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vvolscId
required
string
Example: d09b59cd7bd07a4e9559e78dcea07498

Storage container UID

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get quorum witness configuration details from storage system Primera / Alletra 9K identified by {systemId}

Get quorum witness configuration details from storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq afb4961e47212e5bc88dd35db5be5c83

oData query to filter witness by key.

sort
string
Example: sort=id desc

oData query to sort witness resource by key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1/SGH000XWEE/system-settings/quorum-witness",
  • "total": 1
}

Create quorum witness on storage system Primera / Alletra 9K identified by {systemId}

Create quorum witness on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
required
object

Parameters for create quorum witness action

replicationPartnerSystemId
required
string

SystemId of target replication partner

srcReplicationId
required
string

Id of source replication partner on which quorum witness is to be configured

startQuorumWitness
boolean or null

Specifies start/stop Quorum Witness connectivity on the storage system. If set true, ATF configuration is activated. If set false, ATF configuration is deactivated.

targetReplicationId
required
string

Id of target replication partner on which quorum witness is to be configured

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    },
  • "replicationPartnerSystemId": "7CE816P0SR",
  • "srcReplicationId": "afb4961e47212e5bc88dd35db5be5c83",
  • "startQuorumWitness": true,
  • "targetReplicationId": "afb4961e47212e5bc88dd35db5be5c83"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete quorum witness identified by {replicationPartnerId} on storage system Primera / Alletra 9K identified by {systemId}

Delete quorum witness identified by {replicationPartnerId} on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

replicationPartnerId
required
string
Example: aedec7d11d02f73611a6ff992c256bdb

id of device-type1 replication partner

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of quorum witness configured on replication partner identified by {replicationPartnerId} on storage system Primera / Alletra 9K identified by {systemId}

Get details of quorum witness configured on replication partner identified by {replicationPartnerId} on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

replicationPartnerId
required
string
Example: aedec7d11d02f73611a6ff992c256bdb

id of device-type1 replication partner

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH000XWEE/system-settings/quorum-witness/5a5ce66d4814a5e5156de428abb0a589",
  • "requestUri": "/api/v1/storage-systems/device-type1/SGH000XWEE/system-settings/quorum-witness/5a5ce66d4814a5e5156de428abb0a589",
  • "id": "5a5ce66d4814a5e5156de428abb0a589",
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "generation": 0,
  • "isRemoteArraySupportReplication": true,
  • "name": "IPSource",
  • "quorumATFTimeout": 30,
  • "quorumIpAddress": "10.10.10.11",
  • "quorumSSLPort": 8843,
  • "quorumStatus": "Initializing",
  • "quorumStatusQual": "NA",
  • "quorumVersion": "2.0",
  • "remoteId": "6a5ce66d4814a5e5156de428abb0a580",
  • "remoteName": "IPTarget",
  • "remoteSystemId": "SGH000XWEF",
  • "remoteSystemName": "System102",
  • "resourceUri": "/api/v1/storage-systems/device-type1/SGH000XWEE/system-settings/quorum-witness/5a5ce66d4814a5e5156de428abb0a589",
  • "systemId": "SGH000XWEE",
  • "systemName": "s1511",
  • "type": "quorum-witness"
}

Edit quorum witness identified by {replicationPartnerId} on storage system Primera / Alletra 9K identified by {systemId}

Edit quorum witness identified by {replicationPartnerId} on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

replicationPartnerId
required
string
Example: aedec7d11d02f73611a6ff992c256bdb

id of device-type1 replication partner

Request Body schema: application/json
replicationPartnerSystemId
required
string

SystemId of target replication partner

startQuorumWitness
required
boolean

Specifies start/stop Quorum Witness connectivity on the storage system. If set true, ATF configuration is activated. If set false, ATF configuration is deactivated.

targetReplicationId
required
string

Id of target replication partner on which quorum witness is configured

Responses

Request samples

Content type
application/json
{
  • "replicationPartnerSystemId": "7CE816P0SR",
  • "startQuorumWitness": true,
  • "targetReplicationId": "afb4961e47212e5bc88dd35db5be5c83"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of replication partners on storage system Primera / Alletra 9K identified by {systemId}

Get details of replication partners on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemId eq 7CE751P312

oData query to filter replication partners by key.

sort
string
Example: sort=systemId desc

oData query to sort nodes resource by key.

includeIndirectPartners
boolean
Example: includeIndirectPartners=true

Include indirect partners. Indirect partners are excluded by default. This parameter cannot be used with other query parameters.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type1/SGH000XWEE/system-settings/replication-partners",
  • "total": 1
}

Create replication partners on Primera / Alletra 9K identified by {systemId}

Create replication partners on Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
required
Array of objects (ReplicationPartnerInput)

Responses

Request samples

Content type
application/json
{
  • "replicationPartners": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of replication partner identified by {replicationPartnerId} on storage system Primera / Alletra 9K identified by {systemId}

Get details of replication partner identified by {replicationPartnerId} on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

replicationPartnerId
required
string
Example: aedec7d11d02f73611a6ff992c256bdb

id of device-type1 replication partner

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH000XWEE/system-settings/replication-partners/5a5ce66d4814a5e5156de428abb0a589",
  • "requestUri": "api/v1/storage-systems/device-type1/SGH000XWEE/system-settings/replication-partners/5a5ce66d4814a5e5156de428abb0a589",
  • "id": "5a5ce66d4814a5e5156de428abb0a589",
  • "name": "RCPartner12",
  • "replicationPartnerType": "FC",
  • "status": "Ready",
  • "associatedLinks": [
    ],
  • "bufferSizeB": 1024,
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "displayName": "RCPartner12",
  • "domain": "domain1",
  • "flags": 1,
  • "generation": 0,
  • "health": 1,
  • "isRemoteArraySupportReplication": true,
  • "minPeriodSecs": 300,
  • "nodeWWN": "2FF70002AC020DA1",
  • "numSockets": 2,
  • "policies": {
    },
  • "quorumATFTimeout": 0,
  • "quorumIpAddress": "10.10.10.11",
  • "quorumSSLPort": 0,
  • "quorumStatus": "Initializing",
  • "quorumStatusQual": "NA",
  • "quorumVersion": "2.0",
  • "remoteId": "6a5ce66d4814a5e5156de428abb0a580",
  • "remoteName": "FC-02",
  • "remoteReplicationId": 12,
  • "remoteSystemId": "SGH000XWEF",
  • "remoteSystemName": "System102",
  • "replicationId": 1,
  • "replicationPartnerLinks": {
    },
  • "replicationSystemId": 1,
  • "resourceUri": "/api/v1/storage-systems/device-type1/SGH000XWEE/system-settings/replication-partners/5a5ce66d4814a5e5156de428abb0a589",
  • "state": "UNKNOWN",
  • "systemId": "SGH000XWEE",
  • "systemName": "System101",
  • "systemWWN": "2FF70002AC020CEF",
  • "type": "replication-partner",
  • "version": 41
}

Edit replication partner identified by {replicationPartnerId} on Primera / Alletra 9K identified by {systemId}

Edit replication partner identified by {replicationPartnerId} on Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

replicationPartnerId
required
string
Example: aedec7d11d02f73611a6ff992c256bdb

id of device-type1 replication partner

Request Body schema: application/json
object (AddRemoteCopyLinks)

Request body for adding remote copy links

object or null (RemoveRemoteCopyLinksInput)

Request Body for removing remote copy links

Responses

Request samples

Content type
application/json
{
  • "addRcLinks": {
    },
  • "removeRcLinks": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete replication partner from storage system Primera / Alletra 9K identified by {systemId}

Delete replication partner from storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
required
Array of objects (RemoveRemoteCopyTargetInput)

List of replication partner pairs to be deleted

Responses

Request samples

Content type
application/json
{
  • "replicationPartners": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get telemetry status for a storage system Primera / Alletra 9K

Get telemetry status for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "collectionServer": "string",
  • "commonResourceAttributes": {
    },
  • "connectivityStatus": "NORMAL",
  • "connectivityTestTime": {
    },
  • "details": [
    ],
  • "id": "string",
  • "lastFileSent": "string",
  • "lastFileTransferTime": {
    },
  • "lastSuccessfulConnectivityTestTime": {
    },
  • "proxyConnectivity": "NORMAL",
  • "rDAConfigured": "NORMAL",
  • "rDAStatus": "NORMAL",
  • "rSvSStatus": "NORMAL",
  • "rTSStatus": "NORMAL",
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/telemetryStatus",
  • "resourceUri": "/api/v1/storage-systems/device-type1/7CE751P312/telemetryStatus",
  • "rolledUpStatus": "NORMAL",
  • "sharedVolumeStatus": "NORMAL",
  • "transferStatus": "NORMAL"
}

Get certificates trusted by Primera / Alletra 9K

Get certificates trusted by Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=other

Lucene query to filter Certificates by Key.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 0,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE809P009/trustcerts",
  • "total": 1
}

Add trusted certificates for storage system Primera / Alletra 9K identified by {systemId}

Add trusted certificates for storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
action
required
string
Enum: "VERIFY_CERT_CHAIN" "INSTALL_CERT_CHAIN" "VERIFY_AND_INSTALL_CERT_CHAIN"

Action to perform with trusted certificate

required
object (TrustedCertParams)

Parameters for adding a trusted certificate

Responses

Request samples

Content type
application/json
{
  • "action": "VERIFY_CERT_CHAIN",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get certificates trusted by Primera / Alletra 9K identified by {id}

Get certificates trusted by Primera / Alletra 9K identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: 99691e493067b2b2acf1774fc0ccc011

ID of the certificate

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "commonname": "c3-hp-eskm-01",
  • "detail": {
    },
  • "domain": "hpe.com",
  • "enddate": {
    },
  • "fingerprint": "2e92f97ad86fdcfff295841fefe20a1d71944923",
  • "hash": "47efc91a.0",
  • "id": "99691e493067b2b2acf1774fc0ccc011",
  • "issuer": "CN=c3-hp-eskm-01",
  • "isvalid": true,
  • "keyUsage": "string",
  • "pem": "-----BEGIN CERTIFICATE REQUEST-----abc----END CERTIFICATE REQUEST-----",
  • "serial": "0",
  • "signaturetype": "self-signed",
  • "startdate": {
    },
  • "subject": "CN=c3-hp-eskm-01",
  • "systemId": "7CE809P009",
  • "type": "other",
  • "uri": "/api/v3/trustcerts/99691e493067b2b2acf1774fc0ccc011"
}

Delete trusted certificates from storage system Primera / Alletra 9K identified by {systemId}

Delete trusted certificates from storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
required
Array of objects (RemoveTrustedCertificateInput)

List of certificate IDs to be deleted

Responses

Request samples

Content type
application/json
{
  • "trustedCertificates": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get vcenter settings for a storage system Primera / Alletra 9K

Get vcenter settings for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 0,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE809P009/vm-manager-settings",
  • "total": 1
}

Add vCenter settings to storage system Primera / Alletra 9K

Add vCenter settings to storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
certChainPem
string or null

Certificate chain of the VCenter server as PEM data

description
string or null

Description of the vCenter setting

inetaddress
required
string

Host name or IP address of vCenter server

name
required
string

Name of the vCenter setting

password
required
string

Password to login to the vCenter server

port
required
integer <int64>

Port number of the vCenter server.

username
required
string

Username to login to the vCenter server

Responses

Request samples

Content type
application/json
{
  • "certChainPem": "-----BEGIN CERTIFICATE-----\nMIID2jCCAsKgAwIBAgIJAOiAEUfqLBfBMA0GCSqGSIb3DQEBCwUAMIGQMQswCQYD\n-----END CERTIFICATE-----\n",
  • "description": "vCenter - dataCenter1",
  • "inetaddress": "15.71.130.25",
  • "name": "dataCenter1",
  • "password": "pass",
  • "port": 443,
  • "username": "user1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete vcenter setting identified by {vcenterSettingId} on storage system Primera / Alletra 9K identified by {systemId}

Delete vcenter setting identified by {vcenterSettingId} on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vcenterSettingId
required
string
Example: 7e92269a-12d1-35b4-60e8-5919edfc5475

UID(vcenterSettingId) of the storage system

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get vcenter setting detail for a given vcenter setting of a storage system Primera / Alletra 9K

Get vcenter setting detail for a given vcenter setting of a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vcenterSettingId
required
string
Example: 7e92269a-12d1-35b4-60e8-5919edfc5475

UID(vcenterSettingId) of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/settings/system-settings",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1ca",
  • "description": "sample vc description",
  • "friendlyCert": {
    },
  • "generation": 1627540916540,
  • "id": "c0e4e72b-c9d3-54a4-312f-4ec0f8da498a",
  • "inetaddress": "18.213.214.145",
  • "name": "sample_vc_name",
  • "port": 162,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE809P009/vm-manager-settings/centerid123",
  • "resourceUri": "/api/v1/storage-systems/device-type1/7CE809P009/vm-manager-settings/centerid123",
  • "status": {
    },
  • "systemId": "7CE809P009",
  • "type": "vm-manager-settings",
  • "username": "SysAdmin@machine.local",
  • "vmManagerType": "hyperV"
}

Edit vCenter setting identified by {vcenterSettingId} on Primera / Alletra 9K identified by {systemId}

Edit vCenter setting identified by {vcenterSettingId} on Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vcenterSettingId
required
string
Example: 7e92269a-12d1-35b4-60e8-5919edfc5475

UID(vcenterSettingId) of the storage system

Request Body schema: application/json
certChainPem
string

Certificate chain of the VCenter server as PEM data

description
string

Description of the vCenter setting

inetaddress
string

Host name or IP address of vCenter server

name
string

Name of the vCenter setting

password
string

Password to login to the vCenter server

port
integer <int64>

Port number of the vCenter server.

username
string

Username to login to the vCenter server

Responses

Request samples

Content type
application/json
{
  • "certChainPem": "-----BEGIN CERTIFICATE-----\nMIID2jCCAsKgAwIBAgIJAOiAEUfqLBfBMA0GCSqGSIb3DQEBCwUAMIGQMQswCQYD\n-----END CERTIFICATE-----\n",
  • "description": "vCenter - dataCenter1",
  • "inetaddress": "15.71.130.25",
  • "name": "dataCenter1",
  • "password": "pass",
  • "port": 443,
  • "username": "user1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get all application servers details by Nimble / Alletra 6K

Get all application servers details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter application servers by Key.

sort
string
Example: sort=name desc

oData query to sort application servers by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/application-servers",
  • "total": 1
}

Create Nimble / Alletra 6K application server in system identified by {systemId}

Create Nimble / Alletra 6K application server in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
description
string or null

Text description of application server. String of up to 255 printable ASCII characters. Defaults to the empty string.

hostname
required
string

Application server hostname. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; Hypen and colon are allowed after the first and before the last character.

Array of objects or null or null (AppKeyValue)

Key-value pairs that augment an application server's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed. Defaults to an empty array.

name
required
string

Name of the volume. String of up to 64 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period.

password
string

Application server password. A password with few constraints. A string of up to 255 characters.

port
integer or null <int64>

Application server port number. Positive integer value up to 65535 representing TCP/IP port. Defaults to 65536.

server_type
string or null

Application server type. Defaults to 'vmware'. Possible values are 'vss' and 'vmware'.

username
string or null

Application server username. String of up to 255 printable ASCII characters.

Responses

Request samples

Content type
application/json
{
  • "description": "99.9999% availability",
  • "hostname": "nimble-appserver.com",
  • "metadata": [
    ],
  • "name": "AppServer101",
  • "password": "password_25-24",
  • "port": 1048,
  • "server_type": "vmware",
  • "username": "user256"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove application server identified by {applicationServerId} from Nimble / Alletra 6K

Remove application server identified by {applicationServerId} from Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

applicationServerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of application server. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K application server identified by {applicationServerId}

Get details of Nimble / Alletra 6K application server identified by {applicationServerId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

applicationServerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of application server. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/application-servers/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "hostname": "nimble-appserver.com",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "name": "AppServer101",
  • "server_type": "vmware",
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "creation_time": 3400,
  • "customerId": "string",
  • "description": "99.9999% availability",
  • "generation": 0,
  • "last_modified": 3400,
  • "metadata": [
    ],
  • "port": 1048,
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "type": "string",
  • "username": "user256"
}

Modify Nimble / Alletra 6K application server in system identified by {systemId}

Modify Nimble / Alletra 6K application server in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

applicationServerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of application server. A 42 digit hexadecimal number.

Request Body schema: application/json
description
string or null

Text description of application server. String of up to 255 printable ASCII characters. Defaults to the empty string.

hostname
string or null

Application server hostname. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; Hypen and colon are allowed after the first and before the last character.

Array of objects or null or null (AppKeyValue)

Key-value pairs that augment an application server's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed. Defaults to an empty array.

name
string or null

Name of the volume. String of up to 64 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period.

port
integer or null <int64>

Application server port number. Positive integer value up to 65535 representing TCP/IP port. Defaults to 65536.

server_type
string or null

Application server type. Defaults to 'vmware'. Possible values are 'vss' and 'vmware'.

username
string or null

Application server username. String of up to 255 printable ASCII characters.

Responses

Request samples

Content type
application/json
{
  • "description": "99.9999% availability",
  • "hostname": "nimble-appserver.com",
  • "metadata": [
    ],
  • "name": "AppServer101",
  • "port": 1048,
  • "server_type": "vmware",
  • "username": "user256"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Send auto support information of Nimble / Alletra 6K identified by {systemId}

Send auto support information of Nimble / Alletra 6K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit Nimble Mail Settings of Nimble / Alletra 6K

Edit Nimble Mail Settings of Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
smtp_port
integer or null <int64>

Port number of SMTP Server. Positive integer value up to 65535 representing TCP/IP port.

smtp_server
string or null

Hostname or IP Address of SMTP Server. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character.

Responses

Request samples

Content type
application/json
{
  • "smtp_port": 25,
  • "smtp_server": "example.hpe.com"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get all network settings details by Nimble / Alletra 6K

Get all network settings details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter network settings by Key.

sort
string
Example: sort=name desc

oData query to sort network settings resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/network-settings",
  • "total": 1
}

Get details of Nimble / Alletra 6K network setting identified by {networkSettingId}

Get details of Nimble / Alletra 6K network setting identified by {networkSettingId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

networkSettingId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of network setting. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/network-settings/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "id": "1300000000000004d30000000000000001",
  • "name": "active",
  • "role": "active",
  • "active_since": 1591599112000,
  • "array_list": [
    ],
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "creation_time": 1591599192000,
  • "customerId": "string",
  • "generation": 0,
  • "group_leader_array": "Array12",
  • "iscsi_automatic_connection_method": true,
  • "iscsi_connection_rebalancing": true,
  • "last_active": 1591599122000,
  • "last_modified": 1591599102000,
  • "mgmt_ip": "127.0.0.101",
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "route_list": [
    ],
  • "secondary_mgmt_ip": "127.0.0.102",
  • "subnet_list": [
    ],
  • "type": "string"
}

Edit Nimble / Alletra 6K network setting identified by {networkSettingId}

Edit Nimble / Alletra 6K network setting identified by {networkSettingId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

networkSettingId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of network setting. A 42 digit hexadecimal number.

Request Body schema: application/json
Array of objects or null (NimbleEditArrayNet)

List of array network configs.

iscsi_automatic_connection_method
boolean

Enable automatic connection method. Enabling this means means redirecting connections from the specified iSCSI discovery IP to the best data IP based on connection counts.

iscsi_connection_rebalancing
boolean

Enable connection rebalancing. Enabling this means rebalancing iSCSI connections by periodically breaking existing connections that are out-of-balance, allowing the host to reconnect to a more appropriate data IP.

mgmt_ip
string

Management IP for the Group. Four numbers in the range [0,255] separated by periods.

name
string

Name of the network configuration. Use the name 'draft' when creating a draft configuration. Possible values are 'active', 'backup' and 'draft'.

Array of objects or null (NimbleRoute)

List of static routes.

secondary_mgmt_ip
string or null

Secondary management IP address for the Group. Four numbers in the range [0,255] separated by periods.

Array of objects or null (NimbleSubnet)

List of subnet configs.

Responses

Request samples

Content type
application/json
{
  • "array_list": [
    ],
  • "iscsi_automatic_connection_method": true,
  • "iscsi_connection_rebalancing": true,
  • "mgmt_ip": "128.0.0.1",
  • "name": "draft",
  • "route_list": [
    ],
  • "secondary_mgmt_ip": "128.0.0.1",
  • "subnet_list": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit system settings of Nimble / Alletra 6K

Edit system settings of Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
object or null (EditAlertSettings)
object or null (EditDateTimezoneSettings)
object or null (EditDnsSettings)
object or null (EncryptionSettings)

How encryption is configured for this group. Group encryption settings.

object or null (EditIsnsSettings)
name
string or null

Name of the group. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

object or null (EditProxySettings)
object or null (EditSecuritySettings)
object or null (EditSmtpMailSettings)

Nimble mail-settings input.

object or null (EditSnmpSettings)
object or null (EditSupportSettings)
object or null (EditSyslogdSettings)
object or null (EditSystemParameters)

Responses

Request samples

Content type
application/json
{
  • "alert_settings": {
    },
  • "date_timezone_settings": {
    },
  • "dns_settings": {
    },
  • "encryption_config": {
    },
  • "isns_settings": {
    },
  • "name": "NimbleGroup55",
  • "proxy_settings": {
    },
  • "security_settings": {
    },
  • "smtp_settings": {
    },
  • "snmp_settings": {
    },
  • "support_settings": {
    },
  • "syslogd_settings": {
    },
  • "system_parameters": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get all replication-partners details for Nimble / Alletra 6K

Get all replication-partners details for Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter replication partners by Key.

sort
string
Example: sort=name desc

oData query to sort replication partner resource by Key.

includeIndirectPartners
boolean
Example: includeIndirectPartners=true

Include indirect partners. Indirect partners are excluded by default. This parameter cannot be used with other query parameters.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/replicationpartners",
  • "total": 1
}

Create replication partner pair for Nimble / Alletra 6K

Create replication partner pair for Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
required
Array of objects (ReplicationPartnerObj)

List of replication partners.

Responses

Request samples

Content type
application/json
{
  • "replicationPartners": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K replication-partner identified by {replicationpartnerId}

Get details of Nimble / Alletra 6K replication-partner identified by {replicationpartnerId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

replicationpartnerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of replicationpartner. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/replicationpartners/2a0df0fe6f7dc7bb16000000000000000000004009",
  • "array_serial": "string",
  • "cfg_sync_status": "string",
  • "creation_time": 3400,
  • "folder_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "folder_name": "Folder-A",
  • "hostname": "15.213.204.121",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "is_alive": true,
  • "name": "parnter-A",
  • "partner_type": "string",
  • "paused": true,
  • "pool_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "pool_name": "default-pool",
  • "repl_hostname": "15.213.204.121",
  • "subnet_label": "management",
  • "subnet_netmask": "255.255.255.0",
  • "subnet_network": "128.0.0.1",
  • "subnet_type": "string",
  • "systemId": "0019dbd036e652bd91000000000000000000000001",
  • "version": -1234,
  • "volume_collection_list_count": 1234,
  • "alias": "string",
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "control_port": 1234,
  • "customerId": "string",
  • "data_port": 1234,
  • "description": "99.9999% availability",
  • "full_name": "parnter-A",
  • "generation": 0,
  • "last_keepalive_error": "string",
  • "last_modified": 3400,
  • "last_sync_error": "string",
  • "match_folder": true,
  • "partner_group_uid": 1234,
  • "port_range_start": 0,
  • "proxy_hostname": "string",
  • "proxy_user": "string",
  • "remote_partner_folder_id": "string",
  • "remote_partner_folder_name": "string",
  • "remote_partner_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "remote_partner_name": "string",
  • "remote_partner_pool_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "remote_partner_pool_name": "string",
  • "remote_partner_subnet_label": "management",
  • "remote_partner_subnet_type": "mgmt",
  • "remote_partner_system_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "replication_direction": "string",
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "search_name": "vol:1",
  • "status": "string",
  • "throttled_bandwidth": -1234,
  • "throttled_bandwidth_current": -1234,
  • "throttled_bandwidth_current_kbps": -1234,
  • "throttled_bandwidth_kbps": -1234,
  • "throttles": [
    ],
  • "type": "string",
  • "unique_name": true,
  • "volume_collection_list": [
    ],
  • "witness": "string"
}

Edit a replication partner for Nimble / Alletra 6K given by replicationpartnerId

Edit a replication partner for Nimble / Alletra 6K given by replicationpartnerId

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

replicationpartnerId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of replicationpartner. A 42 digit hexadecimal number.

Request Body schema: application/json
required
Array of objects (EditReplicationPartner)

List of replication partners.

Responses

Request samples

Content type
application/json
{
  • "replicationPartners": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Pause the replication pair of Nimble / Alletra 6K

Pause the replication pair of Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
required
Array of objects (ReplicationPartnerPairAction)

List of replication partner pairs.

Responses

Request samples

Content type
application/json
{
  • "replicationPartners": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Resume the replication pair of Nimble / Alletra 6K

Resume the replication pair of Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
required
Array of objects (ReplicationPartnerPairAction)

List of replication partner pairs.

Responses

Request samples

Content type
application/json
{
  • "replicationPartners": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Test the replication partner pair of Nimble / Alletra 6K

Test the replication partner pair of Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
required
Array of objects (ReplicationPartnerPairAction)

List of replication partner pairs.

Responses

Request samples

Content type
application/json
{
  • "replicationPartners": [
    ]
}

Response samples

Content type
application/json
{
  • "response": [
    ]
}

Remove list of replication partner for Nimble / Alletra 6K

Remove list of replication partner for Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
required
Array of objects (ReplicationPartnerPairAction)

List of replication partner pairs to be deleted

Responses

Request samples

Content type
application/json
{
  • "replicationPartners": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get all witness configuration details by Nimble / Alletra 6K

Get all witness configuration details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004007

Lucene query to filter witnesses by Key.

sort
string
Example: sort=name desc

oData query to sort witnesses resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/witnesses",
  • "total": 1
}

Create a new witness configuration Nimble / Alletra 6K

Create a new witness configuration Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
host
required
string

Hostname or ip addresses of witness. Comma separated strings of up to 63 characters of hostname and/or ip addresses. Total length cannot exceed 255 characters.

password
required
string

Password of witness. String of 0 to 255 characters.

port
integer or null <int64>

Port of witness. Positive integer value up to 65535 representing TCP/IP port. Defaults to 5395.

username
required
string

Username of witness. This has to be a non-root that can login to the witness host. String of up to 32 characters, beginning with a letter or number or period (.) or an underscore (). It can include underscore (), dash (-), period (.) and end with doller ($) sign.

Responses

Request samples

Content type
application/json
{
  • "host": "witness-host9801.sjcvlab.com",
  • "password": "password_25-24",
  • "port": 5395,
  • "username": "witness9801"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove witness identified by {witnessId} from Nimble / Alletra 6K

Remove witness identified by {witnessId} from Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

witnessId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of witness. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K witness configuration identified by {witnessId}

Get details of Nimble / Alletra 6K witness configuration identified by {witnessId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

witnessId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004007

Identifier of witness. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestURI": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/witnesses/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "host": "witness-host9801.sjcvlab.com",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004007",
  • "port": 18976,
  • "username": "witness9801",
  • "associated_links": [
    ],
  • "auto_switchover_messages": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "customerId": "string",
  • "generation": 0,
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "type": "string"
}

Test and validate the witness configuration between the host identified by {witnessId} from Nimble / Alletra 6K identified by {systemId}

Test and validate the witness configuration between the host identified by {witnessId} from Nimble / Alletra 6K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

witnessId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of witness. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "response": [
    ]
}

Get alert-contact details for a storage system HPE Alletra Storage MP

Get alert-contact details for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE809P009/alert-contacts",
  • "systemId": "4UW0001540",
  • "total": 1
}

Add Alert/Mail contact details

Add Alert/Mail contact details

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
company
string or null

Company

companyCode
string or null

Company code

country
string or null

Country

fax
string or null

Fax number

firstName
string or null

First name

includeSvcAlerts
boolean or null

Email sent to contact shall include service alert

lastName
string or null

Last name

notificationSeverities
Array of integers or null

Severities of notifications the contact will be notificated. An array of number: 0 - Fatal, 1 - Critical, 2 - Major, 3 - Minor, 4 - Degraded, 5 - Info, 6 - Debug

preferredLanguage
string or null

Preferred language when being contacted or emailed

primaryEmail
string or null

Primary email address

primaryPhone
string or null

Primary phone

receiveEmail
boolean or null

Contact will receive email notifications. This is a deprecated field and will always pass true to be inline with UI.

receiveGrouped
boolean or null

Contact will receive grouped low urgency email notifications

secondaryEmail
string or null

Secondary email address

secondaryPhone
string or null

Secondary phone

Responses

Request samples

Content type
application/json
{
  • "company": "HPE",
  • "companyCode": "HPE",
  • "country": "US",
  • "fax": "fax_id",
  • "firstName": "john",
  • "includeSvcAlerts": false,
  • "lastName": "kevin",
  • "notificationSeverities": [
    ],
  • "preferredLanguage": "en",
  • "primaryEmail": "kevin.john@hpe.com",
  • "primaryPhone": "98783456",
  • "receiveEmail": true,
  • "receiveGrouped": true,
  • "secondaryEmail": "winny.pooh@hpe.com",
  • "secondaryPhone": "23456789"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete Alert/Email contact of storage system HPE Alletra Storage MP identified by {id}

Delete Alert/Email contact of storage system HPE Alletra Storage MP identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a4c78226-69cd-b9e7-af3e-445ca8f8a655

Unique Identifier of the alert contact

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get alert-contact details for a storage system HPE Alletra Storage MP identified by {id}

Get alert-contact details for a storage system HPE Alletra Storage MP identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a4c78226-69cd-b9e7-af3e-445ca8f8a655

Unique Identifier of the alert contact

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "company": "HPE",
  • "companyCode": "HPE",
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/settings/system-settings",
  • "country": "US",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1sd",
  • "fax": "+1 323 555 1234",
  • "firstName": "john",
  • "generation": 1627540907421,
  • "id": "67d09515-8526-9b02-c0c4-c1f443a39402",
  • "includeSvcAlerts": false,
  • "lastName": "kevin",
  • "notificationSeverities": [
    ],
  • "preferredLanguage": "en",
  • "primaryEmail": "kevin.john@hpe.com",
  • "primaryPhone": "98783456",
  • "receiveEmail": true,
  • "receiveGrouped": true,
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE809P009/alert-contacts",
  • "secondaryEmail": "winny.pooh@hpe.com",
  • "secondaryPhone": "23456789",
  • "systemId": "7CE751P312",
  • "systemSupportContact": false,
  • "type": "alert-contacts"
}

Edit Alert/Email contact details of storage system HPE Alletra Storage MP identified by {id}

Edit Alert/Email contact details of storage system HPE Alletra Storage MP identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a4c78226-69cd-b9e7-af3e-445ca8f8a655

Unique Identifier of the alert contact

Request Body schema: application/json
company
string or null

Company

companyCode
string or null

Company code

country
string or null

Country

fax
string or null

Fax number

firstName
string or null

First name

includeSvcAlerts
boolean or null

Email sent to contact shall include service alert

lastName
string or null

Last name

notificationSeverities
Array of integers or null

Severities of notifications the contact will be notificated. An array of number: 0 - Fatal, 1 - Critical, 2 - Major, 3 - Minor, 4 - Degraded, 5 - Info, 6 - Debug

preferredLanguage
string or null

Preferred language when being contacted or emailed

primaryEmail
string or null

Primary email address

primaryPhone
string or null

Primary phone

receiveEmail
boolean or null

Contact will receive email notifications. This is a deprecated field and will always pass true to be inline with UI.

receiveGrouped
boolean or null

Contact will receive grouped low urgency email notifications

secondaryEmail
string or null

Secondary email address

secondaryPhone
string or null

Secondary phone

Responses

Request samples

Content type
application/json
{
  • "company": "HPE",
  • "companyCode": "HPE",
  • "country": "US",
  • "fax": "fax_id",
  • "firstName": "john",
  • "includeSvcAlerts": false,
  • "lastName": "kevin",
  • "notificationSeverities": [
    ],
  • "preferredLanguage": "en",
  • "primaryEmail": "kevin.john@hpe.com",
  • "primaryPhone": "98783456",
  • "receiveEmail": true,
  • "receiveGrouped": true,
  • "secondaryEmail": "winny.pooh@hpe.com",
  • "secondaryPhone": "23456789"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get array certificates by HPE Alletra Storage MP

Get array certificates by HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=service eq qw-client

Lucene query to filter Certificates by Key.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 0,
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE809P009/certificates",
  • "total": 1
}

Create certificate on storage system HPE Alletra Storage MP identified by {systemId}

Create certificate on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
authorityChain
string

The authority chain for Quorum Witness server certificate.

commonName
string

CommonName for the certificate.

country
string

Two-letter code for the country where organization is located.

days
integer <int64>

Number of days valid for the certificate.

keyLength
integer <int64>

Key length for the certificate.

locality
string

Locality where organization is located.

organization
string

Organization for the certificate

organizationUnit
string

Division of organization handling the certificate.

province
string

Province where organization is located.

service
required
string
Enum: "QW_CLIENT" "QW_SERVER" "WSAPI" "CLI" "CIM" "VASA" "EKM_CLIENT" "SYSLOG_GEN_CLIENT" "SYSLOG_SEC_CLIENT" "UNIFIED_SERVER" "EKM_SERVER"

Name of service the certificate is for.

object (DeviceType4CertSubjectAltName)

Subject Alternative Name for the certificate.

type
required
string

Type of certificate to create.

Responses

Request samples

Content type
application/json
{
  • "authorityChain": "-----BEGIN CERTIFICATE REQUEST-----abc----END CERTIFICATE REQUEST-----",
  • "commonName": "hpe.com CA - Intermediate",
  • "country": "IN",
  • "days": 365,
  • "keyLength": 2048,
  • "locality": "BLR",
  • "organization": "HPE",
  • "organizationUnit": "HPE Alletra Storage MP",
  • "province": "Karnataka",
  • "service": "QW_CLIENT",
  • "subjectAltName": {
    },
  • "type": "csr"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get array certificates by HPE Alletra Storage MP identified by {id}

Get array certificates by HPE Alletra Storage MP identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: 99691e493067b2b2acf1774fc0ccc011

ID of the certificate

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "certType": "cert",
  • "commonResourceAttributes": {
    },
  • "commonname": "HPE_3PAR C630-4UW0002940\"",
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/settings/system-settings",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "displayname": "Certificate HPE_3PAR C630-4UW0002940",
  • "domain": "hpe.com",
  • "enddate": {
    },
  • "fingerprint": "string",
  • "generation": 1627533096726,
  • "id": "99691e493067b2b2acf1774fc0ccc011",
  • "issuer": "CN=HPE_3PAR C630-4UW0002940",
  • "pem": "string",
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE809P009/certificates/99691e493067b2b2acf1774fc0ccc011",
  • "serial": "1",
  • "service": "unified-server",
  • "signaturetype": "self-signed",
  • "startdate": {
    },
  • "subject": "CN=HPE_3PAR C630-4UW0002940",
  • "subjectaltname": "DNS:HPE_3PAR C630-4UW0002940",
  • "systemId": "7CE809P009",
  • "text": "string",
  • "type": "certificates",
  • "uri": "/api/v3/certificates/99691e493067b2b2acf1774fc0ccc011",
  • "vcGuid": "09r907r9hinfniauhfiqh98qh"
}

Import certificate identified by {id} on storage system HPE Alletra Storage MP identified by {systemId}

Import certificate identified by {id} on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: 99691e493067b2b2acf1774fc0ccc011

ID of the certificate

Request Body schema: application/json
authorityChain
required
string

The authority chain for the new certificate.

certificate
required
string

The certificate that results from the Certificate Signing Request (CSR).

vcGuid
string or null

vcGuid of the vCenter. It is supported from OS version 10.4.0 and VASA version 5.0.0.0

Responses

Request samples

Content type
application/json
{
  • "authorityChain": "-----BEGIN CERTIFICATE REQUEST-----abc----END CERTIFICATE REQUEST----- \\n-----BEGIN CERTIFICATE REQUEST-----pqr----END CERTIFICATE REQUEST-----",
  • "certificate": "-----BEGIN CERTIFICATE REQUEST-----abc----END CERTIFICATE REQUEST-----",
  • "vcGuid": "09r907r9hinfniauhfiqh98qh"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete certificates from storage system HPE Alletra Storage MP identified by {systemId}

Delete certificates from storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
required
Array of objects (DeviceType4RemoveCertificateInput)

List of certificate IDs to be deleted

Responses

Request samples

Content type
application/json
{
  • "certificates": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Trigger a collection on the storage system HPE Alletra Storage MP

Trigger a collection on the storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
Array
action
string or null
Enum: "PERFCOLLECTION" "INSPLORECOLLECTION" "APPDUMPCOLLECTION" "CRASHDUMPCOLLECTION" "SPLORCOLLECTION" "WEEKLYCOLLECTION"

Type of a collection.

options
Array of strings or null

Options needed for the collection. If options are not specified, default values will be used.

INSPLORECOLLECTION can have any or all of "clidata", "nodedata" and "tocdata"

 Default options - ["clidata","nodedata","tocdata"]

PERFCOLLECTION should have 3 options,

  • Iteration - a number between 1 to 1000 as a string,

  • Interval - a number in seconds between 1 to 172800 as a string

  • Type of collection -default or -comprehensive

 Default options - ["60","10","-default"]

Other collection types won't require any options, if provided will be ignored.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Set license of the storage system identified by {systemId}

Set license of the storage system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete SMTP/mail server settings

Delete SMTP/mail server settings

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get the system's SMTP/Mail server settigs

Get the system's SMTP/Mail server settigs

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "authenticationRequired": "enabled",
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/settings/system-settings",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cq",
  • "friendlyCert": {
    },
  • "generation": 1627540911681,
  • "mailHostDomain": "hpe.com",
  • "mailHostServer": "example.hpe.com",
  • "port": 25,
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312/mailsettings",
  • "senderEmailId": "someone@maildomain.com",
  • "type": "mail-settings",
  • "username": "username"
}

Add SMTP/Mail server settigs

Add SMTP/Mail server settigs

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
mailHostDomain
string or null

SMTP server's Host Domain

mailHostServer
string or null

SMTP server address/IP

port
integer or null <int64>
Enum: 25 465 587 2525

SMTP server's port number

senderEmailId
string or null

Sender email address

Responses

Request samples

Content type
application/json
{
  • "mailHostDomain": "hpe.com",
  • "mailHostServer": "example.hpe.com",
  • "port": 25,
  • "senderEmailId": "string"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit SMTP/Mail server settigs

Edit SMTP/Mail server settigs

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
mailHostDomain
string or null

SMTP server's Host Domain

mailHostServer
string or null

SMTP server address/IP

port
integer or null <int64>
Enum: 25 465 587 2525

SMTP server's port number

senderEmailId
string or null

Sender email address

Responses

Request samples

Content type
application/json
{
  • "mailHostDomain": "hpe.com",
  • "mailHostServer": "example.hpe.com",
  • "port": 25,
  • "senderEmailId": "string"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get CIM Network-Service details for a storage system HPE Alletra Storage MP

Get CIM Network-Service details for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312/network-services/cim"
}

Edit CIM network service configuration

Edit CIM network service configuration

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object or null

Responses

Request samples

Content type
application/json
{
  • "cim": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get SNMP-Manager Network-Service details for a storage system HPE Alletra Storage MP

Get SNMP-Manager Network-Service details for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312/network-services/snmp-mgr"
}

Add SNMP Manager settings

Add SNMP Manager settings

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
Array of objects or null (DeviceType4SnmpConfigParams)

Specify the SNMP params

Responses

Request samples

Content type
application/json
{
  • "snmpConfig": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete SNMP manager settings identified by {id}

Delete SNMP manager settings identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the SNMP manager

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get a specific SNMP-Manager Network-Service details for a storage system HPE Alletra Storage MP

Get a specific SNMP-Manager Network-Service details for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the SNMP manager

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312/network-services/snmp-mgr"
}

Edit SNMP Manager settings for the specified Id

Edit SNMP Manager settings for the specified Id

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the SNMP manager

Request Body schema: application/json
authenticationPassword
string or null

Specify the SNMPv3 Authentication Password

managerIP
string

Specify the IP address of the host from which the manager runs

notify
string or null
Enum: "ALL" "NODUP" "STANDARD"

Indicates the trap notification types defined by the HPE deviceType1 MIB

port
integer or null <int64>

Specify the port number where the SNMP manager receives traps

privPassword
string or null

Specify the SNMPv3 Authentication Password

retry
integer or null <int64>

Specify the number of times to send a trap (retry) if the SNMP manager is not available.

timeoutSecs
integer or null <int64>

Specify the number of seconds to wait before sending a trap (timeout).

user
string or null

Specify the SNMPv3 user name

userMode
string or null
Enum: "NEW" "EXISTING"

Specify the SNMPv3 user mode

version
integer or null

Specify the SNMP version supported

Responses

Request samples

Content type
application/json
{
  • "authenticationPassword": "Password_1",
  • "managerIP": "15.218.169.163",
  • "notify": "STANDARD",
  • "port": 162,
  • "privPassword": "Password_2",
  • "retry": 2,
  • "timeoutSecs": 162,
  • "user": "user1",
  • "userMode": "NEW",
  • "version": 2
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get SNMP users

Get SNMP users

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

filter
string
Example: filter=systemWWN eq 2FF70002AC018D94

oData query to filter snmpusers resource by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort snmpusers resource by Key.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/snmp-users",
  • "total": 1
}

Get SNMP users identified by {id}

Get SNMP users identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the SNMP manager

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "authprotocol": "SAS",
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/settings/system-settings",
  • "customerId": "string",
  • "displayname": "Drive 0.SIDE_NONE.2.0",
  • "domain": "server.com/collect",
  • "generation": 0,
  • "id": "9c3c4f29a82fd8d632ff379116fa0b8f",
  • "privprotocol": "privprotocol",
  • "resourceUri": "/v1/storage-systems/device-type4/7CE751P312/snmp-users/9c3c4f29a82fd8d632ff379116fa0b8f",
  • "systemId": "7CE751P312",
  • "systemWWN": "2FF70002AC018D94",
  • "type": "string",
  • "username": "username"
}

Get VASA Network-Service details for a storage system Primera / Alletra 9K

Get VASA Network-Service details for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312/network-services/vasa"
}

Configures vasa service for the specified id.

Enables or disable vasa service on a HPE Alletra Storage MP storage system

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vasaId
required
string
Example: a9c455bf98fc1a6bdb90b824e3ac20b8

ID of the VASA service

Request Body schema: application/json
action
string

Specify the action on vasa service. Either START, STOP or RESET

Responses

Request samples

Content type
application/json
{
  • "action": "START"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Configures vasa service for the specified id.

Enables, disable and updates the cert management mode for vasa services on a HPE Alletra Storage MP storage system

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vasaId
required
string
Example: a9c455bf98fc1a6bdb90b824e3ac20b8

ID of the VASA service

Request Body schema: application/json
certMgmt
string or null

Specify the cert mode for vasa provider, supports values server, locked_client or multi_vc. multi_vc is supported from OS version 10.4.0 and Vasa version 5.0.0.0

vasaStateEnabled
boolean or null

Specify the status of vasa service.

Responses

Request samples

Content type
application/json
{
  • "certMgmt": "server",
  • "vasaStateEnabled": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get Network-Settings details for a storage system HPE Alletra Storage MP

Get Network-Settings details for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "portManagement": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE809P009/network-settings"
}

Post Network-Settings details for a storage system HPE Alletra Storage MP

Post Network-Settings details for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
dnsAddresses
Array of strings or null

Dns address of the system

ipv4Address
string or null

ipv4 address of the system

ipv4Gateway
string or null

ipv4 gateway of the system

ipv4SubnetMask
string or null

NetMask for IPV4 address

ipv6Address
string or null

IPV6 address of the system

ipv6Gateway
string or null

IPV6 address of the system

ipv6PrefixLen
string or null

IPV6 Prefix length

object or null

Proxy Setting details for a device

Responses

Request samples

Content type
application/json
{
  • "dnsAddresses": [
    ],
  • "ipv4Address": "string",
  • "ipv4Gateway": "string",
  • "ipv4SubnetMask": "string",
  • "ipv6Address": "string",
  • "ipv6Gateway": "string",
  • "ipv6PrefixLen": "string",
  • "proxyParams": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get service ports for nodes of all storage systems of HPE Alletra Storage MP identified by {systemId} and {nodeId }

Get service ports for nodes of all storage systems of HPE Alletra Storage MP identified by {systemId} and {nodeId }

Authorizations:
JWTAuth
path Parameters
nodeId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

Primary ID of the node

systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=ipv4address eq "169.254.77.160"

oData query to filter systems by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/{systemUid}/nodes/serviceports",
  • "total": 2
}

Get service ports for nodes of all storage systems of HPE Alletra Storage MP identified by {systemId}

Get service ports for nodes of all storage systems of HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=ipv4address eq "169.254.77.160"

oData query to filter systems by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/{systemUid}/nodes/serviceports",
  • "total": 2
}

Get details of performance metrics of remote copy links on storage system identified by {systemid}

Get details of performance metrics of remote copy links on storage system identified by {systemid}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
reportType
string
Example: reportType=Canned,Custom,Def,ApiUser

parameter will be set to report type requested. For api users, set parameter as ApiUser

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

compareBy
string
Example: compareBy=top eq 5 and metrics eq linkRoundTripTime

compareBy will define top and compare metrics for which query has to be made. Allowed values: linkThroughput, linkRoundTripTime, transmittedData

groupBy
string
Example: groupBy=replicationPartnerName,portNsp

groupBy will define comma separated groupBy parameters. Allowed value: replicationPartnerName, portNsp

metricType
string
Example: metricType=linkThroughput,linkRoundTripTime,transmittedData

metricType will define comma separated metrics

filter
string
Example: filter=remoteCopyLinkId in (57f2dc8c75144e21dbfc09705e499580,a8e2c8d70f5a97074e72935af10d9926)

filter will define objects to be filtered. Filterable columns are: * remoteCopyLinkId - id of the remote copy link * targetName - name of the replication partner

Responses

Response samples

Content type
application/json
{
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 162564271,
  • "historyData": {
    },
  • "requestUri": "/v1/storage-systems/device-type4/SGH014XGSP/remotecopylinks-performance",
  • "startTime": 1625556314
}

Get support settings for a storage system HPE Alletra Storage MP

Get support settings for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "connectToHPE": "disabled",
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/settings/system-settings",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1az",
  • "emailNotifications": "enabled",
  • "enterpriseServerURL": "server.com/collect",
  • "generation": 1627540915530,
  • "id": "7CE726P1VX",
  • "miniInsploreEnabled": "disabled",
  • "remoteAccess": "ENABLE_NONROOT",
  • "remoteRequest": [
    ],
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312/supportsettings",
  • "resourceUri": "/api/v1/storage-systems/device-type4/7CE751P312/supportsettings",
  • "type": "support-settings"
}

Add support settings for a storage system HPE Alletra Storage MP

Add support settings for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
connectToHPE
required
string

Enable remote support by allowing sending of files from device to HPE. Allowed values: enabled or disabled. It is mandatory.

deviceId
string

Id of the array. User can get Id info from GET response and this can not be changed.

enterpriseServerURL
string or null

Callhome collection server URL

miniInsploreEnabled
string or null

Enables/Disable scheduled Mini-Insplore collection. Allowed values: enabled or disabled.

remoteAccess
required
string
Enum: "DISABLE" "ENABLE_NONROOT" "ENABLE_ROOT"

Allow HPE Support to access the device remotely. Allowed values: ENABLE_ROOT or DISABLE or ENABLE_NONROOT. It is mandatory.

object or null (DeviceType4remoteRequestAcknowledge)

Accept/Deny/Close the Remote Access request.

Responses

Request samples

Content type
application/json
{
  • "connectToHPE": "string",
  • "deviceId": "string",
  • "enterpriseServerURL": "string",
  • "miniInsploreEnabled": "string",
  • "remoteAccess": "DISABLE",
  • "remoteRequestAcknowledge": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit support settings for a storage system HPE Alletra Storage MP

Edit support settings for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
connectToHPE
required
string

Enable remote support by allowing sending of files from device to HPE. Allowed values: enabled or disabled. It is mandatory.

deviceId
string

Id of the array. User can get Id info from GET response and this can not be changed.

enterpriseServerURL
string or null

Callhome collection server URL

miniInsploreEnabled
string or null

Enables/Disable scheduled Mini-Insplore collection. Allowed values: enabled or disabled.

remoteAccess
required
string
Enum: "DISABLE" "ENABLE_NONROOT" "ENABLE_ROOT"

Allow HPE Support to access the device remotely. Allowed values: ENABLE_ROOT or DISABLE or ENABLE_NONROOT. It is mandatory.

object or null (DeviceType4remoteRequestAcknowledge)

Accept/Deny/Close the Remote Access request.

Responses

Request samples

Content type
application/json
{
  • "connectToHPE": "string",
  • "deviceId": "string",
  • "enterpriseServerURL": "string",
  • "miniInsploreEnabled": "string",
  • "remoteAccess": "DISABLE",
  • "remoteRequestAcknowledge": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of sustainability metrics of enclosure and system power supplies in Watts on storage system identified by {systemid}

Get details of sustainability metrics of enclosure and system power supplies in Watts on storage system identified by {systemid}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

groupBy
string
Example: groupBy=VV_NAME,HOST_NAME,LUN,deviceName

groupBy will define comma separated groupby parameters

metricType
string
Example: metricType=IOPS,LATENCY,THROUGHPUT,IOSIZE,QLEN,AVG_BUSY,powerConsumption

metricType will define comma separated metrics

filter
string
Example: filter=vvname in (vvname1,vvname2,vvname3) ,deviceName in (cage1)

filter will define objects to be filtered

Responses

Response samples

Content type
application/json
{
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 1185586324,
  • "historyData": {
    },
  • "requestUri": "/v1/storage-systems/device-type4/SGH014XGSP/sustainabilityMetrics",
  • "startTime": 1825951613
}

Get the system settings configuration details

Get the system settings configuration details

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE809P009/system-settings"
}

Edit system settings configuration

Edit system settings configuration. Only one type of system settings i.e. either "authMode or dateTime or installationSites or name or ntpAddresses or remoteSyslogSettings or srinfo or supportContact or systemParameters" is allowed to be configured at a time.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object or null
dateTime
string or null

system date time. timezone is mandatory to configure this parameter.

object or null
name
string or null

system name

ntpAddresses
Array of strings or null or null

system ntp addresses. timezone is mandatory to configure this parameter.

object or null
object or null
object or null (DeviceType4ContactsEditDetails)

Contacts details set to receive alerts

object or null
timezone
string or null

system time zone

Responses

Request samples

Content type
application/json
{
  • "authMode": {
    },
  • "dateTime": "01/15/2020 10:00:00",
  • "installationSites": {
    },
  • "name": "Array1",
  • "ntpAddresses": [
    ],
  • "remoteSyslogSettings": {
    },
  • "srinfo": {
    },
  • "supportContact": {
    },
  • "systemParameters": {
    },
  • "timezone": "Asia/Calcutta"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit system settings configuration

Edit system settings configuration. Only one type of system settings i.e. either "authMode or dateTime or installationSites or name or ntpAddresses or remoteSyslogSettings or srinfo or supportContact or systemParameters" is allowed to be configured at a time.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object or null
dateTime
string or null

system date time. timezone is mandatory to configure this parameter.

object or null
name
string or null

system name

ntpAddresses
Array of strings or null or null

system ntp addresses. timezone is mandatory to configure this parameter.

object or null
object or null
object or null (DeviceType4ContactsEditDetails)

Contacts details set to receive alerts

object or null
timezone
string or null

system time zone

Responses

Request samples

Content type
application/json
{
  • "authMode": {
    },
  • "dateTime": "01/15/2020 10:00:00",
  • "installationSites": {
    },
  • "name": "Array1",
  • "ntpAddresses": [
    ],
  • "remoteSyslogSettings": {
    },
  • "srinfo": {
    },
  • "supportContact": {
    },
  • "systemParameters": {
    },
  • "timezone": "Asia/Calcutta"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get vVol details for a storage system HPE Alletra Storage MP

Get vVol details for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312/network-services/vvol",
  • "total": 1
}

Get Storage Container details for a storage system HPE Alletra Storage MP

Get Storage Container details for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312/network-services/vvolscs",
  • "total": 1
}

Delete storage container of storage system HPE Alletra Storage MP identified by {id}

Delete storage container of storage system HPE Alletra Storage MP identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vvolscId
required
string
Example: d09b59cd7bd07a4e9559e78dcea07498

Storage container UID

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit storage container of storage system HPE Alletra Storage MP identified by {id}

Edit storage container of storage system HPE Alletra Storage MP identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vvolscId
required
string
Example: d09b59cd7bd07a4e9559e78dcea07498

Storage container UID

Request Body schema: application/json
comment
string or null

Comment of the Storage Container.

growthLimitMiB
integer or null

Specifies that the auto-grow operation is limited to the specified storage amount. The storage amount can be specified in MiB. A size of 0 (default) means no limit is enforced. To disable auto-grow, set the limit to 1.

growthSizeMiB
integer or null

Specifies the growth increment size, the amount of logical disk storage created on each auto-grow operation. If the size is non-zero it must be 3675 MiB or greater. The size can be specified in MiB. A size of 0 disables the auto-grow feature.

growthWarnMiB
integer or null

Specifies that the threshold of used logical disk space, when exceeded, results in a warning alert. The size can be specified in MiB. A size of 0 (default) means no warning limit is enforced. To set the warning for any used space, set the limit to 1.

name
string

Storage Container Name.

Responses

Request samples

Content type
application/json
{
  • "comment": "Storage Container is for the volume",
  • "growthLimitMiB": 20,
  • "growthSizeMiB": 10,
  • "growthWarnMiB": 18,
  • "name": "<resource_name>"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get quorum witness configuration details from storage system HPE Alletra Storage MP identified by {systemId}

Get quorum witness configuration details from storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq afb4961e47212e5bc88dd35db5be5c83

oData query to filter witness by key.

sort
string
Example: sort=id desc

oData query to sort witness resource by key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type4/SGH000XWEE/system-settings/quorum-witness",
  • "total": 1
}

Create quorum witness on storage system HPE Alletra Storage MP identified by {systemId}

Create quorum witness on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
required
object

Parameters for create quorum witness action

replicationPartnerSystemId
required
string

SystemId of target replication partner

srcReplicationId
required
string

Id of source replication partner on which quorum witness is to be configured

startQuorumWitness
boolean or null

Specifies start/stop Quorum Witness connectivity on the storage system. If set true, ATF configuration is activated. If set false, ATF configuration is deactivated.

targetReplicationId
required
string

Id of target replication partner on which quorum witness is to be configured

Responses

Request samples

Content type
application/json
{
  • "parameters": {
    },
  • "replicationPartnerSystemId": "7CE816P0SR",
  • "srcReplicationId": "afb4961e47212e5bc88dd35db5be5c83",
  • "startQuorumWitness": true,
  • "targetReplicationId": "afb4961e47212e5bc88dd35db5be5c83"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete quorum witness identified by {replicationPartnerId} on storage system HPE Alletra Storage MP identified by {systemId}

Delete quorum witness identified by {replicationPartnerId} on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

replicationPartnerId
required
string
Example: aedec7d11d02f73611a6ff992c256bdb

id of device-type1 replication partner

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of quorum witness configured on replication partner identified by {replicationPartnerId} on storage system HPE Alletra Storage MP identified by {systemId}

Get details of quorum witness configured on replication partner identified by {replicationPartnerId} on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

replicationPartnerId
required
string
Example: aedec7d11d02f73611a6ff992c256bdb

id of device-type1 replication partner

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH000XWEE/system-settings/quorum-witness/5a5ce66d4814a5e5156de428abb0a589",
  • "requestUri": "/api/v1/storage-systems/device-type4/SGH000XWEE/system-settings/quorum-witness/5a5ce66d4814a5e5156de428abb0a589",
  • "id": "5a5ce66d4814a5e5156de428abb0a589",
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "generation": 0,
  • "isRemoteArraySupportReplication": true,
  • "name": "IPSource",
  • "quorumATFTimeout": 30,
  • "quorumIpAddress": "10.10.10.11",
  • "quorumSSLPort": 8843,
  • "quorumStatus": "Initializing",
  • "quorumStatusQual": "NA",
  • "quorumVersion": "2.0",
  • "remoteId": "6a5ce66d4814a5e5156de428abb0a580",
  • "remoteName": "IPTarget",
  • "remoteSystemId": "SGH000XWEF",
  • "remoteSystemName": "System102",
  • "resourceUri": "/api/v1/storage-systems/device-type4/SGH000XWEE/system-settings/quorum-witness/5a5ce66d4814a5e5156de428abb0a589",
  • "systemId": "SGH000XWEE",
  • "systemName": "s1511",
  • "type": "quorum-witness"
}

Edit quorum witness identified by {replicationPartnerId} on storage system HPE Alletra Storage MP identified by {systemId}

Edit quorum witness identified by {replicationPartnerId} on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

replicationPartnerId
required
string
Example: aedec7d11d02f73611a6ff992c256bdb

id of device-type1 replication partner

Request Body schema: application/json
replicationPartnerSystemId
required
string

SystemId of target replication partner

startQuorumWitness
required
boolean

Specifies start/stop Quorum Witness connectivity on the storage system. If set true, ATF configuration is activated. If set false, ATF configuration is deactivated.

targetReplicationId
required
string

Id of target replication partner on which quorum witness is configured

Responses

Request samples

Content type
application/json
{
  • "replicationPartnerSystemId": "7CE816P0SR",
  • "startQuorumWitness": true,
  • "targetReplicationId": "afb4961e47212e5bc88dd35db5be5c83"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of replication partners on storage system HPE Alletra Storage MP identified by {systemId}

Get details of replication partners on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=systemId eq 7CE751P312

oData query to filter replication partners by key.

sort
string
Example: sort=name desc

oData query to sort nodes resource by key.

includeIndirectPartners
boolean
Example: includeIndirectPartners=true

Include indirect partners. Indirect partners are excluded by default. This parameter cannot be used with other query parameters.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type4/SGH000XWEE/system-settings/replication-partners",
  • "total": 1
}

Create replication partners on HPE Alletra Storage MP identified by {systemId}

Create replication partners on HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
required
Array of objects (DeviceType4ReplicationPartnerInput)

Responses

Request samples

Content type
application/json
{
  • "replicationPartners": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of replication partner identified by {replicationPartnerId} on storage system HPE Alletra Storage MP identified by {systemId}

Get details of replication partner identified by {replicationPartnerId} on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

replicationPartnerId
required
string
Example: aedec7d11d02f73611a6ff992c256bdb

id of device-type1 replication partner

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH000XWEE/system-settings/replication-partners/5a5ce66d4814a5e5156de428abb0a589",
  • "requestUri": "api/v1/storage-systems/device-type4/SGH000XWEE/system-settings/replication-partners/5a5ce66d4814a5e5156de428abb0a589",
  • "id": "5a5ce66d4814a5e5156de428abb0a589",
  • "name": "RCPartner12",
  • "replicationPartnerType": "FC",
  • "status": "Ready",
  • "associatedLinks": [
    ],
  • "bufferSizeB": 1024,
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "displayName": "RCPartner12",
  • "domain": "domain1",
  • "flags": 1,
  • "generation": 0,
  • "health": 1,
  • "isRemoteArraySupportReplication": true,
  • "minPeriodSecs": 300,
  • "nodeWWN": "2FF70002AC020DA1",
  • "numSockets": 2,
  • "policies": {
    },
  • "quorumATFTimeout": 0,
  • "quorumIpAddress": "10.10.10.11",
  • "quorumSSLPort": 0,
  • "quorumStatus": "Initializing",
  • "quorumStatusQual": "NA",
  • "quorumVersion": "2.0",
  • "remoteId": "6a5ce66d4814a5e5156de428abb0a580",
  • "remoteName": "FC-02",
  • "remoteReplicationId": 12,
  • "remoteSystemId": "SGH000XWEF",
  • "remoteSystemName": "System102",
  • "replicationId": 1,
  • "replicationPartnerLinks": {
    },
  • "replicationSystemId": 1,
  • "resourceUri": "/api/v1/storage-systems/device-type4/SGH000XWEE/system-settings/replication-partners/5a5ce66d4814a5e5156de428abb0a589",
  • "state": "UNKNOWN",
  • "systemId": "SGH000XWEE",
  • "systemName": "System101",
  • "systemWWN": "2FF70002AC020CEF",
  • "type": "replication-partner",
  • "version": 41
}

Edit replication partner identified by {replicationPartnerId} on HPE Alletra Storage MP identified by {systemId}

Edit replication partner identified by {replicationPartnerId} on HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

replicationPartnerId
required
string
Example: aedec7d11d02f73611a6ff992c256bdb

id of device-type1 replication partner

Request Body schema: application/json
object (DeviceType4AddRemoteCopyLinks)

Request body for adding remote copy links

object or null (DeviceType4RemoveRemoteCopyLinksInput)

Request Body for removing remote copy links

Responses

Request samples

Content type
application/json
{
  • "addRcLinks": {
    },
  • "removeRcLinks": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete replication partner from storage system HPE Alletra Storage MP identified by {systemId}

Delete replication partner from storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
required
Array of objects (DeviceType4RemoveRemoteCopyTargetInput)

List of replication partner pairs to be deleted

Responses

Request samples

Content type
application/json
{
  • "replicationPartners": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get telemetry status for a storage system HPE Alletra Storage MP

Get telemetry status for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "collectionServer": "string",
  • "connectivityStatus": "NORMAL",
  • "connectivityTestTime": {
    },
  • "details": [
    ],
  • "id": "string",
  • "lastFileSent": "string",
  • "lastFileTransferTime": {
    },
  • "lastSuccessfulConnectivityTestTime": {
    },
  • "proxyConnectivity": "NORMAL",
  • "rDAConfigured": "NORMAL",
  • "rDAStatus": "NORMAL",
  • "rSvSStatus": "NORMAL",
  • "rTSStatus": "NORMAL",
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312/telemetryStatus",
  • "resourceUri": "/api/v1/storage-systems/device-type4/7CE751P312/telemetryStatus",
  • "rolledUpStatus": "NORMAL",
  • "sharedVolumeStatus": "NORMAL",
  • "transferStatus": "NORMAL"
}

Get certificates trusted by HPE Alletra Storage MP

Get certificates trusted by HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=other

Lucene query to filter Certificates by Key.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 0,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE809P009/trustcerts",
  • "total": 1
}

Add trusted certificates for storage system HPE Alletra Storage MP identified by {systemId}

Add trusted certificates for storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
action
required
string
Enum: "VERIFY_CERT_CHAIN" "INSTALL_CERT_CHAIN" "VERIFY_AND_INSTALL_CERT_CHAIN"

Action to perform with trusted certificate

required
object (TrustedCertParams)

Parameters for adding a trusted certificate

Responses

Request samples

Content type
application/json
{
  • "action": "VERIFY_CERT_CHAIN",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get certificates trusted by HPE Alletra Storage MP identified by {id}

Get certificates trusted by HPE Alletra Storage MP identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: 99691e493067b2b2acf1774fc0ccc011

ID of the certificate

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "commonname": "c3-hp-eskm-01",
  • "detail": {
    },
  • "domain": "hpe.com",
  • "enddate": {
    },
  • "fingerprint": "2e92f97ad86fdcfff295841fefe20a1d71944923",
  • "hash": "47efc91a.0",
  • "id": "99691e493067b2b2acf1774fc0ccc011",
  • "issuer": "CN=c3-hp-eskm-01",
  • "isvalid": true,
  • "keyUsage": "string",
  • "pem": "-----BEGIN CERTIFICATE REQUEST-----abc----END CERTIFICATE REQUEST-----",
  • "serial": "0",
  • "signaturetype": "self-signed",
  • "startdate": {
    },
  • "subject": "CN=c3-hp-eskm-01",
  • "systemId": "7CE809P009",
  • "type": "other",
  • "uri": "/api/v3/trustcerts/99691e493067b2b2acf1774fc0ccc011"
}

Delete trusted certificates from storage system HPE Alletra Storage MP identified by {systemId}

Delete trusted certificates from storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
required
Array of objects (RemoveTrustedCertificateInput)

List of certificate IDs to be deleted

Responses

Request samples

Content type
application/json
{
  • "trustedCertificates": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get vcenter settings for a storage system HPE Alletra Storage MP

Get vcenter settings for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 0,
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE809P009/vm-manager-settings",
  • "total": 1
}

Add vCenter settings to storage system HPE Alletra Storage MP

Add vCenter settings to storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
certChainPem
string or null

Certificate chain of the VCenter server as PEM data

description
string or null

Description of the vCenter setting

inetaddress
required
string

Host name or IP address of vCenter server

name
required
string

Name of the vCenter setting

password
required
string

Password to login to the vCenter server

port
required
integer <int64>

Port number of the vCenter server.

username
required
string

Username to login to the vCenter server

Responses

Request samples

Content type
application/json
{
  • "certChainPem": "-----BEGIN CERTIFICATE-----\nMIID2jCCAsKgAwIBAgIJAOiAEUfqLBfBMA0GCSqGSIb3DQEBCwUAMIGQMQswCQYD\n-----END CERTIFICATE-----\n",
  • "description": "vCenter - dataCenter1",
  • "inetaddress": "15.71.130.25",
  • "name": "dataCenter1",
  • "password": "pass",
  • "port": 443,
  • "username": "user1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete vcenter setting identified by {vcenterSettingId} on storage system HPE Alletra Storage MP identified by {systemId}

Delete vcenter setting identified by {vcenterSettingId} on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vcenterSettingId
required
string
Example: 7e92269a-12d1-35b4-60e8-5919edfc5475

UID(vcenterSettingId) of the storage system

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get vcenter setting detail for a given vcenter setting of a storage system HPE Alletra Storage MP

Get vcenter setting detail for a given vcenter setting of a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vcenterSettingId
required
string
Example: 7e92269a-12d1-35b4-60e8-5919edfc5475

UID(vcenterSettingId) of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/settings/system-settings",
  • "customerId": "fc5f41652a53497e88cdcebc715cc1ca",
  • "description": "sample vc description",
  • "friendlyCert": {
    },
  • "generation": 1627540916540,
  • "id": "c0e4e72b-c9d3-54a4-312f-4ec0f8da498a",
  • "inetaddress": "18.213.214.145",
  • "name": "sample_vc_name",
  • "port": 162,
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE809P009/vm-manager-settings/centerid123",
  • "resourceUri": "/api/v1/storage-systems/device-type4/7CE809P009/vm-manager-settings/centerid123",
  • "status": {
    },
  • "systemId": "7CE809P009",
  • "type": "vm-manager-settings",
  • "username": "SysAdmin@machine.local",
  • "vmManagerType": "hyperV"
}

Edit vCenter setting identified by {vcenterSettingId} on HPE Alletra Storage MP identified by {systemId}

Edit vCenter setting identified by {vcenterSettingId} on HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vcenterSettingId
required
string
Example: 7e92269a-12d1-35b4-60e8-5919edfc5475

UID(vcenterSettingId) of the storage system

Request Body schema: application/json
certChainPem
string

Certificate chain of the VCenter server as PEM data

description
string

Description of the vCenter setting

inetaddress
string

Host name or IP address of vCenter server

name
string

Name of the vCenter setting

password
string

Password to login to the vCenter server

port
integer <int64>

Port number of the vCenter server.

username
string

Username to login to the vCenter server

Responses

Request samples

Content type
application/json
{
  • "certChainPem": "-----BEGIN CERTIFICATE-----\nMIID2jCCAsKgAwIBAgIJAOiAEUfqLBfBMA0GCSqGSIb3DQEBCwUAMIGQMQswCQYD\n-----END CERTIFICATE-----\n",
  • "description": "vCenter - dataCenter1",
  • "inetaddress": "15.71.130.25",
  • "name": "dataCenter1",
  • "password": "pass",
  • "port": 443,
  • "username": "user1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

tasks

Tasks API

Returns a list of tasks accessible by the user

Returns a list of tasks that are visible to the user. The response can be paged by using the limit and offset query parameters and filtered, sorted and ordered by using the filter, sortby and orderby query parameters.

Authorizations:
JWTAuth
query Parameters
offset
integer
Example: offset=30

The offset query parameter should be used in conjunction with limit for paging, e.g.: offset=30&&limit=10. The offset is the number of items from the beginning of the result set to the first item included in the response.

limit
integer
Example: limit=10

The limit query parameter should be used in conjunction with offset for paging, e.g.: offset=30&&limit=10. The limit is the maximum number of items to include in the response.

filter
string
Example: filter=owner.name eq fred@example.com

The expression to filter responses.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 0,
  • "pageOffset": 0,
  • "total": 0
}

Returns details of a specific task

Returns the task with the given id.

Authorizations:
JWTAuth
path Parameters
id
required
string <uuid>
Example: c1a0eb78-41a0-4151-93b2-f057ffeca3f3

The UUID of the object

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "generation": 0,
  • "id": "string",
  • "name": "string",
  • "resourceUri": "string",
  • "type": "string",
  • "additionalDetails": {
    },
  • "associatedResources": [
    ],
  • "childTasks": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "displayName": "string",
  • "endedAt": "2019-08-24T14:15:22Z",
  • "error": {
    },
  • "estimatedRunningDurationMinutes": 0,
  • "healthStatus": "string",
  • "logMessages": [
    ],
  • "parentTask": {
    },
  • "progressPercent": 100,
  • "recommendations": [
    ],
  • "sourceResource": {
    },
  • "startedAt": "2019-08-24T14:15:22Z",
  • "state": "string",
  • "suggestedPollingIntervalSeconds": 0,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "userId": "string"
}

volume-sets

The Volume-sets API allows the management of volume sets

Get all volume-sets for a systemId

Get all volume sets for a systemId

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq volset and systemId eq 7CE751P312

oData query to filter by Key.

sort
string
Example: sort=systemId desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/applicationsets/14dbcb4be4836ff8f012a6d0118ba83a",
  • "total": 1
}

Get volume-set identified by id

Get volume-set identified by id

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: fd3244ef7f1ab8bd16500c7a41bdf8f8

UID of Volume Set

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "appType": "Oracle Database",
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP",
  • "customerId": "string",
  • "generation": 0,
  • "id": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0",
  • "name": "snap11",
  • "productFamily": "deviceType1",
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/applicationsets/14dbcb4be4836ff8f012a6d0118ba83a",
  • "resourceUri": "/v1/storage-systems/volume-sets",
  • "systemId": "7CE751P312",
  • "type": "string",
  • "volumesCount": 5
}

Get all applicationset details for Primera / Alletra 9K

Get all applicationset details for Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=uid eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter application-sets by Key.

sort
string
Example: sort=name desc

Lucene query to sort application-sets by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC01F0FF/applicationsets",
  • "total": 1
}

Create Application Set for a storage system Primera / Alletra 9K

Create Application Set for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
appSetBusinessUnit
string or null

App set business unit

appSetComments
string or null

App set comments

appSetImportance
string or null (volumeSetImportance)
Enum: "HIGHEST" "HIGH" "MEDIUM" "LOW" "LOWEST"

Priority of the Application Set. Defaults to MEDIUM

appSetName
required
string

App set name

appSetType
required
string or null (volumeSetApplicationType)
Enum: "ORACLE_DATA" "ORACLE_LOG" "MICROSOFT_EXCHANGE" "MICROSOFT_EXCHANGE_LOG" "MICROSOFT_SQL_SERVER" "MICROSOFT_SQL_SERVER_LOG" "VIRTUAL_SERVER_VMWARE_ESXI_STORAGE" "VIRTUAL_SERVER_HYPER_V_STORAGE" "VIRTUAL_DESKTOP_VMWARE_ESXI_STORAGE" "VIRTUAL_DESKTOP_HYPER_V_STORAGE" "SHAREPOINT" "FILE_SERVER" "VEEAM_BACKUP_REPOSITORY" "OTHER" "CUSTOM"

application type

object or null (CreateAppSetQosConfigInput)

Create QoS Configuration Input

customAppType
string or null

App set name for Custom workloads when appSetType=CUSTOM

members
Array of strings or null or null

volumes list

Responses

Request samples

Content type
application/json
{
  • "appSetBusinessUnit": "HPE",
  • "appSetComments": "Edit appset",
  • "appSetImportance": "MEDIUM",
  • "appSetName": "Appset_134",
  • "appSetType": "ORACLE_LOG",
  • "createAppSetQosConfigInput": {
    },
  • "customAppType": "CustomWorkload_123",
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Export applicationset identified by {appsetId} from Primera / Alletra 9K identified by {systemId}

Export applicationset identified by {appsetId} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Request Body schema: application/json
hostGroupIds
required
Array of strings or null or null

HostGroups

proximity
string
Enum: "PRIMARY" "SECONDARY" "ALL"

Host proximity setting for Active Peer Persistence configuration. Supported values are - PRIMARY, SECONDARY and ALL. Default proximity is PRIMARY.

Responses

Request samples

Content type
application/json
{
  • "hostGroupIds": [
    ],
  • "proximity": "PRIMARY"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Primera / Alletra 9K replication partners identified by {systemId} and {appsetId}

Get details of Primera / Alletra 9K replication partners identified by {systemId} and {appsetId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/applicationsets/0af26e4430948dd5c37bea1757107caf/replication-partners",
  • "total": 1
}

Get volume details of replication partners identified by {appsetId} and {replicationPartnerId} for Primera / Alletra 9K

Get volume details of replication partners identified by {appsetId} and {replicationPartnerId} for Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

replicationPartnerId
required
string
Example: aedec7d11d02f73611a6ff992c256bdb

id of device-type1 replication partner

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/applicationsets/0af26e4430948dd5c37bea1757107caf/replication-partners/0af26e4430548dd5c37bea1757107caf/volumes",
  • "total": 1
}

Remove Primera / Alletra 9K snapset in system identified by {snapsetId}

Remove Primera / Alletra 9K snapset in system identified by {snapsetId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

snapsetId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

Identifier of snapset.

query Parameters
force
boolean
Example: force=true

Make snapset offline and remove.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of snapsets identified by {snapsetId} for Applicationset identified by {appsetId} for Primera / Alletra 9K

Get details of snapset identified by {snapsetId} for Applicationset identified by {appsetId} for Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

snapsetId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

Identifier of snapset.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "appSetBusinessUnit": "cssl",
  • "appSetComments": "app set comments",
  • "appSetImportance": "NORMAL",
  • "appSetName": "KA_VEGA_APPSET1_186",
  • "appSetType": "Oracle Database",
  • "comment": "Comments",
  • "commonResourceAttributes": {
    },
  • "creationTime": {
    },
  • "customerId": "string",
  • "displayName": "Application Set KA_VEGA_APPSET1_186 ",
  • "domain": "Domain",
  • "exportStatus": "PARTIALLY_EXPORTED",
  • "generation": 0,
  • "id": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0",
  • "kvPairsPresent": true,
  • "members": [
    ],
  • "name": "KA_VEGA_APPSET2_186",
  • "requestUri": "/v1/storage-systems/device-type1/7CE751P312/applicationsets/fd3244ef7f1ab8bd16500c7a41bdf8f8/snapshots",
  • "serialNumber": "7CE738P06J",
  • "snapSetId": 5,
  • "snapSetParentId": 5,
  • "snapSetParentName": "HPE",
  • "systemId": "7CE751P312",
  • "type": "string",
  • "vvSetType": "VVSET"
}

Unexport applicationset identified by {appsetId} from Primera / Alletra 9K identified by {systemId}

Unexport applicationset identified by {appsetId} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Request Body schema: application/json
hostGroupIds
required
Array of strings or null or null

HostGroups

Responses

Request samples

Content type
application/json
{
  • "hostGroupIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get volumes for an applicationset identified by appsetUid

Get volumes for an applicationset identified by appsetUid

Authorizations:
JWTAuth
path Parameters
appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/primea/2FF70002AC018D94/volumes",
  • "total": 1
}

Delete applicationset identified by {id} from Primera / Alletra 9K identified by {systemId}

Delete applicationset identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get applicationset details for an applicationset identified by appsetUid

Get applicationset details for an applicationset identified by appsetUid

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "appSetBusinessUnit": "cssl",
  • "appSetComments": "app set comments",
  • "appSetExcludeAIQoS": "no",
  • "appSetId": 5,
  • "appSetImportance": "NORMAL",
  • "appSetName": "KA_VEGA_APPSET1_186",
  • "appSetQoSConfig": {
    },
  • "appSetType": "Oracle Database",
  • "appSetTypeEnum": "ORACLE_DATA",
  • "associatedLinks": [
    ],
  • "comment": "Comments",
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/applicationsets/fd3244ef7f1ab8bd16500c7a41bdf8f8",
  • "customerId": "string",
  • "displayName": "Application Set KA_VEGA_APPSET1_186 ",
  • "domain": "Domain",
  • "drState": "Normal",
  • "exportStatus": "PARTIALLY_EXPORTED",
  • "generation": 0,
  • "id": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0",
  • "initiators": [
    ],
  • "isFailoverAllowed": true,
  • "isOverrideAllowed": false,
  • "isPrimary": true,
  • "isSyncAllowed": true,
  • "kvPairsPresent": true,
  • "members": [
    ],
  • "name": "KA_VEGA_APPSET2_186",
  • "nonZeroRtoConfig": "ActiveSync",
  • "remoteRecoveryPoint": {
    },
  • "replicationPartner": [
    ],
  • "replicationState": "Started",
  • "replicationTraffic": "Sending",
  • "replicationType": "periodic",
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC01F0FF/applicationsets/fd3244ef7f1ab8bd16500c7a41bdf8f8",
  • "role": "Primary",
  • "serialNumber": "7CE738P06J",
  • "sizeMiB": 153600,
  • "snapSetParentId": 5,
  • "snapSetParentName": "HPE",
  • "systemId": "7CE751P312",
  • "type": "string",
  • "vvSetType": "VVSET",
  • "zeroRtoConfig": "PP"
}

Edit applicationset identified by {id} from Primera / Alletra 9K identified by {systemId}

Edit applicationset identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Request Body schema: application/json
addMembers
Array of strings or null or null

Members to add to application set

appSetBusinessUnit
string or null

App set business unit

appSetComments
string or null

App set comments

appSetImportance
string or null (volumeSetImportance)
Enum: "HIGHEST" "HIGH" "MEDIUM" "LOW" "LOWEST"

Priority of the Application Set. Defaults to MEDIUM

appSetName
string or null

App set name

appSetType
string or null (volumeSetApplicationType)
Enum: "ORACLE_DATA" "ORACLE_LOG" "MICROSOFT_EXCHANGE" "MICROSOFT_EXCHANGE_LOG" "MICROSOFT_SQL_SERVER" "MICROSOFT_SQL_SERVER_LOG" "VIRTUAL_SERVER_VMWARE_ESXI_STORAGE" "VIRTUAL_SERVER_HYPER_V_STORAGE" "VIRTUAL_DESKTOP_VMWARE_ESXI_STORAGE" "VIRTUAL_DESKTOP_HYPER_V_STORAGE" "SHAREPOINT" "FILE_SERVER" "VEEAM_BACKUP_REPOSITORY" "OTHER" "CUSTOM"

application type

customAppType
string or null

App set name for Custom workloads when appSetType=CUSTOM

object or null (EditAppSetQosConfigInput)

Edit QoS Configuration Input

removeMembers
Array of strings or null or null

Members to remove from application set

Responses

Request samples

Content type
application/json
{
  • "addMembers": [
    ],
  • "appSetBusinessUnit": "HPE",
  • "appSetComments": "Edit appset",
  • "appSetImportance": "MEDIUM",
  • "appSetName": "Appset_134",
  • "appSetType": "ORACLE_LOG",
  • "customAppType": "CustomWorkload_123",
  • "editAppSetQosConfigInput": {
    },
  • "removeMembers": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get capacity details for an applicationset identified by appsetUid

Get capacity details for an applicationset identified by appsetUid

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "capacitySummary": {
    },
  • "customerId": "string",
  • "id": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0",
  • "members": [
    ],
  • "name": "KA_VEGA_APPSET2_186",
  • "requestUri": "/v1/storage-systems/device-type1/SGH029VBHV/applicationsets/fd3244ef7f1ab8bd16500c7a41bdf8f8/capacity-statistics",
  • "systemId": "7CE751P312"
}

Get details of protection policies configured on application set identified by {id} created on Primera / Alletra 9K identified by {systemId}

Get details of protection policies configured on application set identified by {id} created on Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

filter
string
Example: filter=uid eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter application-sets by Key.

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE815P2BH/applicationsets/1c401e3d034598ac41264651a34736e7/protection-policies",
  • "total": 1
}

Add protection policy on application set identified by {id} for a storage system Primera / Alletra 9K identified by {systemId}

Add protection policy on application set identified by {id} for a storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object

Protection policy details

protectionPolicyType
required
string
Enum: "schedule" "sync" "async"

Specifies Protection policy type. Synchronous replication/protection policy provides protection from array or site failures with zero RPO. Using this policy, you can also configure zero RTO policy like Active Peer Persistence. Asynchronous replication/protection policy provides protection from array or site failure with the user defined RPO. Schedule snapshot policy takes snapshots of the member volumes of the protected volume set at periodic intervals defined by the user. You can setup the local snapshot schedule and also setup the co-ordinated synchronized snapshot schedule on the protected volume set configured with synchronous or asynchronous replication policy. You can do this by attaching a scheduled snapshot policy on the volume set having already a synchronous or asynchronous protecting policy.

Array of objects (PrimeraProtectionScheduleInputSchema)

Responses

Request samples

Content type
application/json
{
  • "policy": {
    },
  • "protectionPolicyType": "schedule",
  • "schedules": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit protection policy on application set identified by {id} for a storage system Primera / Alletra 9K identified by {systemId}

Edit protection policy on application set identified by {id} for a storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
Array of objects (PrimeraProtectionScheduleInputSchema)
Array of objects (ModifyProtectionScheduleInputSchema)
object

Protection policy details

protectionPolicyType
required
string
Enum: "schedule" "sync" "async"

Specifies Protection policy type. Synchronous replication/protection policy provides protection from array or site failures with zero RPO. Using this policy, you can also configure zero RTO policy like Active Peer Persistence. Asynchronous replication/protection policy provides protection from array or site failure with the user defined RPO. Schedule snapshot policy takes snapshots of the member volumes of the protected volume set at periodic intervals defined by the user. You can setup the local snapshot schedule and also setup the co-ordinated synchronized snapshot schedule on the protected volume set configured with synchronous or asynchronous replication policy. You can do this by attaching a scheduled snapshot policy on the volume set having already a synchronous or asynchronous protecting policy.

Array of objects (RemoveProtectionScheduleInputSchema)

Responses

Request samples

Content type
application/json
{
  • "createSchedules": [
    ],
  • "modifySchedules": [
    ],
  • "policy": {
    },
  • "protectionPolicyType": "schedule",
  • "removeSchedules": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Fix protection policy configuration on application set identified by {id} for a storage system Primera / Alletra 9K identified by {systemId}

Remedies issues caused in protection policy configuration on application set identified by {id} for a storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object

Protection policy details

protectionPolicyType
required
string
Enum: "schedule" "sync" "async"

Specifies Protection policy type. Synchronous replication/protection policy provides protection from array or site failures with zero RPO. Using this policy, you can also configure zero RTO policy like Active Peer Persistence. Asynchronous replication/protection policy provides protection from array or site failure with the user defined RPO. Schedule snapshot policy takes snapshots of the member volumes of the protected volume set at periodic intervals defined by the user. You can setup the local snapshot schedule and also setup the co-ordinated synchronized snapshot schedule on the protected volume set configured with synchronous or asynchronous replication policy. You can do this by attaching a scheduled snapshot policy on the volume set having already a synchronous or asynchronous protecting policy.

Array of objects (PrimeraProtectionScheduleInputSchema)

Responses

Request samples

Content type
application/json
{
  • "policy": {
    },
  • "protectionPolicyType": "schedule",
  • "schedules": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove protection policy on application set identified by {id} for a storage system Primera / Alletra 9K identified by {systemId}

Remove protection policy on application set identified by {id} for a storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
required
Array of objects (RemoveProtectionPolicyInputSchema)

List of protection policies to be removed

Responses

Request samples

Content type
application/json
{
  • "policies": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get hosts and proximity details identified by application set {id} for Primera / Alletra 9K identified by {systemId}

Get hosts and proximity details identified by application set {id} for Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "resourceURI": "/api/v1/storage-systems/device-type1/2FF70002AC018D94/applicationsets/9c3c4f29a82fd8d632ff379116fa0b8f/proximity-settings",
  • "total": 1
}

Change proximity settings of hosts where volume sets are exported identified by {id} and {systemId} from Primera / Alletra 9K

Change proximity settings of hosts where volume sets are exported identified by {id} and {systemId} from Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Request Body schema: application/json
required
Array of objects (HostProximityInput)

Responses

Request samples

Content type
application/json
{
  • "hosts": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Actions on volume set identified by {id} and {systemId} from Primera / Alletra 9K

Actions on volume set identified by {id} and {systemId} from Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

Request Body schema: application/json
action
string
Enum: "FAILOVER" "SYNC" "OVERRIDE" "START" "STOP" "RECOVER" "RESTORE" "SWITCHOVER" "REVERSE"

Actions on the volume set where remote protection is enabled.

object (RemoteProtectionActionsInputParams)

Responses

Request samples

Content type
application/json
{
  • "action": "SYNC",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get snapshot details of volume sets identified by {id} for Primera / Alletra 9K

Get snapshot details of volume sets identified by {id} for Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/snapshots",
  • "total": 1
}

Create snapshot for application set identified by {id}

Create snapshot for application set identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Request Body schema: application/json
comment
string or null

Comment if any

expireSecs
integer or null

Expiration time in seconds

readOnly
boolean or null

Read only or Read/Write

retainSecs
integer or null <int64>

Reatain time in seconds

snapshotName
required
string or null

Name for snapshot

vvNamePattern
required
string or null (vvNamePattern)
Enum: "PARENT_TIMESTAMP" "PARENT_SEC_SINCE_EPOCH"

name pattern

Responses

Request samples

Content type
application/json
{
  • "comment": "",
  • "expireSecs": 100,
  • "readOnly": false,
  • "retainSecs": 86400,
  • "snapshotName": "snapshot_oracle_1611807822",
  • "vvNamePattern": "PARENT_TIMESTAMP"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get supported protection types for application set identified by {id} on storage system Primera / Alletra 9K identified by {systemId}

Get supported protection types for application set identified by {id} on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

Responses

Response samples

Content type
application/json
{
  • "asyncPartners": [
    ],
  • "commonResourceAttributes": {
    },
  • "customerId": "string",
  • "generation": 0,
  • "isSLDSupported": true,
  • "protectionTypes": [
    ],
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE815P2BH/applicationsets/6e6266d344de3e32b10424466c7d01bb/supportedProtectionTypes",
  • "syncPartners": [
    ]
}

Get all folders details by Nimble / Alletra 6K

Get all folders details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter folders by Key.

sort
string
Example: sort=name desc

oData query to sort folders resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/folders",
  • "total": 1
}

Get all volume-collections details by Nimble / Alletra 6K

Get all volume-collections details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter volume-collection by Key.

sort
string
Example: sort=name desc

oData query to sort volume-collection resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/volume-collections",
  • "total": 1
}

Create Nimble / Alletra 6K volume collection in system identified by {systemId}

Create Nimble / Alletra 6K volume collection in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
agent_hostname
string or null

Generic backup agent hostname. Custom port number can be specified with agent hostname using \":\". String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

agent_username
string or null

Generic backup agent username. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_cluster_name
string or null

If the application is running within a Windows cluster environment, this is the cluster name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_id
string or null

Application ID running on the server. Application ID can only be specified if application synchronization is \"vss\". Possible values: 'inval', 'exchange', 'exchange_dag', 'hyperv', 'sql2005', 'sql2008', 'sql2012', 'sql2014', 'sql2016', 'sql2017'.

app_server
string or null

Application server hostname. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_service_name
string or null

If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_sync
string or null

Application Synchronization. Possible values: 'none', 'vss', 'vmware', 'generic'.

description
string or null

Text description of volume collection. String of up to 255 printable ASCII characters.

is_standalone_volcoll
boolean or null
Deprecated

Indicates whether this is a standalone volume collection. Possible values: 'true', 'false'.

Array of objects or null or null (KeyValue)

Key-value pairs that augment a volume collection's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed.

name
required
string

Name of volume collection. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

prottmpl_id
string or null

Identifier of the protection template whose attributes will be used to create this volume collection. This attribute is only used for input when creating a volume collection and is not outputed. A 42 digit hexadecimal number.

replication_type
string or null

Type of replication configured for the volume collection. Possible values are periodic snapshot and synchronous. Default value is periodic_snapshot.

vcenter_hostname
string or null

VMware vCenter hostname. Custom port number can be specified with vCenter hostname using \":\". String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

vcenter_username
string or null

Application VMware vCenter username. String of up to 80 alphanumeric characters, beginning with a letter. It can include ampersand (@), backslash (), dash (-), period (.), and underscore (_).

volume_list
Array of strings or null or null

List of volume id's that need to be added to the volume collection.

Responses

Request samples

Content type
application/json
{
  • "agent_hostname": "myobject-5",
  • "agent_username": "myobject-5",
  • "app_cluster_name": "myobject-5",
  • "app_id": "inval",
  • "app_server": "myobject-5",
  • "app_service_name": "myobject-5",
  • "app_sync": "vss",
  • "description": "99.9999% availability",
  • "is_standalone_volcoll": true,
  • "metadata": [
    ],
  • "name": "myobject-5",
  • "prottmpl_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "replication_type": "periodic_snapshot",
  • "vcenter_hostname": "myobject-5",
  • "vcenter_username": "administrator@vsphere.local",
  • "volume_list": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove Volume-collection identified by {volumeCollectionId} from Nimble / Alletra 6K

Remove Volume-collection identified by {volumeCollectionId} from Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of Volume Collection. A 42 digit hexadecimal number.

query Parameters
force
boolean
Example: force=true

Forceful delete volume collection option.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K volume-collections identified by {volumeCollectionId}

Get details of Nimble / Alletra 6K volume-collections identified by {volumeCollectionId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of volumeCollection. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/volume-collections/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "app_cluster_name": "myobject-5",
  • "app_id": "hyperv",
  • "app_server": "myobject-5",
  • "app_service_name": "myobject-5",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "name": "vol",
  • "prottmpl_id": "myobject-5",
  • "replication_type": "periodic_snapshot",
  • "synchronous_replication_state": "Failed",
  • "synchronous_replication_type": "not_applicable",
  • "agent_hostname": "myobject-5",
  • "app_sync": "vss",
  • "associated_links": [
    ],
  • "cache_pinned_volume_list": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type2/001491cb6652a03a6b000000000000000000000001/volume-collections/071491cb6652a03a6b000000000000000000000006",
  • "creation_time": 1599110308,
  • "customerId": "string",
  • "description": "99.9999% availability",
  • "downstream_volume_list": [
    ],
  • "full_name": "vol",
  • "generation": 0,
  • "handover_replication_partner": "myobject-5",
  • "is_handing_over": false,
  • "is_mfa_protected": true,
  • "is_standalone_volcoll": false,
  • "lag_time": 3400,
  • "last_replicated_snapcoll": {
    },
  • "last_replicated_snapcoll_list": [
    ],
  • "last_snapcoll": {
    },
  • "metadata": [
    ],
  • "pol_owner_name": "system1",
  • "protection_type": "local",
  • "repl_bytes_transferred": 1234,
  • "repl_priority": "high",
  • "replication_partner": [
    ],
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "schedule_list": [
    ],
  • "search_name": "vol",
  • "snapcoll_count": 1,
  • "srep_last_sync": 0,
  • "srep_resync_percent": 10,
  • "total_repl_bytes": 1234,
  • "type": "string",
  • "upstream_volume_list": [
    ],
  • "vcenter_hostname": "myobject-5",
  • "vcenter_username": "administrator@vsphere.local",
  • "volcoll_creator_id": "0600000000000004d3000000000044000000000002",
  • "volcoll_creator_name": "AF-123456",
  • "volume_count": 1,
  • "volume_list": [
    ]
}

Edit details of Nimble / Alletra 6K Volume-collections identified by {volumeCollectionId}

Edit details of Nimble / Alletra 6K Volume-collections identified by {volumeCollectionId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of volumeCollection. A 42 digit hexadecimal number.

Request Body schema: application/json
agent_hostname
string or null

Generic backup agent hostname. Custom port number can be specified with agent hostname using \":\". String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

agent_username
string or null

Generic backup agent username. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_cluster_name
string or null

If the application is running within a Windows cluster environment, this is the cluster name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_id
string or null

Application ID running on the server. Application ID can only be specified if application synchronization is \"vss\". Possible values: 'inval', 'exchange', 'exchange_dag', 'hyperv', 'sql2005', 'sql2008', 'sql2012', 'sql2014', 'sql2016', 'sql2017'.

app_server
string or null

Application server hostname. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_service_name
string or null

If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

app_sync
string or null

Application Synchronization. Possible values: 'none', 'vss', 'vmware', 'generic'.

description
string or null

Text description of volume collection. String of up to 255 printable ASCII characters.

name
string or null

Name of volume collection. String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

vcenter_hostname
string or null

VMware vCenter hostname. Custom port number can be specified with vCenter hostname using \":\". String of up to 64 alphanumeric characters, - and . and : are allowed after first character.

vcenter_username
string or null

Application VMware vCenter username. String of up to 80 alphanumeric characters, beginning with a letter. It can include ampersand (@), backslash (), dash (-), period (.), and underscore (_).

Responses

Request samples

Content type
application/json
{
  • "agent_hostname": "myobject-5",
  • "agent_username": "myobject-5",
  • "app_cluster_name": "myobject-5",
  • "app_id": "inval",
  • "app_server": "myobject-5",
  • "app_service_name": "myobject-5",
  • "app_sync": "vss",
  • "description": "99.9999% availability",
  • "name": "myobject-5",
  • "vcenter_hostname": "myobject-5",
  • "vcenter_username": "administrator@vsphere.local"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Perform abort handover action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Perform abort handover action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of Volume Collection. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Add volumes to Nimble / Alletra 6K volumes collection in system identified by {systemId}

Add volumes to Nimble / Alletra 6K volumes collection in system identified by {systemId

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of volumeCollection. A 42 digit hexadecimal number.

Request Body schema: application/json
volume_ids
Array of strings or null or null

Volume ids that need to be added to volume collections.

Responses

Request samples

Content type
application/json
{
  • "volume_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Perform demote action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Perform demote action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of Volume Collection. A 42 digit hexadecimal number.

Request Body schema: application/json
invoke_on_upstream_partner
boolean or null

Invoke demote request on upstream partner. Default: 'false'. Possible values: 'true', 'false'.

replication_partner_id
required
string

Replication partner ID of the new owner. A 42 digit hexadecimal number.

Responses

Request samples

Content type
application/json
{
  • "invoke_on_upstream_partner": true,
  • "replication_partner_id": "2a0df0fe6f7dc7bb16000000000000000000004817"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Perform handover action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Perform handover action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of Volume Collection. A 42 digit hexadecimal number.

Request Body schema: application/json
invoke_on_upstream_partner
boolean or null

Invoke handover request on upstream partner. Default: 'false'. This operation is not supported for synchronous replication volume vollections. Possible values: 'true', 'false'.

no_reverse
boolean or null

Do not automatically reverse direction of replication. Using this argument will prevent the new owner from automatically replicating the volume collection to this node when the handover completes. The default behavior is to enable replication back to this node. Default: 'false'. Possible values: 'true', 'false'.

override_upstream_down
boolean or null

Allow the handover request to proceed even if upstream array is down. The default behavior is to return an error when upstream is down. This option is applicable for synchronous replication only. Default: 'false'. Possible values: 'true', 'false'.

replication_partner_id
required
string

Replication partner ID of the new owner. A 42 digit hexadecimal number.

Responses

Request samples

Content type
application/json
{
  • "invoke_on_upstream_partner": false,
  • "no_reverse": false,
  • "override_upstream_down": false,
  • "replication_partner_id": "2a0df0fe6f7dc7bb16000000000000000000004817"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Perform promote action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Perform promote action Nimble / Alletra 6K on a volume collection identified by {volumeCollectionId} in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of Volume Collection. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove volumes from Nimble / Alletra 6K volumes collection in system identified by {systemId}

Remove volumes from Nimble / Alletra 6K volumes collection in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

Identifier of volumeCollection. A 42 digit hexadecimal number.

Request Body schema: application/json
volume_ids
Array of strings or null

Volume ids that need to be remove from volume collections.

Responses

Request samples

Content type
application/json
{
  • "volume_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get all snapshot collections' details of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId}

Get all snapshot collections' details of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of Volume Collection. A 42 digit hexadecimal number.

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter snapshot collections by Key.

sort
string
Example: sort=name desc

oData query to sort snapshot collections resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/volume-collections/0625dab4ed8948f2e000000000000000000000003a/snapshot-collections",
  • "total": 1
}

Create Nimble / Alletra 6K snapshot collection in system identified by {systemId}

Create Nimble / Alletra 6K snapshot collection in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of Volume Collection. A 42 digit hexadecimal number.

Request Body schema: application/json
agent_type
string or null

External management agent type for snapshots being created as part of snapshot collection. Possible values: 'none', 'smis', 'vvol', 'openstack', 'openstackv2'.

allow_writes
boolean or null

Atollow applications to write to created snapshot(s). Mandatory and must be set to 'true' for VSS application synchronized snapshots. Possible values: 'true', 'false'.

description
string or null

Text description of snapshot collection. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.

disable_appsync
boolean or null

Do not perform application synchronization for this snapshot, create a crash-consistent snapshot instead. Possible values: 'true', 'false'.

invoke_on_upstream_partner
boolean or null

Invoke snapshot request on upstream partner. Possible values: 'true', 'false'.

is_external_trigger
boolean or null

Is externally triggered. Possible values: 'true', 'false'.

lock_period
integer or null <int64>

Number of seconds to keep a snapshot as immutable.

Array of objects or null or null (KeyValue)

Key-value pairs that augment a snapshot collection's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed.

name
required
string

Name of snapshot collection. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints.

replicate
boolean or null

True if this snapshot collection has been marked for replication. Possible values: 'true', 'false'.

replicate_to
string or null

Specifies the partner name that the snapshots in this snapshot collection are replicated to. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.

skip_db_consistency_check
boolean or null

Skip consistency check for database files on this snapshot. This option only applies to volume collections with application synchronization set to VSS, application ID set to MS Exchange 2010 or later with Database Availability Group (DAG), snap_verify option set to true, and disable_appsync option set to false. Possible values: 'true', 'false'.

snap_verify
boolean or null

Run verification tool on this snapshot. This option can only be used with a volume collection that has application synchronization. Possible values: 'true', 'false'.

start_online
boolean or null

Start with snapshot set online. Possible values: 'true', 'false'.

Array of objects or null or null (NimbleVolumeSnapAttr)

List of snapshot attributes for snapshots being created as part of snapshot collection creation. List of volumes with per snapshot attributes.

Responses

Request samples

Content type
application/json
{
  • "agent_type": "string",
  • "allow_writes": true,
  • "description": "99.9999% availability",
  • "disable_appsync": true,
  • "invoke_on_upstream_partner": true,
  • "is_external_trigger": false,
  • "lock_period": 0,
  • "metadata": [
    ],
  • "name": "snap1",
  • "replicate": true,
  • "replicate_to": "string",
  • "skip_db_consistency_check": true,
  • "snap_verify": true,
  • "start_online": true,
  • "vol_snap_attr_list": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of snapshot collection of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId} by {snapshotId}

Get details of snapshot collection of Nimble / Alletra 6K Volume collection identified by {volumeCollectionId} by {snapshotId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of Volume Collection. A 42 digit hexadecimal number.

snapshotCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of snapshot Collection. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/volumes/0625dab4ed8948f2e000000000000000000000003a/snapshots/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "has_locked_snapshots": true,
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "name": "snap1",
  • "online_status": "online",
  • "sched_id": "2a1df0fe6f7dc7bb16000000000000000000004017",
  • "schedule_id": "2a1df0fe6f7dc7bb16000000000000000000004017",
  • "srep_owner_id": "2a1df0fe6f7dc7bb16000000000000000000004017",
  • "volcoll_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "allow_writes": false,
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "creation_time": 1598951404,
  • "customerId": "string",
  • "description": "99.9999% availability",
  • "generation": 0,
  • "is_complete": false,
  • "is_external_trigger": false,
  • "is_manual": false,
  • "is_manually_managed": false,
  • "is_mfa_protected": true,
  • "is_replica": false,
  • "is_unmanaged": true,
  • "last_modified": 1598952427,
  • "metadata": [
    ],
  • "origin_name": "myobject-5",
  • "peer_snapcoll_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "repl_status": "in_progress",
  • "replicate": false,
  • "replicate_to": "myobject-5",
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "snapshots_list": [
    ],
  • "type": "string",
  • "volcoll_creator_id": "0600000000000004d3000000000044000000000002",
  • "volcoll_creator_name": "AF-123456"
}

Remove multiple snapshot collections identified by {volumeCollectionId} from Nimble / Alletra 6K

Remove multiple snapshot collections identified by {volumeCollectionId} from Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of Volume Collection. A 42 digit hexadecimal number.

Request Body schema: application/json
force
boolean or null

Force remove.

required
Array of objects (SnapshotCollectionAction)

List of snapshot collections to be deleted.

Responses

Request samples

Content type
application/json
{
  • "force": true,
  • "snapshot_collections": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Perform offline/online action on snapshot collections of Nimble / Alletra 6K and associated with volume collection {volumeCollectionId} in the system identified by {systemId}

Perform offline/online action on snapshot collections of Nimble / Alletra 6K and associated with volume collection {volumeCollectionId} in the system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeCollectionId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of Volume Collection. A 42 digit hexadecimal number.

Request Body schema: application/json
online
required
boolean

Online state for the corresponding snapshots. For a snapshot, 'online' means it could be mounted for data restore.

snapshot_collection_ids
required
Array of strings

List of IDs of snapshot collections to be set online/offline.

Responses

Request samples

Content type
application/json
{
  • "online": true,
  • "snapshot_collection_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get all applicationset details for HPE Alletra Storage MP

Get all applicationset details for HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=uid eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter application-sets by Key.

sort
string
Example: sort=name desc

Lucene query to sort application-sets by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC01F0FF/applicationsets",
  • "total": 1
}

Create Application Set for a storage system HPE Alletra Storage MP

Create Application Set for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
appSetBusinessUnit
string or null

App set business unit

appSetComments
string or null

App set comments

appSetImportance
string or null (DeviceType4VsAppSetImportance)
Deprecated
Enum: "HIGHEST" "HIGH" "MEDIUM" "LOW" "LOWEST"

Priority of the Application Set. Defaults to MEDIUM. This field is deprecated.

appSetName
required
string

App set name

appSetType
required
string or null (DeviceType4VolumeSetApplicationType)
Enum: "ORACLE_DATA" "ORACLE_LOG" "MICROSOFT_EXCHANGE" "MICROSOFT_EXCHANGE_LOG" "MICROSOFT_SQL_SERVER" "MICROSOFT_SQL_SERVER_LOG" "VIRTUAL_SERVER_VMWARE_ESXI_STORAGE" "VIRTUAL_SERVER_HYPER_V_STORAGE" "VIRTUAL_DESKTOP_VMWARE_ESXI_STORAGE" "VIRTUAL_DESKTOP_HYPER_V_STORAGE" "SHAREPOINT" "FILE_SERVER" "VEEAM_BACKUP_REPOSITORY" "OTHER" "CUSTOM"

application type

object or null (DeviceType4CreateAppSetQosConfigInput)

Create QoS Configuration Input (Applicable for OS version 10.4.0 and above)

customAppType
string or null

App set name for Custom workloads when appSetType=CUSTOM

members
Array of strings or null or null

volumes list

Responses

Request samples

Content type
application/json
{
  • "appSetBusinessUnit": "HPE",
  • "appSetComments": "Edit appset",
  • "appSetImportance": "MEDIUM",
  • "appSetName": "Appset_134",
  • "appSetType": "ORACLE_LOG",
  • "createAppSetQosConfigInput": {
    },
  • "customAppType": "CustomWorkload_123",
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Export applicationset identified by {appsetId} from HPE Alletra Storage MP identified by {systemId}

Export applicationset identified by {appsetId} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Request Body schema: application/json
Array of objects or null

Host Group IDs and the corresponding attributes for each host group ID. NVMe transport type for each host Group ID is defined in this map and it is applicable if all the hosts of this host group are associated with the NVMe protocol.

hostGroupIds
required
Array of strings or null or null

HostGroups

proximity
string
Enum: "PRIMARY" "SECONDARY" "ALL"

Host proximity setting for Active Peer Persistence configuration. Supported values are - PRIMARY, SECONDARY and ALL. Default proximity is PRIMARY.

Responses

Request samples

Content type
application/json
{
  • "hostGroupDataMap": [
    ],
  • "hostGroupIds": [
    ],
  • "proximity": "PRIMARY"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of HPE Alletra Storage MP replication partners identified by {systemId} and {appsetId}

Get details of HPE Alletra Storage MP replication partners identified by {systemId} and {appsetId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312/applicationsets/0af26e4430948dd5c37bea1757107caf/replication-partners",
  • "total": 1
}

Get volume details of replication partners identified by {appsetId} and {replicationPartnerId} for HPE Alletra Storage MP

Get volume details of replication partners identified by {appsetId} and {replicationPartnerId} for HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

replicationPartnerId
required
string
Example: aedec7d11d02f73611a6ff992c256bdb

id of device-type1 replication partner

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE751P312/applicationsets/0af26e4430948dd5c37bea1757107caf/replication-partners/0af26e4430548dd5c37bea1757107caf/volumes",
  • "total": 1
}

Remove HPE Alletra Storage MP snapset in system identified by {snapsetId}

Remove HPE Alletra Storage MP snapset in system identified by {snapsetId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

snapsetId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

Identifier of snapset.

query Parameters
force
boolean
Example: force=true

Make snapset offline and remove.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of snapsets identified by {snapsetId} for Applicationset identified by {appsetId} for HPE Alletra Storage MP

Get details of snapset identified by {snapsetId} for Applicationset identified by {appsetId} for HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

snapsetId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

Identifier of snapset.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "Mode": "RO",
  • "appSetBusinessUnit": "cssl",
  • "appSetComments": "app set comments",
  • "appSetImportance": "NORMAL",
  • "appSetName": "KA_VEGA_APPSET1_186",
  • "appSetType": "Oracle Database",
  • "comment": "Comments",
  • "commonResourceAttributes": {
    },
  • "creationTime": {
    },
  • "customerId": "string",
  • "displayName": "Application Set KA_VEGA_APPSET1_186 ",
  • "domain": "Domain",
  • "exportStatus": "PARTIALLY_EXPORTED",
  • "generation": 0,
  • "id": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0",
  • "kvPairsPresent": true,
  • "members": [
    ],
  • "name": "KA_VEGA_APPSET2_186",
  • "requestUri": "/v1/storage-systems/device-type4/7CE751P312/applicationsets/fd3244ef7f1ab8bd16500c7a41bdf8f8/snapshots",
  • "serialNumber": "7CE738P06J",
  • "snapSetId": 5,
  • "snapSetParentId": 5,
  • "snapSetParentName": "HPE",
  • "systemId": "7CE751P312",
  • "type": "string",
  • "vvSetType": "VVSET"
}

Unexport applicationset identified by {appsetId} from HPE Alletra Storage MP identified by {systemId}

Unexport applicationset identified by {appsetId} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Request Body schema: application/json
hostGroupIds
required
Array of strings or null or null

HostGroups

Responses

Request samples

Content type
application/json
{
  • "hostGroupIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get volumes for an applicationset identified by appsetUid

Get volumes for an applicationset identified by appsetUid

Authorizations:
JWTAuth
path Parameters
appsetId
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/primea/2FF70002AC018D94/volumes",
  • "total": 1
}

Remove applicationset identified by {id} from HPE Alletra Storage MP identified by {systemId}

Remove applicationset identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get applicationset details for an applicationset identified by appsetUid

Get applicationset details for an applicationset identified by appsetUid

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "appSetBusinessUnit": "cssl",
  • "appSetComments": "app set comments",
  • "appSetExcludeAIQoS": "no",
  • "appSetId": 5,
  • "appSetImportance": "NORMAL",
  • "appSetName": "KA_VEGA_APPSET1_186",
  • "appSetQoSConfig": {
    },
  • "appSetType": "Oracle Database",
  • "appSetTypeEnum": "ORACLE_DATA",
  • "associatedLinks": [
    ],
  • "comment": "Comments",
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/applicationsets/fd3244ef7f1ab8bd16500c7a41bdf8f8",
  • "customerId": "string",
  • "displayName": "Application Set KA_VEGA_APPSET1_186 ",
  • "domain": "Domain",
  • "drState": "Normal",
  • "exportStatus": "PARTIALLY_EXPORTED",
  • "generation": 0,
  • "id": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0",
  • "initiators": [
    ],
  • "isFailoverAllowed": true,
  • "isOverrideAllowed": false,
  • "isPrimary": true,
  • "isSyncAllowed": true,
  • "kvPairsPresent": true,
  • "members": [
    ],
  • "name": "KA_VEGA_APPSET2_186",
  • "nonZeroRtoConfig": "ActiveSync",
  • "remoteRecoveryPoint": {
    },
  • "replicationPartner": [
    ],
  • "replicationState": "Started",
  • "replicationTraffic": "Sending",
  • "replicationType": "periodic",
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC01F0FF/applicationsets/fd3244ef7f1ab8bd16500c7a41bdf8f8",
  • "role": "Primary",
  • "serialNumber": "7CE738P06J",
  • "shortName": "VegaApplications~886",
  • "sizeMiB": 153600,
  • "snapSetParentId": 5,
  • "snapSetParentName": "HPE",
  • "systemId": "7CE751P312",
  • "type": "string",
  • "vvSetType": "VVSET",
  • "zeroRtoConfig": "PP"
}

Edit applicationset identified by {id} from HPE Alletra Storage MP identified by {systemId}

Edit applicationset identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Request Body schema: application/json
addMembers
Array of strings or null or null

Members to add to application set

appSetBusinessUnit
string or null

App set business unit

appSetComments
string or null

App set comments

appSetImportance
string or null (DeviceType4VsAppSetImportance)
Deprecated
Enum: "HIGHEST" "HIGH" "MEDIUM" "LOW" "LOWEST"

Priority of the Application Set. Defaults to MEDIUM. This field is deprecated.

appSetName
string or null

App set name

appSetType
string or null (DeviceType4volumeSetApplicationTypePut)
Enum: "ORACLE_DATA" "ORACLE_LOG" "MICROSOFT_EXCHANGE" "MICROSOFT_EXCHANGE_LOG" "MICROSOFT_SQL_SERVER" "MICROSOFT_SQL_SERVER_LOG" "VIRTUAL_SERVER_VMWARE_ESXI_STORAGE" "VIRTUAL_SERVER_HYPER_V_STORAGE" "VIRTUAL_DESKTOP_VMWARE_ESXI_STORAGE" "VIRTUAL_DESKTOP_HYPER_V_STORAGE" "SHAREPOINT" "FILE_SERVER" "VEEAM_BACKUP_REPOSITORY" "OTHER" "CUSTOM"

Application set type. Not applicable for OS Version 10.4.0 and above.

customAppType
string or null

App set name for Custom workloads when appSetType=CUSTOM

object or null (DeviceType4EditAppSetQosConfigInput)

Edit QoS Configuration Input (Applicable for OS version 10.4.0 and above)

removeMembers
Array of strings or null or null

Members to remove from application set

Responses

Request samples

Content type
application/json
{
  • "addMembers": [
    ],
  • "appSetBusinessUnit": "HPE",
  • "appSetComments": "Edit appset",
  • "appSetImportance": "MEDIUM",
  • "appSetName": "Appset_134",
  • "appSetType": "ORACLE_LOG",
  • "customAppType": "CustomWorkload_123",
  • "editAppSetQosConfigInput": {
    },
  • "removeMembers": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get capacity details for an applicationset identified by appsetUid

Get capacity details for an applicationset identified by appsetUid

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "capacitySummary": {
    },
  • "commonResourceAttributes": {
    },
  • "customerId": "string",
  • "id": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0",
  • "members": [
    ],
  • "name": "KA_VEGA_APPSET2_186",
  • "requestUri": "/v1/storage-systems/device-type4/SGH029VBHV/applicationsets/fd3244ef7f1ab8bd16500c7a41bdf8f8/capacity-statistics",
  • "systemId": "7CE751P312"
}

Get details of protection policies configured on application set identified by {id} created on HPE Alletra Storage MP identified by {systemId}

Get details of protection policies configured on application set identified by {id} created on HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

filter
string
Example: filter=uid eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter application-sets by Key.

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE815P2BH/applicationsets/1c401e3d034598ac41264651a34736e7/protection-policies",
  • "total": 1
}

Add protection policy on application set identified by {id} for a storage system HPE Alletra Storage MP identified by {systemId}

Add protection policy on application set identified by {id} for a storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object

Protection policy details

protectionPolicyType
required
string
Enum: "schedule" "sync" "async"

Specifies Protection policy type. Synchronous replication/protection policy provides protection from array or site failures with zero RPO. Using this policy, you can also configure zero RTO policy like Active Peer Persistence. Asynchronous replication/protection policy provides protection from array or site failure with the user defined RPO. Schedule snapshot policy takes snapshots of the member volumes of the protected volume set at periodic intervals defined by the user. You can setup the local snapshot schedule and also setup the co-ordinated synchronized snapshot schedule on the protected volume set configured with synchronous or asynchronous replication policy. You can do this by attaching a scheduled snapshot policy on the volume set having already a synchronous or asynchronous protecting policy.

Array of objects (DeviceType4ProtectionScheduleInputSchema)

Responses

Request samples

Content type
application/json
{
  • "policy": {
    },
  • "protectionPolicyType": "schedule",
  • "schedules": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit protection policy on application set identified by {id} for a storage system HPE Alletra Storage MP identified by {systemId}

Edit protection policy on application set identified by {id} for a storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
Array of objects (DeviceType4ProtectionScheduleInputSchema)
Array of objects (DeviceType4ModifyProtectionScheduleInputSchema)
object

Protection policy details

protectionPolicyType
required
string
Enum: "schedule" "sync" "async"

Specifies Protection policy type. Synchronous replication/protection policy provides protection from array or site failures with zero RPO. Using this policy, you can also configure zero RTO policy like Active Peer Persistence. Asynchronous replication/protection policy provides protection from array or site failure with the user defined RPO. Schedule snapshot policy takes snapshots of the member volumes of the protected volume set at periodic intervals defined by the user. You can setup the local snapshot schedule and also setup the co-ordinated synchronized snapshot schedule on the protected volume set configured with synchronous or asynchronous replication policy. You can do this by attaching a scheduled snapshot policy on the volume set having already a synchronous or asynchronous protecting policy.

Array of objects (DeviceType4RemoveProtectionScheduleInputSchema)

Responses

Request samples

Content type
application/json
{
  • "createSchedules": [
    ],
  • "modifySchedules": [
    ],
  • "policy": {
    },
  • "protectionPolicyType": "schedule",
  • "removeSchedules": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Fix protection policy configuration on application set identified by {id} for a storage system HPE Alletra Storage MP identified by {systemId}

Remedies issues caused in protection policy configuration on application set identified by {id} for a storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
object

Protection policy details

protectionPolicyType
required
string
Enum: "schedule" "sync" "async"

Specifies Protection policy type. Synchronous replication/protection policy provides protection from array or site failures with zero RPO. Using this policy, you can also configure zero RTO policy like Active Peer Persistence. Asynchronous replication/protection policy provides protection from array or site failure with the user defined RPO. Schedule snapshot policy takes snapshots of the member volumes of the protected volume set at periodic intervals defined by the user. You can setup the local snapshot schedule and also setup the co-ordinated synchronized snapshot schedule on the protected volume set configured with synchronous or asynchronous replication policy. You can do this by attaching a scheduled snapshot policy on the volume set having already a synchronous or asynchronous protecting policy.

Array of objects (DeviceType4ProtectionScheduleInputSchema)

Responses

Request samples

Content type
application/json
{
  • "policy": {
    },
  • "protectionPolicyType": "schedule",
  • "schedules": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove protection policy on application set identified by {id} for a storage system HPE Alletra Storage MP identified by {systemId}

Remove protection policy on application set identified by {id} for a storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
required
Array of objects (DeviceType4RemoveProtectionPolicyInputSchema)

List of protection policies to be removed

Responses

Request samples

Content type
application/json
{
  • "policies": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get hosts and proximity details identified by application set {id} for HPE Alletra Storage MP identified by {systemId}

Get hosts and proximity details identified by application set {id} for HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "resourceURI": "/api/v1/storage-systems/device-type4/2FF70002AC018D94/applicationsets/9c3c4f29a82fd8d632ff379116fa0b8f/proximity-settings",
  • "total": 1
}

Change proximity settings of hosts where volume sets are exported identified by {id} and {systemId} from HPE Alletra Storage MP

Change proximity settings of hosts where volume sets are exported identified by {id} and {systemId} from HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Request Body schema: application/json
Array of objects (DeviceType4HostGroupProximityInput)
Array of objects (DeviceType4HostProximityInput)

Responses

Request samples

Content type
application/json
{
  • "hostGroups": [
    ],
  • "hosts": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Actions on volume set identified by {id} and {systemId} from HPE Alletra Storage MP

Actions on volume set identified by {id} and {systemId} from HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

Request Body schema: application/json
action
string
Enum: "FAILOVER" "SYNC" "OVERRIDE" "START" "STOP" "RECOVER" "RESTORE" "SWITCHOVER" "REVERSE"

Actions on the volume set where remote protection is enabled.

object (DeviceType4RemoteProtectionActionsInputParams)

Responses

Request samples

Content type
application/json
{
  • "action": "SYNC",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get snapshot details of volume sets identified by {id} for HPE Alletra Storage MP

Get snapshot details of volume sets identified by {id} for HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/snapshots",
  • "total": 1
}

Create snapshot for application set identified by {id}

Create snapshot for application set identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

UID of the applicationset

Request Body schema: application/json
comment
string or null

Comment if any

expireSecs
integer or null

Expiration time in seconds

readOnly
boolean or null

Read only or Read/Write

retainSecs
integer or null <int64>

Reatain time in seconds

snapshotName
required
string or null

Name for snapshot. For the HPE Alletra Storage MP systems, the maximum supported length is 31 characters in OS versions up to 10.4.0. For the OS version 10.4.2 and above, this limit is 248 characters.

vvNamePattern
required
string or null (DeviceType4vvNamePattern)
Enum: "PARENT_TIMESTAMP" "PARENT_SEC_SINCE_EPOCH"

name pattern

Responses

Request samples

Content type
application/json
{
  • "comment": "",
  • "expireSecs": 100,
  • "readOnly": false,
  • "retainSecs": 86400,
  • "snapshotName": "snapshot_oracle_1611807822",
  • "vvNamePattern": "PARENT_TIMESTAMP"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get supported protection types for application set identified by {id} on storage system HPE Alletra Storage MP identified by {systemId}

Get supported protection types for application set identified by {id} on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: e9d353bf98fc1a6bdb90b824e3ca14b5

ID of the applicationset

systemId
required
string
Example: 7CE751P312

systemId of the storage system

Responses

Response samples

Content type
application/json
{
  • "asyncPartners": [
    ],
  • "commonResourceAttributes": {
    },
  • "customerId": "string",
  • "generation": 0,
  • "isSLDSupported": true,
  • "protectionTypes": [
    ],
  • "requestUri": "/api/v1/storage-systems/device-type4/7CE815P2BH/applicationsets/6e6266d344de3e32b10424466c7d01bb/supportedProtectionTypes",
  • "syncPartners": [
    ]
}

Get all volume-sets

Get all volume sets

Authorizations:
JWTAuth
query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq volset and systemId eq 7CE751P312

oData query to filter by Key.

sort
string
Example: sort=systemId desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/applicationsets/14dbcb4be4836ff8f012a6d0118ba83a",
  • "total": 1
}

Get volume-set identified by id

Get volume-set identified by id

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: fd3244ef7f1ab8bd16500c7a41bdf8f8

UID of Volume Set

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "appType": "Oracle Database",
  • "application": "string",
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "customerId": "string",
  • "generation": 0,
  • "id": "4c74ec5c-ecec-4483-9506-3fb5dc45b5d0",
  • "name": "snap11",
  • "productFamily": "deviceType1",
  • "resourceUri": "/v1/storage-systems/volume-sets",
  • "systemId": "7CE751P312",
  • "type": "string"
}

Get volumes identified by volume set id

Get volumes identified by volume set id

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: fd3244ef7f1ab8bd16500c7a41bdf8f8

UID of Volume Set

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type1/7CE751P312/applicationsets/14dbcb4be4836ff8f012a6d0118ba83a",
  • "total": 1
}

volumes

The volumes API allows the management of volumes

Get details of volumes identified with {systemId}

Get details of volumes identified with {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/volumes",
  • "total": 1
}

Create a clone of a snapshot identified by {snapshotId} for Primera / Alletra 9K systems.

Create a clone of a snapshot identified by {snapshotId} for Primera / Alletra 9K systems.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

Request Body schema: application/json
autoLun
boolean or null

Secify to use auto lun number.

destinationCpg
string or null

Name of the User CPG

destinationSnapshotCpg
string or null

Name of the Snapshot CPG

destinationVolume
required
string

Name of the destination volume.

hostGroupId
string or null

Unique identifier of host group.

lun
integer or null <int64>

LUN of volume.

priority
string or null
Enum: "PRIORITYTYPE_HIGH" "PRIORITYTYPE_MED" "PRIORITYTYPE_LOW"

Priority of the task for clone of a snashot. Defualts to MEDIUM.

Responses

Request samples

Content type
application/json
{
  • "autoLun": true,
  • "destinationCpg": "SSD_r6",
  • "destinationSnapshotCpg": "SSD_r6",
  • "destinationVolume": "destinationVol1",
  • "hostGroupId": "fd3244ef7f1ab8bd16500c7a41bdf8f8",
  • "lun": 0,
  • "priority": "PRIORITYTYPE_MED"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Export vlun for snapshot identified by {id} from Primera / Alletra 9K identified by {systemId}

Export vlun for snapshot identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

Request Body schema: application/json
Array of objects or null

Custom LUN Id for multiple host groups

autoLun
boolean or null

Auto Lun

hostGroupIds
required
Array of strings or null or null

HostGroups

maxAutoLun
integer or null <int64>

Number of volumes.

noVcn
boolean or null

No VCN

override
boolean or null

Override

position
string or null
Deprecated

Position. This field is deprecated.

proximity
string
Enum: "PRIMARY" "SECONDARY" "ALL"

Host proximity setting for Active Peer Persistence configuration. Supported values are - PRIMARY, SECONDARY and ALL. Default proximity is PRIMARY.

Responses

Request samples

Content type
application/json
{
  • "LUN": [
    ],
  • "autoLun": true,
  • "hostGroupIds": [
    ],
  • "maxAutoLun": 1,
  • "noVcn": true,
  • "override": true,
  • "position": "position_1",
  • "proximity": "PRIMARY"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Unexport vlun for snapshot identified by {id} from Primera / Alletra 9K identified by {systemId}

Unexport vlun for snapshot identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

Request Body schema: application/json
hostGroupIds
required
Array of strings or null or null

HostGroups

Responses

Request samples

Content type
application/json
{
  • "hostGroupIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of vluns for Snapshot identified by {snapshotId} for Primera / Alletra 9K

Get details of vluns for Snapshot identified by {snapshotId} for Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=id asc,name desc

Query to sort the response with specified key and order

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "- TO BE IMPLEMENTED",
  • "total": 2
}

Get details of vlun identified by {id} for Snapshot identified by {snapshotId} for Primera / Alletra 9K

Get details of vlun identified by {id} for Snapshot identified by {snapshotId} for Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the vlun

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/volumes/{volumeUid}/vluns/{uid}",
  • "deviceWWNs": "",
  • "diskPartition": "",
  • "displayname": "",
  • "domain": "",
  • "failedPathInterval": 1,
  • "failedPathPolicy": "",
  • "id": "",
  • "initiators": {
    },
  • "lun": 1,
  • "mountPoint": "",
  • "mountPointFsau": 1,
  • "multiPathType": "",
  • "portPos": {
    },
  • "rawVolume": "",
  • "remoteName": "",
  • "requestUri": "- TO BE IMPLEMENTED",
  • "resourceUri": "- TO BE IMPLEMENTED",
  • "state": {
    },
  • "status": "",
  • "systemId": "",
  • "tpgId": 1,
  • "type": "",
  • "usedSpace": 1,
  • "volumeGroup": "",
  • "volumeManager": "",
  • "volumeName": "",
  • "volumeWWN": "",
  • "vvReservedUserSpace": 1,
  • "vvSize": 1
}

Get all volumes details for Primera / Alletra 9K

Get all volumes details for Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/primea/2FF70002AC018D94/volumes",
  • "total": 1
}

Create volume for a storage system Primera / Alletra 9K

Create volume for a storage system Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
comments
string or null

test

count
integer or null

Volumes count

dataReduction
boolean or null

Data Reduction

name
required
string

Name of the volume

sizeMib
required
integer

Size in MB

snapCpg
string or null

Snap CPG

snapshotAllocWarning
integer or null

Snapshot Alloc Warning

userAllocWarning
integer or null

User Alloc Warning

userCpg
required
string

User CPG of the volume to be created

Responses

Request samples

Content type
application/json
{
  • "comments": "test",
  • "count": 2,
  • "dataReduction": true,
  • "name": "<resource_name>",
  • "sizeMib": 16384,
  • "snapCpg": "SSD_r6",
  • "snapshotAllocWarning": 5,
  • "userAllocWarning": 5,
  • "userCpg": "SSD_r6"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get performance history of Primera / Alletra 9K Volumes

Get performance history of Primera / Alletra 9K Volumes

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
reportType
string
Example: reportType=Canned,Custom,Def,ApiUser

parameter will be set to report type requested. For api users, set parameter as ApiUser

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

compareBy
string
Example: compareBy=top eq 5 and metrics eq readIops

compareBy will define top and compare metrics for which query has to be made. Allowed values: readIops, writeIops, totalIops, readThroughput, writeThroughput, totalThroughput, readLatency, writeLatency, totalLatency, readIosize, writeIosize, totalIosize, totalQlen, avgBusy

groupBy
string
Example: groupBy=vvName

groupBy will define comma separated groupBy parameters. Allowed values are: vvName, hostName, appsetType, appsetName, portNsp. By default, groupBy will be set to vvName. If groupBy is used along with filter query parameter, only following combinations are allowed:

  • filter: vvId eq 179fa4a77c8497aacdee87d0fb67066b then groupBy should be vvName
  • filter: appsetId eq 4765171ee6d74340fca5996b90875d45 then groupBy should be appsetName
  • filter: hostIds eq 61e2d16fb28d5e6e75198039fcb4f068 then groupBy should be hostName
filter
string
Example: filter=vvId in (5df1fc8108e1c74b7041625a2f94d098,cd6c28c563b60f391fcd6dee8b92360c)

filter will define objects to be filtered. Filterable columns are:

  • hostIds - id of the host
  • appsetId - id of the application set
  • vvId - id of the volume
component
string
Value: "VLUN"
Example: component=VLUN

component will give information about resource to be queried

metricType
string
Example: metricType=IOPS,LATENCY,THROUGHPUT,IOSIZE,QLEN,AVG_BUSY

metricType will define comma separated metrics

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 162564271,
  • "historyData": {
    },
  • "requestUri": "/v1/storage-systems/device-type1/SGH014XGSP/volumes/performance-history",
  • "startTime": 1625556314
}

Remove volume identified by {volumeId} from Primera / Alletra 9K

Remove volume identified by {volumeId} from Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
unExport
boolean
Example: unExport=true

UnExport Host,HostSet and delete volume

cascade
boolean
Example: cascade=true

Delete snapshot and volume

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Primera / Alletra 9K Volume identified by {id}

Get details of Primera / Alletra 9K Volume identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "adminAllocationSettings": {
    },
  • "adminSpace": {
    },
  • "associatedLinks": [
    ],
  • "baseId": 0,
  • "comment": "string",
  • "commonResourceAttributes": {
    },
  • "compactEfficiency": 0,
  • "compressionEfficiency": 0,
  • "compressionPolicy": "string",
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/volumes/{uid}",
  • "conversionType": "CONVERSIONTYPE_THIN",
  • "copiedMB": 0,
  • "copiedPerc": 0,
  • "copyOfID": 0,
  • "creationTime": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "dataReduction": "string",
  • "ddcSize": 0,
  • "ddsSize": 0,
  • "dedup": "string",
  • "dedupSavingsSize": 0,
  • "dedupWrittenSize": 0,
  • "devType": "string",
  • "displayname": "string",
  • "domain": "string",
  • "efficiencyUpdateTime": {
    },
  • "expirationTime": {
    },
  • "fullyProvisioned": true,
  • "generation": 0,
  • "headsPerCylinder": 0,
  • "healthState": 0,
  • "hidden": true,
  • "hostWrittenMiB": 0,
  • "hostWrittenToVirtualPercent": 0,
  • "id": "string",
  • "initiators": [
    ],
  • "name": "Finance",
  • "parentID": 0,
  • "physParentID": 0,
  • "physicalCopy": true,
  • "policy": {
    },
  • "provType": "string",
  • "raid": "string",
  • "rcopyStatus": "string",
  • "readOnly": true,
  • "requestUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/volumes/{uid}",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC018D94/volumes/{uid}",
  • "retentionTime": {
    },
  • "roChildID": 0,
  • "rwChildID": 0,
  • "sectorsPerTrack": 0,
  • "sharedParentId": 0,
  • "sizeMiB": 0,
  • "snapShotTier": "string",
  • "snapshotAllocLimit": 0,
  • "snapshotAllocWarning": 0,
  • "snapshotAllocationSettings": {
    },
  • "snapshotCpgID": 0,
  • "snapshotCpgName": "string",
  • "snapshotSpace": {
    },
  • "snapshotTdvvSize": {
    },
  • "snapshotUsedToVirtualPercent": 0,
  • "spaceCalculationTime": {
    },
  • "started": true,
  • "state": {
    },
  • "storageTier": "string",
  • "systemId": "7CE751P312",
  • "thinProvisioned": true,
  • "thinSavings": "string",
  • "totalRawReservedMiB": 0,
  • "totalReservedMiB": 0,
  • "totalSpaceMiB": 0,
  • "type": "string",
  • "unrefSpaceFreedTime": {
    },
  • "usedCapacity": 0,
  • "usedSizeMiB": 0,
  • "userAllocLimit": 0,
  • "userAllocWarning": 0,
  • "userAllocationSettings": {
    },
  • "userCpgID": 0,
  • "userCpgName": "string",
  • "userReservedToVirtualPercent": 0,
  • "userSpace": {
    },
  • "userUsedToVirtualPercent": 0,
  • "vlunSectorSize": 0,
  • "volumeId": 0,
  • "volumePerformance": {
    },
  • "volumeType": "VVTYPE_BASE",
  • "wwn": "60002AC0000000000000006B0001FFEB"
}

Edit volume identified by {volumeId} from Primera / Alletra 9K

Edit volume identified by {volumeId} from Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

Request Body schema: application/json
conversionType
string or null
Enum: "CONVERSIONTYPE_THIN" "CONVERSIONTYPE_DDS" "CONVERSIONTYPE_V1" "CONVERSIONTYPE_V2"

conversion type (this argument is depricated, use dataReduction instead)

dataReduction
boolean or null

Data Reduction on Volume

name
string or null

volume name

sizeMib
number or null <float64>

Size in MiB

snapshotAllocWarning
integer or null <int64>

snapshot alloc space allocation warning

snapshotCpgName
string or null

Snapshot CPG name. Editing of this parameter snapshotCpgName is supported on HPE Primera 4.6.0 and HPE Alletra 9K 9.6.0 and above system OS versions.

userAllocWarning
integer or null <int64>

User alloc space limit warning

userCpgName
string or null

user cpg name

Responses

Request samples

Content type
application/json
{
  • "conversionType": "CONVERSIONTYPE_THIN",
  • "dataReduction": true,
  • "name": "volume_Name",
  • "sizeMib": 1,
  • "snapshotAllocWarning": 1,
  • "snapshotCpgName": "cpg_1",
  • "userAllocWarning": 1,
  • "userCpgName": "cpg_1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get volume capacity trend data of Primera / Alletra 9K Volume identified by {id}

Get volume capacity trend data of Primera / Alletra 9K Volume identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "capacityData": {
    },
  • "commonResourceAttributes": {
    },
  • "endTime": 1625209133,
  • "requestUri": "/v1/storage-systems/device-type1/SGH014XGSP/volumes/a7c4e6593f51d0b98f0e40d7e6df04fd/capacity-history",
  • "startTime": 1625122733
}

Create a clone volume identified by {id} for Primera / Alletra 9K systems.

Create a clone volume identified by {id} for Primera / Alletra 9K systems.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

Request Body schema: application/json
destinationVolume
required
string

Name of the destination volume.

object or null (offlineClone)

Offline clone of a volume.

online
boolean or null

Create an online or offline clone of a volume.

object or null (onlineClone)

Online clone of a volume.

priority
string or null
Enum: "PRIORITYTYPE_HIGH" "PRIORITYTYPE_MED" "PRIORITYTYPE_LOW"

Priority of the task for clone volume. Defualts to MEDIUM.

Responses

Request samples

Content type
application/json
{
  • "destinationVolume": "destinationVol1",
  • "offlineClone": {
    },
  • "online": true,
  • "onlineClone": {
    },
  • "priority": "PRIORITYTYPE_MED"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Export vlun for volume identified by {id} from Primera / Alletra 9K identified by {systemId}

Export vlun for volume identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

Request Body schema: application/json
Array of objects or null

Custom LUN Id for multiple host groups

autoLun
boolean or null

Auto Lun

hostGroupIds
required
Array of strings or null or null

HostGroups

maxAutoLun
integer or null <int64>

Number of volumes.

noVcn
boolean or null

No VCN

override
boolean or null

Override

position
string or null
Deprecated

Position. This field is deprecated.

proximity
string
Enum: "PRIMARY" "SECONDARY" "ALL"

Host proximity setting for Active Peer Persistence configuration. Supported values are - PRIMARY, SECONDARY and ALL. Default proximity is PRIMARY.

Responses

Request samples

Content type
application/json
{
  • "LUN": [
    ],
  • "autoLun": true,
  • "hostGroupIds": [
    ],
  • "maxAutoLun": 1,
  • "noVcn": true,
  • "override": true,
  • "position": "position_1",
  • "proximity": "PRIMARY"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get performance trend data of Primera / Alletra 9K Volume identified by {id}

Get performance trend data of Primera / Alletra 9K Volume identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 162564271,
  • "historyData": {
    },
  • "requestUri": "/v1/storage-systems/device-type1/SGH014XGSP/volumes/a7c4e6593f51d0b98f0e40d7e6df04fd/performance-history",
  • "startTime": 1625556314
}

Get performance statistics of Primera / Alletra 9K Volume identified by {id}

Get performance statistics of Primera / Alletra 9K Volume identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "iops": {
    },
  • "latencyMs": {
    },
  • "requestUri": "/v1/storage-systems/device-type1/SGH014XGSP/volumes/a7c4e6593f51d0b98f0e40d7e6df04fd/performance-statistics",
  • "resourceUri": "/v1/storage-systems/device-type1/SGH014XGSP/volumes/a7c4e6593f51d0b98f0e40d7e6df04fd/performance-statistics",
  • "throughputKbps": {
    }
}

Get snapshot details of volume identified by {id} for Primera / Alletra 9K

Get snapshot details of volume identified by {id} for Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type1/7CE751P312/applicationsets/8c18425671d44803b4512f4ca1917410/snapshots",
  • "total": 1
}

Create snapshot for volumes identified by {id}

Create snapshot for volumes identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

Request Body schema: application/json
comment
string or null

Comment if any

customName
string or null

Name for snapshot

expireSecs
integer or null

Expiration time in seconds

namePattern
required
string or null (namePattern)
Enum: "PARENT_TIMESTAMP" "PARENT_SEC_SINCE_EPOCH" "CUSTOM"

name pattern

readOnly
boolean or null

Read only or Read/Write

retainSecs
integer or null <int64>

Reatain time in seconds

Responses

Request samples

Content type
application/json
{
  • "comment": "",
  • "customName": "snap1",
  • "expireSecs": 86400,
  • "namePattern": "PARENT_TIMESTAMP",
  • "readOnly": false,
  • "retainSecs": 86400
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Unexport vlun for volume identified by {id} from Primera / Alletra 9K identified by {systemId}

Unexport vlun for volume identified by {id} from Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

Request Body schema: application/json
hostGroupIds
required
Array of strings or null or null

HostGroups

Responses

Request samples

Content type
application/json
{
  • "hostGroupIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of vluns for Volume identified by {volumeId} for Primera / Alletra 9K

Get details of vluns for Volume identified by {volumeId} for Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=id asc,name desc

Query to sort the response with specified key and order

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "- TO BE IMPLEMENTED",
  • "total": 2
}

Get the details of the clone volumes associated with a base volume identified by {volumeId} for Primera / Alletra 9K systems.

Get the details of the clone volumes associated with a base volume identified by {volumeId} for Primera / Alletra 9K systems.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/primea/2FF70002AC018D94/volumes",
  • "total": 1
}

Promote a clone volume identified by {cloneId} of a volume identified by {volumeId} on storage system Primera / Alletra 9K identified by {systemId}

Promote a clone volume identified by {cloneId} of a volume identified by {volumeId} on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

cloneId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the clone

Request Body schema: application/json
priority
string or null (clonePriority)
Enum: "PRIORITYTYPE_HIGH" "PRIORITYTYPE_MED" "PRIORITYTYPE_LOW"

Priority of the task for promoting/resynchronizing the clone volume. Defaults to MEDIUM.

Responses

Request samples

Content type
application/json
{
  • "priority": "PRIORITYTYPE_MED"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Resynchronize a clone volume identified by {cloneId} of a volume identified by {volumeId} on storage system Primera / Alletra 9K identified by {systemId}

Resynchronize a clone volume identified by {cloneId} of a volume identified by {volumeId} on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

cloneId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the clone

Request Body schema: application/json
priority
string or null (clonePriority)
Enum: "PRIORITYTYPE_HIGH" "PRIORITYTYPE_MED" "PRIORITYTYPE_LOW"

Priority of the task for promoting/resynchronizing the clone volume. Defaults to MEDIUM.

Responses

Request samples

Content type
application/json
{
  • "priority": "PRIORITYTYPE_MED"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove Primera / Alletra 9K snapshot in system identified by {snapshotId}

Remove Primera / Alletra 9K snapshot in system identified by {snapshotId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

Identifier of snapshot.

query Parameters
force
boolean
Example: force=true

Make snapshot offline and remove.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of snapshot identified by {snapshotId} for Volume identified by {volumeId} for Primera / Alletra 9K

Get details of vlun identified by {id} for Volume identified by {volumeId} for Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "adminAllocationSettings": {
    },
  • "adminSpace": {
    },
  • "baseId": 0,
  • "comment": "string",
  • "commonResourceAttributes": {
    },
  • "compactEfficiency": 0,
  • "compressionEfficiency": 0,
  • "compressionPolicy": "string",
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/volumes/014f8f647893f228bcf8b7c3f7eebbc5/snapshots/e1892c0fb437d0aeef880124c2db9957",
  • "conversionType": "CONVERSIONTYPE_THIN",
  • "copiedMB": 0,
  • "copiedPerc": 0,
  • "copyOfID": 0,
  • "creationTime": {
    },
  • "customerId": "string",
  • "dataReduction": "string",
  • "ddcSize": 0,
  • "ddsSize": 0,
  • "dedup": "string",
  • "dedupSavingsSize": 0,
  • "dedupWrittenSize": 0,
  • "devType": "string",
  • "displayname": "string",
  • "domain": "string",
  • "efficiencyUpdateTime": {
    },
  • "expirationTime": {
    },
  • "fullyProvisioned": true,
  • "generation": 0,
  • "headsPerCylinder": 0,
  • "healthState": 0,
  • "hidden": true,
  • "hostWrittenMiB": 0,
  • "hostWrittenToVirtualPercent": 0,
  • "id": "b7107a30-260a-41c1-a47f-e50770c414c9",
  • "initiators": [
    ],
  • "name": "Finance",
  • "parentID": 0,
  • "physParentID": 0,
  • "physicalCopy": true,
  • "policy": {
    },
  • "provType": "string",
  • "raid": "string",
  • "rcopyStatus": "string",
  • "readOnly": true,
  • "retentionTime": {
    },
  • "roChildID": 0,
  • "rwChildID": 0,
  • "sectorsPerTrack": 0,
  • "sharedParentId": 0,
  • "sizeMiB": 0,
  • "snapshotAllocLimit": 0,
  • "snapshotAllocWarning": 0,
  • "snapshotAllocationSettings": {
    },
  • "snapshotCpgID": 0,
  • "snapshotCpgName": "string",
  • "snapshotId": 0,
  • "snapshotSpace": {
    },
  • "snapshotTdvvSize": {
    },
  • "snapshotType": "string",
  • "snapshotUsedToVirtualPercent": 0,
  • "spaceCalculationTime": {
    },
  • "started": true,
  • "state": {
    },
  • "systemId": "7CE751P312",
  • "thinProvisioned": true,
  • "totalRawReservedMiB": 0,
  • "totalReservedMiB": 0,
  • "totalSpaceMiB": 0,
  • "type": "string",
  • "unrefSpaceFreedTime": {
    },
  • "usedCapacity": 0,
  • "usedSizeMiB": 0,
  • "userAllocLimit": 0,
  • "userAllocWarning": 0,
  • "userAllocationSettings": {
    },
  • "userCpgID": 0,
  • "userCpgName": "string",
  • "userReservedToVirtualPercent": 0,
  • "userSpace": {
    },
  • "userUsedToVirtualPercent": 0,
  • "vlunSectorSize": 0,
  • "wwn": "60002AC0000000000000006B0001FFEB"
}

Promote a snapshot identified by {snapshotId} of a volume identified by {volumeId} on storage system Primera / Alletra 9K identified by {systemId}

Promote a snapshot identified by {snapshotId} of a volume identified by {volumeId} on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

Request Body schema: application/json
priority
string or null (priority)
Enum: "PRIORITYTYPE_HIGH" "PRIORITYTYPE_MED" "PRIORITYTYPE_LOW"

Priority of the task for promoting the snapshot. Defualts to PRIORITYTYPE_MED.

target
string or null

Target volume name to which the snapshot need to be promoted. If not specified it will be promoted to its base volume.

Responses

Request samples

Content type
application/json
{
  • "priority": "PRIORITYTYPE_HIGH",
  • "target": "volume1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove vlun idenfied by {id} form volume identified by {volumeId} from Primera / Alletra 9K

Remove vlun idenfied by {id} form volume identified by {volumeId} from Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the vlun

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of vlun identified by {id} for Volume identified by {volumeId} for Primera / Alletra 9K

Get details of vlun identified by {id} for Volume identified by {volumeId} for Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the vlun

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type1/SGH014XGSP/volumes/{volumeUid}/vluns/{uid}",
  • "deviceWWNs": "",
  • "diskPartition": "",
  • "displayname": "",
  • "domain": "",
  • "failedPathInterval": 1,
  • "failedPathPolicy": "",
  • "id": "",
  • "initiators": {
    },
  • "lun": 1,
  • "mountPoint": "",
  • "mountPointFsau": 1,
  • "multiPathType": "",
  • "portPos": {
    },
  • "rawVolume": "",
  • "remoteName": "",
  • "requestUri": "- TO BE IMPLEMENTED",
  • "resourceUri": "- TO BE IMPLEMENTED",
  • "state": {
    },
  • "status": "",
  • "systemId": "",
  • "tpgId": 1,
  • "type": "",
  • "usedSpace": 1,
  • "volumeGroup": "",
  • "volumeManager": "",
  • "volumeName": "",
  • "volumeWWN": "",
  • "vvReservedUserSpace": 1,
  • "vvSize": 1
}

Get all access-control-records details by Nimble / Alletra 6K

Get all access-control-records details by Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter Access Control Record by Key.

sort
string
Example: sort=name desc

oData query to sort Access Control Record resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/nimble/2a0df0fe6f7dc7bb16000000000000000000004817/access-control-records",
  • "total": 1
}

Create Nimble / Alletra 6K access control record in system identified by {systemId}

Create Nimble / Alletra 6K access control record in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
apply_to
string or null

External management agent type. Possible values:'volume', 'pe', 'vvol_volume', 'vvol_snapshot', 'snapshot', 'both'.

chap_user_id
string or null

Identifier for the CHAP user.

initiator_group_id
string or null

Identifier for the initiator group.

lun
integer or null <int64>

If this access control record applies to a regular volume, this attribute is the volume's LUN (Logical Unit Number). If the access protocol is iSCSI, the LUN will be 0. However, if the access protocol is Fibre Channel, the LUN will be in the range from 0 to 2047. If this record applies to a Virtual Volume, this attribute is the volume's secondary LUN in the range from 0 to 399999, for both iSCSI and Fibre Channel. If the record applies to a OpenstackV2 volume, the LUN will be in the range from 0 to 2047, for both iSCSI and Fibre Channel. If this record applies to a protocol endpoint or only a snapshot, this attribute is not meaningful and is set to null.

pe_id
string or null

Identifier for the protocol endpoint this access control record applies to.

pe_ids
Array of strings or null or null

List of candidate protocol endpoints that may be used to access the Virtual Volume. One of them will be selected for the access control record. This field is required only when creating an access control record for a Virtual Volume.

snap_id
string or null

Identifier for the snapshot this access control record applies to.

systemUid
string or null
Deprecated

Rest ID of the array containing this controller. Filter, Sort. This field is deprecated.

vol_id
string or null

Identifier for the volume this access control record applies to.

Responses

Request samples

Content type
application/json
{
  • "apply_to": "pe",
  • "chap_user_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "initiator_group_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "lun": 8,
  • "pe_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "pe_ids": [
    ],
  • "snap_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "systemUid": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "vol_id": "064323bdd90b39c3a7000000000000000000000016"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove access-control-record identified by {accessControlRecordId} from Nimble / Alletra 6K

Remove access-control-record identified by {accessControlRecordId} from Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

accessControlRecordId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of Access Control Record. A 42 digit hexadecimal number.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K access-control-records identified by {accessControlRecordId}

Get details of Nimble / Alletra 6K access-control-records identified by {accessControlRecordId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

accessControlRecordId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the Access Control Record . A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/access-control-records/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "access_protocol": "fc",
  • "chap_user_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "chap_user_name": "myobject-5",
  • "creation_time": 1600169692,
  • "id": "0d4323bdd90b39c3a7000000000000000000000012",
  • "initiator_group_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "initiator_group_name": "3PAR-Host",
  • "last_modified": 1600169692,
  • "lun": 8,
  • "pe_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "pe_lun": 1234,
  • "pe_name": "myobject-5",
  • "snap_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "snap_name": "snap_test",
  • "vol_id": "064323bdd90b39c3a7000000000000000000000016",
  • "vol_name": "vv1",
  • "apply_to": "volume",
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "customerId": "string",
  • "generation": 0,
  • "pe_ids": [
    ],
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "snapluns": [
    ],
  • "type": "string",
  • "vol_agent_type": "smis"
}

Edit access-control-record identified by {accessControlRecordId} for Nimble / Alletra 6K

Edit access-control-record identified by {accessControlRecordId} for Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

accessControlRecordId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of Access Control Record. A 42 digit hexadecimal number.

Request Body schema: application/json
apply_to
string or null
Enum: "volume" "pe" "vvol_volume" "vvol_snapshot" "snapshot" "both"

Type of object this access control record applies to. Possible values:'volume', 'pe', 'vvol_volume', 'vvol_snapshot', 'snapshot', 'both'.

Responses

Request samples

Content type
application/json
{
  • "apply_to": "pe"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Create provisioning workflow for a Nimble / Alletra 6K storage system identified by {systemId}

Create provisioning workflow for a Nimble / Alletra 6K storage system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
agent_type
string or null

External management agent type. Defaults to 'none'. Possible values: 'none', 'smis', 'vvol', 'openstack', 'openstackv2'

app_uuid
string or null

Application identifier of volume. String of up to 255 alphanumeric characters, hyphen, colon, dot and underscore are allowed. Defaults to the empty string.

appSetName
string or null

The name of the application set associated with the volume.It can be a string of up to 255 alphanumeric characters, including hyphens, colons, dots, and underscores. Defaults to an empty string if not specified.

count
required
integer

Number of volumes to be created.

dedupe_enabled
boolean or null

Indicate whether dedupe is enabled. Defaults to 'false'.

downstreamPartner
string or null

Name of the downstream partner

downstreamPartnerId
string or null

ID of the downstream partner

encryption_cipher
string or null
Enum: "none" "aes_256_xts"

The encryption cipher of the volume. Possible values: 'none', 'aes_256_xts'. Applicable for only version 6.1.2 and above.

folder_id
string or null

ID of the folder holding this volume. An optional NsObjectID. A 42 digit hexadecimal int64 or the empty string. Defaults to the empty string.

Array of objects or null or null (NimbleHostGroupDetails)

List of host group details.

limit
integer or null <int64>

Limit for the volume as a percentage of volume size. Percentage as integer from 0 to 100. Defaults to the default volume limit set on group, typically 100.

limit_iops
integer or null <int64>

IOPS limit for this volume. If limit_iops is not specified when a volume is created, or if limit_iops is set to -1, then the volume has no IOPS limit. If limit_iops is not specified while creating a clone, IOPS limit of parent volume will be used as limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops _ampersand_amp;lt;= ((limit_mbps MB/s * 2^20 B/MB) / block_size B). By default the volume is created with unlimited iops.

limit_mbps
integer or null <int64>

Throughput limit for this volume in MB/s. If limit_mbps is not specified when a volume is created, or if limit_mbps is set to -1, then the volume has no MBPS limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops _ampersand_amp;lt;= ((limit_mbps MB/s * 2^20 B/MB) / block_size B). By default, the volume is created with unlimited throughput.

name
required
string

Name of the volume. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints.

object or null (CustomApplicationParameters)

Params required to create custom workload

perfpolicy_id
string or null

Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size. A 42 digit hexadecimal int64. Defaults to ID of the 'default' performance policy.

pool_id
string or null

Identifier associated with the pool in the storage pool table. A 42 digit hexadecimal int64. Defaults to the ID of the 'default' pool.

protectionPolicyId
string or null

Protection policy ID

Array of objects or null

Protection Policy Schedule

replicationStartTime
integer or null <int64>

Remote replication start time which will be used to offset local snapshot start time

size
required
integer <int64>

Volume size in megabytes. Size is required for creating a volume but not for cloning an existing volume.When creating a new volume, size is required. When cloning an existing volume, size defaults to that of the parent volume.

suffix
integer or null

suffix for customized volume name

volColId
string or null

volume collection id

volColName
string or null

volume collection Name

warn_level
integer or null <int64>
Deprecated

Threshold for available space as a percentage of volume size below which an alert is raised. If this option is not specified, array default volume warn level setting is used to decide the warning level for this volume. Percentage as integer from 0 to 100. Defaults to the default volume warning level set on the group, typically 80.

Responses

Request samples

Content type
application/json
{
  • "agent_type": "none",
  • "app_uuid": "rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18",
  • "appSetName": "myAppSetName_123",
  • "count": 3,
  • "dedupe_enabled": false,
  • "downstreamPartner": "<resource_name>",
  • "downstreamPartnerId": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "encryption_cipher": "none",
  • "folder_id": "1234123412341234123412341234123412341234cd",
  • "host_groups": [
    ],
  • "limit": 100,
  • "limit_iops": -1,
  • "limit_mbps": -1,
  • "name": "volume1",
  • "perfpolicy": {
    },
  • "perfpolicy_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "pool_id": "0a00000000000004d3000000000000000000000001",
  • "protectionPolicyId": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "protectionPolicySchedules": [
    ],
  • "replicationStartTime": 16384456,
  • "size": 16,
  • "suffix": 4,
  • "volColId": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "volColName": "appset_1",
  • "warn_level": 80
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Provisioning review for a storage system Nimble / Alletra 6K

Provisioning review for a storage system Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
host_groups
Array of strings or null or null

list of host groups

Responses

Request samples

Content type
application/json
{
  • "host_groups": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Edit Multiple Nimble / Alletra 6K snapshots in system identified by {systemId}

Edit Multiple Nimble / Alletra 6K snapshots in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
required
Array of objects or null (NimbleEditSnapshotInput)

Responses

Request samples

Content type
application/json
{
  • "snapshot_list": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get all volumes details for Nimble / Alletra 6K

Get all volumes details for Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter volumes by Key.

sort
string
Example: sort=name desc

oData query to sort volumes resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/volumes",
  • "total": 1
}

Create Nimble / Alletra 6K volume in system identified by {systemId}

Create Nimble / Alletra 6K volume in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

Request Body schema: application/json
agent_type
string or null

External management agent type. Defaults to 'none'. Possible values: 'none', 'smis', 'vvol', 'openstack', 'openstackv2'

app_uuid
string or null

Application identifier of volume. String of up to 255 alphanumeric characters, hyphen, colon, dot and underscore are allowed. Defaults to the empty string.

base_snap_id
string or null

Base snapshot ID. This attribute is required together with name and clone when cloning a volume with the create operation. A 42 digit hexadecimal int64. Defaults to the empty string.

block_size
integer or null <int64>

Size in bytes of blocks in the volume. Defaults to 4096.

cache_pinned
boolean or null

If set to true, all the contents of this volume are kept in flash cache. This provides for consistent performance guarantees for all types of workloads. The amount of flash needed to pin the volume is equal to the limit for the volume. Defaults to 'false'.

clone
boolean or null

Whether this volume is a clone. Use this attribute in combination with name and base_snap_id to create a clone by setting clone = true. Defaults to 'false'.

dedupe_enabled
boolean or null

Indicate whether dedupe is enabled. Defaults to 'false'.

description
string or null

Text description of volume. String of up to 255 printable ASCII characters. Defaults to the empty string.

dest_pool_id
string or null

ID of the destination pool where the volume is moving to. A 42 digit hexadecimal int64. Defaults to the empty string.

encryption_cipher
string or null

The encryption cipher of the volume. Defaults to 'none'. Possible values: 'none', 'aes_256_xts'

folder_id
string or null

ID of the folder holding this volume. An optional NsObjectID. A 42 digit hexadecimal int64 or the empty string. Defaults to the empty string.

limit
integer or null <int64>

Limit for the volume as a percentage of volume size. Percentage as integer from 0 to 100. Defaults to the default volume limit set on group, typically 100.

limit_iops
integer or null <int64>

IOPS limit for this volume. If limit_iops is not specified when a volume is created, or if limit_iops is set to -1, then the volume has no IOPS limit. If limit_iops is not specified while creating a clone, IOPS limit of parent volume will be used as limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops _ampersand_amp;lt;= ((limit_mbps MB/s * 2^20 B/MB) / block_size B). By default the volume is created with unlimited iops.

limit_mbps
integer or null <int64>

Throughput limit for this volume in MB/s. If limit_mbps is not specified when a volume is created, or if limit_mbps is set to -1, then the volume has no MBPS limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops _ampersand_amp;lt;= ((limit_mbps MB/s * 2^20 B/MB) / block_size B). By default, the volume is created with unlimited throughput.

Array of objects or null or null (KeyValue)

Key-value pairs that augment a volume's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed. Defaults to an empty array.

multi_initiator
boolean or null

This indicates whether volume and its snapshots are multi-initiator accessible. This attribute applies only to volumes and snapshots available to iSCSI initiators. Defaults to 'false'.

name
required
string

Name of the volume. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints.

online
boolean or null

Online state of volume, available for host initiators to establish connections. Defaults to 'true'.

owned_by_group_id
string or null

ID of group that currently owns the volume. A 42 digit hexadecimal int64. Defaults to the ID of the group that created the volume.

perfpolicy_id
string or null

Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size. A 42 digit hexadecimal int64. Defaults to ID of the 'default' performance policy.

pool_id
string or null

Identifier associated with the pool in the storage pool table. A 42 digit hexadecimal int64. Defaults to the ID of the 'default' pool.

read_only
boolean or null

Volume is read-only. Defaults to 'false'.

reserve
integer or null <int64>
Deprecated

Amount of space to reserve for this volume as a percentage of volume size. Percentage as integer either 0 or 100. Defaults to the default volume reservation set on the group, typically 0.

size
integer or null <int64>

Volume size in megabytes. Size is required for creating a volume but not for cloning an existing volume.When creating a new volume, size is required. When cloning an existing volume, size defaults to that of the parent volume.

snap_reserve
integer or null <int64>
Deprecated

Amount of space to reserve for snapshots of this volume as a percentage of volume size. Defaults to the default snapshot reserve set on the group, typically 0.

snap_warn_level
integer or null <int64>
Deprecated

Threshold for available space as a percentage of volume size below which an alert is raised. Defaults to the default snapshot warning level set on the group, typically 0.

suffix
integer
Deprecated

suffix for customized volume name. This field is deprecated.

warn_level
integer or null <int64>
Deprecated

Threshold for available space as a percentage of volume size below which an alert is raised. If this option is not specified, array default volume warn level setting is used to decide the warning level for this volume. Percentage as integer from 0 to 100. Defaults to the default volume warning level set on the group, typically 80.

Responses

Request samples

Content type
application/json
{
  • "agent_type": "none",
  • "app_uuid": "rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18",
  • "base_snap_id": "2a0df0fe6f7dc7bb16000000000000000000004017",
  • "block_size": 4096,
  • "cache_pinned": false,
  • "clone": false,
  • "dedupe_enabled": false,
  • "description": "99.9999% availability",
  • "dest_pool_id": "0a00000000000004d3000000000000000000000001",
  • "encryption_cipher": "none",
  • "folder_id": "1234123412341234123412341234123412341234cd",
  • "limit": 100,
  • "limit_iops": -1,
  • "limit_mbps": -1,
  • "metadata": [
    ],
  • "multi_initiator": false,
  • "name": "volume1",
  • "online": true,
  • "owned_by_group_id": "2a0df0fe6f7dc7bb16000000000000000000004007",
  • "perfpolicy_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "pool_id": "0a00000000000004d3000000000000000000000001",
  • "read_only": false,
  • "reserve": 0,
  • "size": 1024,
  • "snap_reserve": 0,
  • "snap_warn_level": 0,
  • "suffix": 4,
  • "warn_level": 80
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get performance history of Nimble / Alletra 6K Volumes

Get performance history of Nimble / Alletra 6K Volumes

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

query Parameters
range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

compareBy
string
Example: compareBy=top eq 5 and metrics eq readIops

compareBy will define top and compare metrics for which query has to be made. Allowed values: readIops, writeIops, totalIops, readThroughput, writeThroughput, totalThroughput, readLatency, writeLatency, totalLatency, readIosize, writeIosize, totalIosize, totalQlen, avgBusy

filter
string
Example: filter=vvname in (vvname1,vvname2,vvname3) ,deviceName in (cage1)

filter will define objects to be filtered

metricType
string
Example: metricType=IOPS,LATENCY,THROUGHPUT

metricTypes will define comma separated metrics

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 162564271,
  • "historyData": {
    },
  • "requestUri": "/v1/storage-systems/device-type2/0000000110000000/volumes/volume-performance",
  • "startTime": 1625556314
}

Remove volume identified by {volumeId} from Nimble / Alletra 6K

Remove volume identified by {volumeId} from Nimble / Alletra 6K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

query Parameters
offline
boolean
Deprecated
Example: offline=true

Make volume offline and delete. Deprecated - Use force instead of offline.

force
boolean
Example: force=true

Make volume and associated snapshots offline, stop protection and delete.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of Nimble / Alletra 6K Volume identified by {volumeId}

Get details of Nimble / Alletra 6K Volume identified by {volumeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/volumes/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "base_snap_id": "2a0df0fe6f7dc7bb16000000000000000000004017",
  • "base_snap_name": "snp1",
  • "clone": false,
  • "dest_pool_id": "0a00000000000004d3000000000000000000000001",
  • "dest_pool_name": "myobject-5",
  • "folder_id": "1234123412341234123412341234123412341234cd",
  • "folder_name": "myobject-5",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "name": "volume1",
  • "online": true,
  • "owned_by_group": "g1a1",
  • "owned_by_group_id": "2a0df0fe6f7dc7bb16000000000000000000004007",
  • "parent_vol_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "parent_vol_name": "1234123412341234abcdacbdacbdacbd",
  • "perfpolicy_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "perfpolicy_name": "default",
  • "pool_id": "0a00000000000004d3000000000000000000000001",
  • "pool_name": "default",
  • "read_only": false,
  • "replication_role": "no_replication",
  • "secondary_serial_number": "1234123412341234abcdacbdacbdacbd",
  • "serial_number": "5596fd1da1c87b8d6c9ce900d3040000",
  • "size": 1024,
  • "target_name": "iqn.2007-11.com.storage:vol0.762157726640911-v00000000000004d3.00000005.000004d3",
  • "volcoll_id": "1234123412341234123412341234123412341234cd",
  • "volcoll_name": "myobject-5",
  • "access_control_records": [
    ],
  • "agent_type": "none",
  • "app_category": "Other",
  • "app_uuid": "rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18",
  • "associated_links": [
    ],
  • "block_size": 4096,
  • "cache_needed_for_pin": 104857600,
  • "cache_pinned": false,
  • "cache_policy": "normal",
  • "caching_enabled": true,
  • "cksum_last_verified": 1598952427,
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type2/001491cb6652a03a6b000000000000000000000001/volumes/071491cb6652a03a6b000000000000000000000006",
  • "content_repl_errors_found": false,
  • "creation_time": 1598951404,
  • "customerId": "string",
  • "dedupe_enabled": true,
  • "description": "99.9999% availability",
  • "encryption_cipher": "none",
  • "force": false,
  • "full_name": "default:/volume1",
  • "generation": 0,
  • "has_locked_snapshots": false,
  • "inherit_acl": false,
  • "is_mfa_protected": true,
  • "iscsi_target_scope": "group",
  • "last_content_snap_br_cg_uid": 0,
  • "last_content_snap_br_gid": 0,
  • "last_content_snap_id": 0,
  • "last_modified": 1598952427,
  • "last_snap": {
    },
  • "limit": 100,
  • "limit_iops": -1,
  • "limit_mbps": -1,
  • "metadata": [
    ],
  • "move_aborting": false,
  • "move_bytes_migrated": 0,
  • "move_bytes_remaining": 0,
  • "move_est_compl_time": 0,
  • "move_start_time": 0,
  • "multi_initiator": false,
  • "needs_content_repl": false,
  • "num_snaps": 28,
  • "offline_reason": "user",
  • "online_snaps": [
    ],
  • "perfpolicy_creator_id": "0600000000000004d3000000000044000000000002",
  • "perfpolicy_creator_name": "AF-123456",
  • "pinned_cache_size": 0,
  • "pre_filter": "exampleFilter",
  • "previously_deduped": true,
  • "projected_num_snaps": 0,
  • "protection_type": "local",
  • "reserve": 0,
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "search_name": "volume1",
  • "snap_reserve": 0,
  • "snap_usage_compressed_bytes": 0,
  • "snap_usage_populated_bytes": 0,
  • "snap_usage_uncompressed_bytes": 0,
  • "snap_warn_level": 0,
  • "space_usage_level": "normal",
  • "srep_last_sync": 1598952427,
  • "srep_resync_percent": 0,
  • "thinly_provisioned": true,
  • "total_usage_bytes": 0,
  • "type": "string",
  • "upstream_cache_pinned": false,
  • "usage_valid": true,
  • "vol_state": "online",
  • "vol_usage_compressed_bytes": 0,
  • "vol_usage_mapped_bytes": 0,
  • "vol_usage_uncompressed_bytes": 0,
  • "volcoll_creator_id": "0600000000000004d3000000000044000000000002",
  • "volcoll_creator_name": "AF-123456",
  • "volume_creator_id": "0600000000000004d3000000000044000000000002",
  • "volume_creator_name": "AF-1234567",
  • "vpd_ieee0": "bea16133315c83ab6c9ce90098b0ea001",
  • "vpd_ieee1": "6c9ce90098b0ea001",
  • "vpd_t10": "Nimble bea16133315c83ab6c9ce90098b0ea001",
  • "warn_level": 80,
  • "volume_export_details": {
    }
}

Edit details of Nimble / Alletra 6K Volume identified by {volumeId}

Edit details of Nimble / Alletra 6K Volume identified by {volumeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

Request Body schema: application/json
app_uuid
string or null

Application identifier of volume. String of up to 255 alphanumeric characters, hyphen, colon, dot and underscore are allowed.

caching_enabled
boolean or null
Deprecated

Indicate caching the volume is enabled.

dedupe_enabled
boolean or null

Indicate whether dedupe is enabled.

description
string or null

Text description of volume. String of up to 255 printable ASCII characters.

folder_id
string or null

ID of the folder holding this volume. An optional NsObjectID. A 42 digit hexadecimal number or the empty string.

force
boolean or null

Forcibly offline, reduce size or change read-only status a volume.

limit
integer or null <int64>

Limit for the volume as a percentage of volume size. Percentage as integer from 0 to 100.

limit_iops
integer or null <int64>

IOPS limit for this volume. If limit_iops is not specified when a volume is created, or if limit_iops is set to -1, then the volume has no IOPS limit. If limit_iops is not specified while creating a clone, IOPS limit of parent volume will be used as limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops _ampersand_amp;lt;= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).

limit_mbps
integer or null <int64>

Throughput limit for this volume in MB/s. If limit_mbps is not specified when a volume is created, or if limit_mbps is set to -1, then the volume has no MBPS limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. If both limit_iops and limit_mbps are specified, limit_mbps must not be hit before limit_iops. In other words, IOPS and MBPS limits should honor limit_iops _ampersand_amp;lt;= ((limit_mbps MB/s * 2^20 B/MB) / block_size B).

name
string or null

Name of the volume. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period.

online
boolean or null

Online state of volume, available for host initiators to establish connections.

owned_by_group_id
string or null

ID of group that currently owns the volume. A 42 digit hexadecimal number.

perfpolicy_id
string or null

Identifier of the performance policy. After creating a volume, performance policy for the volume can only be changed to another performance policy with same block size. A 42 digit hexadecimal number. Filter, Sort

size
integer or null <int64>

Volume size in megabytes. Size is required for creating a volume but not for cloning an existing volume.

Responses

Request samples

Content type
application/json
{
  • "app_uuid": "rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18",
  • "caching_enabled": true,
  • "dedupe_enabled": true,
  • "description": "99.9999% availability",
  • "folder_id": "1234123412341234123412341234123412341234cd",
  • "force": true,
  • "limit": 0,
  • "limit_iops": -1,
  • "limit_mbps": -1,
  • "name": "volume1",
  • "online": true,
  • "owned_by_group_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "perfpolicy_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "size": 1024
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Move Nimble / Alletra 6K volume identified by {volumeId} to another pool.

Move Nimble / Alletra 6K volume identified by {volumeId} to another pool.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

Request Body schema: application/json
dest_pool_id
required
string or null

ID of the destination pool or folder. Specify a pool ID when the volumes should not be in a folder; otherwise, specify a folder ID and the pool will be derived from the folder. A 42 digit hexadecimal number

Responses

Request samples

Content type
application/json
{
  • "dest_pool_id": "0a00000000000004d3000000000000000000000001"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Restore Nimble / Alletra 6K volume identified by {volumeId} from a previous snapshot.

Restore Nimble / Alletra 6K volume identified by {volumeId} from a previous snapshot.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

Request Body schema: application/json
base_snap_id
required
string or null

ID of the snapshot to which this the volume is restored.

enable_vol_offline
boolean

Option to specify if volume should be set offline before restore. This value should be set to true if the volume is online.

Responses

Request samples

Content type
application/json
{
  • "base_snap_id": "0a00000000000004d3000000000000000000000481",
  • "enable_vol_offline": true
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get volume capacity trend data of Nimble / Alletra 6K Volume identified by {volumeId}

Get volume capacity trend data of Nimble / Alletra 6K Volume identified by {volumeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "count": 144,
  • "requestUri": "/api/v1/storage-systems/device-type2/00473102de2f5f39d8000000000000000000000001/volumes/37473102de2f5f39d8000000000000000000000027/capacity-history",
  • "series_data": [
    ],
  • "total": 144
}

Create Nimble / Alletra 6K clone volume identified by {volumeId}.

Create Nimble / Alletra 6K clone volume identified by {volumeId}.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

Request Body schema: application/json
clone_volume_name
required
string

Name of the clone volume.

host_group_id
string or null

Identifier for the host group.

lun
integer or null <int64>

Custom LUN ID for the host group. Specify integer in the range 0 to 2047.

Responses

Request samples

Content type
application/json
{
  • "clone_volume_name": "clone_volume",
  • "host_group_id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "lun": 100
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Configure access for volume identified by {volumeId} from Nimble / Alletra 6K identified by {systemId}

Configure access for volume identified by {volumeId} from Nimble / Alletra 6K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

Request Body schema: application/json
apply_to
string or null
Enum: "volume" "snapshot" "both"

Type of object this access control record applies to. Possible values:'volume', 'snapshot', 'both'.

force_apply_to
boolean or null

Forceful export of volume or snapshot as per the requested apply_to option.

Array of objects or null

list of host_groups

Responses

Request samples

Content type
application/json
{
  • "apply_to": "volume",
  • "force_apply_to": true,
  • "host_groups": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get performance trend data of Nimble / Alletra 6K Volume identified by {id}

Get performance trend data of Nimble / Alletra 6K Volume identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "iops_metrics_data": {
    },
  • "latency_metrics_data": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type2/00473102de2f5f39d8000000000000000000000001/volumes/37473102de2f5f39d8000000000000000000000027/performance-history",
  • "throughput_metrics_data": {
    }
}

Get performance statistics of Nimble / Alletra 6K Volume identified by {volumeId}

Get performance statistics of Nimble / Alletra 6K Volume identified by {volumeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "iops": {
    },
  • "latency": {
    },
  • "requestURI": "/api/v1/storage-systems/device-type2/00473102de2f5f39d8000000000000000000000001/volumes/37473102de2f5f39d8000000000000000000000027/performance-statistics",
  • "resourceUri": "/api/v1/storage-systems/device-type2/00473102de2f5f39d8000000000000000000000001/volumes/37473102de2f5f39d8000000000000000000000027/performance-statistics",
  • "throughput": {
    }
}

Get all snapshots' details of Nimble / Alletra 6K Volume identified by {volumeId}

Get all snapshots' details of Nimble / Alletra 6K Volume identified by {volumeId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter snapshots by Key.

sort
string
Example: sort=name desc

oData query to sort snapshots resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/volumes/0625dab4ed8948f2e000000000000000000000003a/snapshots",
  • "total": 1
}

Create Nimble / Alletra 6K snapshot in system identified by {systemId}

Create Nimble / Alletra 6K snapshot in system identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

Request Body schema: application/json
app_uuid
string or null

Application identifier of snapshots. String of up to 255 alphanumeric characters, hyphen, colon, dot and underscore are allowed. Defaults to empty string.

description
string or null

Text description of snapshot. String of up to 255 printable ASCII characters. Defaults to the empty string.

lock_period
integer or null <int64>

Number of seconds to keep a snapshot as immutable.

Array of objects or null or null (KeyValue)

Key-value pairs that augment a volume's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed. Defaults to an empty array.

name
required
string

Name of the snapshot. String of up to 215 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for object sets containing volumes, snapshots, snapshot collections and protocol endpoints.

online
boolean or null

Online state for a snapshot means it could be mounted for data restore. Defaults to 'false'.

writable
boolean or null

Allow snapshot to be writable. Mandatory and must be set to 'true' for VSS application synchronized snapshots. Defaults to 'false'.

Responses

Request samples

Content type
application/json
{
  • "app_uuid": "rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18",
  • "description": "99.9999% availability",
  • "lock_period": 0,
  • "metadata": [
    ],
  • "name": "snap1",
  • "online": false,
  • "writable": false
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove Nimble / Alletra 6K snapshot in system identified by {snapshotId}

Remove Nimble / Alletra 6K snapshot in system identified by {snapshotId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

snapshotId
required
string
Example: 2a0df0fe6f7dc7bb17000000000000000000000008

Identifier of snapshot. A 42 digit hexadecimal number.

query Parameters
force
boolean
Example: force=true

Make snapshot offline and remove.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of snapshot of Nimble / Alletra 6K Volume identified by {volumeId} by {snapshotId}

Get details of snapshot of Nimble / Alletra 6K Volume identified by {volumeId} by {snapshotId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

snapshotId
required
string
Example: 2a0df0fe6f7dc7bb17000000000000000000000008

Identifier of snapshot. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "requestUri": "api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817/volumes/0625dab4ed8948f2e000000000000000000000003a/snapshots/2a0df0fe6f7dc7bb16000000000000000000004007",
  • "id": "2a0df0fe6f7dc7bb16000000000000000000004817",
  • "is_locked": true,
  • "name": "snap1",
  • "online": true,
  • "pool_name": "default",
  • "replication_status": "in_progress",
  • "schedule_id": "2a1df0fe6f7dc7bb16000000000000000000004017",
  • "schedule_name": "snp1",
  • "serial_number": "5596fd1da1c87b8d6c9ce900d3040000",
  • "size": 1024,
  • "snap_collection_id": "2a0df0fe6f7dc7bb16000000000000000000004014",
  • "snap_collection_name": "snp1",
  • "target_name": "iqn.2007-11.com.storage:vol0.762157726640911-v00000000000004d3.00000005.000004d3",
  • "writable": false,
  • "access_control_records": [
    ],
  • "agent_type": "none",
  • "app_uuid": "rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18",
  • "associated_links": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "null",
  • "creation_time": 1598951404,
  • "customerId": "string",
  • "description": "99.9999% availability",
  • "expiry_after": 0,
  • "expiry_time": 0,
  • "generation": 0,
  • "is_manually_managed": false,
  • "is_mfa_protected": true,
  • "is_replica": false,
  • "is_unmanaged": true,
  • "last_modified": 1598952427,
  • "lock_period": 0,
  • "metadata": [
    ],
  • "new_data_compressed_bytes": 0,
  • "new_data_uncompressed_bytes": 0,
  • "new_data_valid": true,
  • "offline_reason": "user",
  • "origin_name": "nimbleGroup",
  • "resourceUri": "/api/v1/storage-systems/device-type2/2a0df0fe6f7dc7bb16000000000000000000004817",
  • "retention_time": 0,
  • "type": "string",
  • "vol_id": "0625dab4ed8948f2e000000000000000000000003a",
  • "vol_name": "vol1",
  • "volume_creator_id": "0600000000000004d3000000000044000000000002",
  • "volume_creator_name": "AF-123456",
  • "vpd_ieee0": "bea16133315c83ab6c9ce90098b0ea001",
  • "vpd_ieee1": "6c9ce90098b0ea001",
  • "vpd_t10": "Nimble bea16133315c83ab6c9ce90098b0ea001",
  • "snapshot_export_details": {
    }
}

Configure access for snapshot identified by {snapshotId} from Nimble / Alletra 6K identified by {systemId}

Configure access for snapshot identified by {snapshotId} from Nimble / Alletra 6K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

snapshotId
required
string
Example: 2a0df0fe6f7dc7bb17000000000000000000000008

Identifier of snapshot. A 42 digit hexadecimal number.

Request Body schema: application/json
apply_to
string or null
Enum: "volume" "snapshot" "both"

Type of object this access control record applies to. Possible values:'volume', 'snapshot', 'both'.

force_apply_to
boolean or null

Forceful export of volume or snapshot as per the requested apply_to option.

Array of objects or null

list of host groups

Responses

Request samples

Content type
application/json
{
  • "apply_to": "snapshot",
  • "force_apply_to": true,
  • "host_groups": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete access for snapshot identified by {snapshotId} from Nimble / Alletra 6K identified by {systemId}

Delete access for snapshot identified by {snapshotId} from Nimble / Alletra 6K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

snapshotId
required
string
Example: 2a0df0fe6f7dc7bb17000000000000000000000008

Identifier of snapshot. A 42 digit hexadecimal number.

Request Body schema: application/json
Array of objects or null

list of host_groups

Responses

Request samples

Content type
application/json
{
  • "host_groups": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Delete access for volume identified by {volumeId} from Nimble / Alletra 6K identified by {systemId}

Delete access for volume identified by {volumeId} from Nimble / Alletra 6K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the storage system

volumeId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000000007

Identifier of volume. A 42 digit hexadecimal number.

Request Body schema: application/json
Array of objects or null

list of host_groups

Responses

Request samples

Content type
application/json
{
  • "host_groups": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Create a clone of a snapshot identified by {snapshotId} for HPE Alletra Storage MP systems.

Create a clone of a snapshot identified by {snapshotId} for HPE Alletra Storage MP systems.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

Request Body schema: application/json
autoLun
boolean or null

Secify to use auto lun number.

destinationCpg
string or null

Name of the User CPG

destinationVolume
required
string

Name of the destination volume.

hostGroupId
string or null

Unique identifier of host group.

lun
integer or null <int64>

LUN of volume.

priority
string or null
Enum: "PRIORITYTYPE_HIGH" "PRIORITYTYPE_MED" "PRIORITYTYPE_LOW"

Priority of the task for clone of a snashot. Defualts to MEDIUM.

Responses

Request samples

Content type
application/json
{
  • "autoLun": true,
  • "destinationCpg": "SSD_r6",
  • "destinationVolume": "destinationVol1",
  • "hostGroupId": "fd3244ef7f1ab8bd16500c7a41bdf8f8",
  • "lun": 0,
  • "priority": "PRIORITYTYPE_MED"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Export vlun for snapshot identified by {id} from HPE Alletra Storage MP identified by {systemId}

Export vlun for snapshot identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

Request Body schema: application/json
Array of objects or null

Custom LUN Id for multiple host groups

autoLun
boolean or null

Auto Lun

hostGroupIds
required
Array of strings or null or null

HostGroups

maxAutoLun
integer or null <int64>

Number of volumes.

noVcn
boolean or null

No VCN

override
boolean or null

Override

position
string or null
Deprecated

Position. This field is deprecated.

proximity
string
Enum: "PRIMARY" "SECONDARY" "ALL"

Host proximity setting for Active Peer Persistence configuration. Supported values are - PRIMARY, SECONDARY and ALL. Default proximity is PRIMARY.

Responses

Request samples

Content type
application/json
{
  • "LUN": [
    ],
  • "autoLun": true,
  • "hostGroupIds": [
    ],
  • "maxAutoLun": 1,
  • "noVcn": true,
  • "override": true,
  • "position": "position_1",
  • "proximity": "PRIMARY"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Unexport vlun for snapshot identified by {id} from HPE Alletra Storage MP identified by {systemId}

Unexport vlun for snapshot identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

Request Body schema: application/json
hostGroupIds
required
Array of strings or null or null

HostGroups

Responses

Request samples

Content type
application/json
{
  • "hostGroupIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of vluns for Snapshot identified by {snapshotId} for HPE Alletra Storage MP

Get details of vluns for Snapshot identified by {snapshotId} for HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=id asc,name desc

Query to sort the response with specified key and order

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "- TO BE IMPLEMENTED",
  • "total": 2
}

Get details of vlun identified by {id} for Snapshot identified by {snapshotId} for HPE Alletra Storage MP

Get details of vlun identified by {id} for Snapshot identified by {snapshotId} for HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the vlun

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/volumes/{volumeUid}/vluns/{uid}",
  • "deviceWWNs": "",
  • "diskPartition": "",
  • "displayname": "",
  • "domain": "",
  • "failedPathInterval": 1,
  • "failedPathPolicy": "",
  • "id": "",
  • "initiators": {
    },
  • "lun": 1,
  • "mountPoint": "",
  • "mountPointFsau": 1,
  • "multiPathType": "",
  • "portPos": {
    },
  • "rawVolume": "",
  • "remoteName": "",
  • "requestUri": "- TO BE IMPLEMENTED",
  • "resourceUri": "- TO BE IMPLEMENTED",
  • "state": {
    },
  • "status": "",
  • "systemId": "",
  • "tpgId": 1,
  • "type": "",
  • "usedSpace": 1,
  • "volumeGroup": "",
  • "volumeManager": "",
  • "volumeName": "",
  • "volumeWWN": "",
  • "vvReservedUserSpace": 1,
  • "vvSize": 1
}

Get all volumes details for HPE Alletra Storage MP

Get all volumes details for HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/primea/2FF70002AC018D94/volumes",
  • "total": 1
}

Create volume for a storage system HPE Alletra Storage MP

Create volume for a storage system HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
comments
string or null

test

count
integer or null

Volumes count

dataReduction
boolean or null

Data Reduction

name
required
string

Name of the volume. For the HPE Alletra Storage MP systems, the maximum supported length is 31 characters in OS versions up to 10.4.0. For the OS version 10.4.2 and above, this limit is 255 characters.

sizeMib
required
integer

Size of the volume to be created.

snapshotAllocWarning
integer or null

Snapshot Alloc Warning

userAllocWarning
integer or null

User Alloc Warning

userCpg
required
string

User CPG

Responses

Request samples

Content type
application/json
{
  • "comments": "test",
  • "count": 2,
  • "dataReduction": true,
  • "name": "<resource_name>",
  • "sizeMib": 16384,
  • "snapshotAllocWarning": 5,
  • "userAllocWarning": 5,
  • "userCpg": "SSD_r6"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get performance history of Volumes on storage system identified by {systemid}

Get performance history of Volumes on storage system identified by {systemid}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
reportType
string
Example: reportType=Canned,Custom,Def,ApiUser

parameter will be set to report type requested. For api users, set parameter as ApiUser

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

compareBy
string
Example: compareBy=top eq 5 and metrics eq readIops

compareBy will define top and compare metrics for which query has to be made. Allowed values: readIops, writeIops, totalIops, readThroughput, writeThroughput, totalThroughput, readLatency, writeLatency, totalLatency, readIosize, writeIosize, totalIosize, totalQlen, avgBusy

groupBy
string
Example: groupBy=vvName

groupBy will define comma separated groupBy parameters. Allowed values are: vvName, hostName, appsetType, appsetName, portNsp, targetName. By default, groupBy will be set to vvName. If groupBy is used along with filter query parameter, only following combinations are allowed:

  • filter: vvId eq 179fa4a77c8497aacdee87d0fb67066b then groupBy should be vvName
  • filter: appsetId eq 4765171ee6d74340fca5996b90875d45 then groupBy should be appsetName
  • filter: hostIds eq 61e2d16fb28d5e6e75198039fcb4f068 then groupBy should be hostName
  • filter: targetName eq 08BM_s0B8X then groupBy should be targetName
filter
string
Example: filter=vvId in (5df1fc8108e1c74b7041625a2f94d098,cd6c28c563b60f391fcd6dee8b92360c)

filter will define objects to be filtered. Filterable columns are:

  • hostIds - id of the host
  • appsetId - id of the application set
  • vvId - id of the volume
  • targetName - name of the replication partner
component
string
Value: "VLUN"
Example: component=VLUN

component will give information about resource to be queried

metricType
string
Example: metricType=IOPS,LATENCY,THROUGHPUT,IOSIZE,QLEN,AVG_BUSY

metricType will define comma separated metrics

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 162564271,
  • "historyData": {
    },
  • "requestUri": "/v1/storage-systems/device-type4/SGH014XGSP/volumes/performance-history",
  • "startTime": 1625556314
}

Remove volume identified by {volumeId} from HPE Alletra Storage MP

Remove volume identified by {volumeId} from HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
unExport
boolean
Example: unExport=true

UnExport Host,HostSet and delete volume

cascade
boolean
Example: cascade=true

Delete snapshot and volume

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of HPE Alletra Storage MP Volume identified by {id}

Get details of HPE Alletra Storage MP Volume identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "adminAllocationSettings": {
    },
  • "associatedLinks": [
    ],
  • "baseId": 0,
  • "bulkvv": true,
  • "comment": "string",
  • "commonResourceAttributes": {
    },
  • "compressionPolicy": "string",
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/volumes/{uid}",
  • "conversionType": "CONVERSIONTYPE_THIN",
  • "copyOfID": 0,
  • "copyOfShortName": "VegaCopyOfShortNames~66",
  • "creationTime": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "dataReduction": "string",
  • "dedup": "string",
  • "devType": "string",
  • "displayname": "string",
  • "domain": "string",
  • "efficiencyUpdateTime": {
    },
  • "expirationTime": {
    },
  • "fullyProvisioned": true,
  • "generation": 0,
  • "headsPerCylinder": 0,
  • "healthState": 0,
  • "hidden": true,
  • "id": "string",
  • "initiators": [
    ],
  • "name": "Finance",
  • "nguid": "60002AC0000800660002AC130007EEFD",
  • "parentID": 0,
  • "pevv": true,
  • "physParentID": 0,
  • "physicalCopy": true,
  • "policy": {
    },
  • "provType": "string",
  • "raid": "string",
  • "rcopyStatus": "string",
  • "readOnly": true,
  • "requestUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/volumes/{uid}",
  • "resourceUri": "/v1/storage-systems/device-type4/2FF70002AC018D94/volumes/{uid}",
  • "retentionTime": {
    },
  • "roChildID": 0,
  • "rwChildID": 0,
  • "sectorsPerTrack": 0,
  • "sharedParentId": 0,
  • "shortName": "VegaVolumesShortName~67245",
  • "snapShotTier": "string",
  • "snapshotAllocLimit": 0,
  • "snapshotAllocWarning": 0,
  • "snapshotAllocationSettings": {
    },
  • "spaceCalculationTime": {
    },
  • "started": true,
  • "state": {
    },
  • "storageTier": "string",
  • "systemId": "7CE751P312",
  • "thinProvisioned": true,
  • "type": "string",
  • "unrefSpaceFreedTime": {
    },
  • "userAllocLimit": 0,
  • "userAllocWarning": 0,
  • "userAllocationSettings": {
    },
  • "userCpgID": 0,
  • "userCpgName": "string",
  • "usrCpgShortName": "VegaUserCpgShortName~97",
  • "vlunSectorSize": 0,
  • "volumeCapacity": {
    },
  • "volumeId": 0,
  • "volumePerformance": {
    },
  • "volumeType": "VVTYPE_BASE",
  • "wwn": "60002AC0000000000000006B0001FFEB"
}

Edit volume identified by {volumeId} from HPE Alletra Storage MP

Edit volume identified by {volumeId} from HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

Request Body schema: application/json
conversionType
string or null
Enum: "CONVERSIONTYPE_THIN" "CONVERSIONTYPE_DDS" "CONVERSIONTYPE_V1" "CONVERSIONTYPE_V2"

conversion type (this argument is depricated, use dataReduction instead)

dataReduction
boolean or null

Data Reduction on Volume.

name
string or null

volume name. For the HPE Alletra Storage MP systems, the maximum supported length is 31 characters in OS versions up to 10.4.0. For the OS version 10.4.2 and above, this limit is 255 characters.

sizeMib
number or null <float64>

Size of the volume to be edited.

snapshotAllocWarning
integer or null <int64>

snapshot alloc space allocation warning

userAllocWarning
integer or null <int64>

User alloc space limit warning

userCpgName
string or null

user cpg name

Responses

Request samples

Content type
application/json
{
  • "conversionType": "CONVERSIONTYPE_THIN",
  • "dataReduction": true,
  • "name": "volume_Name",
  • "sizeMib": 1,
  • "snapshotAllocWarning": 1,
  • "userAllocWarning": 1,
  • "userCpgName": "cpg_1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get volume capacity trend data of HPE Alletra Storage MP Volume identified by {id}

Get volume capacity trend data of HPE Alletra Storage MP Volume identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "capacityData": {
    },
  • "commonResourceAttributes": {
    },
  • "endTime": 1625209133,
  • "requestUri": "/v1/storage-systems/device-type4/SGH014XGSP/volumes/a7c4e6593f51d0b98f0e40d7e6df04fd/capacity-history",
  • "startTime": 1625122733
}

Create a clone volume identified by {id} for HPE Alletra Storage MP systems.

Create a clone volume identified by {id} for HPE Alletra Storage MP systems.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

Request Body schema: application/json
destinationVolume
required
string

Name of the destination volume.

object or null (DeviceType4offlineClone)

Offline clone of a volume.

online
boolean or null

Create an online or offline clone of a volume.

object or null (DeviceType4onlineClone)

Online clone of a volume.

priority
string or null
Enum: "PRIORITYTYPE_HIGH" "PRIORITYTYPE_MED" "PRIORITYTYPE_LOW"

Priority of the task for clone volume. Defualts to MEDIUM.

Responses

Request samples

Content type
application/json
{
  • "destinationVolume": "destinationVol1",
  • "offlineClone": {
    },
  • "online": true,
  • "onlineClone": {
    },
  • "priority": "PRIORITYTYPE_MED"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Export vlun for volume identified by {id} from HPE Alletra Storage MP identified by {systemId}

Export vlun for volume identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

Request Body schema: application/json
Array of objects or null

Custom LUN Id for multiple host groups

autoLun
boolean or null

Auto Lun

hostGroupIds
required
Array of strings or null or null

HostGroups

maxAutoLun
integer or null <int64>

Number of volumes.

noVcn
boolean or null

No VCN

override
boolean or null

Override

position
string or null
Deprecated

Position. This field is deprecated.

proximity
string
Enum: "PRIMARY" "SECONDARY" "ALL"

Host proximity setting for Active Peer Persistence configuration. Supported values are - PRIMARY, SECONDARY and ALL. Default proximity is PRIMARY.

Responses

Request samples

Content type
application/json
{
  • "LUN": [
    ],
  • "autoLun": true,
  • "hostGroupIds": [
    ],
  • "maxAutoLun": 1,
  • "noVcn": true,
  • "override": true,
  • "position": "position_1",
  • "proximity": "PRIMARY"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get histogram buckets distribution of I/Os of a volume for a given duration.

Get histogram buckets distribution of I/Os of a volume for a given duration. buckets query param must be one or more combination of the following values: Size512B, Size1k, Size2k, Size4k, Size8k, Size16k, Size32k, Size64k, Size128k, Size256k, Size512k, Size1m, Size2m

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

ioType
string
Enum: "read" "write"

Indicates if histogram metrics to be calculated for read or write.

buckets
string

Comma separated buckets list. Following values are supported: Size512B, Size1k, Size2k, Size4k, Size8k, Size16k, Size32k, Size64k, Size128k, Size256k, Size512k, Size1m, Size2m

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "endTime": 1669880791,
  • "requestUri": "/api/v1/storage-systems/device-type4/ABC239XFZ9/volumes/60002AC000000000000005B200029834/performance-histogram",
  • "sizeHistogramData": {
    },
  • "startTime": 1669794391
}

Get performance trend data of HPE Alletra Storage MP Volume identified by {id}

Get performance trend data of HPE Alletra Storage MP Volume identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

range
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

range will define start and end time in which query has to be made.

timeIntervalMin
integer
Enum: 5 60 1440 10080
Example: timeIntervalMin=60

It defines granularity in minutes.

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 162564271,
  • "historyData": {
    },
  • "requestUri": "/v1/storage-systems/device-type4/SGH014XGSP/volumes/a7c4e6593f51d0b98f0e40d7e6df04fd/performance-history",
  • "startTime": 1625556314
}

Get performance statistics of HPE Alletra Storage MP Volume identified by {id}

Get performance statistics of HPE Alletra Storage MP Volume identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "commonResourceAttributes": {
    },
  • "iops": {
    },
  • "latencyMs": {
    },
  • "requestUri": "/v1/storage-systems/device-type4/SGH014XGSP/volumes/a7c4e6593f51d0b98f0e40d7e6df04fd/performance-statistics",
  • "resourceUri": "/v1/storage-systems/device-type4/SGH014XGSP/volumes/a7c4e6593f51d0b98f0e40d7e6df04fd/performance-statistics",
  • "throughputKbps": {
    }
}

Get snapshot details of volume identified by {id} for HPE Alletra Storage MP

Get snapshot details of volume identified by {id} for HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/device-type4/7CE751P312/applicationsets/8c18425671d44803b4512f4ca1917410/snapshots",
  • "total": 1
}

Create snapshot for volumes identified by {id}

Create snapshot for volumes identified by {id}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

Request Body schema: application/json
comment
string or null

Comment if any

customName
string or null

Name for snapshot. For the HPE Alletra Storage MP systems, the maximum supported length is 31 characters in OS versions up to 10.4.0. For the OS version 10.4.2 and above, this limit is 255 characters.

expireSecs
integer or null

Expiration time in seconds

namePattern
required
string or null (DeviceType4NamePattern)
Enum: "PARENT_TIMESTAMP" "PARENT_SEC_SINCE_EPOCH" "CUSTOM"

name pattern

readOnly
boolean or null

Read only or Read/Write

retainSecs
integer or null <int64>

Reatain time in seconds

Responses

Request samples

Content type
application/json
{
  • "comment": "",
  • "customName": "snap1",
  • "expireSecs": 86400,
  • "namePattern": "PARENT_TIMESTAMP",
  • "readOnly": false,
  • "retainSecs": 86400
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Unexport vlun for volume identified by {id} from HPE Alletra Storage MP identified by {systemId}

Unexport vlun for volume identified by {id} from HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

Request Body schema: application/json
hostGroupIds
required
Array of strings or null or null

HostGroups

Responses

Request samples

Content type
application/json
{
  • "hostGroupIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of vluns for Volume identified by {volumeId} for HPE Alletra Storage MP

Get details of vluns for Volume identified by {volumeId} for HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=id asc,name desc

Query to sort the response with specified key and order

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "- TO BE IMPLEMENTED",
  • "total": 2
}

Get the details of the clone volumes associated with a base volume identified by {volumeId} for HPE Alletra Storage MP systems.

Get the details of the clone volumes associated with a base volume identified by {volumeId} for HPE Alletra Storage MP systems.

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/primea/2FF70002AC018D94/volumes",
  • "total": 1
}

Promote a clone volume identified by {cloneId} of a volume identified by {volumeId} on storage system HPE Alletra Storage MP identified by {systemId}

Promote a clone volume identified by {cloneId} of a volume identified by {volumeId} on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

cloneId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the clone

Request Body schema: application/json
priority
string or null (DeviceType4ClonePriority)
Enum: "PRIORITYTYPE_HIGH" "PRIORITYTYPE_MED" "PRIORITYTYPE_LOW"

Priority of the task for promoting/resynchronizing the clone volume. Defaults to MEDIUM.

Responses

Request samples

Content type
application/json
{
  • "priority": "PRIORITYTYPE_MED"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Resynchronize a clone volume identified by {cloneId} of a volume identified by {volumeId} on storage system HPE Alletra Storage MP identified by {systemId}

Resynchronize a clone volume identified by {cloneId} of a volume identified by {volumeId} on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

cloneId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the clone

Request Body schema: application/json
priority
string or null (DeviceType4ClonePriority)
Enum: "PRIORITYTYPE_HIGH" "PRIORITYTYPE_MED" "PRIORITYTYPE_LOW"

Priority of the task for promoting/resynchronizing the clone volume. Defaults to MEDIUM.

Responses

Request samples

Content type
application/json
{
  • "priority": "PRIORITYTYPE_MED"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get volume latency annotations for device-type4

Get the high latency points to be annotated segregated into read and write categories

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: ABC239XFZ9

SystemId of the HPE Alletra Storage MP storage system

volumeId
required
string
Example: 60002AC000000000000005B200029834

VolumeId of the device-type4 storage system

query Parameters
timeIntervalMin
required
integer
Enum: 5 60 1440

Time interval granularity in minutes

range
required
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

Specifies the time period for which hotspot metrics are to be calculated. Both startTime and endTime should be specified

operationType
string
Enum: "READ" "WRITE" "ALL"
Example: operationType=READ

Indicates if hotspots metrics to be calculated for read, write or both operations. If this field is not provided, hotspots are calculated for both operations

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "customerId": "fc5f41652a53497e88cdcebc715cc1cf",
  • "endTime": 1669880791,
  • "latencyAnnotations": {
    },
  • "requestUri": "/api/v1/storage-systems/device-type4/ABC239XFZ9/volumes/60002AC000000000000005B200029834/insights/latency-annotations",
  • "startTime": 1669794391,
  • "systemId": "ABC239XFZ9",
  • "volumeId": "60002AC000000000000005B200029834"
}

Get latency drifts of a volume for a give duration

Get latency drifts of a volume for a give duration.The minimum duration supported is 8 hours and a maximum duration of 2 days. Drifts are detected in both read and write latency metrics

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: ABC239XFZ9

SystemId of the HPE Alletra Storage MP storage system

volumeId
required
string
Example: 60002AC000000000000005B200029834

VolumeId of the device-type4 storage system

query Parameters
timeIntervalMin
required
integer
Enum: 5 60 1440

Time interval granularity in minutes

range
required
string
Example: range=startTime eq 1605063600 and endTime eq 1605186000

Specifies the time period for which hotspot metrics are to be calculated. Both startTime and endTime should be specified

operationType
string
Enum: "READ" "WRITE" "ALL"
Example: operationType=READ

Indicates if hotspots metrics to be calculated for read, write or both operations. If this field is not provided, hotspots are calculated for both operations

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "driftsDetected": [
    ],
  • "endTime": 1669880791,
  • "requestUri": "/api/v1/storage-systems/device-type4/ABC239XFZ9/volumes/60002AC000000000000005B200029834/insights/performance-drifts",
  • "startTime": 1669794391,
  • "systemId": "ABC239XFZ9",
  • "tenantId": "fc5f41652a53497e88cdcebc715xxxxx",
  • "timezone": "Asia/Calcutta",
  • "volumeId": "60002AC000000000000005B200029834"
}

Remove HPE Alletra Storage MP snapshot in system identified by {snapshotId}

Remove HPE Alletra Storage MP snapshot in system identified by {snapshotId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

Identifier of snapshot.

query Parameters
force
boolean
Example: force=true

Make snapshot offline and remove.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of snapshot identified by {snapshotId} for Volume identified by {volumeId} for HPE Alletra Storage MP

Get details of vlun identified by {id} for Volume identified by {volumeId} for HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "adminAllocationSettings": {
    },
  • "baseId": 0,
  • "comment": "string",
  • "commonResourceAttributes": {
    },
  • "compressionPolicy": "string",
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/volumes/014f8f647893f228bcf8b7c3f7eebbc5/snapshots/e1892c0fb437d0aeef880124c2db9957",
  • "conversionType": "CONVERSIONTYPE_THIN",
  • "copyOfID": 0,
  • "creationTime": {
    },
  • "customerId": "string",
  • "dataReduction": "string",
  • "dedup": "string",
  • "devType": "string",
  • "displayname": "string",
  • "domain": "string",
  • "efficiencyUpdateTime": {
    },
  • "expirationTime": {
    },
  • "fullyProvisioned": true,
  • "generation": 0,
  • "headsPerCylinder": 0,
  • "healthState": 0,
  • "hidden": true,
  • "id": "b7107a30-260a-41c1-a47f-e50770c414c9",
  • "initiators": [
    ],
  • "name": "Finance",
  • "parentID": 0,
  • "physParentID": 0,
  • "physicalCopy": true,
  • "policy": {
    },
  • "provType": "string",
  • "raid": "string",
  • "rcopyStatus": "string",
  • "readOnly": true,
  • "retentionTime": {
    },
  • "roChildID": 0,
  • "rwChildID": 0,
  • "sectorsPerTrack": 0,
  • "sharedParentId": 0,
  • "snapshotAllocLimit": 0,
  • "snapshotAllocWarning": 0,
  • "snapshotAllocationSettings": {
    },
  • "snapshotCapacity": {
    },
  • "snapshotId": 0,
  • "snapshotType": "string",
  • "spaceCalculationTime": {
    },
  • "started": true,
  • "state": {
    },
  • "systemId": "7CE751P312",
  • "thinProvisioned": true,
  • "type": "string",
  • "unrefSpaceFreedTime": {
    },
  • "userAllocLimit": 0,
  • "userAllocWarning": 0,
  • "userAllocationSettings": {
    },
  • "userCpgID": 0,
  • "userCpgName": "string",
  • "vlunSectorSize": 0,
  • "wwn": "60002AC0000000000000006B0001FFEB"
}

Promote a snapshot identified by {snapshotId} of a volume identified by {volumeId} on storage system HPE Alletra Storage MP identified by {systemId}

Promote a snapshot identified by {snapshotId} of a volume identified by {volumeId} on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

snapshotId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the snapshots

Request Body schema: application/json
priority
string or null (DeviceType4Priority)
Enum: "PRIORITYTYPE_HIGH" "PRIORITYTYPE_MED" "PRIORITYTYPE_LOW"

Priority of the task for promoting the snapshot. Defualts to PRIORITYTYPE_MED.

target
string or null

Target volume name to which the snapshot need to be promoted. If not specified it will be promoted to its base volume.

Responses

Request samples

Content type
application/json
{
  • "priority": "PRIORITYTYPE_HIGH",
  • "target": "volume1"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Remove vlun idenfied by {id} form volume identified by {volumeId} from HPE Alletra Storage MP

Remove vlun idenfied by {id} form volume identified by {volumeId} from HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the vlun

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Get details of vlun identified by {id} for Volume identified by {volumeId} for HPE Alletra Storage MP

Get details of vlun identified by {id} for Volume identified by {volumeId} for HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

volumeId
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID of the vlun

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/device-type4/SGH014XGSP/volumes/{volumeUid}/vluns/{uid}",
  • "deviceWWNs": "",
  • "diskPartition": "",
  • "displayname": "",
  • "domain": "",
  • "failedPathInterval": 1,
  • "failedPathPolicy": "",
  • "id": "",
  • "initiators": {
    },
  • "lun": 1,
  • "mountPoint": "",
  • "mountPointFsau": 1,
  • "multiPathType": "",
  • "portPos": {
    },
  • "rawVolume": "",
  • "remoteName": "",
  • "requestUri": "- TO BE IMPLEMENTED",
  • "resourceUri": "- TO BE IMPLEMENTED",
  • "state": {
    },
  • "status": "",
  • "systemId": "",
  • "tpgId": 1,
  • "type": "",
  • "usedSpace": 1,
  • "volumeGroup": "",
  • "volumeManager": "",
  • "volumeName": "",
  • "volumeWWN": "",
  • "vvReservedUserSpace": 1,
  • "vvSize": 1
}

Get all volumes

Get all volumes

Authorizations:
JWTAuth
query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=name eq array1 and wwn eq 2FF70002AC018D94

oData query to filter by Key.

sort
string
Example: sort=systemWWN desc

oData query to sort by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/v1/storage-systems/volumes",
  • "total": 1
}

Get details of Volume identified by {id}

Get details of Volume identified by {id}

Authorizations:
JWTAuth
path Parameters
id
required
string
Example: a7c4e6593f51d0b98f0e40d7e6df04fd

UID(volumeuid) of the storage system

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "associatedLinks": [
    ],
  • "commonResourceAttributes": {
    },
  • "consoleUri": "data-ops-manager/storage-systems/volumes/{uid}",
  • "customerId": "string",
  • "generation": 0,
  • "healthState": "NORMAL",
  • "hostWrittenCapacityMiB": 0,
  • "id": "string",
  • "initiators": [
    ],
  • "isInternal": false,
  • "isSystemVolume": false,
  • "name": "Finance",
  • "productFamily": "deviceType1",
  • "requestUri": "/v1/storage-systems/{systemUid}/volumes/{uid}",
  • "resourceUri": "/v1/storage-systems/device-type1/2FF70002AC01F0FF/volumes/{uid}",
  • "sizeMiB": 0,
  • "spaceWarning": 0,
  • "subType": "PROVTYPE_DDS",
  • "systemId": "7CE751P312",
  • "thinSavings": "1:1",
  • "type": "string",
  • "usedCapacityPercent": 1.2345,
  • "usedSizeMiB": 0,
  • "volumeSetId": "7CE751P312",
  • "volumeType": "VVTYPE_BASE",
  • "wwn": "string"
}

vvolscs

The vvolscs API allows the management of VMware storage container.

Creates VMware storage container on storage system Primera / Alletra 9K identified by {systemId}

Creates VMware storage container on storage system Primera / Alletra 9K identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
comment
string or null

Storage Container Comment

domain
string or null

Domain that the resource belongs to

hostIDs
Array of strings or null

Host IDs

hostSetIDs
Array of strings or null

Host Set IDs

keep
boolean or null

Indicates if a volume set with existing volumes to be marked as a VMware storage container

members
Array of strings

Names of the set members

name
required
string

Storage Container Name.

Responses

Request samples

Content type
application/json
{
  • "comment": "test",
  • "domain": "domain",
  • "hostIDs": [
    ],
  • "hostSetIDs": [
    ],
  • "keep": true,
  • "members": [
    ],
  • "name": "<resource_name>"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Edit Storage container identified by {vvolscId} from Primera / Alletra 9K

Edit Storage container identified by {volumeId} from Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vvolscId
required
string
Example: d09b59cd7bd07a4e9559e78dcea07498

Storage container UID

Request Body schema: application/json
comment
string or null

Comments for the object set to be modified

Array of objects or null

List of member object to set proximity for host and rcopy groups

members
Array of strings or null

List of members of the object set to be modified

name
string or null

Storage Container Name.

Responses

Request samples

Content type
application/json
{
  • "comment": "test",
  • "hostProximity": [
    ],
  • "members": [
    ],
  • "name": "<resource_name>"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Attach host to Storage container identified by {vvolscId} from Primera / Alletra 9K

Attach host to Storage container identified by {vvolscId} from Primera / Alletra 9K

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vvolscId
required
string
Example: d09b59cd7bd07a4e9559e78dcea07498

Storage container UID

Request Body schema: application/json
action
string
Value: "ATTACH_VVOLSC"

Attach action name

hostIDs
Array of strings or null

Host IDs

hostSetIDs
Array of strings or null

Host Set IDs

Responses

Request samples

Content type
application/json
{
  • "action": "ATTACH_VVOLSC",
  • "hostIDs": [
    ],
  • "hostSetIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Creates VMware storage container on storage system HPE Alletra Storage MP identified by {systemId}

Creates VMware storage container on storage system HPE Alletra Storage MP identified by {systemId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

Request Body schema: application/json
domain
string or null

Domain that the resource belongs to

hostIDs
Array of strings or null

Host IDs

hostSetIDs
Array of strings or null

Host Set IDs

name
required
string

Storage Container Name.

scType
string or null

Field is supported from 10.4.0 and above. Indicates the type of the VMware VASA storage container that would get created in the system. Valid values are NVMe and SCSI.

transportType
string or null

Transport type of the NVMe protocol. The value will be either NVMe/FC or NVMe/TCP and the default value is NVMe/FC. This parameter is supported from the system OS version 10.5.0. Transport type will be used to attach or detach a NVMe/TCP or NVMe/FC hosts/host groups from a storage container created with NVMe protocol.

Responses

Request samples

Content type
application/json
{
  • "domain": "domain",
  • "hostIDs": [
    ],
  • "hostSetIDs": [
    ],
  • "name": "<resource_name>",
  • "scType": "SCSI",
  • "transportType": "string"
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Attach host to Storage container identified by {vvolscId} from HPE Alletra Storage MP

Attach host to Storage container identified by {volumeId} from HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vvolscId
required
string
Example: d09b59cd7bd07a4e9559e78dcea07498

Storage container UID

Request Body schema: application/json
action
string

Attach or Detach action name

object

Responses

Request samples

Content type
application/json
{
  • "action": "string",
  • "parameter": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

Detach host to Storage container identified by {vvolscId} from HPE Alletra Storage MP

Detach host to Storage container identified by {volumeId} from HPE Alletra Storage MP

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

vvolscId
required
string
Example: d09b59cd7bd07a4e9559e78dcea07498

Storage container UID

Request Body schema: application/json
action
string

Attach or Detach action name

object

Responses

Request samples

Content type
application/json
{
  • "action": "string",
  • "parameter": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully submitted",
  • "status": "SUBMITTED",
  • "taskUri": "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
}

InventoryHistory

Get details of HPE Alletra Storage MP Inventory history

Get details of HPE Alletra Storage MP Inventory history

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

query Parameters
limit
integer >= 0
Example: limit=10

Number of items to return at a time

offset
integer >= 0
Example: offset=5

The offset of the first item in the collection to return

filter
string
Example: filter=id eq 2a0df0fe6f7dc7bb16000000000000000000004817

Lucene query to filter InventoryUpdate by Key.

sort
string
Example: sort=logTime desc

oData query to sort InventoryUpdate resource by Key.

select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pageLimit": 1,
  • "pageOffset": 1,
  • "requestUri": "/api/v1/storage-systems/device-type4/inventory-history",
  • "total": 1
}

Get details of HPE Alletra Storage MP InventoryUpdate identified by {inventoryUpdateId}

Get details of HPE Alletra Storage MP InventoryUpdate identified by {inventoryUpdateId}

Authorizations:
JWTAuth
path Parameters
systemId
required
string
Example: 7CE751P312

systemId of the storage system

inventoryUpdateId
required
string
Example: 2a0df0fe6f7dc7bb16000000000000000000004817

ID of the HPE Alletra Storage MP Inventory Update. A 42 digit hexadecimal number.

query Parameters
select
string
Example: select=id

Query to select only the required parameters, separated by . if nested

Responses

Response samples

Content type
application/json
{
  • "changes": [
    ],
  • "customerId": "string",
  • "displayname": "Component - Cage 1, Sub-Component - Node 0, Change - Added",
  • "generation": 0,
  • "lastModifiedEpoch": 1669184604,
  • "parent": {
    },
  • "subComponent": "Node 0",
  • "systemId": "9c3c4f29a82fd8d632ff379116fa0b88",
  • "systemWWN": "swK21",
  • "type": "string",
  • "uid": "2ada727846d8a6e34540e619a6945aa2",
  • "uri": "/api/v3/inventory-history/2492b4e84f7536577a38be78f0da0c1a"
}