Skip to content
/ports

HPE Greenlake For Storage Fleet REST APIs (1.2.0)

HPE Greenlake For Storage Fleet REST APIs

Download OpenAPI description
storage-fleet-api.json
storage-fleet-api.yaml
Overview
License

HPE End User License Agreement

Languages
Servers

https://eu1.data.cloud.hpe.com/

https://us1.data.cloud.hpe.com/

https://jp1.data.cloud.hpe.com/

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/storage-fleet/public/openapi/storage-fleet-public-v1alpha1/storage-fleet-api/

certificates

The Certificate API provides endpoints for managing and configuring certificates.

Operations

controllers

The controllers API allows the management of controller fleet.

Operations

enclosures

The Enclosure API provides endpoints for managing and configuring enclosures.

Operations

encryption

The encryption API allows the actions on encryption.

Operations

jbofioms

The JBOF IOM API provides endpoints for managing and configuring JBOF IOMs.

Operations

object-notification-clients

The Object Notification Client API provides endpoints for managing and configuring object notification clients.

Operations

ports

The ports API allows the management of ports.

Operations

Get details of HPE Alletra Storage MP B10000 Ports

Request

Get details of HPE Alletra Storage MP B10000 Ports

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Query
limitinteger[ 0 .. 5000 ]

Number of items to return at a time

Default 100
Example: limit=10
offsetinteger[ 0 .. 100000 ]

The offset of the first item in the collection to return

Default 0
Example: offset=5
filterstring

oData query to filter ports by Key.

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

oData query to sort ports by Key.

Example: sort=name desc
selectstring

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

Example: select=id
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(DeviceType4portsList)required
items[].​idstringrequired

Unique Identifier of the resource Filter

Example: "9d765763116c20a508e8996f2a10821d"
items[].​typestringrequired

type

Example: "string"
items[].​associatedLinksArray of objects or null(DeviceType4portsAssociatedLinks)
items[].​cardTypeobject or null(DeviceType4cardType)
items[].​classinteger or null

Fibre Channel class (can be either 2 or 3)

items[].​class2string or null

Class2 state and configuration

items[].​commonResourceAttributesobject or null(commonResourceAttributes)
items[].​configstring or null

Configuration state of port

Example: "valid"
items[].​configModestring or null

Connection mode of the port

items[].​connectionTypestring or null

port connection type

items[].​customerIdstring or null

customerId

Example: "string"
items[].​devicesArray of objects or null or null(DeviceType4connectedDevices)
items[].​displaynamestring or null

Name to be used for display purposes

items[].​domainstring or null

Domain that the resource belongs to

items[].​enclosureCardIdinteger or null

ID of the enclosure card

items[].​enclosureCardPciUidstring or null

UID of the enclosure card PCI card

items[].​enclosureCardUidstring or null

Unique Identifier of the enclosure card

items[].​enclosureIdinteger or null

ID of the enclosure

items[].​enclosureUidstring or null

Unique Identifier of the enclosure Filter

items[].​fcDataobject or null(DeviceType4portFC)
items[].​fileDataobject or null(DeviceType4portFile)
items[].​fwVersionstring or null

Firmware version

Example: "12.2.396.1"
items[].​generationinteger or null

generation

Example: 0
items[].​hostVirtualPortsArray of objects or null or null(DeviceType4HostVirtualPort)
items[].​interruptCoalescestring or null

Interrupt Coalesce

items[].​ipDataobject or null(DeviceType4portIP)
items[].​iscsiDataobject or null(DeviceType4portISCSI)
items[].​labelstring or null

Label Filter, Sort

Example: "IP0"
items[].​manufacturingobject or null(DeviceType4ManufacturingSingle)
items[].​modestring or null

Current mode the port is in Filter, Sort

items[].​modeChangestring or null

Indicates if the mode change is allowed or prohibited

items[].​namestring or null

Name of the resource Filter, Sort

items[].​nodeIdstring or null

Unique Identifier of the node Filter

Example: "e9d353bf98fc1a6bdb90b824e3ca14b5"
items[].​nvmeDataobject or null(DeviceType4PortNVMe)
items[].​partnerobject or null(DeviceType4partner)
items[].​portSfpobject or null(DeviceType4portSfp)
items[].​portTypestring or null

Type of the port based on the device it is connected to Filter, Sort

items[].​positionobject or null(DeviceType4portPosition)
items[].​protocolstring or null

Current protocol the port is in Filter, Sort

items[].​resourceUristring or null

resourceUri for detailed port object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports/220fcd48857f63c0f354c6723ec5d5cb"
items[].​revisionstring or null

Revision of the Host Bus Adapter

items[].​smartSanstring or null

Smart SAN status

items[].​speedActualstring or null

Actual speed that port is running at Filter

items[].​speedConfiguredstring or null

Speed that is configured to run as

items[].​speedMaxstring or null

Maximum speed that port can run at

items[].​speedMinstring or null

Minimum speed that port can run at

items[].​stateobject or null(DeviceType4State)
items[].​stateDescriptionArray of strings or null or null(DeviceType4stateDescription)
items[].​systemIdstring or null

SystemUid/SerialNumber of the array.

Example: "7CE751P312"
items[].​tgtModeWriteOptstring or null

Target mode write optimization setting

items[].​uniqueWwnstring or null

Unique WWN setting

items[].​vcnstring or null

VLUN change notification

items[].​virtualPortsArray of objects or null

Virtual ports

items[].​vlansArray of objects or null or null(DeviceType4vlan)
totalinteger

Total number of items matching the filter parameter in the request.

Response
application/json
{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

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

Request

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

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
Query
report-typestring

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

Example: report-type=Canned,Custom,Def,ApiUser
rangestring

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

Example: range=startTime eq 1605063600 and endTime eq 1605186000
time-interval-mininteger

It defines granularity in minutes.

Enum5601440
Example: time-interval-min=60
compare-bystring

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

Example: compare-by=top eq 5 and metrics eq readIops
group-bystring

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
Example: group-by=port_type,nsp
metric-typestring

metricType will define comma separated metrics

Example: metric-type=IOPS,LATENCY,THROUGHPUT,IOSIZE,QLEN,AVG_BUSY
filterstring

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

Example: filter=port_type eq host and nsp in (0:3:1,0:4:1)
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports-performance \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects or null(DeviceType4PerformanceHistoryData)required
items[].​idstringrequired

Identifier for the resource.

Example: "6848ef683c27403e96caa51816ddc72c"
items[].​typestringrequired

type

Example: "Type of the resource"
items[].​commonResourceAttributesobject or null(commonResourceAttributesPerf)
items[].​customerIdstring or null

customerId

Example: "fc5f41652a53497e88cdcebc715cc1cf"
items[].​endTimeinteger or null

end time of history data

Example: 162564271
items[].​historyDataobject or null

performance history data

items[].​startTimeinteger or null

start time of history data

Example: 1625556314
totalinteger

Total number of items matching the filter parameter in the request.

Response
application/json
{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

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

Request

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

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of the port

Example: d0fcfe2ff572f44e5beb0a9712c76d5d
Query
selectstring

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

Example: select=id
curl -i -X GET \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports/d0fcfe2ff572f44e5beb0a9712c76d5d \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

Unique Identifier of the resource

Example: "9d765763116c20a508e8996f2a10821d"
typestringrequired

type

Example: "string"
associatedLinksArray of objects or null(DeviceType4portsAssociatedLinks)
cardTypeobject or null(DeviceType4cardType)
classinteger or null

Fibre Channel class (can be either 2 or 3)

class2string or null

Class2 state and configuration

commonResourceAttributesobject or null(commonResourceAttributes)
configstring or null

Configuration state of port

Example: "valid"
configModestring or null

Connection mode of the port

connectionTypestring or null

port connection type

customerIdstring or null

customerId

Example: "string"
devicesArray of objects or null or null(DeviceType4connectedDevices)
displaynamestring or null

Name to be used for display purposes

domainstring or null

Domain that the resource belongs to

enclosureCardIdinteger or null

ID of the enclosure card

enclosureCardPciIdinteger or null

ID of the enclosure card PCI card

enclosureCardPciUidstring or null

UID of the enclosure card PCI card

enclosureCardUidstring or null

Unique Identifier of the enclosure card

enclosureIdinteger or null

ID of the enclosure

enclosureUidstring or null

Unique Identifier of the enclosure

failoverStatusstring or null

Failover status of this port and the partner

fcDataobject or null(DeviceType4portFC)
fileDataobject or null(DeviceType4portFile)
fwVersionstring or null

Firmware version

Example: "12.2.396.1"
generationinteger or null

generation

Example: 0
hostVirtualPortsArray of objects or null or null(DeviceType4HostVirtualPort)
interruptCoalescestring or null

Interrupt Coalesce

ipDataobject or null(DeviceType4portIP)
iscsiDataobject or null(DeviceType4portISCSI)
labelstring or null

Label

Example: "IP0"
manufacturingobject or null(DeviceType4ManufacturingSingle)
modestring or null

Current mode the port is in

modeChangestring or null

Indicates if the mode change is allowed or prohibited

namestring or null

Name of the resource

nodeCardIdstring or null

Unique Identifier of the node adapter card

nodeIdstring or null

Unique Identifier of the node

Example: "e9d353bf98fc1a6bdb90b824e3ca14b5"
nvmeDataobject or null(DeviceType4PortNVMe)
partnerobject or null(DeviceType4partnerPort)
portSfpobject or null(DeviceType4portSfp)
portTypestring or null

Type of the port based on the device it is connected to

positionobject or null(DeviceType4portPosition)
protocolstring or null

Current protocol the port is in

resourceUristring or null

resourceUri for detailed ports object

Example: "/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports/220fcd48857f63c0f354c6723ec5d5cb"
revisionstring or null

Revision of the Host Bus Adapter

smartSanstring or null

Smart SAN status

speedActualstring or null

Actual speed that port is running at

speedConfiguredstring or null

Speed that is configured to run as

speedMaxstring or null

Maximum speed that port can run at

speedMinstring or null

Minimum speed that port can run at

stateobject or null(DeviceType4State)
stateDescriptionArray of strings or null or null(DeviceType4stateDescription)
systemIdstring or null

SystemUid / SerialNumber of the array

Example: "7CE751P312"
tgtModeWriteOptstring or null

Target mode write optimization setting

uniqueWwnstring or null

Unique WWN setting

vcnstring or null

VLUN change notification

virtualPortsArray of objects or null

Virtual ports

vlansArray of objects or null or null(DeviceType4vlan)
Response
application/json
{
  "associatedLinks": [
    { … },
    { … }
  ],
  "cardType": {
    "default": "string",
    "key": "string"
  },
  "class": 0,
  "class2": "string",
  "commonResourceAttributes": {
    "cloudState": "CONNECTED",
    "errCode": "E01",
    "errMessage": "This storage system is not actively monitored in the cloud portal. Data Services Cloud Console proactively disabled monitoring and management of storage system with serial number {systemId} for sending excessive cloud events or for not responding to requests."
  },
  "config": "valid",
  "configMode": "string",
  "connectionType": "string",
  "customerId": "string",
  "devices": [
    { … }
  ],
  "displayname": "string",
  "domain": "string",
  "enclosureCardId": 0,
  "enclosureCardPciId": 0,
  "enclosureCardPciUid": "string",
  "enclosureCardUid": "string",
  "enclosureId": 0,
  "enclosureUid": "string",
  "failoverStatus": "string",
  "fcData": {
    "nodeWwn": "string",
    "portWwn": "string"
  },
  "fileData": {
    "failoverIps": "string",
    "ipDisabled": true,
    "linkState": "string",
    "prefixLength": 0,
    "vlanId": 0
  },
  "fwVersion": "12.2.396.1",
  "generation": 0,
  "hostVirtualPorts": [
    { … }
  ],
  "id": "9d765763116c20a508e8996f2a10821d",
  "interruptCoalesce": "string",
  "ipData": {
    "autoneg": true,
    "delimitedMacAddress": "string",
    "duplex": "string",
    "gatewayAddress": "string",
    "gatewayAddressV6": "string",
    "ipAddress": "string",
    "ipAddressV6": "string",
    "macAddress": "string",
    "mtu": "string",
    "subnetMask": "string",
    "subnetMaskV6": "string"
  },
  "iscsiData": {
    "delimitedMacAddress": "string",
    "ethernetFlowControl": "string",
    "gatewayAddress": "string",
    "gatewayAddressV6": "string",
    "ipAddress": "string",
    "ipAddressV6": "string",
    "iscsiName": "string",
    "isnsPrimaryAddress": "string",
    "isnsTcpPort": 0,
    "macAddress": "string",
    "mtu": "string",
    "peerEnabled": true,
    "sendTargetGroupTag": 0,
    "subnetMask": "string",
    "subnetMaskV6": "string",
    "supportsVlan": true,
    "targetPortalGroupTag": 0
  },
  "label": "IP0",
  "manufacturing": {
    "assemblyRev": "002*",
    "checkSum": "--",
    "hpeModelName": "HPE 3PAR 600 2S Node",
    "manufacturer": "XYRATEX",
    "model": "0974244-06",
    "saleablePartNumber": "0974244-06",
    "saleableSerialNumber": "4UW0002941",
    "serialNumber": "PMW0974244G4T88",
    "sparePartNumber": "P04031-001"
  },
  "mode": "string",
  "modeChange": "string",
  "name": "string",
  "nodeCardId": "string",
  "nodeId": "e9d353bf98fc1a6bdb90b824e3ca14b5",
  "nvmeData": {
    "delimitedMacAddress": "string",
    "eth": "string",
    "ethernetFlowControl": "string",
    "gatewayAddress": "string",
    "gatewayAddressV6": "FE80::1",
    "ipAddress": "string",
    "ipAddressV6": "2001:db8:abcd:12:ffff:ffff:ffff:ff16",
    "macAddress": "string",
    "mode": "string",
    "mtu": "string",
    "nqn": "string",
    "pcidev": "string",
    "prefixLength": 0,
    "prefixLengthV6": 13,
    "protocol": "string",
    "rate": "string",
    "state": "string",
    "transport": { … },
    "vlanCount": 0,
    "vlans": [ … ]
  },
  "partner": {
    "nodeWwnOrName": "string",
    "portWwnOrIp": "string",
    "position": { … }
  },
  "portSfp": {
    "fwVersion": "string",
    "manufacturing": { … },
    "qualified": true,
    "rxLossPin": { … },
    "rxPowerLow": true,
    "speed": 0,
    "state": { … },
    "supportDdm": true,
    "txDisablePin": { … },
    "txFaultPin": { … }
  },
  "portType": "string",
  "position": {
    "node": 0,
    "port": 0,
    "slot": 0
  },
  "protocol": "string",
  "resourceUri": "/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports/220fcd48857f63c0f354c6723ec5d5cb",
  "revision": "string",
  "smartSan": "string",
  "speedActual": "string",
  "speedConfigured": "string",
  "speedMax": "string",
  "speedMin": "string",
  "state": {
    "detailed": [ … ],
    "overall": "STATE_NORMAL"
  },
  "stateDescription": [
    "string"
  ],
  "systemId": "7CE751P312",
  "tgtModeWriteOpt": "string",
  "type": "string",
  "uniqueWwn": "string",
  "vcn": "string",
  "virtualPorts": [
    { … }
  ],
  "vlans": [
    { … }
  ]
}

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

Request

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

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of the port

Example: d0fcfe2ff572f44e5beb0a9712c76d5d
Bodyapplication/jsonrequired
portEnableboolean

Port enable true or false

Example: true
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports/d0fcfe2ff572f44e5beb0a9712c76d5d \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
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 B10000 identified by {systemId}

Request

Clear the details of the ports identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of the port

Example: d0fcfe2ff572f44e5beb0a9712c76d5d
Bodyapplication/json
ipTypestring 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

Example: "v6"
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports/d0fcfe2ff572f44e5beb0a9712c76d5d/clear \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
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 B10000 identified by {systemId}

Request

Edit iscsi ports identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of the port

Example: d0fcfe2ff572f44e5beb0a9712c76d5d
Bodyapplication/jsonrequired
enablePeerboolean or null

Make the iSCSI port peer enabled. This is supported from OS version 10.4.0.

Example: true
ethernetFlowControlstring or null

Flow Control setting of the port. Applicable for HPE Alletra Storage MP B10000 10.5.0 OS version and above. Ethernet Pause (EthPause) pauses transmission of all traffic on a physical Ethernet link. Data center bridging (DCB) is an enhancement to the Ethernet-pause protocol, that enables 0-drop packet delivery for certain traffic classes.

Enum"None""EthPause""DCB"
labelstring or null

label of the port to edit to

Example: "port_123"
mtustring

Maximum transmission unit (MTU) size

Example: "1500"
vlansArray of objects or null or null

Port VLANs information. Specifying VLAN id is mandatory to configure VLAN.

curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports/d0fcfe2ff572f44e5beb0a9712c76d5d/edit-iscsi \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
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 B10000 identified by {systemId}

Request

Edit rcip ports identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of the port

Example: d0fcfe2ff572f44e5beb0a9712c76d5d
Bodyapplication/jsonrequired
gatewayAddressstring or null(ipv4)

Gateway address to edit to for IPv4 address

Example: "255.255.255.0"
gatewayAddressV6string or null

Gateway address to edit to for IPv6 address

Example: "FE80::1"
ipAddressstring or null(ipv4)

IPv4 address to edit to

Example: "192.168.193.21"
ipAddressV6string or null

IPv6 address to edit to

Example: "2001:db8:abcd:12:ffff:ffff:ffff:ff16"
mtustring

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

Example: "1500"
netMaskstring or null(ipv4)

NetMask address to edit to for IPv4 address

Example: "255.255.255.0"
netMaskV6string or null

NetMask address to edit to for IPv6 address

Example: "64"
speedConfiguredstring or null

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

Example: "1"
curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports/d0fcfe2ff572f44e5beb0a9712c76d5d/edit-rcip \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
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 B10000 identified by {systemId}

Request

Edit ports identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of the port

Example: d0fcfe2ff572f44e5beb0a9712c76d5d
Bodyapplication/jsonrequired
configModestring or null

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

Example: "Host"
connectionTypestring or null

Port connection Type. Possible Values: Point, Loop

Example: "Loop"
interuptCoalesceboolean or null

Port interuptCoalesce enabled or not

Example: true
labelstring

Port name

Example: "FCPort1"
speedConfiguredstring or null

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

Example: "8"
uniqueWwnboolean or null

Port uniquewwn enabled or not

Example: true
vcnboolean or null

VLUN change notification enabled or not

Example: true
curl -i -X PUT \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports/d0fcfe2ff572f44e5beb0a9712c76d5d/fc \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
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 B10000 identified by {systemId}

Request

Initialize the details of the ports identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of the port

Example: d0fcfe2ff572f44e5beb0a9712c76d5d
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports/d0fcfe2ff572f44e5beb0a9712c76d5d/initialize \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
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 B10000 identified by {systemId}

Request

Ping iscsi ports identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of the port

Example: d0fcfe2ff572f44e5beb0a9712c76d5d
Bodyapplication/jsonrequired
ipAddressstring(ipv4)

IP Address to ping

Example: "192.168.193.32"
ipAddressv6string(ipv6)

IP Address to ping

Example: "2001:db8:abcd:12:ffff:ffff:ffff:ff16"
pingCountinteger

ping count

Example: 4
vlanIdstring

VLAN ID

Example: "4"
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports/d0fcfe2ff572f44e5beb0a9712c76d5d/ping-iscsi \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
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 B10000 identified by {systemId}

Request

Ping rcip ports identified by {id} from HPE Alletra Storage MP B10000 identified by {systemId}

Security
bearer
Path
systemIdstringrequired

systemId of the storage system

Example: 7CE751P312
idstringrequired

UID of the port

Example: d0fcfe2ff572f44e5beb0a9712c76d5d
Bodyapplication/jsonrequired
ipAddressstring(ipv4)

IP Address to ping

Example: "192.168.193.32"
ipAddressv6string(ipv6)

IP Address to ping

Example: "2001:db8:abcd:12:ffff:ffff:ffff:ff16"
packetSizeinteger

Packet size of the ping

Example: 4
pingCountinteger

ping count

Example: 4
waitTimeinteger

Wait time

Example: 100
curl -i -X POST \
  https://eu1.data.cloud.hpe.com/storage-fleet/v1alpha1/devtype4-storage-systems/7CE751P312/ports/d0fcfe2ff572f44e5beb0a9712c76d5d/ping-rcip \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Accepted

Headers
Locationstring

This contains the URI of the task used to monitor the request

Bodyapplication/json
taskUristringrequired

Task URI which can be used to monitor the status of the operation.

Example: "/rest/vega/v1/tasks/4969a568-6fed-4915-bcd5-e4566a75e00c"
messagestring

Task Message.

Example: "Successfully submitted"
statusstring

Status of the task.

Example: "SUBMITTED"
Response
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.

Operations

storage-nodes

The Storage Node API provides endpoints for managing and configuring storage nodes.

Operations

storage-systems

The storage-systems API allows the management of storage device.

Operations

switches

The Switch API provides endpoints for managing and configuring switches.

Operations

system-settings

The System Settings API allows the monitoring of System settings for the device.

Operations

vvolscs

Operations