Update

Parameter	Type	JSON Type	Description	Mandatory
id	NsObjectID	string	Identifier for the pool. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.	true
name	NsObjectName	string	Name of pool. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.	false
description	NsDescription	string	Text description of pool. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.	false
array_list	NsArrayDetailList	Array of NsArrayDetail	List of arrays in the pool with detailed information. When create/update array list, only arrays' id is required. List of arrays' detailed information.	false
force	NsBoolean	boolean	Forcibly delete the specified pool even if it contains deleted volumes whose space is being reclaimed. Forcibly remove an array from array_list via an update operation even if the array is not reachable. There should no volumes currently in the pool for the forced update operation to succeed. Possible values: 'true', 'false'.	false
dedupe_all_volumes	NsBoolean	boolean	Indicates if dedupe is enabled by default for new volumes on this pool. Possible values: 'true', 'false'.	false

JSON Request

            

{
   "data" : {
      "name" : "pool0.421467625108686"
   }
}

Response

Parameter	Type	JSON Type	Description
id	NsObjectID	string	Identifier for the pool. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
name	NsObjectName	string	Name of pool. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
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'.
search_name	NsSearchName	string	Name of pool used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'.
description	NsDescription	string	Text description of pool. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.
creation_time	NsTime	number	Time when this pool was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
last_modified	NsTime	number	Time when this pool was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
capacity	NsBytes	number	Total storage 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'.
unused_reserve	NsBytes	number	Unused reserve space of the pool in bytes. Unsigned 64-bit integer. Example: '1234'.
free_space	NsBytes	number	Free space of the pool in bytes. Unsigned 64-bit integer. Example: '1234'.
cache_capacity	NsBytes	number	Total usable cache capacity of the pool in bytes. Unsigned 64-bit integer. Example: '1234'.
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'.
dedupe_capacity_bytes	NsBytes	number	The dedupe capacity of a hybrid pool. Does not apply to all-flash pools. Unsigned 64-bit integer. Example: '1234'.
dedupe_usage_bytes	NsBytes	number	The dedupe usage of a hybrid pool. Does not apply to all-flash pools. 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'.
dedupe_ratio	NsRatio	number	Dedupe savings for the pool expressed as ratio. Fraction expressed as floating point number. Example: '9.18'.
clone_ratio	NsRatio	number	Clone savings for the pool expressed as ratio. Fraction expressed as floating point number. Example: '9.18'.
vol_thin_provisioning_ratio	NsRatio	number	Thin provisioning savings for volumes in the pool expressed as ratio. Fraction expressed as floating point number. Example: '9.18'.
snapcoll_count	NsUnsignedLong	number	Snapshot collection count. Unsigned 64-bit integer. Example: 1234.
snap_count	NsUnsignedLong	number	Snapshot count. Unsigned 64-bit integer. Example: 1234.
array_count	NsUnsignedLong	number	Number of arrays in the pool. Unsigned 64-bit integer. Example: 1234.
vol_count	NsUnsignedLong	number	Number of volumes assigned to the pool. Unsigned 64-bit integer. Example: 1234.
array_list	NsArrayDetailList	Array of NsArrayDetail	List of arrays in the pool with detailed information. When create/update array list, only arrays' id is required. List of arrays' detailed information.
unassigned_array_list	NsArraySummaryList	Array of NsArraySummary	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.
vol_list	NsVolumeList	Array of NsVolumeSummary	The list of volumes in the pool. List of volumes.
pinned_vol_list	NsPinnedVolumeInfoList	Array of NsPinnedVolumeInfo	The list of pinned volumes in the pool. List of pinned volumes in a pool.
folder_list	NsFolderList	Array of NsFolderSummary	The list of fully qualified names of folders in the pool. List of fully qualified names of folders in a pool.
usage_valid	NsBoolean	boolean	Indicates whether the usage of pool is valid. Possible values: 'true', 'false'.
all_flash	NsBoolean	boolean	Indicate whether the pool is an all_flash pool. Possible values: 'true', 'false'.
dedupe_capable	NsBoolean	boolean	Indicates whether the pool is capable of hosting deduped volumes. Possible values: 'true', 'false'.
dedupe_all_volumes	NsBoolean	boolean	Indicates if dedupe is enabled by default for new volumes on this pool. Possible values: 'true', 'false'.
is_default	NsBoolean	boolean	Indicates if this is the default pool. Possible values: 'true', 'false'.

JSON Response

            

{
   "data" : {
      "snapcoll_count" : 0,
      "array_list" : [
         {
            "id" : "0900000000000004d3000000000000000000000003",
            "array_id" : "0900000000000004d3000000000000000000000003",
            "name" : "g1a3",
            "array_name" : "g1a3",
            "usage" : 0,
            "usage_valid" : true,
            "migrate" : "none",
            "evac_usage" : 0,
            "evac_time" : 0,
            "snap_usage_compressed_bytes" : 0,
            "usable_capacity" : 3983343616,
            "vol_usage_compressed_bytes" : 0
         }
      ],
      "array_count" : 1,
      "unassigned_array_list" : null,
      "free_space" : 3983343616,
      "vol_list" : null,
      "pinned_cache_capacity" : 0,
      "snap_count" : 0,
      "id" : "0a00000000000004d3000000000000000000000002",
      "creation_time" : 1430267624,
      "usage" : 0,
      "usage_valid" : true,
      "pinned_vol_list" : null,
      "unused_reserve" : 0,
      "pinnable_cache_capacity" : 1489539563,
      "search_name" : "pool0.421467625108686",
      "last_modified" : 1430267626,
      "name" : "pool0.421467625108686",
      "cache_capacity" : 2145386496,
      "capacity" : 3983343616,
      "description" : "",
      "full_name" : "pool0.421467625108686",
      "vol_count" : 0
   }
}