Merge

POST v1/pools/id/actions/merge

Description

Merge the specified pool into the target pool. All volumes on the specified pool are moved to the target pool and the specified pool is then deleted. All the arrays in the pool are assigned to the target pool.

Normal Response Codes

200

HTTP Error Codes

400 401 403 404 405 409 500 503

Detail Codes

SM_ddup_folder_merge

SM_folder_conflict

SM_invalid_arg_value

SM_invalid_path_variable

SM_invalid_query_param

SM_limit_hret_snap_pool

SM_limit_hret_snap_retention_pool

SM_limit_scope_values

SM_malformed_url

SM_missing_arg

SM_no_action_found

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_not_enough_cache

SM_pool_flash_mismatch

SM_pool_not_found

SM_pool_volmv_einprog

SM_unexpected_query_param

SM_usage_unavaiable

SM_version_name

Request

Parameter	Type	JSON Type	Description	Mandatory
id	NsObjectID	string	ID of the specified pool. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.	true
target_pool_id	NsObjectID	string	ID of the target pool. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.	true
force	NsBoolean	boolean	Forcibly merge the specified pool into target pool. Possible values: 'true', 'false'.	false

JSON Request

            

{
   "data" : {
      "target_pool_id" : "0a00000000000004d3000000000000000000000007"
   }
}

Response

Type: NsPoolMergeReturn

Member	Type	JSON Type	Description
snapcoll_count	NsUnsignedLong	number	Snapshot collection count. Unsigned 64-bit integer. Example: 1234.
array_list	NsArrayDetailList	array	List of arrays in the pool with detailed information. When create/update array list, only arrays' id is required. List of arrays' detailed information.
array_count	NsUnsignedLong	number	Number of arrays in the pool. Unsigned 64-bit integer. Example: 1234.
unassigned_array_list	NsArraySummaryList	array	List of arrays being unassigned from the pool. List of arrays' information. Each item contains array_name and array_id for the array name and its ID respectively.
all_flash	NsBoolean	boolean	Indicate whether the pool is an all_flash pool. Possible values: 'true', 'false'.
cache_capacity	NsBytes	number	Total usable cache capacity of the pool in bytes. Unsigned 64-bit integer. Example: '1234'.
capacity	NsBytes	number	Total storage space of the pool in bytes. Unsigned 64-bit integer. Example: '1234'.
compressed_snap_usage_bytes	NsBytes	number	Compressed usage of snapshots in the pool. Unsigned 64-bit integer. Example: '1234'.
compressed_vol_usage_bytes	NsBytes	number	Compressed usage of volumes in the pool. Unsigned 64-bit integer. Example: '1234'.
compression_ratio	NsRatio	number	Compression savings for the pool expressed as ratio. Fraction expressed as floating point number. Example: '9.18'.
creation_time	NsTime	number	Time when this pool was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
dedupe_ratio	NsRatio	number	Dedupe savings for the pool expressed as ratio. Fraction expressed as floating point number. Example: '9.18'.
description	NsDescription	string	Text description of pool. Default: ''. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.
free_space	NsBytes	number	Free space of the pool in bytes. Unsigned 64-bit integer. Example: '1234'.
full_name	NsObjectName	string	Fully qualified name of pool. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
id	NsObjectID	string	Identifier for the pool. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
dedupe_enabled	NsBoolean	boolean	Indicate whether the pool is a dedupe enabled pool. Possible values: 'true', 'false'.
last_modified	NsTime	number	Time when this pool was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
name	NsObjectName	string	Name of pool. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
pinnable_cache_capacity	NsBytes	number	Total pinnable cache capacity of the pool in bytes. Unsigned 64-bit integer. Example: '1234'.
pinned_cache_capacity	NsBytes	number	Total pinned cache capacity of the pool in bytes. Unsigned 64-bit integer. Example: '1234'.
pinned_vol_list	NsVolumeList	array	The list of pinned volumes in the pool. List of volumes.
savings_compression	NsBytes	number	Space usage savings in the pool due to compression. Unsigned 64-bit integer. Example: '1234'.
savings_dedupe	NsBytes	number	Space usage savings in the pool due to deduplication. Unsigned 64-bit integer. Example: '1234'.
search_name	NsSearchName	string	Name of pool used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'.
snap_compression_ratio	NsRatio	number	Compression ratio of snapshots in the pool. Fraction expressed as floating point number. Example: '9.18'.
snap_count	NsUnsignedLong	number	Snapshot count. Unsigned 64-bit integer. Example: 1234.
uncompressed_snap_usage_bytes	NsBytes	number	Uncompressed usage of snapshots in the pool. Unsigned 64-bit integer. Example: '1234'.
uncompressed_vol_usage_bytes	NsBytes	number	Uncompressed usage of volumes in the pool. Unsigned 64-bit integer. Example: '1234'.
unused_reserve	NsBytes	number	Unused reserve space of the pool in bytes. Unsigned 64-bit integer. Example: '1234'.
usage	NsBytes	number	Used space of the pool in bytes. Unsigned 64-bit integer. Example: '1234'.
usage_valid	NsBoolean	boolean	Indicate whether the usage of pool is valid. Possible values: 'true', 'false'.
vol_compression_ratio	NsRatio	number	Compression ratio of volumes in the pool. Fraction expressed as floating point number. Example: '9.18'.
vol_count	NsUnsignedLong	number	Number of volumes assigned to the pool. Unsigned 64-bit integer. Example: 1234.
vol_list	NsVolumeList	array	The list of volumes in the pool. List of volumes.

JSON Response

            

{
   "data" : {
      "snapcoll_count" : 0,
      "array_list" : [
         {
            "id" : "0900000000000004d3000000000000000000000004",
            "array_id" : "0900000000000004d3000000000000000000000004",
            "name" : "g1a4",
            "array_name" : "g1a4",
            "usage" : 0,
            "usage_valid" : "true",
            "migrate" : "none",
            "evac_usage" : 0,
            "evac_time" : 0,
            "usable_capacity" : 3983343616
         },
         {
            "id" : "0900000000000004d3000000000000000000000003",
            "array_id" : "0900000000000004d3000000000000000000000003",
            "name" : "g1a3",
            "array_name" : "g1a3",
            "usage" : 0,
            "usage_valid" : "true",
            "migrate" : "none",
            "evac_usage" : 0,
            "evac_time" : 0,
            "usable_capacity" : 3983343616
         }
      ],
      "array_count" : 2,
      "unassigned_array_list" : null,
      "pool_free_space" : 7966687232,
      "vol_list" : [
         {
            "id" : "0600000000000004d300000000000000000000001b",
            "vol_id" : "0600000000000004d300000000000000000000001b",
            "name" : "vol11",
            "vol_name" : "vol11"
         },
         {
            "id" : "0600000000000004d300000000000000000000001c",
            "vol_id" : "0600000000000004d300000000000000000000001c",
            "name" : "vol12",
            "vol_name" : "vol12"
         }
      ],
      "pinned_cache_capacity" : 0,
      "pool_unused_reserve" : 0,
      "snap_count" : 0,
      "pool_usage" : 0,
      "creation_time" : 1426776557,
      "id" : "0a00000000000004d3000000000000000000000007",
      "pinned_vol_list" : null,
      "pool_capacity" : 7966687232,
      "pinnable_cache_capacity" : 2979079127,
      "search_name" : "pool0.184354593834968",
      "last_modified" : 1426776559,
      "name" : "pool0.184354593834968",
      "pool_cache_capacity" : 4290772992,
      "description" : "",
      "full_name" : "pool0.184354593834968",
      "vol_count" : 2
   }
}