diff options
Diffstat (limited to 'lib/os_mon/doc/src/disksup.xml')
| -rw-r--r-- | lib/os_mon/doc/src/disksup.xml | 51 |
1 files changed, 46 insertions, 5 deletions
diff --git a/lib/os_mon/doc/src/disksup.xml b/lib/os_mon/doc/src/disksup.xml index 59ba7eaf9e..4dd81e6099 100644 --- a/lib/os_mon/doc/src/disksup.xml +++ b/lib/os_mon/doc/src/disksup.xml @@ -4,7 +4,7 @@ <erlref> <header> <copyright> - <year>1996</year><year>2022</year> + <year>1996</year><year>2023</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -122,15 +122,15 @@ <name since="">get_disk_data() -> [DiskData]</name> <fsummary>Get data for the disks in the system</fsummary> <type> - <v>DiskData = {Id, KByte, Capacity}</v> + <v>DiskData = {Id, TotalKiB, Capacity}</v> <v> Id = string()</v> - <v> KByte = int()</v> + <v> TotalKiB = int()</v> <v> Capacity = int()</v> </type> <desc> <p>Returns the result of the latest disk check. <c>Id</c> is a - string that identifies the disk or partition. <c>KByte</c> is - the total size of the disk or partition in kbytes. + string that identifies the disk or partition. <c>TotalKiB</c> is + the total size of the disk or partition in kibibytes. <c>Capacity</c> is the percentage of disk space used.</p> <p>The function is asynchronous in the sense that it does not invoke a disk check, but returns the latest available value.</p> @@ -139,6 +139,47 @@ </desc> </func> <func> + <name since="OTP @OTP-18303@">get_disk_info() -> [DiskData]</name> + <fsummary>Immediately get information for the disks in the system</fsummary> + <type> + <v>DiskData = {Id, TotalKiB, AvailableKiB, Capacity}</v> + <v> Id = string()</v> + <v> TotalKiB = int()</v> + <v> AvailableKiB = int()</v> + <v> Capacity = int()</v> + </type> + <desc> + <p>Immediately fetches total space, available space and capacity for local disks. + <c>Id</c> is a string that identifies the disk or partition. + <c>TotalKiB</c> is the total size of the disk or partition in kibibytes. + <c>AvailableKiB</c> is the disk space used in kibibytes. + <c>Capacity</c> is the percentage of disk space used.</p> + <p>Returns <c>[{"none",0,0,0}]</c> if <c>disksup</c> is not + available.</p> + </desc> + </func> + <func> + <name since="OTP @OTP-18303@">get_disk_info(Path) -> DiskData</name> + <fsummary>Immediately get information for a single path</fsummary> + <type> + <v>DiskData = [{Id, TotalKiB, AvailableKiB, Capacity}]</v> + <v> Id = string()</v> + <v> TotalKiB = int()</v> + <v> AvailableKiB = int()</v> + <v> Capacity = int()</v> + </type> + <desc> + <p>Immediately fetches total space, available space and capacity for a path. + <c>Id</c> is a string that identifies the disk or partition. + <c>TotalKiB</c> is the total size of the disk or partition in kibibytes. + <c>AvailableKiB</c> is the disk space used in kibibytes. + <c>Capacity</c> is the percentage of disk space used.</p> + <p>Returns <c>[{Path,0,0,0}]</c> if the <c>Path</c> is invalid or space + can't be determined. Returns <c>[{"none",0,0,0}]</c> if <c>disksup</c> is not + available.</p> + </desc> + </func> + <func> <name since="">get_check_interval() -> MS</name> <fsummary>Get time interval, in milliseconds, for the periodic disk space check</fsummary> <type> |