system.info¶

Returns basic system information.

Type: object

Type: array
No Additional Items

SystemInfoResult

Type: object

SystemInfoResult return fields.

No Additional Properties

Version

Type: string

TrueNAS version.

Buildtime

Type: stringFormat: date-time

TrueNAS build time.

Hostname

Type: string

System host name.

Physmem

Type: integer

System physical memory in bytes.

Model

Type: string

CPU model.

Cores

Type: integer

Number of CPU cores.

Physical Cores

Type: integer

Number of physical CPU cores.

Loadavg

Type: array

System load averages over 1, 5, and 15 minute periods.

No Additional Items

Each item of this array must be:

Type: object

Uptime

Type: string

Human-readable system uptime string.

Uptime Seconds

Type: number

System uptime in seconds since boot.

System Serial

System hardware serial number. null if not available.

Type: string

Type: null

System Product

System product name from hardware manufacturer. null if not available.

Any of

Option 1
Option 2

Type: string

Type: null

System Product Version

System product version from hardware manufacturer. null if not available.

Any of

Option 1
Option 2

Type: string

Type: null

License

System license information. null if no license is installed.

Any of

Option 1
Option 2

Type: object

Type: null

Boottime

Type: stringFormat: date-time

System boot time.

Datetime

Type: stringFormat: date-time

Current system date and time.

Timezone

Type: string

System timezone identifier.

System Manufacturer

System manufacturer name from hardware. null if not available.

Any of

Option 1
Option 2

Type: string

Type: null

Ecc Memory

Type: boolean

Whether the system has ECC (Error Correcting Code) memory.

Required roles: READONLY_ADMIN

Table Of Contents

Previous topic

Next topic

system.info¶

SystemInfoResult

Version

Buildtime

Hostname

Physmem

Model

Cores

Physical Cores

Loadavg

Each item of this array must be:

Uptime

Uptime Seconds

System Serial

Any of

System Product

Any of

System Product Version

Any of

License

Any of

Boottime

Datetime

Timezone

System Manufacturer

Any of

Ecc Memory

Table Of Contents

Previous topic

Next topic

system.info¶

Call parameters

Return value

SystemInfoResult

version Required

Version

buildtime Required

Buildtime

hostname Required

Hostname

physmem Required

Physmem

model Required

Model

cores Required

Cores

physical_cores Required

Physical Cores

loadavg Required

Loadavg

Each item of this array must be:

uptime Required

Uptime

uptime_seconds Required

Uptime Seconds

system_serial Required

System Serial

Any of

system_product Required

System Product

Any of

system_product_version Required

System Product Version

Any of

license Required

License

Any of

boottime Required

Boottime

datetime Required

Datetime

timezone Required

Timezone

system_manufacturer Required

System Manufacturer

Any of

ecc_memory Required

Ecc Memory