Create

Parameter	Type	JSON Type	Description	Default	Mandatory	Deprecated
name	NsObjectName	string	Name of folder. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.		true
description	NsDescription	string	Text description of folder. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.	''	false
pool_id	NsObjectID	string	ID of the pool where the folder resides. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.		true
limit_bytes	NsUnsignedLong	number	Folder limit size in bytes. By default, a folder (except SMIS and VVol types) does not have a limit. If limit_bytes is not specified when a folder is created, or if limit_bytes is set to the largest possible 64-bit signed integer (9223372036854775807), then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. On output, if the folder has a limit, the limit_bytes_specified attribute will be true and limit_bytes will be the limit. If the folder does not have a limit, the limit_bytes_specified attribute will be false and limit_bytes will be interpreted based on the value of the usage_valid attribute. If the usage_valid attribute is true, limits_byte will be the capacity of the pool. Otherwise, limits_bytes is not meaningful and can be null. SMIS and VVol folders require a size limit. This attribute is superseded by limit_size_bytes. Unsigned 64-bit integer. Example: 1234.	(Unlimited.)	false	Yes
limit_size_bytes	NsSignedLong	number	Folder size limit in bytes. If limit_size_bytes is not specified when a folder is created, or if limit_size_bytes is set to -1, then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. Folders with an agent_type of 'smis' or 'vvol' must have a size limit. Signed 64-bit integer. Example: -1234.	(Unlimited.)	false
agent_type	NsAgentType	string enum	External management agent type. Possible values: 'none', 'smis', 'vvol', 'openstack', 'openstackv2'.	'none'	false
inherited_vol_perfpol_id	NsObjectID	string	Identifier of the default performance policy for a newly created volume. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.	(ID of the 'default' performance policy.)	false
appserver_id	NsObjectID	string	Identifier of the application server associated with the folder. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.	''	false
limit_iops	NsSignedLong	number	IOPS limit for this folder. If limit_iops is not specified when a folder is created, or if limit_iops is set to -1, then the folder has no IOPS limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. Signed 64-bit integer. Example: -1234.	(Unlimited.)	false
limit_mbps	NsSignedLong	number	Throughput limit for this folder in MB/s. If limit_mbps is not specified when a folder is created, or if limit_mbps is set to -1, then the folder has no throughput limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. Signed 64-bit integer. Example: -1234.	(Unlimited.)	false

JSON Request

            

{
   "data" : {
      "name" : "folder0.871528991804556",
      "limit_bytes" : 1000,
      "pool_name" : "default"
   }
}

Response

Parameter	Type	JSON Type	Description	Deprecated
id	NsObjectID	string	Identifier for the folder. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
name	NsObjectName	string	Name of folder. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
fqn	NsAbsolutePath	string	Fully qualified name of folder in the pool. Absolute path that starts with / and delimited by /. Each component name must conform to NsObjectName type. Example: '/path/to/folder'.
full_name	NsString	string	Fully qualified name of folder in the group. Plain string.
search_name	NsSearchName	string	Name of folder used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'.
description	NsDescription	string	Text description of folder. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.
pool_name	NsObjectName	string	Name of the pool where the folder resides. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
pool_id	NsObjectID	string	ID of the pool where the folder resides. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
limit_bytes_specified	NsBoolean	boolean	Indicates whether the folder has a limit. Possible values: 'true', 'false'.	Yes
limit_bytes	NsUnsignedLong	number	Folder limit size in bytes. By default, a folder (except SMIS and VVol types) does not have a limit. If limit_bytes is not specified when a folder is created, or if limit_bytes is set to the largest possible 64-bit signed integer (9223372036854775807), then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. On output, if the folder has a limit, the limit_bytes_specified attribute will be true and limit_bytes will be the limit. If the folder does not have a limit, the limit_bytes_specified attribute will be false and limit_bytes will be interpreted based on the value of the usage_valid attribute. If the usage_valid attribute is true, limits_byte will be the capacity of the pool. Otherwise, limits_bytes is not meaningful and can be null. SMIS and VVol folders require a size limit. This attribute is superseded by limit_size_bytes. Unsigned 64-bit integer. Example: 1234.	Yes
limit_size_bytes	NsSignedLong	number	Folder size limit in bytes. If limit_size_bytes is not specified when a folder is created, or if limit_size_bytes is set to -1, then the folder has no limit. Otherwise, a limit smaller than the capacity of the pool can be set. Folders with an agent_type of 'smis' or 'vvol' must have a size limit. Signed 64-bit integer. Example: -1234.
capacity_bytes	NsBytes	number	Capacity of the folder in bytes. If the folder's size has a limit, capacity_bytes will be the folder's size limit. If the folder's size does not have a limit, capacity_bytes will be the pool's capacity. This field is meaningful only when the usage_valid attribute is true. Unsigned 64-bit integer. Example: '1234'.
free_space_bytes	NsBytes	number	Free space in the folder in bytes. If the folder has a limit, free_space_bytes will be the folder's free space (the folder's space limit minus the folder's space consumption). If the folder does not have a limit, free_space_bytes will be the pool's free space. This field is meaningful only when the usage_valid attribute is true. Unsigned 64-bit integer. Example: '1234'.
usage_valid	NsBoolean	boolean	Indicate whether the space usage attributes of folder are valid. Possible values: 'true', 'false'.
agent_type	NsAgentType	string enum	External management agent type. Possible values: 'none', 'smis', 'vvol', 'openstack', 'openstackv2'.
inherited_vol_perfpol_id	NsObjectID	string	Identifier of the default performance policy for a newly created volume. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
inherited_vol_perfpol_name	NsObjectName	string	Name of the default performance policy for a newly created volume. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
unused_reserve_bytes	NsBytes	number	Unused reserve of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true. Unsigned 64-bit integer. Example: '1234'.
unused_snap_reserve_bytes	NsBytes	number	Unused reserve of snapshots of volumes in the folder in bytes. This field is meaningful only when the usage_valid attribute is true. Unsigned 64-bit integer. Example: '1234'.
usage_bytes	NsBytes	number	Compressed and deduped usage of volumes and snapshots in folder. This field is meaningful only when the usage_valid attribute is true. Unsigned 64-bit integer. Example: '1234'.
compressed_vol_usage_bytes	NsBytes	number	Compressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true. Unsigned 64-bit integer. Example: '1234'.
compressed_snap_usage_bytes	NsBytes	number	Compressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true. Unsigned 64-bit integer. Example: '1234'.
uncompressed_vol_usage_bytes	NsBytes	number	Uncompressed usage of volumes in the folder. This field is meaningful only when the usage_valid attribute is true. Unsigned 64-bit integer. Example: '1234'.
uncompressed_snap_usage_bytes	NsBytes	number	Uncompressed usage of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true. Unsigned 64-bit integer. Example: '1234'.
vol_compression_ratio	NsRatio	number	Compression ratio of volumes in the folder. This field is meaningful only when the usage_valid attribute is true. Fraction expressed as floating point number. Example: '9.18'.
snap_compression_ratio	NsRatio	number	Compression ratio of snapshots in the folder. This field is meaningful only when the usage_valid attribute is true. Fraction expressed as floating point number. Example: '9.18'.
compression_ratio	NsRatio	number	Compression savings for the folder expressed as ratio. This field is meaningful only when the usage_valid attribute is true. Fraction expressed as floating point number. Example: '9.18'.
creation_time	NsTime	number	Time when this folder was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
last_modified	NsTime	number	Time when this folder was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
num_snaps	NsUnsignedLong	number	Number of snapshots inside the folder. This attribute is deprecated and has no meaningful value. Unsigned 64-bit integer. Example: 1234.	Yes
num_snapcolls	NsUnsignedLong	number	Number of snapshot collections inside the folder. This attribute is deprecated and has no meaningful value. Unsigned 64-bit integer. Example: 1234.	Yes
app_uuid	NsAppUuid	string	Application identifier of the folder. String of up to 255 alphanumeric characters, hyphen, colon, dot and underscore are allowed. Example: 'rfc4122.943f7dc1-5853-497c-b530-f689ccf1bf18'.
volume_list	NsVolumeList	Array of NsVolumeSummary	List of volumes contained by the folder. List of volumes.
appserver_id	NsObjectID	string	Identifier of the application server associated with the folder. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
appserver_name	NsObjectName	string	Name of the application server associated with the folder. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
limit_iops	NsSignedLong	number	IOPS limit for this folder. If limit_iops is not specified when a folder is created, or if limit_iops is set to -1, then the folder has no IOPS limit. IOPS limit should be in range [256, 4294967294] or -1 for unlimited. Signed 64-bit integer. Example: -1234.
limit_mbps	NsSignedLong	number	Throughput limit for this folder in MB/s. If limit_mbps is not specified when a folder is created, or if limit_mbps is set to -1, then the folder has no throughput limit. MBPS limit should be in range [1, 4294967294] or -1 for unlimited. Signed 64-bit integer. Example: -1234.

JSON Response

            

{
   "data" : {
      "usage_bytes" : 0,
      "snap_compression_ratio" : 1,
      "fqn" : "/folder0.871528991804556",
      "vol_compression_ratio" : 1,
      "dedupe_ratio" : 1,
      "pool_id" : "0a00000000000004d3000000000000000000000001",
      "uncompressed_vol_usage_bytes" : 0,
      "limit_bytes" : 1000,
      "creation_time" : 1431988266,
      "id" : "2f00000000000004d3000000000000000000000001",
      "compressed_snap_usage_bytes" : 0,
      "compressed_vol_usage_bytes" : 0,
      "last_modified" : 1431988266,
      "name" : "folder0.871528991804556",
      "uncompressed_snap_usage_bytes" : 0,
      "description" : "",
      "compression_ratio" : 1,
      "agent_type" : "none",
      "pool_name" : "default"
   }
}