Resource igroups | Mars OS REST APIs

Resource /webmapi/igroupsExpand | Collapse

APIs for grouping host initiators

GET /webmapi/igroups

Display initiator group details

Description

Display initiator group details

HTTP Example

GET /webmapi/igroups

Output

Reports successful result in ResponseContentType<ContainerType<IGroupInfoType>>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
IGROUP_SHOW_IGROUP_NOT_FOUND	6000	Initiator group not found.

Produces

application/json

Since

1.0

POST /webmapi/igroups

Create an initiator group

Description

Create an initiator group

HTTP Example

POST /webmapi/igroups

Input

Pass input arguments in IGroupCreateInputType

Output

Reports successful result in ResponseContentType<UuidType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
IGROUP_CREATE_EXISTS	6008	Initiator group already exists.
IGROUP_CREATE_INVALID_PARAM	6009	Invalid parameter.
IGROUP_CREATE_INITIATOR_CONFLICTING_OS	6011	One of the initiators being added to this new initiator group belongs to another initiator group with a different operating system type.
IGROUP_CREATE_MAX_INITIATORS	6012	Maximum number of initiators across all initiator groups has been exceeded.
IGROUP_CREATE_MAX_INITIATORS_PER_IGROUP	6013	Initiator group's maximum initiator count has been exceeded.
IGROUP_CREATE_MAX_IGROUP_COUNT_EXCEEDED	6021	Maximum initiator group count has been exceeded.
IGROUP_CREATE_DUPLICATE_INPUTS	6030	Initiator specified more than once.
IGROUP_CREATE_DISCARDED	6031	Internal error occurred and the operation was discarded. This is usually a transient error.

Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/igroups/action/add

Add an initiator to an initiator group

Description

Add an initiator to an initiator group

HTTP Example

PUT /webmapi/igroups/action/add

Input

Pass input arguments in IGroupModifyInputType

Output

Reports successful result in ResponseContentType<IGroupAddOutputType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
IGROUP_ADD_IGROUP_NOT_FOUND	6001	Initiator group not found.
IGROUP_ADD_EXISTS	6002	Initiator already exists in the initiator group.
IGROUP_ADD_INITIATOR_CONFLICTING_OS	6004	One of the initiators being added belongs to an initiator group with a different operating system type.
IGROUP_ADD_MAX_INITIATORS	6017	Maximum number of initiators across all initiator groups has been exceeded.
IGROUP_ADD_MAX_INITIATORS_PER_IGROUP	6018	Maximum number of initiators in the initiator group has been exceeded.
IGROUP_ADD_DUPLICATE_LUN	6023	One of the initiators being added is already mapped to one of the LUNs in the initiator groups.
IGROUP_ADD_LUN_ID_IN_USE	6024	One of the initiators being added already has a map that uses a LUN ID in use by this initiator group.
IGROUP_ADD_DUPLICATE_INPUTS	6025	List of initiators to add contains one or more duplicates.
IGROUP_ADD_DISCARDED	6026	Internal error occurred and the operation was discarded. This is usually a transient error.

Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/igroups/action/remove

Remove an initiator from an initiator group

Description

Remove an initiator from an initiator group

HTTP Example

PUT /webmapi/igroups/action/remove

Input

Pass input arguments in IGroupModifyInputType

Output

Reports successful result in ResponseContentType<IGroupRemoveOutputType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
IGROUP_REMOVE_IGROUP_NOT_FOUND	6006	Initiator group not found.
IGROUP_REMOVE_INITIATOR_NOT_FOUND	6007	Initiator not found.
IGROUP_REMOVE_DUPLICATE_INPUTS	6027	Initiator specified more than once.
IGROUP_REMOVE_DISCARDED	6028	Internal error occurred and the operation was discarded. This is usually a transient error.

Produces

application/json

Consumes

application/json

Since

1.0

PUT /webmapi/igroups/action/rename

Rename an initiator group

Description

Rename an initiator group

HTTP Example

PUT /webmapi/igroups/action/rename

Input

Pass input arguments in ResourceRenameInputType

Output

Reports successful result in ResponseContentType

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
IGROUP_RENAME_IGROUP_NOT_FOUND	6019	Initiator group not found.
IGROUP_RENAME_IGROUP_EXISTS	6020	Initiator group name already in use.
IGROUP_RENAME_DISCARDED	6029	Internal error occurred and the operation was discarded. This is usually a transient error.

Produces

application/json

Consumes

application/json

Since

1.0

DELETE /webmapi/igroups/bulk

Delete multiple initiator group instances.

Description

Delete multiple initiator group instances.

HTTP Example

DELETE /webmapi/igroups/bulk?ids=param0&force=param1

Query Parameters:

idsThe IDs of the initiator groups to delete.

Format: ?ids=id1,id2,...

Example: /webmapi/igroups/bulk?ids=igrp1,igrp2,igrp3&force=true

forceForces the operation (required=false, default=false).

Format: ?force={true|false}

Example: ?force=true

True will forcefully perform the operation. Default is false.

Output

Reports successful result in ResponseContentType<BulkResultBooleanType>

Errors

Reports bulk errors in ResponseContentType<BulkResultType<BulkItemErrorType>>

Error Key	Error Code	Error Description
IGROUP_DESTROY_IGROUP_NOT_FOUND	6014	Initiator group not found.
IGROUP_DESTROY_IGROUP_HAS_MAPS	6015	Initiator group could not be destroyed because it has maps.
IGROUP_DESTROY_INTERNAL_ERROR	6016	Unable to fetch information internally.
IGROUP_DESTROY_DISCARDED	6022	Internal error occurred and the operation was discarded. This is usually a transient error.

Additional errors specific to bulk requests include the following:

Error Key	Error Description
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULK	Request has invalid bulk input.
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULK_COUNT	Request has incorrect bulk item count {0}.
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULK_OVERLIMIT	Request bulk input is over limit: count={0} and limit={1}.
WEBUI_WEBAPI_ERROR_INVALID_REQ_BULK_NONUNIQUE_OPERATION_ID	Bulk request contains non-unique operation identifier: {0}.
WEBUI_WEBAPI_ERROR_BULK_PARTIALFAILED	Some bulk operations are failed.
WEBUI_WEBAPI_ERROR_BULK_ALLFAILED	All bulk operations have failed.
WEBUI_WEBAPI_ERROR_BULK_MISMATCHCOUNT	Bulk result count does not match bulk item count.

Produces

application/json

Since

1.0.2

PUT /webmapi/igroups/ostype

Modify the operating system type of the specified initiator groups

Description

Modify the operating system type of the specified initiator groups

HTTP Example

PUT /webmapi/igroups/ostype

Input

Pass input arguments in IGroupModifyOsTypeInputType

Output

Reports successful result in ResponseContentType<IGroupModifyOsTypeOutputType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
IGROUP_MODIFY_IGROUP_NOT_FOUND	6032	Initiator group not found.
IGROUP_MODIFY_DISCARDED	6033	Internal error occurred and the operation was discarded.
IGROUP_MODIFY_NO_NAMES_GIVEN	6034	You must specify names or universally unique IDs (UUIDs).
IGROUP_MODIFY_INITIATOR_CONFLICTING_OS	6035	Operation would have resulted in initiator(s) belonging to initiator groups of differing operating system types.

Produces

application/json

Consumes

application/json

Since

1.0

GET /webmapi/igroups/{id}

Get the specified initiator group instance

Description

Get the specified initiator group 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/igroups/{id}

Path Parameters:

idThe ID or name of the instance (required=true).

Output

Reports successful result in ResponseContentType<IGroupInfoType>

Errors

Reports errors in ResponseContentType<ErrorType>

Error Key	Error Code	Error Description
IGROUP_SHOW_IGROUP_NOT_FOUND	6000	Initiator group not found.

Produces

application/json

Since

1.0

DELETE /webmapi/igroups/{id}

Destroy an initiator group

Description

Destroy an initiator group

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/igroups/{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 Key	Error Code	Error Description
IGROUP_DESTROY_IGROUP_NOT_FOUND	6014	Initiator group not found.
IGROUP_DESTROY_IGROUP_HAS_MAPS	6015	Initiator group could not be destroyed because it has maps.
IGROUP_DESTROY_INTERNAL_ERROR	6016	Unable to fetch information internally.
IGROUP_DESTROY_DISCARDED	6022	Internal error occurred and the operation was discarded. This is usually a transient error.

Produces

application/json

Since

1.0