filesystem.statfs

Return stats from the filesystem of a given path.

Raises: CallError(ENOENT) - Path not found

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: path

path

Type: string

Must be at least 1 characters long

Return value

FilesystemStatfsData

Type: object
No Additional Properties

flags Required

Flags

Type: array

Combined per-mount options and per-superblock options for mounted filesystem.

No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: enum (of string)

Must be one of:

• "RW"
• "RO"
• "XATTR"
• "NOACL"
• "NFS4ACL"
• "POSIXACL"
• "CASESENSITIVE"
• "CASEINSENSITIVE"
• "NOATIME"
• "RELATIME"
• "NOSUID"
• "NODEV"
• "NOEXEC"

Type: object

fsid Required

Fsid

Type: string

Unique filesystem ID as returned by statvfs.

Must be at least 1 characters long

fstype Required

Fstype

String representation of filesystem type from mountinfo.

Any of

• Option 1
• Option 2

Type: enum (of string)

Must be one of:

• "RW"
• "RO"
• "XATTR"
• "NOACL"
• "NFS4ACL"
• "POSIXACL"
• "CASESENSITIVE"
• "CASEINSENSITIVE"
• "NOATIME"
• "RELATIME"
• "NOSUID"
• "NODEV"
• "NOEXEC"

Type: object

source Required

Source

Type: string

Source for the mounted filesystem. For ZFS this will be dataset name.

Must be at least 1 characters long

dest Required

Dest

Type: string

Local path on which filesystem is mounted.

Must be at least 1 characters long

blocksize Required

Blocksize

Type: integer

Filesystem block size as reported by statvfs.

total_blocks Required

Total Blocks

Type: integer

Filesystem size as reported in blocksize blocks as reported by statvfs.

free_blocks Required

Free Blocks

Type: integer

Number of free blocks as reported by statvfs.

avail_blocks Required

Avail Blocks

Type: integer

Number of available blocks as reported by statvfs.

total_blocks_str Required

Total Blocks Str

Type: string

Must be at least 1 characters long

free_blocks_str Required

Free Blocks Str

Type: string

Must be at least 1 characters long

avail_blocks_str Required

Avail Blocks Str

Type: string

Must be at least 1 characters long

files Required

Files

Type: integer

Number of inodes in use as reported by statvfs.

free_files Required

Free Files

Type: integer

Number of free inodes as reported by statvfs.

name_max Required

Name Max

Type: integer

Maximum filename length as reported by statvfs.

total_bytes Required

Total Bytes

Type: integer

free_bytes Required

Free Bytes

Type: integer

avail_bytes Required

Avail Bytes

Type: integer

total_bytes_str Required

Total Bytes Str

Type: string

Must be at least 1 characters long

free_bytes_str Required

Free Bytes Str

Type: string

Must be at least 1 characters long

avail_bytes_str Required

Avail Bytes Str

Type: string

Must be at least 1 characters long

Required roles: FILESYSTEM_ATTRS_READ