File system management resources
You can create, mount, unmount, update, and delete file systems, as well as display detailed information for a file system or a list of all file systems in a storage system, a file pool, or a virtual file server in Storage Advisor.
Getting file systems for a storage system
You can display information about file systems in a specified storage system.
GET https://ipAddress/v1/file/storage-systems/storageSystemId/file-systems
Use the ID of the storage system as the storageSystemId.
Not applicable.
The response body structure is shown below:
{ "fileSystems": [ "links": [ { "rel":"_self", "href":"" }, { "rel":"_filePool1", "href":"/v1/storage-systems/{storageSystemId}/filepools/ filePool1" }, { "rel":"_fsServer1", "href":"/v1/storage-systems/{storageSystemId}/vfs/ fsServer1" } ], "id": "", "label": "", "filePoolId": , "evsId": 1, "fileSystemCapacityDetails": { "capacity": , "freeCapacity": , "usedCapacity": , "expansionLimit": , "unlimitedExpansion": }, "status": "", "blockSize": , "fileSystemTraits": { "readOnly": , "sysLocked": , "worm": , "nonStrictWorm": , "readCache": , "objectReplicationTarget": , "ndmRecoveryTarget": , "dedupeSupported": , "dedupeEnabled": } } ] }
Parameter |
Type |
Description |
links | List | Displays related resources. |
self | String | URI that includes the resource ID. |
id | Integer | ID of the file system. |
label | String | Name of the file system. |
filePoolId | String | ID of the storage pool. |
evsId | Integer | ID of the virtual file server. |
fileSystemCapacityDetails | String | The file system capacity details. |
capacity | String | The file system size limit in bytes. Min = 1, max = 1099511627776. |
freeCapacity | String | Capacity available, in bytes. |
usedCapacity | String | Sum of used capacity across all pools of the specified type in the storage system, in bytes. |
expansionLimit | String | Size of the expansion limit, in bytes. |
unlimitedExpansion | Boolean | Whether the expansion is limited. |
status | String | Status of the virtual file server. Valid values: mounted or unmounted. |
blockSize | String | Block size of the file system, either 32 KiB or 4 KiB. |
fileSystemTraits | String | The characteristics of the file system. It describes whether the file system is read-only, and whether object replication is set on the file system. |
readOnly | Boolean | Whether the cache is read. |
sysLocked | Boolean | Whether or not the file system is locked. |
worm | Boolean | The file system WORM type. The server supports two types of WORM file systems: strict and non-strict. |
nonStrictWorm | Boolean | The nonStrictWorm file system enables users to test WORM storage before committing to a "strict" file system. |
readCache | Boolean | Whether the cache is read. |
objectReplicationTarget | Boolean | Whether there is an object replication target. |
ndmRecoveryTarget | Boolean | Whether there is an object recovery target. |
dedupeSupported | Boolean | Whether deduplication is supported. |
dedupeEnabled | Boolean | Whether deduplication is enabled. |
Status code | HTTP name | Description |
200 | OK | Success. |
401 | Unauthorized | The operation is not authorized. |
403 | Forbidden | The server failed to authenticate the request. |
404 | Not found | The specified resource ID is not valid or the resource does not exist. |
Request with JSON command:
https://172.17.64.109/v1/file/storage-systems/410500/file-systems
JSON response:
{ "fileSystems": [ { "id": "55E9CC7EDEBE2B0D0000000000000000", "label": "AutomationFS85", "filePoolId": 6190571495709419190, "evsId": 2, "fileSystemCapacityDetails": { "capacity": 19126026240, "freeCapacity": 16399564800, "usedCapacity": 2726461440, "expansionLimit": 1073741824, "unlimitedExpansion": false }, "status": "Mounted", "blockSize": 32768, "fileSystemTraits": { "readOnly": false, "sysLocked": false, "worm": false, "nonStrictWorm": false, "readCache": false, "objectReplicationTarget": false, "ndmRecoveryTarget": false, "dedupeSupported": true, "dedupeEnabled": true } }, ] }
Getting a single file system
You can display information about a specific file system.
GET https://ipAddress/v1/file/storage-systems/storageSystemId/file-systems/fileSystemId
Use the ID of the storage system as the storageSystemId.
Use the ID of the file system as the fileSystemId.
Not applicable.
The response body structure is shown below:
{ "id": "", "label": "", "filePoolId": , "evsId": , "fileSystemCapacityDetails": { "capacity": , "freeCapacity": , "usedCapacity": , "expansionLimit": , "unlimitedExpansion": }, "status": "", "blockSize": , "fileSystemTraits": { "readOnly": , "sysLocked": , "worm": , "nonStrictWorm": , "readCache": , "objectReplicationTarget": , "ndmRecoveryTarget": , "dedupeSupported": , "dedupeEnabled": } }
Parameter |
Type |
Description |
id | Integer | ID of the file system. |
label | String | Name of the file system. |
filePoolId | String | ID of the storage pool. |
evsId | Integer | ID of the virtual file server. |
status | String | Status of the virtual file server. Valid values: mounted or unmounted. |
blockSize | String | Block size of the file system, either 32 KiB or 4KiB. |
fileSystemCapacityDetails | String | The file system capacity details. |
capacity | String | The file system size limit in bytes. Min = 1, max = 1099511627776. |
freeCapacity | String | Capacity available, in bytes. |
usedCapacity | String | Sum of used capacity across all pools of the specified type in the storage system, in bytes. |
expansionLimit | String | Size of the expansion limit, in bytes. |
unlimitedExpansion | Boolean | Whether the expansion is limited. |
fileSystemTraits | String | The characteristics of the file system. It describes whether the file system is read-only, and whether object replication is set on the file system. |
readOnly | Boolean | Whether the cache is read. |
sysLocked | Boolean | Whether or not the file system is locked. |
worm | Boolean | The file system WORM type. The server supports two types of WORM file systems: strict and non-strict. |
nonStrictWorm | Boolean | The nonStrictWorm file system enables users to test WORM storage before committing to a "strict" file system. |
readCache | Boolean | Whether the cache is read. |
objectReplicationTarget | Boolean | Whether there is an object replication target. |
ndmRecoveryTarget | Boolean | Whether there is an object recovery target. |
dedupeSupported | Boolean | Whether deduplication is supported. |
dedupeEnabled | Boolean | Whether deduplication is enabled. |
Status code | HTTP name | Description |
200 | OK | Success. |
401 | Unauthorized | The operation is not authorized. |
403 | Forbidden | The server failed to authenticate the request. |
404 | Not found | The specified resource ID is not valid or the resource does not exist. |
Request with JSON command:
https://172.17.64.109/v1/file/storage-systems/410500/file-systems/55E9F6F812D9CF310000000000000000
JSON response:
{ "id": "55E9F6F812D9CF310000000000000000", "label": "AutomationFS53", "filePoolId": 6190571495709419190, "evsId": 2, "fileSystemCapacityDetails": { "capacity": 19126026240, "freeCapacity": 16399499264, "usedCapacity": 2726526976, "expansionLimit": 1073741824, "unlimitedExpansion": false }, "status": "Mounted", "blockSize": 32768, "fileSystemTraits": { "readOnly": false, "sysLocked": false, "worm": false, "nonStrictWorm": false, "readCache": false, "objectReplicationTarget": false, "ndmRecoveryTarget": false, "dedupeSupported": true, "dedupeEnabled": true } }
Getting File Systems for a File Pool
You can display information about all file systems in the specified file pool.
GET https://ipAddress/v1/file/storage-systems/storageSystemId/file-pools/poolId/file-systems
Use the ID of the storage system as the storageSystemId.
Use the ID of the file pool as the poolId.
Not applicable.
The response body structure is shows below:
{ "fileSystems": [ "links": [ { "rel":"_self", "href":"" }, { "rel":"_filePool1", "href":"/v1/storage-systems/{storageSystemId}/filepools/ filePool1" }, { "rel":"_fsServer1", "href":"/v1/storage-systems/{storageSystemId}/fs-server/ fsServer1" } ], "id": "", "label": "", "filePoolId": , "evsId": 1, "fileSystemCapacityDetails": { "capacity": , "freeCapacity": , "usedCapacity": , "expansionLimit": , "unlimitedExpansion": }, "status": "", "blockSize": , "fileSystemTraits": { "readOnly": , "sysLocked": , "worm": , "nonStrictWorm": , "readCache": , "objectReplicationTarget": , "ndmRecoveryTarget": , "dedupeSupported": , "dedupeEnabled": } } ] }
Parameter |
Type |
Description |
links | List | Displays related resources. |
self | String | URI that includes the resource ID. |
id | Integer | ID of the file system. |
label | String | Name of the file system. |
filePoolId | String | ID of the storage pool. |
evsId | Integer | ID of the virtual file server. |
fileSystemCapacityDetails | String | The file system capacity details. |
capacity | String | The file system size limit in bytes. Min = 1, max = 1099511627776. |
freeCapacity | String | Capacity available, in bytes. |
usedCapacity | String | Sum of used capacity across all pools of the specified type in the storage system, in bytes. |
expansionLimit | String | Size of the expansion limit, in bytes. |
unlimitedExpansion | Boolean | Whether the expansion is limited. |
status | String | Status of the virtual file server. Valid values: mounted or unmounted. |
blockSize | String | Block size of the file system, either 32KiB or 4KiB. |
fileSystemTraits | String | The characteristics of the file system. It describes whether the file system is read-only, and whether object replication is set on the file system. |
readOnly | Boolean | Whether the cache is read. |
sysLocked | Boolean | Whether or not the file system is locked. |
worm | Boolean | The file system WORM type. The server supports two types of WORM file systems: strict and non-strict. |
nonStrictWorm | Boolean | The nonStrictWorm file system enables users to test WORM storage before committing to a "strict" file system. |
readCache | Boolean | Whether the cache is read. |
objectReplicationTarget | Boolean | Whether there is an object replication target. |
ndmRecoveryTarget | Boolean | Whether there is an object recovery target. |
dedupeSupported | Boolean | Whether deduplication is supported. |
dedupeEnabled | Boolean | Whether deduplication is enabled. |
Status code | HTTP name | Description |
200 | OK | Success. |
401 | Unauthorized | The operation is not authorized. |
403 | Forbidden | The server failed to authenticate the request. |
404 | Not found | The specified resource ID is not valid or the resource does not exist. |
Request with JSON command:
https://172.17.64.111/v1/file/storage-systems/410500/file-pools/6190571495709419190/file-systems
JSON response:
{ "fileSystems": [ "links": [ { "rel":"_self", "href":"" }, { "rel":"_filePool1", "href":"/v1/storage-systems/{storageSystemId}/filepools/ filePool1" }, { "rel":"_fsServer1", "href":"/v1/storage-systems/{storageSystemId}/fs-server/ fsServer1" } ], "id": "050001134F55D7B10000000000000000", "label": "FSCreatedFromSmu", "filePoolId": 361060684191926460, "evsId": 1, "fileSystemCapacityDetails": { "capacity": 19495124992, "freeCapacity": 0, "usedCapacity": 0, "expansionLimit": 10737418240, "unlimitedExpansion": false }, "status": "Not Mounted", "blockSize": 0, "fileSystemTraits": { "readOnly": false, "sysLocked": false, "worm": false, "nonStrictWorm": false, "readCache": false, "objectReplicationTarget": false, "ndmRecoveryTarget": false, "dedupeSupported": false, "dedupeEnabled": false } } ] }
Getting file systems for a virtual file server
In a specified storage system, you can display information about file systems that belong to a virtual file server.
GET https://ipAddress/v1/file/storage-systems/storageSystemId/vfs/vfsuuId/file-systems
Use the ID of the storage system as the storageSystemId.
Use the universal unique identifier of the virtual file server as the vfsuuId.
Not applicable.
The response body structure is shown below:
{ "fileSystems": { "id": "", "label": "", "filePoolId": , "evsId": , "fileSystemCapacityDetails": { "capacity": , "freeCapacity": , "usedCapacity": , "expansionLimit": , "unlimitedExpansion": }, "status": "", "blockSize": , "fileSystemTraits": { "readOnly": , "sysLocked": , "worm": , "nonStrictWorm": , "readCache": , "objectReplicationTarget": , "ndmRecoveryTarget": , "dedupeSupported": , "dedupeEnabled": } }
Parameter |
Type |
Description |
id | Integer | ID of the file system. |
label | String | Name of the file system. |
filePoolId | String | ID of the storage pool. |
evsId | Integer | ID of the virtual file server. |
status | String | Status of the virtual file server. Valid values: mounted or unmounted. |
blockSize | String | Block size of the file system, either 32 KiB or 4 KiB. |
fileSystemCapacityDetails | String | The file system capacity details. |
capacity | String | The file system size limit in bytes. Min = 1, max = 1099511627776. |
freeCapacity | String | Capacity available, in bytes. |
usedCapacity | String | Sum of used capacity across all pools of the specified type in the storage system, in bytes. |
expansionLimit | String | Size of the expansion limit, in bytes. |
unlimitedExpansion | Boolean | Whether the expansion is limited. |
fileSystemTraits | String | The characteristics of the file system. It describes whether the file system is read-only, and whether object replication is set on the file system. |
readOnly | Boolean | Whether the cache is read. |
sysLocked | Boolean | Whether or not the file system is locked. |
worm | Boolean | The file system WORM type. The server supports two types of WORM file systems: strict and non-strict. |
nonStrictWorm | Boolean | The nonStrictWorm file system enables users to test WORM storage before committing to a "strict" file system. |
readCache | Boolean | Whether the cache is read. |
objectReplicationTarget | Boolean | Whether there is an object replication target. |
ndmRecoveryTarget | Boolean | Whether there is an object recovery target. |
dedupeSupported | Boolean | Whether deduplication is supported. |
dedupeEnabled | Boolean | Whether deduplication is enabled. |
Status code | HTTP name | Description |
200 | OK | Success. |
401 | Unauthorized | The operation is not authorized. |
403 | Forbidden | The server failed to authenticate the request. |
404 | Not found | The specified resource ID is not valid or the resource does not exist. |
Request with JSON command:
https://172.17.64.109/v1/file/storage-systems/410304/vfs/0201EF861F061E7B0000000000000000/file-systems
JSON response:
{ "fileSystems": [ { "id": "0201EF861F061E7B0000000000000000", "label": "EVS-true-FS-test-1-SS", "filePoolId": 144124183381760338, "evsId": 1, "status": "Mounted", "blockSize": 32768, "fileSystemCapacityDetails": { "capacity": 19260243968, "freeCapacity": 16478306304, "usedCapacity": 2781937664, "expansionLimit": 112321312334, "unlimitedExpansion": false }, "fileSystemTraits": { "readOnly": false, "sysLocked": false, "worm": false, "nonStrictWorm": false, "readCache": false, "objectReplicationTarget": false, "ndmRecoveryTarget": false, "dedupeSupported": true, "dedupeEnabled": true, } }
Creating a file system
You can create a file system. After creating the file system, the API mounts and formats the new file system.
POST https://ipAddress/v1/file/storage-systems/storageSystemId/file-systems
Use the ID of the storage system as the storageSystemId.
The request body structure is shown below:
{ "label": "", "filePoolId": "", "capacity": , "blockSize": , "evsId": "", }
Parameter |
Required |
Type |
Description |
label | No | String | The name of the file system. |
filePoolId | Yes | String | The storage pool ID where the file system is created. |
capacity | Yes | String | The file system size limit, in bytes. Min = 1, max = 1099511627776. |
blockSize | No | Integer | The block size of the file system, either 32 KiB or 4 KiB. |
evsId | Yes | String | ID of the virtual file server. |
The response body structure is shown below:
{ "jobId": "", "title": { "text": "", "messageCode": "", "parameters": { } }, "user": "", "status": "", "startDate": , "endDate": , "parentJobId": , "reports": [ { "reportMessage": { "text": "", "messageCode": "", "parameters": { "fileSystemId": "" } }, "severity": "", "creationDate": } ], "links": [ { "rel": "_self", "href": "/v1/jobs/" } ], "tags": [ ], "isSystem": }
Parameter |
Type |
Description |
jobId | String | The ID of the job that is created to carry out the request. |
title | Object | The title of the job in progress. |
text | String | Text of the message. |
messageCode | String | ID of the message. This maps to the message description. |
parameters | Object | List of parameters and the values, as captured in the job message. |
user | String | Name of the user who started the job. |
status | String |
Job status. Valid values: • In Progress • Failed • Success • Success With Errors |
startDate | Integer | The date and time this job started. Format is the Unix epoch. |
endDate | Integer | Date and time when this job ended. If the job is still in progress, this parameter does not return a value. Format is the Unix epoch. |
parentJobId | Integer | The ID of the job that spawned this job. If not applicable, the value null is returned. |
reports | List | Messages associated with this job. |
links | List | Displays related resources. |
self | String | URI that includes the resource ID. |
tags | List | List of user-defined identifiers. Each identifier (tag) must be a minimum of three characters in length. |
isSystem | Boolean | Whether a job was created by a system or a user. If the job is generated by a system, the system automatically sets it to true. If a user generates a job, the system sets to false. |
Status code | HTTP name | Description |
201 | Created | The server has started the operation. |
202 | Accepted | The request has been accepted for processing, but the processing has not been completed. |
400 | Bad request | Required HTTP header was not specified. |
403 | Forbidden | The server failed to authenticate the request. |
404 | Not found | The specified resource ID is not valid or the resource does not exist. |
409 | Conflict | The specified resource type does not match the existing resource type. |
503 | Service unavailable | The server is currently unable to receive requests. Retry your request. |
https://172.17.64.122/v1/file/storage-systems/410209/file-systems
{ "label":"NewFS", "filePoolId":"144578117277982905", "capacity":10737418240, "blockSize":32, "evsId":"2", }
{ "jobId": "a88bd309-fe36-4d68-b3b3-342d1edf20e8", "title": { "text": "Creating File System with Label FSforenableevs", "messageCode": "CreateFileSystemJobPreTitleMessage", "parameters": {} }, "user": "sysadmin", "status": "IN_PROGRESS", "startDate": 1452129643172, "endDate": null, "parentJobId": null, "reports": [], "links": [ { "rel": "_self", "href": "/v1/jobs/a88bd309-fe36-4d68-b3b3-342d1edf20e8" } ], "tags": [{ "tag": "STORAGE" }, { "tag": "CREATE" }, { "tag": "410500" }, { "tag": "FILE" }, { "tag": "USER" } ], "isSystem": false }
Mounting a file system
You can mount a file system using Storage Advisor even if a file system already created outside of Storage Advisor. The API also formats the file system after mounting it.
PATCH https://ipAddress/v1/file/storage-systems/storageSystemId/file-systems/fileSystemId
Use the ID of the storage system as the storageSystemId.
Use the ID of the file system as the fileSystemId.
{ "label" : "", "status" : "mount", "blockSize" : "", "expansionLimit " : "" }
Parameter |
Required |
Type |
Description |
label | No | String | The name of the file system. |
status | No | String | Mount or unmount. Default value: mount. |
blockSize | Yes | String | When mounting a file system this parameter is required. If a file system is formatted, this parameter is ignored. |
expansionLimit | No | String | The file system expansion limit. |
{ "jobId": "", "title": { "text": "", "messageCode": "", "parameters": {} }, "user": "", "status": "", "startDate": , "endDate": , "parentJobId": , "reports": [], "links": [ { "rel": "_self", "href": "/v1/jobs/" } ], "tags": [], "isSystem": }
Parameter |
Type |
Description |
jobId | String | The ID of the job that is created to carry out the request. |
title | Object | The title of the job in progress. |
text | String | Text of the message. |
messageCode | String | ID of the message. This maps to the message description. |
parameters | Object | List of parameters and the values, as captured in the job message. |
user | String | Name of the user who started the job. |
status | String |
Job status. Valid values: • In Progress • Failed • Success • Success With Errors |
startDate | Integer | The date and time this job started. Format is the Unix epoch. |
endDate | Integer | Date and time when this job ended. If the job is still in progress, this parameter does not return a value. Format is the Unix epoch. |
parentJobId | Integer | The ID of the job that spawned this job. If not applicable, the value null is returned. |
reports | List | Messages associated with this job. |
links | List | Displays related resources. |
self | String | URI that includes the resource ID. |
tags | List | List of user-defined identifiers. Each identifier (tag) must be a minimum of three characters in length. |
isSystem | Boolean | Whether a job was created by a system or a user. If the job is generated by a system, the system automatically sets it to true. If a user generates a job, the system sets to false. |
Status code | HTTP name | Description |
202 | Accepted | The request has been accepted for processing, but the processing has not been completed. |
204 | No content | The request was successful, but the response does not exist. |
401 | Unauthorized | The operation is not authorized. |
403 | Forbidden | The server failed to authenticate the request. |
404 | Not found | The specified resource ID is not valid or the resource does not exist. |
409 | Conflict | The specified resource type does not match the existing resource type. |
https://172.17.64.109/v1/file/storage-systems/410500/file-systems/55E9F6F812D9CF310000000000000000
{ "label" : "", "status" : "mount", "blockSize" : "", "expansionLimit " : "" }
{ "jobId": "bb1b9bd9-b0f1-4842-8b95-521bdef776ba", "title": { "text": "Modifying File System with Label FirstFS2", "messageCode": "MountFileSystemJobPreTitleMessage", "parameters": {} }, "user": "sysadmin", "status": "IN_PROGRESS", "startDate": 1452129926168, "endDate": null, "parentJobId": null, "reports": [], "links": [ { "rel": "_self", "href": "/v1/jobs/bb1b9bd9-b0f1-4842-8b95-521bdef776ba" } ], "tags": [ { "tag": "STORAGE" }, { "tag": "410500" }, { "tag": "0500B2335827A5C60000000000000000" }, { "tag": "UPDATE" }, { "tag": "FILE" }, { "tag": "USER" } ], "isSystem": false }
Unmounting a file system
You can unmount a file system.
PATCH https://ipAddress/v1/file/storage-systems/storageSystemId/file-systems/fileSystemId
Use the ID of the storage system as the storageSystemId.
Use the ID of the file system as the fileSystemId.
The request body structure is shown below:
{ "label" "status" : "unmount", "blockSize" : "", "expansionLimit " : "" }
Parameter |
Required |
Type |
Description |
label | No | String | The name of the file system. |
status | Yes | String | Mount or unmount. |
blockSize | No | String | If the file system is formatted, this parameter is ignored. |
expansionLimit | No | String | The file system expansion limit. |
The response body structure is shown below:
{ "jobId": "", "title": { "text": "", "messageCode": "", "parameters": {} }, "user": "", "status": "", "startDate": , "endDate": , "parentJobId": , "reports": [], "links": [ { "rel": "_self", "href": "/v1/jobs/" } ], "tags": [], "isSystem": }
Parameter |
Type |
Description |
jobId | String | The ID of the job that is created to carry out the request. |
title | Object | The title of the job in progress. |
text | String | Text of the message. |
messageCode | String | ID of the message. This maps to the message description. |
parameters | Object | List of parameters and the values, as captured in the job message. |
user | String | Name of the user who started the job. |
status | String |
Job status. Valid values: • In Progress • Failed • Success • Success With Errors |
startDate | Integer | The date and time this job started. Format is the Unix epoch. |
endDate | Integer | Date and time when this job ended. If the job is still in progress, this parameter does not return a value. Format is the Unix epoch. |
parentJobId | Integer | The ID of the job that spawned this job. If not applicable, the value null is returned. |
reports | List | Messages associated with this job. |
links | List | Displays related resources. |
self | String | URI that includes the resource ID. |
tags | List | List of user-defined identifiers. Each identifier (tag) must be a minimum of three characters in length. |
isSystem | Boolean | Whether a job was created by a system or a user. If the job is generated by a system, the system automatically sets it to true. If a user generates a job, the system sets to false. |
Status code | HTTP name | Description |
202 | Accepted | The request has been accepted for processing, but the processing has not been completed. |
204 | No content | The request was successful, but the response does not exist. |
401 | Unauthorized | The operation is not authorized. |
403 | Forbidden | The server failed to authenticate the request. |
404 | Not found | The specified resource ID is not valid or the resource does not exist. |
409 | Conflict | The specified resource type does not match the existing resource type. |
{ "status":"unmount" }
Request with JSON command:
https://172.17.64.122/v1/file/storage-systems/410209/file-systems/02029EC8EBDD7EB80000000000000000
{ "jobId": "bb1b9bd9-b0f1-4842-8b95-521bdef776ba", "title": { "text": "Mounting File System", "messageCode": "MountFileSystemJobPreTitleMessage", "parameters": {} }, "user": "sysadmin", "status": "IN_PROGRESS", "startDate": 1452129926168, "endDate": null, "parentJobId": null, "reports": [], "links": [ { "rel": "_self", "href": "/v1/jobs/bb1b9bd9-b0f1-4842-8b95-521bdef776ba" } ], "tags": [], "isSystem": false }
Updating a file system
You can modify a file system with one or more parameters. You can also rename or expand a file system.
PATCH https://ipAddress/v1/file/storage-systems/storageSystemId/file-systems/fileSystemId
Use the ID of the storage system as the storageSystemd.
Use the ID of the file system as the fileSystemId.
The request body structure is shown below:
{ “label”: “”, “expansionLimit”: “” }
Parameter |
Required |
Type |
Description |
label | No | String | The name of the file system. |
expansionLimit | Yes | String | The file system expansion limit. |
The response body structure is shown below:
{ "jobId": "", "title": { "text": "", "messageCode": "", "parameters": {} }, "user": "", "status": "", "startDate": , "endDate": , "parentJobId": , "reports": [], "links": [ { "rel": "_self", "href": "/v1/jobs/" } ], "tags": [], "isSystem": }
Parameter |
Type |
Description |
jobId | String | The ID of the job that is created to carry out the request. |
title | Object | The title of the job in progress. |
text | String | Text of the message. |
messageCode | String | ID of the message. This maps to the message description. |
parameters | Object | List of parameters and the values, as captured in the job message. |
user | String | Name of the user who started the job. |
status | String |
Job status. Valid values: • In Progress • Failed • Success • Success With Errors |
startDate | Integer | The date and time this job started. Format is the Unix epoch. |
endDate | Integer | Date and time when this job ended. If the job is still in progress, this parameter does not return a value. Format is the Unix epoch. |
parentJobId | Integer | The ID of the job that spawned this job. If not applicable, the value null is returned. |
reports | List | Messages associated with this job. |
links | List | Displays related resources. |
self | String | URI that includes the resource ID. |
tags | List | List of user-defined identifiers. Each identifier (tag) must be a minimum of three characters in length. |
isSystem | Boolean | Whether a job was created by a system or a user. If the job is generated by a system, the system automatically sets it to true. If a user generates a job, the system sets to false. |
Status code | HTTP name | Description |
200 | OK | Success. |
202 | Accepted | The request has been accepted for processing, but the processing has not been completed. |
401 | Unauthorized | The operation is not authorized. |
403 | Forbidden | The server failed to authenticate the request. |
404 | Not found | The specified resource ID is not valid or the resource does not exist. |
https://172.17.64.122/v1/file/storage-systems/410209/file-systems/02029F5C1178864D0000000000000000
{ "label":"NewFS17", "expansionLimit":10737418240 }
{ "jobId": "bb1b9bd9-b0f1-4842-8b95-521bdef776ba", "title": { "text": "Modifying File System with Label FirstFS2", "messageCode": "ModifyFileSystemJobPreTitleMessage", "parameters": {} }, "user": "sysadmin", "status": "IN_PROGRESS", "startDate": 1452129926168, "endDate": null, "parentJobId": null, "reports": [], "links": [ { "rel": "_self", "href": "/v1/jobs/bb1b9bd9-b0f1-4842-8b95-521bdef776ba" } ], "tags": [{ "tag": "STORAGE" }, { "tag": "410500" }, { "tag": "0500B2335827A5C60000000000000000" }, { "tag": "UPDATE" }, { "tag": "FILE" }, { "tag": "USER" } ], "isSystem": false }
Deleting a file system
You can delete a file system. Unmount the file system before deleting it. When a file system is deleted all associated shares (Windows OS) and exports (Linux OS) are deleted.
DELETE https://ipAddress/v1/file/storage-systems/storageSystemId/file-systems/fileSystemId
Use the ID of the storage system as the storageSystemId.
Use the ID of the file system as the fileSystemId.
Not applicable.
The response body structure is shown below:
{ "jobId": "", "title": { "text": "", "messageCode": "", "parameters": { } }, "user": "", "status": "", "startDate": , "endDate": , "parentJobId": , "reports": [ ], "links": [ { "rel": "_self", "href": "/v1/jobs/" } ], "tags": [ ], "isSystem": }
Parameter |
Type |
Description |
jobId | String | The ID of the job that is created to carry out the request. |
title | Object | The title of the job in progress. |
text | String | Text of the message. |
messageCode | String | ID of the message. This maps to the message description. |
parameters | Object | List of parameters and the values, as captured in the job message. |
user | String | Name of the user who started the job. |
status | String |
Job status. Valid values: • In Progress • Failed • Success • Success With Errors |
startDate | Integer | The date and time this job started. Format is the Unix epoch. |
endDate | Integer | Date and time when this job ended. If the job is still in progress, this parameter does not return a value. Format is the Unix epoch. |
parentJobId | Integer | The ID of the job that spawned this job. If not applicable, the value null is returned. |
reports | List | Messages associated with this job. |
links | List | Displays related resources. |
self | String | URI that includes the resource ID. |
tags | List | List of user-defined identifiers. Each identifier (tag) must be a minimum of three characters in length. |
isSystem | Boolean | Whether a job was created by a system or a user. If the job is generated by a system, the system automatically sets it to true. If a user generates a job, the system sets to false. |
Status code | HTTP name | Description |
200 | OK | Success. |
202 | Accepted | The request has been accepted for processing, but the processing has not been completed. |
401 | Unauthorized | The operation is not authorized. |
403 | Forbidden | The server failed to authenticate the request. |
404 | Not found | The specified resource ID is not valid or the resource does not exist. |
Request with JSON command:
https://172.17.64.109:8183/v1/file/storage-systems/21000/file-systems/ebc4b9b8-529e-11d1-9003-040100050000
JSON Response:
{ "jobId": "e10b1e6c-6985-4a1d-9161-68cfa3c96b29", "title": { "text": "Deleting File System with Label FirstFS2renamed", "messageCode": "DeleteFileSystemJobPreTitleMessage", "parameters": {} }, "user": "sysadmin", "status": "IN_PROGRESS", "startDate": 1453254388625, "endDate": null, "parentJobId": null, "reports": [], "links": [ { "rel": "_self", "href": "/v1/jobs/e10b1e6c-6985-4a1d-9161-68cfa3c96b29" } ], "tags": [ { "tag": "STORAGE" }, { "tag": "DELETE" }, { "tag": "410500" }, { "tag": "0500B2335827A5C60000000000000000" }, { "tag": "FILE" }, { "tag": "USER" } ], "isSystem": false }