freebox_api_php/docs/services/Storage/Storage.md

37 lines
944 B
Markdown
Raw Permalink Normal View History

2016-06-11 21:29:34 +02:00
# Storage
2016-06-11 23:16:01 +02:00
**Namespace** : alphayax\freebox\api\v3\services\Storage
# Overview
- [Disk](Storage.md#Disk)
- [Partition](Storage.md#Partition)
2016-06-11 21:29:34 +02:00
2016-06-11 23:16:01 +02:00
<a name="Disk"></a>
2016-06-11 21:29:34 +02:00
## Disk
2016-06-11 23:16:01 +02:00
**Class** : alphayax\freebox\api\v3\services\Storage\Disk
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
| `getAll` | Get the list of disks |
| `getFromId` | Get a given disk info |
| `update` | Update a disk state |
2016-06-11 23:16:01 +02:00
| `format` | Format the disk with the given id There will be one partition using all the available space on disk. All previous data will be lost. |
2016-06-11 21:29:34 +02:00
2016-06-11 23:16:01 +02:00
<a name="Partition"></a>
2016-06-11 21:29:34 +02:00
## Partition
2016-06-11 23:16:01 +02:00
**Class** : alphayax\freebox\api\v3\services\Storage\Partition
2016-06-11 21:29:34 +02:00
### Public methods
| Method | Description |
|---|---|
| `getAll` | Get the list of partitions |
| `getFromId` | Get a given partition info |
2016-06-11 23:16:01 +02:00
| `check` | Checks the partition with the given id *NOTE* once started you can monitor the fsck process getting the partition information |