System Information

35 min

\urls summary\ url get post patch put delete /rest/v1/rpc/show clock n y n n n /rest/v1/rpc/show login policy n y n n n /rest/v1/rpc/show user policy n y n n n /rest/v1/running/system info y n n n n /rest/v1/running/system info/fan info/{id} y n n n n /rest/v1/running/system info/hardware info y n n n n /rest/v1/running/system info/psu info/{id} y n n n n /rest/v1/running/system info/ssd health y n n n n /rest/v1/running/system info/sys eeprom y n n n n /rest/v1/running/system info/temperature/{device id} y n n n n /rest/v1/rpc/system show n y n n n rest/v1/rpc/show version info n y n n n rest/v1/rpc/show resource info n y n n n rest/v1/rpc/show device info n y n n n rest/v1/rpc/show system users n y n n n rest/v1/rpc/show supported timezones n y n n n rest/v1/rpc/show tcam profile n y n n n \examples\ \\ get https //{switch ip}/rest/v1/rpc/show version info \\ \esource usage\ get https //{switch ip}/rest/v1/rpc/show resource info \\ \\ get https //{switch ip}/rest/v1/rpc/show device info \\ get https //{switch ip}/rest/v1/rpc/show system users \show supported timezones\ get https //{switch ip}/rest/v1/rpc/show supported timezones \\ get https //{switch ip}/rest/v1/rpc/show tcam profile \show clock\ post https //{switch ip}/rest/v1/rpc/show clock \show login policy\ post https //{switch ip}/rest/v1/rpc/show login policy \show user policy\ post https //{switch ip}/rest/v1/rpc/show user policy \get fans information by id\ get https //{switch ip}/rest/v1/running/system info/fan info/10 \get hardware information\ get https //{switch ip}/rest/v1/running/system info/hardware info \get psu information\ get https //{switch ip}/rest/v1/running/system info/psu info \get ssd health\ get https //{switch ip}/rest/v1/running/system info/ssd health \get system eeprom information\ get https //{switch ip}/rest/v1/running/system info/sys eeprom \get system temperature of device\ get https //{switch ip}/rest/v1/running/system info/temperature/0 \get system information by command\ post https //{switch ip}/rest/v1/rpc/system show { "run cmd" "show system uptime" } \properties descriptions\ \system read only information\ tree diagrams + ro system info + ro fan info \[id] \| + ro id \| + ro position in parent? \| + ro parent name? \| + ro direction? \| + ro speed? \| + ro presence? \| + ro timestamp? \| + ro is replaceable? + ro psu info \[id] \| + ro id \| + ro presence? \| + ro status? \| + ro temperature? \| + ro voltage in? \| + ro current in? \| + ro power in? \| + ro voltage out? \| + ro current out? \| + ro power out? \| + ro direction? \| + ro power warning? \| + ro direction warning? \| + ro is replaceable? \| + ro position in parent? \| + ro parent name? + ro ssd health \| + ro device model? \| + ro firmware? \| + ro serial number? \| + ro health? \| + ro temperature? + ro hardware info \| + ro platform? \| + ro hwsku? \| + ro asic? \| + ro asic count? \| + ro serial number? \| + ro model number? \| + ro hardware revision? \| + ro switch type? + ro sys eeprom \| + ro entry \[code] \| | + ro code \| | + ro name? \| | + ro len? \| | + ro eeprom value? \| + ro checksum valid? + ro temperature \[device id] + ro device id + ro position in parent? + ro parent name? + ro temperature? + ro high threshold? + ro critical high threshold? + ro low threshold? + ro critical low threshold? + ro warning status? + ro timestamp? + ro is replaceable? table of properties name required type/range description system info ro path only node, has no configurable value system information fan info ro path only node, has no configurable value id ro string (sub property of fan info) fan id position in parent ro 0 255 (sub property of fan info) the position number of the fan in its parent device parent name ro string (sub property of fan info) the name of the parent device where the fan is located direction ro string (sub property of fan info) the rotation direction of the fan speed ro string (sub property of fan info) fan speed presence ro "true" "false" (sub property of fan info) the presence status of the fan timestamp ro string (sub property of fan info) last update timestamp is replaceable ro "true" "false" (sub property of fan info) if it is replaceable psu info ro path only node, has no configurable value id ro psu id (sub property of psu info) psu id presence ro "true" "false" (sub property of psu info) power supply unit presence status status ro "true" "false" (sub property of psu info) power supply unit status temperature ro string (sub property of psu info) power supply unit temperature information voltage in ro decimal64 (sub property of psu info) power supply unit input voltage current in ro decimal64 (sub property of psu info) power supply unit input current power in ro decimal64 (sub property of psu info) power supply unit input power voltage out ro decimal64 (sub property of psu info) power supply unit output voltage current out ro decimal64 (sub property of psu info) power supply unit output current power out ro decimal64 (sub property of psu info) power supply unit output power direction ro string (sub property of psu info) the airflow direction of the power supply unit power warning ro "true" "false" (sub property of psu info) if there is a power warning direction warning ro "true" "false" (sub property of psu info) if there is a direction warning is replaceable ro "true" "false" (sub property of psu info) if it is replaceable position in parent ro 0 255 (sub property of psu info) the position number of the power supply unit in its parent device parent name ro string (sub property of psu info) the name of the parent device where the power supply unit is located ssd health ro path only node, has no configurable value device model ro string (sub property of ssd health) ssd device model firmware ro string (sub property of ssd health) ssd firmware serial number ro string (sub property of ssd health) ssd serial number health ro string (sub property of ssd health) ssd health temperature ro string (sub property of ssd health) ssd temperature hardware info ro path only node, has no configurable value platform ro string (sub property of hardware info) hardware platform information hwsku ro string (sub property of hardware info) hardware stock keeping unit asic ro string (sub property of hardware info) asic type asic count ro 0 255 (sub property of hardware info) asic count serial number ro string (sub property of hardware info) hardware serial number model number ro string (sub property of hardware info) hardware model number hardware revision ro 0 255 (sub property of hardware info) hardware revision switch type ro string (sub property of hardware info) hardware switch type sys eeprom ro path only node, has no configurable value entry ro (sub property of sys eeprom) path only node, has no configurable value code ro string (sub property of entry) system eeprom code name ro string (sub property of entry) system eeprom tlv name len ro 0 255 (sub property of entry) system eeprom data length eeprom value ro string (sub property of entry) system eeprom data value checksum valid ro "true" "false" (sub property of sys eeprom) verify the integrity and accuracy of the hardware platform information temperature ro path only node, has no configurable value device id ro string (sub property of temperature) device id position in parent ro 0 255 (sub property of temperature) the position number of the device in its parent device parent name ro string (sub property of temperature) the name of the parent device where this device is located temperature ro decimal64 (sub property of temperature) the temperature of this device high threshold ro string (sub property of temperature) high threshold of this device critical high threshold ro string (sub property of temperature) critical high threshold of this device low threshold ro string (sub property of temperature) low threshold of this device critical low threshold ro string (sub property of temperature) critical low threshold of this device warning status ro "true" "false" (sub property of temperature) warning status of this device timestamp ro string (sub property of temperature) last update timestamp is replaceable ro "true" "false" (sub property of temperature) if it is replaceable \system show\ tree diagrams + x system show \| + w input \| | + w run cmd \| + ro output \| + ro text? table of properties name required type/range description system show m path only node, has no configurable value run cmd m "show hardware info" "show platform fan" "show platform psu status" "show platform ssd health" "show platform summary" "show platform sys eeprom" "show platform temperature" "show system reboot cause" "show system uptime" "show clock" (sub property of input) run system show cmd text ro string (sub property of output) result \show user policy\ tree diagrams + x show user policy \| + ro output \| + ro data? table of properties name required type/range description show user policy m path only node, has no configurable value show user policy data ro \<anydata> (sub property of output) \show login policy\ tree diagrams + x show login policy \| + ro output \| + ro data? table of properties name required type/range description show login policy m path only node, has no configurable value show login policy data ro \<anydata> (sub property of output) \show clock\ tree diagrams + x show clock + ro output + ro data? table of properties name required type/range description show clock m path only node, has no configurable value display time data ro \<anydata> (sub property of output) \\ tree diagrams + x show version info \| + ro output \| + ro version info \| + ro software version? \| + ro distribution? \| + ro kernel? \| + ro build commit? \| + ro build date? \| + ro build author? \| + ro model number? \| + ro platform? \| + ro hwsku? \| + ro serial number? \| + ro asic? \| + ro hardware revision? table of properties name required type/range description show version info m path only node, has no configurable value show version information version info ro path only node, has no configurable value software version ro string (sub property of version info) distribution ro string (sub property of version info) linux distribution kernel ro string (sub property of version info) linux kernel version build commit ro string (sub property of version info) the commit hash the software was built on build date ro string (sub property of version info) the build date build author ro string (sub property of version info) the build user model number ro string (sub property of version info) machine model number platform ro string (sub property of version info) machine platform information hwsku ro string (sub property of version info) hardware stock keeping unit serial number ro string (sub property of version info) identifier for the device asic ro string (sub property of version info) asic type hardware revision ro uint8 (sub property of version info) \\ tree diagrams + x show resource info \| + ro output \| + ro resource usage \| + ro cpu usage? \| + ro memory usage? \| + ro total memory? \| + ro used memory? \| + ro free memory? \| + ro cached memory? \| + ro disk used? table of properties name required type/range description show resource info m path only node, has no configurable value show resource usage resource usage ro path only node, has no configurable value cpu usage ro string (sub property of resource usage) the percentage of cpu load memory usage ro string (sub property of resource usage) the memory utilization rate total memory ro decimal64 (sub property of resource usage) the total physical ram used memory ro decimal64 (sub property of resource usage) the amount of ram currently actively used free memory ro decimal64 (sub property of resource usage) the amount of completely unused ram cached memory ro decimal64 (sub property of resource usage) memory used for system caching disk used ro string (sub property of resource usage) the disk usage percentage \\ tree diagrams + x show device info \| + ro output \| + ro device info \| + ro software? \| + ro device model? \| + ro product id? table of properties name required type/range description show device info m path only node, has no configurable value show device infomation device info ro path only node, has no configurable value software ro string (sub property of device info) software version device model ro string (sub property of device info) product id ro string (sub property of device info) \\ tree diagrams + x show system users \| + ro output \| + ro users info \| + ro user info \[terminal type] \| + ro user name? \| + ro terminal type \| + ro login time? \| + ro ip? table of properties name required type/range description show system users m path only node, has no configurable value show system users information users info ro path only node, has no configurable value user info ro (sub property of users info) path only node, has no configurable value user name ro string (sub property of user info) terminal type ro string (sub property of user info) login time ro string (sub property of user info) ip ro string (sub property of user info) user login ip \\ tree diagrams + x show supported timezones \| + ro output \| + ro timezones \| + ro timezone \[time zone] \| + ro time zone table of properties name required type/range description show supported timezones m path only node, has no configurable value show supported timezones timezones ro path only node, has no configurable value timezone ro (sub property of timezones) path only node, has no configurable value time zone ro string (sub property of timezone) each supported timezone \\ tree diagrams + x show tcam profile + ro output + ro current profile type? table of properties name required type/range description show tcam profile m path only node, has no configurable value show tcam profile information current profile type ro string