Format a file system
Formats a file system. Specify the file system block size.
HTTP request syntax (URI)
POST <base_URI>/v8/storage/filesystems/{filesystemId}/format
Parameters
| Name | Type | Required | Values | Description |
| filesystemId | URI_PARAM | Y | string | Either the file system object ID or HNAS file system ID. |
| blockSize | BODY | Y | number | Specifies the block size of the file system in kilobytes (KB). Accepted values can be either 4 or 32. |
| isReplicationTarget | BODY | N | boolean | Format the filesystem for use as a target for object replication. The default value is False. |
| dedupeSupported | BODY | N | boolean | Format the filesystem with support for dedupe. The default value is False. |
| dedupeDisabled | BODY | N | boolean | Use this option to prevent the file system from being scheduled for dedupe, even though its format supports it. Only applicable where dedupeSupported=true |
Return codes
| Code | Data | Description |
| 204 | No Data | File system successfully formatted. |
| 400 | Error Message | Missing or invalid request contents. |
| 403 | Error Message | Operation forbidden by access level. |
| 404 | Error Message | Requested resource not found. |
| 500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 204 indicates that the API did not complete successfully.
Request example: Format a filesystem that supports dedupe, with a 4K block size
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/filesystems/3836363236374331323541433731414230303030303030303030303030303030/format –d '{"blockSize":4, "dedupeSupported":true}' -X POST
Response example:
HTTP/1.1 204 No Content