DCNM Connect
The following are the Static Flow Stitching REST APIs:
Status
The following table details the API Response code, status and, the HTTPS methods.
|
|
|
200 |
OK |
GET |
202 |
Accepted |
POST PUT DELETE |
400 |
Bad Request |
GET POST PUT DELETE |
401 |
Unauthorized |
GET POST PUT DELETE |
403 |
Forbidden |
GET POST PUT DELETE |
404 |
Not Found |
GET POST PUT DELETE |
405 |
Method Not Allowed |
GET POST PUT DELETE |
500 |
Internal Server Error |
GET POST PUT DELETE |
Resource Name
/storageorchestration/createLun
Description
Create a LUN/Volume of the given type and size within the given pool.
URL
https://<dcnm-ip-address>/fm/fmrest/storageorchestration/createLun
Return Value
Format: JSON
Type: Object
|
|
|
systemSerial |
S |
A unique identifying string from the SMI-S Provider which represents the Storage System. |
systemPartNum |
S |
Secondary identification of storage system |
poolName |
S |
The Pool from which the storage volume is taken from, LUN is created, and associated. |
lunName |
S |
The intended name of the volume. |
size |
S |
The size of the volume in bytes |
raidType |
S |
Requested Raid Level (Pool specific) eg. "RAID1", "RAID5", "RAID6", etc. |
type |
I |
The type of volume being created. Acceptable values for this parameter are:
- 2 for a fully allocated LUN
- 5 for a thinly provisioned LUN
|
Resource Name
storageorchestration/deleteLun
Description
Remove an existing LUN/Volume.
URL
https://<dcnm-ip-address>/fm/fmrest/storageorchestration/deleteLun
Return Value
Format: JSON
Type: Long
|
|
|
systemSerial |
S |
A unique identifying string from the SMI-S Provider which represents the Storage System. |
systemPartNum |
S |
Secondary identification of storage system |
lunId |
S |
LUN ID of the LUN to be deleted. |
Resource Name
storageorchestration/maskLun
Description
Add a Host and Lun Mapping
URL
https://<dcnm-ip-address>/fm/fmrest/storageorchestration/maskLun
Parameter
|
|
|
hostId |
String |
Unique identifier of the host (sender/receiver) |
Return Value
Format: JSON
Type: Long
|
|
|
systemSerial |
S |
A unique identifying string from the SMI-S Provider which represents the Storage System. |
systemPartNum |
S |
Secondary identification of storage system |
initiator |
S |
WWN of Host Port |
target |
S |
WWN of Storage Port |
lunId |
S |
LUN ID |
deviceNumber |
S |
Empty string. |
lunAccess |
I |
Access control:
- 1= read only
- 2 = read/write
Some storage systems only support 2 = read/write. |
Resource Name
/storageorchestration/unMaskLun
Description
Remove an existing Host through Lun Mapping
URL
https://<dcnm-ip-address>/fm/fmrest/storageorchestration/unMaskLun
Return Value
Format: JSON
Type: Long
|
|
|
systemSerial |
S |
A unique identifying string from the SMI-S Provider which represents the Storage System. |
systemPartNum |
S |
Secondary identification of storage system |
initiator |
S |
WWN of Host Port |
target |
S |
WWN of Storage Port |
lunId |
S |
LUN ID |
Resource Name
/storageorchestration/createZone
Description
Add a zone entry for HostPort-StoragePort pair. If the zone already exists, it will return as successful with appropriate response message.
URL
https://<dcnm-ip-address>/fm/fmrest/storageorchestration/createZone
Return Value
Format: JSON
Type: Long
|
|
|
initiator |
S |
WWN of Host Port |
target |
S |
WWN of Target Port |
Resource Name
/storageorchestration/checkClearZone
Description
Checks the zoning of a HostPort-StoragePort pair. If that pair is no longer being used in any Host LUN Masks, the zone is removed
URL
https://<dcnm-ip-address>/fm/fmrest/storageorchestration/checkClearZone
Return Value
Format: JSON
Type: Long
|
|
|
initiator |
S |
WWN of Host Port |
target |
S |
WWN of Target Port |