Table Of Contents
- JSON-RPC 2.0 over WebSocket API
- API Methods
- acme.dns.authenticator
- alert
- alertclasses
- alertservice
- api_key
- app
- app.available
- app.available_space
- app.categories
- app.certificate_choices
- app.config
- app.container_console_choices
- app.container_ids
- app.convert_to_custom
- app.create
- app.delete
- app.get_instance
- app.gpu_choices
- app.ip_choices
- app.latest
- app.outdated_docker_images
- app.pull_images
- app.query
- app.redeploy
- app.rollback
- app.rollback_versions
- app.similar
- app.start
- app.stop
- app.update
- app.upgrade
- app.upgrade_summary
- app.used_ports
- app.image
- app.ix_volume
- app.registry
- auth
- boot.environment
- catalog
- certificate
- cloud_backup
- cloudsync
- cloudsync.credentials
- config
- core
- cronjob
- device
- disk
- docker
- docker.network
- enclosure.label
- failover.reboot
- fc
- fc.fc_host
- fcport
- filesystem
- filesystem.acltemplate
- ftp
- group
- initshutdownscript
- ipmi
- iscsi.auth
- iscsi.extent
- iscsi.global
- iscsi.initiator
- iscsi.portal
- iscsi.target
- iscsi.targetextent
- keychaincredential
- keychaincredential.create
- keychaincredential.delete
- keychaincredential.generate_ssh_key_pair
- keychaincredential.get_instance
- keychaincredential.query
- keychaincredential.remote_ssh_host_key_scan
- keychaincredential.remote_ssh_semiautomatic_setup
- keychaincredential.setup_ssh_connection
- keychaincredential.update
- keychaincredential.used_by
- nfs
- pool
- pool.dataset
- pool.resilver
- pool.scrub
- pool.snapshottask
- pool.snapshottask.create
- pool.snapshottask.delete
- pool.snapshottask.delete_will_change_retention_for
- pool.snapshottask.get_instance
- pool.snapshottask.max_count
- pool.snapshottask.max_total_count
- pool.snapshottask.query
- pool.snapshottask.run
- pool.snapshottask.update
- pool.snapshottask.update_will_change_retention_for
- privilege
- rdma
- reporting
- reporting.exporters
- sharing.nfs
- sharing.smb
- smb
- snmp
- staticroute
- system
- system.general
- system.ntpserver
- system.reboot
- system.security
- system.security.info
- tn_connect
- truenas
- user
- vm
- vm.bootloader_options
- vm.clone
- vm.create
- vm.delete
- vm.flags
- vm.get_available_memory
- vm.get_console
- vm.get_display_devices
- vm.get_instance
- vm.get_memory_usage
- vm.log_file_download
- vm.log_file_path
- vm.port_wizard
- vm.poweroff
- vm.query
- vm.random_mac
- vm.resolution_choices
- vm.restart
- vm.resume
- vm.start
- vm.status
- vm.stop
- vm.supports_virtualization
- vm.suspend
- vm.update
- vm.virtualization_details
- vm.device
- webui.crypto
- webui.enclosure
- webui.main.dashboard
- API Events
- acme.dns.authenticator
- alert
- alertservice
- api_key
- app
- app.image
- app.registry
- auth
- certificate
- cloud_backup
- cloudsync
- cloudsync.credentials
- container
- container.device
- core
- cronjob
- directoryservices
- disk
- docker
- docker.network
- failover
- failover.disabled
- failover.reboot
- fc.fc_host
- fcport
- filesystem
- filesystem.acltemplate
- group
- initshutdownscript
- interface
- iscsi.auth
- iscsi.extent
- iscsi.initiator
- iscsi.portal
- iscsi.target
- iscsi.targetextent
- jbof
- kerberos.keytab
- kerberos.realm
- keychaincredential
- nvmet.host
- nvmet.host_subsys
- nvmet.namespace
- nvmet.port
- nvmet.port_subsys
- nvmet.subsys
- pool
- pool.dataset
- pool.scrub
- pool.snapshot
- pool.snapshottask
- privilege
- replication
- reporting
- reporting.exporters
- rsynctask
- service
- sharing.nfs
- sharing.smb
- sharing.webshare
- staticroute
- system
- system.ntpserver
- system.reboot
- tn_connect
- truecommand
- tunable
- update
- user
- vm
- vm.device
- vmware
- Jobs
- Query Methods
- Role-Based Access Control
Previous topic
Next topic
webui.enclosure.dashboard¶
This endpoint is used by the webUI for the enclosure dashboard page for TrueNAS sold hardware.
An example of what this returns looks like the following (some redundant information cut out for brevity):
[{ "name": "iX 4024Sp c205", "model": "M40", "controller": true, "dmi": "TRUENAS-M40-HA", "status": ["OK"], "id": "5b0bd6d1a30714bf", "vendor": "iX", "product": "4024Sp", "revision": "c205", "bsg": "/dev/bsg/0:0:23:0", "sg": "/dev/sg25", "pci": "0:0:23:0", "rackmount": true, "top_loaded": false, "front_slots": 24, "rear_slots": 0, "internal_slots": 0, "elements": { "Array Device Slot": { "1": { "descriptor": "slot00", "status": "OK", "dev": "sda", "supports_identify_light": true, "name": "sda", "size": 12000138625024, "model": "HUH721212AL4200", "serial": "XXXXX", "advpowermgmt": "DISABLED", "transfermode": "Auto", "hddstandby": "ALWAYS ON", "description": "", "rotationrate": 7200, "pool_info": { "pool_name": "test", "disk_status": "ONLINE", "disk_read_errors": 0, "disk_write_errors": 0, "disk_checksum_errors": 0, "vdev_name": "mirror-0", "vdev_type": "data", "vdev_disks": [ {
“enclosure_id”: “5b0bd6d1a30714bf”, “slot”: 1, “dev”: “sda” }, { “enclosure_id”: “5b0bd6d1a30714bf”, “slot”: 2, “dev”: “sdb” }, { “enclosure_id”: “5b0bd6d1a30714bf”, “slot”: 3, “dev”: “sdc” }
] }
} }
} }]
Type: object
No Additional Items
Type: array
No Additional Items
No Additional Items
Result
Type: array of objectNo Additional Items
Each item of this array must be:
Type: object
Required roles: ENCLOSURE_READ