Skip to main content

Module nodes_api

Module nodes_api 

Source

Enums§

NodesCreateTermproxyError
struct for typed errors of method nodes_create_termproxy
NodesGetIdentityError
struct for typed errors of method nodes_get_identity
NodesGetJournalError
struct for typed errors of method nodes_get_journal
NodesGetNodesByNodeError
struct for typed errors of method nodes_get_nodes_by_node
NodesGetNodesError
struct for typed errors of method nodes_get_nodes
NodesGetReportError
struct for typed errors of method nodes_get_report
NodesGetRrdError
struct for typed errors of method nodes_get_rrd
NodesGetSyslogError
struct for typed errors of method nodes_get_syslog
NodesGetVncwebsocketError
struct for typed errors of method nodes_get_vncwebsocket

Functions§

nodes_create_termproxy
Call termproxy and return shell ticket Permissions: The user needs Sys.Console on /system.
nodes_get_identity
Returns a unique server identity. The ID is derived from /etc/machine-id.
nodes_get_journal
Read syslog entries.
nodes_get_nodes
List Nodes (only for compatibility)
nodes_get_nodes_by_node
Directory index.
nodes_get_report
Generate a report
nodes_get_rrd
Read node stats
nodes_get_syslog
Read syslog entries.
nodes_get_vncwebsocket
Upgraded to websocket Permissions: The user needs Sys.Console on /system. Wire-level note: this endpoint answers HTTP 101 Upgrade, not a JSON body. The 200 schema below is the apidoc-declared shape for tooling, but real clients perform a WebSocket upgrade and exchange framed messages on the resulting socket. See the x-pbs-websocket extension for the framing and the list of sibling endpoints that issue tickets.