System
System / Backup
Execute backup of configuration, database, and file system metadata.
This web service runs the snbackup command.
Parameters
| Parameter | Req / Opt | Num | Description | CLI Option |
|---|---|---|---|---|
|
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
|
jobtype |
Optional | 1 | This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. | None |
|
format |
Optional | 1 | The output format requested. Valid values are json and text. The default is text. |
-F |
Example
|
|
Output
|
- Update database backup catalog
|
System / Backup Status
Retrieves the status of the backup operation.
This web service runs the snbackup command.
Note: This web service returns text or json output. The default is text.
Parameters
This web service does not contain any parameters.
Example
|
|
Output
|
|
System / File System Report
This web service reports the status of a file system and the status of stripe groups that belong to it.
Parameters
| Parameter | Req / Opt | Num | Description | CLI Option |
|---|---|---|---|---|
|
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
|
jobtype |
Optional | 1 | This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. | None |
|
format |
Optional | 1 | The output format requested. The valid values are xml, json and text. The default value is text. | -F
|
|
filesystem |
Required | 1 | The file system name for which status is required. | None |
|
showstripegroups |
Optional | 1 | This option will also enable the status information of stripe groups. The valid values are true and false. The default value is false. |
Example
|
https://<<SERVER>>/sws/v2/system/filesystem/info ?filesystem=snfx1 &showstripegroups=true &format=json |
Output
{
"status" : "Online",
"totalSpace" : "19.991 GB",
"usedSpace" : "9.1 GB",
"usedPercent" : "45%",
"freeSpace" : "10.937 GB",
"freePercent" : "55%",
"sgList" : [ {
"name" : "sg0",
"totalSpace" : "19.99 GB",
"reservedSpace" : "4.13 GB",
"freeSpace" : "15.07 GB"
} ]
}
|
System / Information
Retrieves the latest status of system components.
This web service runs control scripts for different components and gathers the output.
Parameters
|
Parameter |
Req / Opt |
Num |
Description |
CLI Option |
|---|---|---|---|---|
|
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
|
jobtype |
Optional | 1 | This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. | None |
|
|
Optional |
1 |
The output format requested. Valid values are xml, json and text. The default is text. |
|
Example
|
|
Output
|
|
System / Parameters
Report the value for the specified Tertiary Manager system parameter.
This web service runs the showsysparm command.
Parameters
|
Parameter |
Req / Opt |
Num |
Description |
CLI Option |
|---|---|---|---|---|
|
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
|
jobtype |
Optional | 1 | This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. | None |
|
|
Optional |
1 |
The output format requested. Valid values are xml, json and text. The default is text. |
|
|
|
Required |
N |
Name of the system parameter. |
no CLI option |
Example
|
|
Output
|
|
