Mars OS REST API Reference, 1.0.2
OverviewIndexRoot ResourceErrors
Resource /webmapi/lunsExpand | Collapse

APIs for logical storage volumes

GET /webmapi/luns
Display a set of LUNs given the options provided
Description

Display a set of LUNs given the options provided

HTTP Example

GET /webmapi/luns

Output

Reports successful result in ResponseContentType<ContainerType<LunInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
LUN_SHOW_LUN_NOT_FOUND27068LUN not found.
Produces

application/json

Since

1.0

POST /webmapi/luns
Create a LUN
Description

Create a LUN

HTTP Example

POST /webmapi/luns

Input

Pass input arguments in LunCreateInputType

Output

Reports successful result in ResponseContentType<UuidType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
LUN_CREATE_EXISTS_LUN27061Name specified for this LUN is already in use by an existing LUN.
LUN_CREATE_MAX_LUN_SIZE_EXCEEDED27064Size exceeds the maximum LUN size.
LUN_CREATE_MAX_LUN_COUNT_EXCEEDED27065Maximum LUN count has been exceeded.
LUN_CREATE_LUN_SIZE_TOO_SMALL27066Size is less than or equal to 0.
LUN_CREATE_DISCARDED27067Internal error occurred and the operation was discarded. This is usually a transient error.
LUN_CREATE_TOTAL_PROVISIONED_SPACE_EXCEEDED27080Creating this LUN would exceed the limit on provisioned space.
Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/luns
Modify a LUN's attribute
Description

Modify a LUN's attribute

HTTP Example

PUT /webmapi/luns

Input

Pass input arguments in LunModifyInputType

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
LUN_MODIFY_SERIAL_NUMBER_IN_USE27037New serial number is already in use.
LUN_MODIFY_LUN_NOT_FOUND27038LUN not found.
LUN_MODIFY_LUN_NOT_OFFLINE27039LUN must be offline for this operation.
LUN_MODIFY_LUN_NVFAILED27040LUN status is nvfail. Use lun modify command to clear nvfail status.
LUN_MODIFY_DISCARDED27042Internal error occurred and the operation was discarded. This is usually a transient error.
LUN_MODIFY_TOO_MANY_MODIFICATIONS27043Too many changes requested.
LUN_MODIFY_COMMENT_TOO_LONG27044Comment is longer than 255 characters.
LUN_MODIFY_MUST_MODIFY_SOMETHING27045No change requested.
LUN_MODIFY_LUN_ALREADY_ONLINE27074LUN is already online.
LUN_MODIFY_LUN_ALREADY_OFFLINE27075LUN is already offline.
LUN_MODIFY_LUN_NOT_NVFAILED27076LUN does not have nvfail status.
LUN_MODIFY_VOLUME_NOT_FOUND27077Volume not found.
LUN_MODIFY_INCORRECT_MAX_EXTENT_SIZE27078Internal error saving the extent size.
LUN_MODIFY_NO_CHANGE27079No change requested.
Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/luns/action/map
Map a LUN to an initiator group
Description

Map a LUN to an initiator group

HTTP Example

PUT /webmapi/luns/action/map

Input

Pass input arguments in LunMapInputType

Output

Reports successful result in ResponseContentType<LunMapOutputType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
LUN_MAP_LUN_NOT_FOUND27004LUN not found.
LUN_MAP_IGROUP_NOT_FOUND27005Initiator group not found.
LUN_MAP_LUN_ID_OUT_OF_RANGE27006Specified LUN ID is out of range (0 - 4095).
LUN_MAP_LUN_ALREADY_MAPPED_TO_IGROUP27007LUN is already mapped to the initiator group.
LUN_MAP_LUN_ID_IN_USE27008LUN ID is already used by this initiator group.
LUN_MAP_LUN_ALREADY_MAPPED27009Specified LUN is already mapped to an initiator(s) in the initiator group via another initiator group.
LUN_MAP_LUN_ID_COULD_NOT_BE_SELECTED27010Could not find an available LUN ID from 0-4095 to use -- all have been taken by initiators in the initiator group.
LUN_MAP_LUN_MAP_LIMIT_EXCEEDED27011LUN already mapped to the maximum number of initiator groups.
LUN_MAP_DISCARDED27014Internal error occurred and the operation was discarded. This is usually a transient error.
LUN_MAP_LUN_ID_IN_USE_VIA_OTHER_IGROUP27072Specified LUN ID is already used by an initiator(s) in the initiator group via another initiator group.
Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/luns/action/rename
Rename a LUN
Description

Rename a LUN

HTTP Example

PUT /webmapi/luns/action/rename

Input

Pass input arguments in ResourceRenameInputType

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
LUN_RENAME_LUN_NOT_FOUND27027LUN not found.
LUN_RENAME_EXISTS_LUN27028New name specified for this LUN is already in use by an existing LUN.
LUN_RENAME_DISCARDED27030Internal error occurred and the operation was discarded. This is usually a transient error.
Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/luns/action/resize
Resize a LUN
Description

Resize a LUN

Only enlarging a LUN is allowed at this time.

HTTP Example

PUT /webmapi/luns/action/resize

Input

Pass input arguments in LunResizeInputType

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
LUN_RESIZE_LUN_NOT_FOUND27015LUN not found.
LUN_RESIZE_DISCARDED27016Internal error occurred and the operation was discarded. This is usually a transient error.
LUN_RESIZE_SHRINK_NOT_SUPPORTED27017Only growing the LUN is allowed at this time.
LUN_RESIZE_MAX_SIZE_EXCEEDED27018New size exceeds maximum LUN size.
LUN_RESIZE_NO_CHANGE27019New size is the same as old LUN size.
LUN_RESIZE_LUN_RESIZE_FAILED27020Internal error resizing LUN.
LUN_RESIZE_LUN_NVFAILED27021LUN status is nvfail. Use lun modify command to clear nvfail status.
LUN_RESIZE_TOTAL_PROVISIONED_SPACE_EXCEEDED27073Creating this LUN would exceed the limit on provisioned space.
Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/luns/action/unmap
Un-map a LUN from an initiator group
Description

Un-map a LUN from an initiator group

HTTP Example

PUT /webmapi/luns/action/unmap

Input

Pass input arguments in LunUnmapInputType

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
LUN_UNMAP_LUN_NOT_FOUND27054LUN not found.
LUN_UNMAP_IGROUP_NOT_FOUND27055Initiator group not found.
LUN_UNMAP_LUN_NOT_MAPPED_TO_IGROUP27056LUN is not mapped to the specified initiator group.
LUN_UNMAP_BAD_PARAMS27057Internal parameter translation failed.
LUN_UNMAP_DISCARDED27058Internal error occurred and the operation was discarded. This is usually a transient error.
Produces

application/json

Consumes

application/json

Since

1.0

POST /webmapi/luns/bulk
Create multiple LUN instances
Description

Create multiple LUN instances

HTTP Example

POST /webmapi/luns/bulk

Input

Pass input arguments in BulkType<LunCreateInputType>

Output

Reports successful result in ResponseContentType<BulkResultType<UuidType>>

Errors

Reports bulk errors in ResponseContentType<BulkResultType<BulkItemErrorType>>

Error KeyError CodeError Description
LUN_CREATE_EXISTS_LUN27061Name specified for this LUN is already in use by an existing LUN.
LUN_CREATE_MAX_LUN_SIZE_EXCEEDED27064Size exceeds the maximum LUN size.
LUN_CREATE_MAX_LUN_COUNT_EXCEEDED27065Maximum LUN count has been exceeded.
LUN_CREATE_LUN_SIZE_TOO_SMALL27066Size is less than or equal to 0.
LUN_CREATE_DISCARDED27067Internal error occurred and the operation was discarded. This is usually a transient error.
LUN_CREATE_TOTAL_PROVISIONED_SPACE_EXCEEDED27080Creating this LUN would exceed the limit on provisioned space.

Additional errors specific to bulk requests include the following:

Error KeyError Description
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULKRequest has invalid bulk input.
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULK_COUNTRequest has incorrect bulk item count {0}.
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULK_OVERLIMITRequest bulk input is over limit: count={0} and limit={1}.
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULK_NONUNIQUE_OPERATION_IDBulk request contains non-unique operation identifier: {0}.
WEBUI_WEBAPI_ERROR_BULK_PARTIALFAILEDSome bulk operations are failed.
WEBUI_WEBAPI_ERROR_BULK_ALLFAILEDAll bulk operations have failed.
WEBUI_WEBAPI_ERROR_BULK_MISMATCHCOUNTBulk result count does not match bulk item count.
Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/luns/bulk/action/map
Map multiple LUN instances to initiator groups
Description

Map multiple LUN instances to initiator groups

HTTP Example

PUT /webmapi/luns/bulk/action/map

Input

Pass input arguments in BulkType<LunMapInputType>

Output

Reports successful result in ResponseContentType<BulkResultType<LunMapOutputType>>

Errors

Reports bulk errors in ResponseContentType<BulkResultType<BulkItemErrorType>>

Error KeyError CodeError Description
LUN_MAP_LUN_NOT_FOUND27004LUN not found.
LUN_MAP_IGROUP_NOT_FOUND27005Initiator group not found.
LUN_MAP_LUN_ID_OUT_OF_RANGE27006Specified LUN ID is out of range (0 - 4095).
LUN_MAP_LUN_ALREADY_MAPPED_TO_IGROUP27007LUN is already mapped to the initiator group.
LUN_MAP_LUN_ID_IN_USE27008LUN ID is already used by this initiator group.
LUN_MAP_LUN_ALREADY_MAPPED27009Specified LUN is already mapped to an initiator(s) in the initiator group via another initiator group.
LUN_MAP_LUN_ID_COULD_NOT_BE_SELECTED27010Could not find an available LUN ID from 0-4095 to use -- all have been taken by initiators in the initiator group.
LUN_MAP_LUN_MAP_LIMIT_EXCEEDED27011LUN already mapped to the maximum number of initiator groups.
LUN_MAP_DISCARDED27014Internal error occurred and the operation was discarded. This is usually a transient error.
LUN_MAP_LUN_ID_IN_USE_VIA_OTHER_IGROUP27072Specified LUN ID is already used by an initiator(s) in the initiator group via another initiator group.

Additional errors specific to bulk requests include the following:

Error KeyError Description
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULKRequest has invalid bulk input.
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULK_COUNTRequest has incorrect bulk item count {0}.
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULK_OVERLIMITRequest bulk input is over limit: count={0} and limit={1}.
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULK_NONUNIQUE_OPERATION_IDBulk request contains non-unique operation identifier: {0}.
WEBUI_WEBAPI_ERROR_BULK_PARTIALFAILEDSome bulk operations are failed.
WEBUI_WEBAPI_ERROR_BULK_ALLFAILEDAll bulk operations have failed.
WEBUI_WEBAPI_ERROR_BULK_MISMATCHCOUNTBulk result count does not match bulk item count.
Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/luns/bulk/action/unmap
Un-map multiple LUN instances from initiator groups
Description

Un-map multiple LUN instances from initiator groups

HTTP Example

PUT /webmapi/luns/bulk/action/unmap

Input

Pass input arguments in BulkType<LunUnmapInputType>

Output

Reports successful result in ResponseContentType<BulkResultBooleanType>

Errors

Reports bulk errors in ResponseContentType<BulkResultType<BulkItemErrorType>>

Error KeyError CodeError Description
LUN_UNMAP_LUN_NOT_FOUND27054LUN not found.
LUN_UNMAP_IGROUP_NOT_FOUND27055Initiator group not found.
LUN_UNMAP_LUN_NOT_MAPPED_TO_IGROUP27056LUN is not mapped to the specified initiator group.
LUN_UNMAP_BAD_PARAMS27057Internal parameter translation failed.
LUN_UNMAP_DISCARDED27058Internal error occurred and the operation was discarded. This is usually a transient error.

Additional errors specific to bulk requests include the following:

Error KeyError Description
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULKRequest has invalid bulk input.
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULK_COUNTRequest has incorrect bulk item count {0}.
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULK_OVERLIMITRequest bulk input is over limit: count={0} and limit={1}.
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULK_NONUNIQUE_OPERATION_IDBulk request contains non-unique operation identifier: {0}.
WEBUI_WEBAPI_ERROR_BULK_PARTIALFAILEDSome bulk operations are failed.
WEBUI_WEBAPI_ERROR_BULK_ALLFAILEDAll bulk operations have failed.
WEBUI_WEBAPI_ERROR_BULK_MISMATCHCOUNTBulk result count does not match bulk item count.
Produces

application/json

Consumes

application/json

Since

1.0

GET /webmapi/luns/maps
Display a set of LUN maps given the options provided
Description

Display a set of LUN maps given the options provided

Maps are the initiator groups to which the LUN is mapped.

HTTP Example

GET /webmapi/luns/maps

Output

Reports successful result in ResponseContentType<ContainerType<LunMapInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
LUN_MAP_SHOW_LUN_NOT_FOUND27069LUN not found.
LUN_MAP_SHOW_IGROUP_NOT_FOUND27070Initiator group not found.
LUN_MAP_SHOW_TOO_MANY_OPTIONS_SPECIFIED27071Too many options specified.
Produces

application/json

Since

1.0

GET /webmapi/luns/{id}
Get a specific LUN instance
Description

Get a specific LUN instance

If the instance name is either . or .. , it may be specified in the URL in a pair of single quotes like '.' and '..' (in order to avoid it getting removed by browser or any such client application).

HTTP Example

GET /webmapi/luns/{id}

Path Parameters:
idThe ID or name of the instance (required=true).
Output

Reports successful result in ResponseContentType<LunInfoType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
LUN_SHOW_LUN_NOT_FOUND27068LUN not found.
Produces

application/json

Since

1.0

DELETE /webmapi/luns/{id}
Destroy a LUN
Description

Destroy a LUN

If the instance name is either . or .. , it may be specified in the URL in a pair of single quotes like '.' and '..' (in order to avoid it getting removed by browser or any such client application).

HTTP Example

DELETE /webmapi/luns/{id}?force=param0

Query Parameters:
forceForces the operation (required=false, default=false).

Format: ?force={true|false}

Example: ?force=true

True will forcefully perform the operation. Default is false.

Path Parameters:
idThe ID or name of the instance (required=true).
Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
LUN_DESTROY_LUN_NOT_FOUND27046LUN not found.
LUN_DESTROY_LUN_MAPPED_AND_ONLINE27048LUN is mapped and online.
LUN_DESTROY_INTERNAL_ERROR27049Internal error: unable to fetch LUN information.
LUN_DESTROY_SNAPS_EXIST27050LUN has snapshots.
LUN_DESTROY_LUN_ONLINE_FAILED27051Internal error bringing LUN online.
LUN_DESTROY_LUN_OFFLINE_FAILED27052Internal error taking LUN offline.
LUN_DESTROY_DISCARDED27053Internal error occurred and the operation was discarded. This is usually a transient error.
Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/luns/{id}/action/offline
Take a LUN offline
Description

Take a LUN offline

If the instance name is either . or .. , it may be specified in the URL in a pair of single quotes like '.' and '..' (in order to avoid it getting removed by browser or any such client application).

HTTP Example

PUT /webmapi/luns/{id}/action/offline

Path Parameters:
idThe ID or name of the instance (required=true).
Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
LUN_OFFLINE_LUN_NOT_FOUND27000LUN not found.
LUN_OFFLINE_LUN_ALREADY_OFFLINE27001LUN is already offline.
LUN_OFFLINE_DISCARDED27003Internal error occurred and the operation was discarded. This is usually a transient error.
Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/luns/{id}/action/online
Bring a LUN online
Description

Bring a LUN online

If the instance name is either . or .. , it may be specified in the URL in a pair of single quotes like '.' and '..' (in order to avoid it getting removed by browser or any such client application).

HTTP Example

PUT /webmapi/luns/{id}/action/online

Path Parameters:
idThe ID or name of the instance (required=true).
Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
LUN_ONLINE_LUN_NOT_FOUND27023LUN not found.
LUN_ONLINE_LUN_ALREADY_ONLINE27024LUN is already online.
LUN_ONLINE_DISCARDED27026Internal error occurred and the operation was discarded. This is usually a transient error.
Produces

application/json

Consumes

application/json

Since

1.0

GET /webmapi/luns/{id}/maps
Display a set of LUN maps given the options provided
Description

Display a set of LUN maps given the options provided

Maps are the initiator groups to which the LUN is mapped. If the instance name is either . or .. , it may be specified in the URL in a pair of single quotes like '.' and '..' (in order to avoid it getting removed by browser or any such client application).

HTTP Example

GET /webmapi/luns/{id}/maps

Path Parameters:
idThe ID or name of the instance (required=true).
Output

Reports successful result in ResponseContentType<LunMapInfoType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error KeyError CodeError Description
LUN_MAP_SHOW_LUN_NOT_FOUND27069LUN not found.
LUN_MAP_SHOW_IGROUP_NOT_FOUND27070Initiator group not found.
LUN_MAP_SHOW_TOO_MANY_OPTIONS_SPECIFIED27071Too many options specified.
Produces

application/json

Since

1.0

Mars OS REST API Reference, 1.0.2
OverviewIndexRoot ResourceErrors
Copyright (c) 2015 NetApp, Inc. All rights reserved.