XMLSysInfo Output
This document explains all (possible) output elements in plain English.
For a formal description of the output grammar, look at the
XML Schema.
A fairly verbose
example output
is also available.
Due to the fact that the output is encoded in XML, clients need to be prepared
to translate the following entity references:
&- The amersand character:
& (element contents only)
"- The quotation sign:
" (attribute contents only)
'- The (regular!) apostrophe sign:
' (attribute contents only)
<- The lower-than sign:
<
>- The greater-than sign:
>
Note that an element's unique meaning depends on its context.
Element names are not unique by themselves.
Legend
Types
- boolean
-
A value of either true or false.
- integer
-
An integer value of a given width and signedness.
- decimal
-
A decimal (floating-point) value.
- token
-
A character string without line feeds, carriage returns, tabs,
leading/trailing whitespaces, or multiple spaces.
May be arbitrary, or explicitly restricted to a set of contents with a given
parseability.
- normalizedString
-
A character string, like the token type, but may contain multiple
spaces and always has arbitrary, purely informational content.
- flag
-
An empty element that indicates something by its presence or absence.
- node
-
An empty element that has child elements.
Note that the various <count/> elements usually have the width of the
host system's size_t for programming reasons.
However, such high numbers are hardly to be expected there.
These are exceptions, and programs that read XSI output should expect all other
integer widths to be how they are for a reason.
Occurrences
Not all information gathered by XMLSysInfo is available on all of the supported
operating systems, architectures and hardware setups.
Because of this, not all of the possible output elements are always present.
For example, a few elements can only appear on certain platforms, and some
others need to be replaced with generic, less detailed output elements.
These variances between systems cannot be avoided entirely, and are necessary
to provide as accurate as possible - and never false - information.
The description row of an element explains the special cases.
The phrases that define the occurrence of an element in the output grammar are
defined as follows:
- once
-
The element occurs exactly one time (and is therefore available everywhere
by definintion.)
- optionally once
-
The element may or may not occur one time.
- multiple
-
The element occurs one or more times.
- arbitrary
-
The element can occur zero, one or multiple times.
Attributes use different phrases:
- mandatory
-
The attribute must always be present.
- optional
-
The attribute's presence is optional.
Default values
An element or attribute with a default value is practically present in every
output, even if XSI did not include it.
For example, the <collisions/> element in the networking section defaults
to zero. This means that when it is not included in the output, there were no
collisions on that particular network interface.
Output Map
Element Index
Attribute Index
Elements
XMLSysInfo Configuration
|
<xsi_config/>
|
|
node
|
|
<xmlsysinfo/>
|
|
<update_timestamp/>,
<defaults/>,
<compress_output/>,
<format_output/>,
<no_names/>,
<one_client_mode/>,
<one_shot/>,
<show_packet_filter/>,
<show_raid/>,
<update_interval/>,
<listen_addr/>,
<listen_port/>
|
|
schema_version,
xsi_version
|
|
once
|
|
N/A
|
Element containing flags and regular elements that indicate the
configuration of the xsi(8) daemon, including mode of
operation, timestamp of last update, listening addresses, and others.
|
|
<update_timestamp/>
|
|
decimal
|
|
<xsi_config/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the value of time when the last statistics update happened, in
seconds since the Epoch.
If both XSI servers and clients have good system time, it can be used to
determine and compare the age of the data last received from XSI.
|
|
<defaults/>
|
|
flag
|
|
<xsi_config/>
|
|
none
|
|
none
|
|
optionally once
|
|
N/A
|
Present, if no command line options that affect the output were given to the
xsi(8) daemon, i.e. the default configuration is used.
XSI is configured to send snapshots of system information and statistics -
updated every two seconds - in unformatted, uncompressed XML.
No packet filter or RAID information is included in the output.
|
|
<compress_output/>
|
|
flag
|
|
<xsi_config/>
|
|
none
|
|
none
|
|
optionally once
|
|
N/A
|
Present, if the user requested XSI output to be compressed with the
-c command line parameter.
|
|
<format_output/>
|
|
flag
|
|
<xsi_config/>
|
|
none
|
|
none
|
|
optionally once
|
|
N/A
|
Present, if the user requested XSI output to be formatted with newlines and
indentation, to make it more human-readable.
The command line parameter -f was used.
|
|
<no_names/>
|
|
flag
|
|
<xsi_config/>
|
|
none
|
|
none
|
|
optionally once
|
|
N/A
|
Present, if user names are being excluded from the output.
The command line parameter -N was used.
This flag suppresses the
username
attribute of the
<euid/>
element, and prevents
<login_user/>
from appearing in the output.
|
|
<one_client_mode/>
|
|
flag
|
|
<xsi_config/>
|
|
none
|
|
none
|
|
optionally once
|
|
N/A
|
Present, if XSI is running in "One-Client Mode", where it expects to be
queried by one client only, with the client's queries triggering updates of
the statistics (requested with the -1 command line parameter.)
|
|
<one_shot/>
|
|
flag
|
|
<xsi_config/>
|
|
none
|
|
none
|
|
optionally once
|
|
N/A
|
Present, if the XML output came from XSI running once in "One-Shot Mode",
by using the -o command line parameter.
Time-sensitive elements containing "per second" values are not included in
the output.
|
|
<show_packet_filter/>
|
|
flag
|
|
<xsi_config/>
|
|
none
|
|
none
|
|
optionally once
|
|
N/A
|
Present, if the user requested packet filter statistics to be included in
the output by supplying the -F command line parameter.
This enables the
<packet_filter/>
element.
|
|
<show_raid/>
|
|
flag
|
|
<xsi_config/>
|
|
none
|
|
none
|
|
optionally once
|
|
N/A
|
Only available on systems running OpenBSD with RAID controllers supported
by bio(4).
Present, if the user requested RAID information to be included in the output
by supplying the -r device command line parameter.
This enables the
<raid/>
element.
|
|
<update_interval/>
|
|
decimal
|
|
<xsi_config/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
Present as soon as the first update interval passed, and will not show up in
"One-Shot Mode" output.
Contains the actual time spent between updates, which may deviate slightly
from the update interval requested by the -i interval command
line parameter.
All "per second" values in the output are calculated with it.
In "One-Client Mode", significant deviations from the expected update
interval value can be used to detect error conditions where more than one
client is querying XSI.
Note that the accuracy of this value depends on the system's perception of
time and is affected by clock skew.
|
|
<listen_addr/>
|
|
token (parseable)
|
|
<xsi_config/>
|
|
none
|
|
none
|
|
arbitrary
|
|
none
|
Each <listen_addr/> element contains an IP address the
xsi(8) daemon is listening on.
IPv4 addresses use the dotted-quad notation, IPv6 addresses use the standard
notation with colons.
Does not appear in "One-Shot Mode" output.
|
|
<listen_port/>
|
|
integer (16-bit, unsigned)
|
|
<xsi_config/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
This element contains the port number the xsi(8) daemon is
listening on.
Does not appear in "One-Shot Mode" output.
|
System Information
|
<arch/>
|
|
token (low parseability)
|
|
<machine/>
|
|
none
|
|
none
|
|
once
|
|
none
|
Contains the name of the machine's architecture, such as i386 or
sparc64, as reported by the operating system.
Its content is equivalent to the output of the uname -m command
on the system.
As such, it has a relatively predictable set of possible contents.
However, one cannot rely on the same architecture having identical machine
names on different platforms.
For example, one operating system may call an architecture amd64,
while another calls the same architecture x86_64.
|
|
<model/>
|
|
normalizedString
|
|
<machine/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the vendor-supplied string describing the machine model - usually,
this is closely related to the CPU model and brand.
Present only where available.
|
|
<cpu_freq/>
|
|
integer (32-bit)
|
|
<machine/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
If available, this element show the current CPU frequency in MHz.
|
|
<vendor/>
|
|
normalizedString
|
|
<machine/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the vendor-supplied string with the vendor's or manufacturer's
name.
In case of custom-built computers, this is usually the manufacturer of the
mainboard.
Present only where available.
|
|
<product/>
|
|
normalizedString
|
|
<machine/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the vendor-supplied string with the product name.
This can be either the product name of the entire system or, in most cases
with custom-built computers, the product name of the mainboard.
Present only where available.
|
|
<version/>
|
|
normalizedString
|
|
<machine/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the vendor-supplied string with the product version or revision.
Present only where available.
|
|
<serial_no/>
|
|
token (very low parseability)
|
|
<machine/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
Contains the vendor-supplied string with the serial number of the product.
This is a character string that often contains a number.
However, strings like Not set by OEM and obviously bogus
serial numbers like 123456789 or 000000000 are not
uncommon.
Not all vendors choose a sane format for their serial numbers.
Present only where available.
|
|
<uuid/>
|
|
token (high parseability)
|
|
<machine/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the vendor-supplied string with the system's UUID.
The content can be expected to be an UUID in canoncial form.
However, this still is just a vendor-supplied character string and XSI does
not check whether it is a valid UUID or not.
Present only where available.
|
|
<count/>
|
|
integer (up to 64-bit, unsigned)
|
|
<cpus/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of CPUs used in the system.
|
|
<cpu_load/>
|
|
node
|
|
<cpus/>
|
|
<system/>,
<user/>,
<nice/>,
<interrupt/>,
<idle/>
|
|
num
|
|
once or multiple
|
|
N/A
|
Contains child elements that show the current load distribution on the
various CPU states.
Attribute presence or absence affects meaning!
num attribute exists:
The load distribution on the CPU with the specified number is shown.
num attribute does not exist:
The load distribution of all CPUs in the system is summarized below one
<cpu_load/> element (only on platforms where CPU-specific load
distribution cannot be determined.)
|
|
<system/>
|
|
decimal
|
|
<cpu_load/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the percentage, from 0.0 to 100.0, of CPU time spent in the
kernel during the last update interval.
|
|
<user/>
|
|
decimal
|
|
<cpu_load/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the percentage, from 0.0 to 100.0, of CPU time spent on userland
applications during the last update interval.
|
|
<nice/>
|
|
decimal
|
|
<cpu_load/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the percentage, from 0.0 to 100.0, of CPU time spent on userland
applications that are running with a lowered scheduling priority during the
last update interval.
|
|
<interrupt/>
|
|
decimal
|
|
<cpu_load/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the percentage, from 0.0 to 100.0, of CPU time spent on serving
interrupts during the last update interval.
|
|
<idle/>
|
|
decimal
|
|
<cpu_load/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the percentage, from 0.0 to 100.0, of CPU time spent doing
nothing during the last update interval.
|
|
<cpu_load_total/>
|
|
node
|
|
<cpus/>
|
|
<system/>,
<user/>,
<nice/>,
<interrupt/>,
<idle/>
|
|
num
|
|
once or multiple
|
|
N/A
|
Contains child elements that show the load distribution on the various CPU
states since the last reboot.
Attribute presence or absence affects meaning!
num attribute exists:
The load distribution on the CPU with the specified number is shown.
num attribute does not exist:
The load distribution of all CPUs in the system is summarized below one
<cpu_load_total/> element (only on platforms where CPU-specific load
distribution cannot be determined.)
|
|
<system/>
|
|
decimal
|
|
<cpu_load_total/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the percentage, from 0.0 to 100.0, of CPU time spent in the
kernel since the last reboot.
|
|
<user/>
|
|
decimal
|
|
<cpu_load_total/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the percentage, from 0.0 to 100.0, of CPU time spent on userland
applications since the last reboot.
|
|
<nice/>
|
|
decimal
|
|
<cpu_load_total/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the percentage, from 0.0 to 100.0, of CPU time spent on userland
applications that are running with a lowered scheduling priority since the
last reboot.
|
|
<interrupt/>
|
|
decimal
|
|
<cpu_load_total/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the percentage, from 0.0 to 100.0, of CPU time spent on serving
interrupts since the last update reboot.
|
|
<idle/>
|
|
decimal
|
|
<cpu_load_total/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the percentage, from 0.0 to 100.0, of CPU time spent doing
nothing since the last reboot.
|
|
<interrupts/>
|
|
node
|
|
<system/>
|
|
<ints_persec/>,
<ints_persec_total/>
|
|
none
|
|
optionally once
|
|
N/A
|
|
Element containing child elements with information about the current number
of interrupts and where they come from.
Not present in "One-Shot Mode", or when reading interrupt statistics is not
(yet) supported on the host platform.
|
|
<ints_persec/>
|
|
decimal
|
|
<interrupts/>
|
|
none
|
|
source
|
|
multiple
|
|
none
|
|
Has the number of interrupts per second during the last update interval,
from a given
source.
|
|
<ints_persec_total/>
|
|
decimal
|
|
<interrupts/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
This element conveniently shows the sum of interrupts per second during the
last update interval.
|
|
<memory/>
|
|
node
|
|
<system/>
|
|
<ram/>,
<swap/>
|
|
none
|
|
optionally once
|
|
N/A
|
|
Element containing child elements with information about RAM and swap space.
Present, if information about virtual memory could be obtained.
|
|
<ram/>
|
|
node
|
|
<memory/>
|
|
<total/>,
<free/>
|
|
none
|
|
once
|
|
N/A
|
|
Element containing child elements with information about RAM usage.
|
|
<total/>
|
|
integer (64-bit, unsigned)
|
|
<ram/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the total amount of RAM, in bytes, managed by the operating system.
This is the result of the number of memory pages multiplied by the
system's page size.
This value may be less than the physical RAM installed in the system.
|
|
<free/>
|
|
integer (64-bit, unsigned)
|
|
<ram/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the amount of RAM available to programs, in bytes.
This is the result of the number of free memory pages multiplied by the
system's page size.
Memory reserved for the kernel, pagedaemon, etc, does not count as "free".
|
|
<swap/>
|
|
node
|
|
<memory/>
|
|
<total/>,
<free/>
|
|
none
|
|
once
|
|
N/A
|
|
Element containing child elements with information about swap space usage.
|
|
<total/>
|
|
integer (64-bit, unsigned)
|
|
<swap/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the total amount of available swap space, in bytes.
|
|
<free/>
|
|
integer (64-bit, unsigned)
|
|
<swap/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the amount of free swap space, in bytes.
|
|
<type/>
|
|
token (medium parseability)
|
|
<os/>
|
|
none
|
|
none
|
|
once
|
|
none
|
Contains the official name of the operating system, i.e. the same output as
running the uname command without parameters.
As such, it usually contains only one of the names of operating
systems supported by XSI.
Clients should be able to handle unexpected OS type tokens.
|
|
<release/>
|
|
token (low parseability)
|
|
<os/>
|
|
none
|
|
none
|
|
once
|
|
none
|
Contains the official release of the operating system, i.e. the same output
as running the uname -r command.
The differences between operating systems, which all follow different
conventions, are large.
In the case of Linux, distribution vendors meddle with it as well.
|
|
<os_status/>
|
|
token (low parseability)
|
|
<os/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Optional element containing the development status token of the operating
system, such as stable, current, etc.
Only available if it both exists and is reasonably easy to obtain from the
system.
May be of use if the client knows about the development process of the
monitored operating system.
|
|
<kernel/>
|
|
token (parseable)
|
|
<os/>
|
|
none
|
|
none
|
|
once
|
|
none
|
Contains the kernel version, normalized to be as compareable between
operating systems as possible.
It has two easily distinguishable formats:
1. [kernel name]#<kernel build no.> <ccyymmddHHMM (kernel build date)>
e.g. GENERIC#123 200612301559
2. [kernel name]#<kernel build no.> p<kernel patch no.> (Solaris)
e.g. Generic#19 p118855
The kernel name is optional, as it may not exist (seen on Linux).
Followed by a # (hash) sign comes the kernel build number, which is an unsigned integer.
Next is a whitespace.
If the second word begins with a number, it is format version 1 and the
second word is the kernel build date (ISO).
If the second word begins with a lower-case p, format version
2 is used (Solaris only) and the following digits are the kernel patch
number.
If the kernel patch number is zero, it does not exist and the
monitored system is OpenSolaris.
|
|
<version_string/>
|
|
normalizedString
|
|
<os/>
|
|
none
|
|
none
|
|
once
|
|
none
|
Contains a verbose version string, which either resembles the output of the
command uname -a or whatever the operating system puts on top
of its /etc/motd file - whichever contains more information.
|
|
<uptime/>
|
|
integer (64-bit, signed, non-negative)
|
|
<os/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
Contains the operating system uptime, in seconds.
The actual width is that of the host system's time_t and may be
64-bit internally.
However, it can be expected that a signed, 32-bit integer is enough to store
this number.
|
|
<load_averages/>
|
|
node
|
|
<os/>
|
|
<avg1min/>,
<avg5min/>,
<avg15min/>
|
|
none
|
|
optionally once
|
|
N/A
|
|
Element containing child elements about the system's load avagers.
Present, if this data could be obtained (which is usually the case on all
supported platforms.)
|
|
<avg1min/>
|
|
decimal
|
|
<load_averages/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains a number describing the system's load average during the last
minute.
How this number is calculated and its exact meaning is operating system
dependent and all in all, it does not carry much weight.
Usually, it increases with the number or processes in the run queue, but is
not related to the actual load put on the system by those processes, and
should therefore be taken with a grain of salt.
|
|
<avg5min/>
|
|
decimal
|
|
<load_averages/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains a number describing the system's load average during the last
five minutes.
How this number is calculated and its exact meaning is operating system
dependent and all in all, it does not carry much weight.
Usually, it increases with the number or processes in the run queue, but is
not related to the actual load put on the system by those processes, and
should therefore be taken with a grain of salt.
|
|
<avg15min/>
|
|
decimal
|
|
<load_averages/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains a number describing the system's load average during the last
fifteen minutes.
How this number is calculated and its exact meaning is operating system
dependent and all in all, it does not carry much weight.
Usually, it increases with the number or processes in the run queue, but is
not related to the actual load put on the system by those processes, and
should therefore be taken with a grain of salt.
|
|
<count/>
|
|
integer (up to 64-bit, unsigned)
|
|
<processes/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of user processes on the system.
|
|
<running/>
|
|
integer (32-bit, unsigned)
|
|
<processes/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of running user processes on the system.
This includes both processes that are in the run queue and those that are
currently being executed on a processor.
|
|
<zombies/>
|
|
integer (32-bit, unsigned)
|
|
<processes/>
|
|
none
|
|
none
|
|
once
|
0
|
|
Contains the number of zombie processes on the system.
|
|
<name/>
|
|
normalizedString
|
|
<top/>
XOR (
<cpu_top/>
OR
<mem_top/>
)
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the name of the process that consumes most of the CPU time, memory,
or both.
|
|
<pid/>
|
|
integer (32-bit, unsigned)
|
|
<top/>
XOR (
<cpu_top/>
OR
<mem_top/>
)
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the PID (process ID number) of the process that consumes most of
the CPU time, memory, or both.
|
|
<euid/>
|
|
integer (32-bit, unsigned)
|
|
<top/>
XOR (
<cpu_top/>
OR
<mem_top/>
)
|
|
none
|
|
username
|
|
once
|
|
none
|
|
Contains the EUID (effective user ID number) of the process that consumes
most of the CPU time, memory, or both.
|
|
<login_user/>
|
|
normalizedString
|
|
<top/>
XOR (
<cpu_top/>
OR
<mem_top/>
)
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
Appears only on *BSD.
Contains the login username of who started the process that consumes most of
the CPU time, memory, or both.
Can be suppressed by the user with the -N command line
parameter, in which case the
<no_names>
flag appears below
<xsi_config/>.
|
|
<cpu_percent/>
|
|
decimal
|
|
<top/>
XOR (
<cpu_top/>
OR
<mem_top/>
)
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the percentage of CPU time used by the process that consumes most
of the CPU time, memory, or both.
|
|
<res_size/>
|
|
integer (64-bit, unsigned)
|
|
<top/>
XOR (
<cpu_top/>
OR
<mem_top/>
)
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the amount of memory, in bytes, used by the process that consumes
most of the CPU time, memory, or both.
|
|
<nice/>
|
|
integer (32-bit)
|
|
<top/>
XOR (
<cpu_top/>
OR
<mem_top/>
)
|
|
none
|
|
none
|
|
once
|
0
|
Contains the nice value (scheduling priority) of the process that
consumes most of the CPU time, memory, or both.
The nice value is an integer number in the range
[-20..20], with -20 being the highest,
0 being the standard and 20 being the lowest
priority.
|
|
<running/>
|
|
flag
|
|
<top/>
XOR (
<cpu_top/>
OR
<mem_top/>
)
|
|
none
|
|
none
|
|
optionally once
|
|
N/A
|
|
Present, if the process, which consumes most of the CPU time, memory, or
both, is currently running.
|
Sensors
|
<sensors/>
|
|
node
|
|
<xmlsysinfo/>
|
|
<count/>,
<sensor/>
|
|
none
|
|
optionally once
|
|
N/A
|
|
Element containing child elements about sensors.
Present only when one or more valid sensors could be found in the system.
|
|
<count/>
|
|
node
|
|
<sensors/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of valid sensors found in the system.
|
|
<sensor/>
|
|
node
|
|
<sensors/>
|
|
<other_type/>,
<status/>,
<sensor_descr/>,
<value_unknown/>,
<value/>,
<other_value/>,
<indicator/>,
<drive_status/>,
<value_age/>
|
|
id,
dev,
type
|
|
multiple
|
|
none
|
Element containing child elements that describe a sensor and, if available,
the value it reports.
Note:
In order to support sensors XMLSysInfo knows nothing about, the
system-dependent code may set the
type
to other, in which case the real sensor type is provided in the
<other_type/>
element.
The sensor value will then be contained in the
<other_value/>
element, with its own
unit
attribute indicating the value's unit.
For more information about the available sensor types, see the description
of the
type
attribute.
The attribute tuple
"id,
dev,
type"
uniquely identifies a sensor on a system.
|
|
<other_type/>
|
|
token (low parseability)
|
|
<sensor/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
Contains the sensor's type, in case it is not part of the sensor types
anticipated by XMLSysInfo and
type
was set to other.
The value is obtained from the operating system, if possible, or otherwise a
meaningful name will be supplied.
|
|
<status/>
|
|
token (parseable, restricted)
|
|
<sensor/>
|
|
none
|
|
none
|
|
optionally once
|
unspecified
|
Contains the sensor's status token, if available.
Values restricted to:
unspecified,
OK,
WARN,
CRITICAL,
unknown
|
|
<sensor_descr/>
|
|
normalizedString
|
|
<sensor/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains a vendor-supplied string describing the sensor, if available.
|
|
<value_unknown/>
|
|
flag
|
|
<sensor/>
|
|
none
|
|
none
|
|
optionally once
|
|
N/A
|
|
Present, if the (valid) sensor's value is currently unknown for some reason.
|
|
<value/>
|
|
decimal
|
|
<sensor/>
|
|
none
|
|
unit
|
|
optionally once
|
|
none
|
Contains the value of a sensor in a given
unit,
if the value is known and the sensor is not of the
type
indicator or drive.
|
|
<value/>
|
|
decimal
|
|
<sensor/>
|
|
none
|
|
unit
|
|
optionally once
|
|
none
|
Contains the value of a sensor in a given
unit,
if the value is known and the sensor is of the
type
other.
It is possible that the value looks like an integer, in case the sensor is
of the kind that shows raw values.
|
|
<indicator/>
|
|
token (parseable, restricted)
|
|
<sensor/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
Contains the value of a sensor of the
type
indicator.
Values restricted to:
ON,
OFF,
invalid
|
|
<drive_status/>
|
|
token (parseable, restricted)
|
|
<sensor/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
Contains the value of a sensor of the
type
drive.
Values restricted to:
empty,
ready,
powering_up,
online,
idle,
active,
rebuilding,
powering_down,
failed,
degraded,
other
|
|
<value_age/>
|
|
decimal
|
|
<sensor/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
Only available on OpenBSD:
Contains the age of the current sensor value, in seconds.
Present only if this information can be obtained directly from the sensor
hardware itself.
|
Storage
|
<storage/>
|
|
node
|
|
<xmlsysinfo/>
|
|
<filesystems/>,
<disks/>,
<raid/>
|
|
none
|
|
optionally once
|
|
N/A
|
|
Element containing child elements about filesystems, disk I/O and RAID.
Present on all supported platforms, which have at least the
<filesystems/> element with information
about the root filesystem.
|
|
<filesystems/>
|
|
node
|
|
<storage/>
|
|
<count/>,
<mount/>
|
|
none
|
|
once
|
|
N/A
|
|
Element containing child elements about mounted filesystems.
At least one mounted filesystem, local or remote, always exists.
|
|
<count/>
|
|
integer (up to 64-bit, unsigned)
|
|
<filesystems/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of mounted filesystems on the system.
|
|
<mount/>
|
|
node
|
|
<filesystems/>
|
|
<size/>,
<nodes/>
|
|
type,
from,
to
|
|
multiple
|
|
none
|
|
Element containing child elements about the space and inodes (i.e. vnodes)
of a mounted filesystem.
Filesystem type and mount information is contained in the attributes of this
element.
|
|
<total/>
|
|
integer (64-bit, unsigned)
|
|
<size/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the total amount of space, in bytes, in the mounted filesystem.
|
|
<size_free/>
|
|
integer (64-bit, unsigned)
|
|
<size/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the amount of free space, in bytes, in the mounted filesystem.
This value includes free space reserved for the superuser.
|
|
<available/>
|
|
integer (64-bit, signed)
|
|
<size/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the amount of space available to users without superuser
privileges, in bytes, in the mounted filesystem.
This value is negative when the superuser filled the filesystem past the
amount of space available to regular users.
|
|
<nodes/>
|
|
node
|
|
<mount/>
|
|
<total/>,
<free/>
|
|
none
|
|
once
|
|
none
|
|
Element containing child elements about the total and free inodes (i.e.
vnodes) on a mounted filesystem.
|
|
<total/>
|
|
integer (64-bit, unsigned)
|
|
<nodes/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the total number of inodes in the mounted filesystem.
|
|
<free/>
|
|
integer (64-bit, unsigned)
|
|
<nodes/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of free inodes in the mounted filesystem.
|
|
<disks/>
|
|
node
|
|
<storage/>
|
|
<count/>,
<disk/>,
<disk_summary/>
|
|
none
|
|
optionally once
|
|
N/A
|
|
Element containing child elements about the I/O load of disk devices, such
as harddisks, CD/DVD drives, etc.
Present only when information about one or more local disk devices could
be found.
|
|
<count/>
|
|
integer (up to 64-bit, unsigned)
|
|
<disks/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of disks found on the system.
|
|
<transfers/>
|
|
node
|
|
<disk/>
|
|
<read_persec/>,
<write_persec/>
|
|
none
|
|
optionally once
|
|
N/A
|
Element containing child elements about transfers per second on a disk
device.
Not present if the device is
idle
and there is nothing to report, or if no transfer counters are available on
the platform.
Note:
The value transfers per second is a relative measurement, which has
a meaning that is defined by the operating system and also the type of disk
device.
|
|
<bytes/>
|
|
node
|
|
<disk/>
|
|
<read_persec/>,
<write_persec/>
|
|
none
|
|
optionally once
|
|
N/A
|
|
Element containing child elements about I/O rates in bytes per second on a
disk device.
Not present if the device is
idle
and there is nothing to report, or if no appropriate byte counters are
available on the platform.
|
|
<disk_summary/>
|
|
node
|
|
<disks/>
|
|
<transfers/>,
<bytes/>
|
|
idle
|
|
once
|
|
N/A
|
|
Element containing child elements about the total I/O load of all disk
devices in the system, unless all disks are currently idle and there is
nothing to report.
|
|
<transfers/>
|
|
node
|
|
<disk_summary/>
|
|
<read_persec/>,
<write_persec/>
|
|
none
|
|
optionally once
|
|
N/A
|
Element containing child elements about transfers per second on all disk
devices.
Not present if all devices are
idle
and there is nothing to report, or if no transfer counters are available on
the platform.
Note:
The value transfers per second is a relative measurement, which has
a meaning that is defined by the operating system and also the type of disk
device.
|
|
<bytes/>
|
|
node
|
|
<disk_summary/>
|
|
<read_persec/>,
<write_persec/>
|
|
none
|
|
optionally once
|
|
N/A
|
|
Element containing child elements about I/O rates in bytes per second on all
disk devices.
Not present if every device is
idle
and there is nothing to report, or if no appropriate byte counters are
available on the platform.
|
|
<read_persec/>
|
|
decimal
|
|
<transfers/>
OR
<transfers/>
|
|
none
|
|
none
|
|
once
|
|
none
|
Contains the number of read transfers, per second, during the last update
interval - on either a specific disk device or all disk devices.
Note:
This element has no default value on its own. Clients may, however,
make the following assumption:
If this element ever occured in the output, a default value of
0.0
is to be assumed.
Until then, no default value must be assumed, because I/O transfer counters
are not available on the platform and their value is unknown.
|
|
<write_persec/>
|
|
decimal
|
|
<transfers/>
OR
<transfers/>
|
|
none
|
|
none
|
|
once
|
|
none
|
Contains the number of write transfers, per second, during the last update
interval - on either a specific disk device or all disk devices.
Note:
This element has no default value on its own. Clients may, however,
make the following assumption:
If this element ever occured in the output, a default value of
0.0
is to be assumed.
Until then, no default value must be assumed, because I/O transfer counters
are not available on the platform and their value is unknown.
|
|
<read_persec/>
|
|
decimal
|
|
<transfers/>
OR
<transfers/>
|
|
none
|
|
none
|
|
once
|
|
none
|
Contains the number of bytes read, per second, during the last update
interval - on either a specific disk device or all disk devices.
Note:
This element has no default value on its own. Clients may, however,
make the following assumption:
If this element ever occured in the output, a default value of
0.0
is to be assumed.
Until then, no default value must be assumed, because I/O byte counters
are not available on the platform and their value is unknown.
|
|
<write_persec/>
|
|
decimal
|
|
<transfers/>
OR
<transfers/>
|
|
none
|
|
none
|
|
once
|
|
none
|
Contains the number of bytes written, per second, during the last update
interval - on either a specific disk device or all disk devices.
Note:
This element has no default value on its own. Clients may, however,
make the following assumption:
If this element ever occured in the output, a default value of
0.0
is to be assumed.
Until then, no default value must be assumed, because I/O byte counters
are not available on the platform and their value is unknown.
|
|
<raid/>
|
|
node
|
|
<storage/>
|
|
<volume/>,
<reserve_disk/>
|
|
controller
|
|
arbitrary
|
|
N/A
|
Only available on systems running OpenBSD with RAID controllers supported
by bio(4).
Element containing child elements with RAID management information about
volumes and disks connected to a certain RAID
controller.
RAID monitoring is a feature that needs to be requested by the user by
specifying the -r device command line parameter one or more
times (when monitoring several controllers), with
device being a
controller
to be monitored.
A disk that is connected to a RAID controller is either part of a volume
(a volume disk) or it is a reserve disk, never both.
|
|
<status/>
|
|
token (parseable, restricted)
|
|
<volume/>
|
|
none
|
|
none
|
|
once
|
|
none
|
Contains the status of a RAID volume or the task it currently performs.
Values restricted to:
online,
offline,
degraded,
building,
scrubbing,
rebuild,
invalid,
unknown
|
|
<size/>
|
|
integer (64-bit, unsigned)
|
|
<volume/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the (available) size of the RAID volume, in bytes.
|
|
<level/>
|
|
token (medium parseability)
|
|
<volume/>
|
|
none
|
|
none
|
|
once
|
|
none
|
Contains a character string stating the RAID level of the volume, e.g.
RAID0, RAID5, etc.
A limited set of tokens may be expected, but clients that try to parse this
value should account for further RAID levels to be invented and, in this
case, to be supported by OpenBSD.
|
|
<progress_percent/>
|
|
integer (32-bit, signed)
|
|
<task/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
Contains a percentage between 0 and 100 percent
about the progress of the current task.
|
|
<elapsed_time/>
|
|
integer (32-bit, signed)
|
|
<task/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the elapsed time, in seconds, since the beginning of the current
task.
|
|
<status/>
|
|
token (parseable, restricted)
|
|
<volume_disk/>
OR
<reserve_disk/>
|
|
none
|
|
none
|
|
once
|
|
none
|
Contains the current status of the disk.
Values restricted to:
online,
offline,
failed,
rebuild,
hot_spare,
unused,
scrubbing,
invalid,
unknown
|
|
<enclosure/>
|
|
token (low parseability)
|
|
<volume_disk/>
OR
<reserve_disk/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
Contains the name of the SCSI enclosure management driver, if applicable,
such as safte0.
A very limited set of possible values can be expected, however, clients
trying to parse this value should account for new driver development in
OpenBSD.
|
|
<vendor/>
|
|
normalizedString
|
|
<volume_disk/>
OR
<reserve_disk/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the vendor-supplied string with the disk's vendor or manufacturer
name, if available.
|
|
<serial_no/>
|
|
token (very low parseability)
|
|
<volume_disk/>
OR
<reserve_disk/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the vendor-supplied string with the disk's serial number, if
available.
This string is normalized by XSI itself, in order to facilitate parsing a
bit.
|
Networking
|
<hostname/>
|
|
token (parseable)
|
|
<networking/>
|
|
none
|
|
none
|
|
once
|
|
none
|
Contains the system's hostname as returned by the gethostname()
function.
Whether the hostname also contains the system's domain or not depends on the
operating system.
|
|
<ip_routes/>
|
|
node
|
|
<networking/>
|
|
<default/>
|
|
none
|
|
optionally once
|
|
N/A
|
|
Element containing child elements with information about the system's
default routes.
Present only if one or more default routes are present.
A system can have multiple default routes, for different address families
and in multipath routing setups.
|
|
<default/>
|
|
token (parseable)
|
|
<ip_routes/>
|
|
none
|
|
family
|
|
multiple
|
|
none
|
|
Contains the IP address of the default route's destination.
|
|
<interfaces/>
|
|
node
|
|
<networking/>
|
|
<count/>,
<interface/>
|
|
none
|
|
arbitrary
|
|
N/A
|
|
Element containing child elements with information about network interfaces.
Present only if one or more interfaces were found.
|
|
<count/>
|
|
integer (up to 64-bit, unsigned)
|
|
<interfaces/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of network interfaces found on the system.
|
|
<interface/>
|
|
node
|
|
<interfaces/>
|
|
<metric/>,
<mtu/>,
<properties/>,
<if_descr/>,
<media/>,
<link_state/>,
<duplex/>,
<carp/>,
<addresses/>,
<statistics/>
|
|
name,
up
|
|
multiple
|
|
N/A
|
|
Element containing child elements with information and statistics about the
interface name.
If the interface is not
up,
then this element is empty.
|
|
<metric/>
|
|
integer (32-bit, signed)
|
|
<interface/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the interface metric, if applicable.
|
|
<mtu/>
|
|
integer (32-bit, signed)
|
|
<interface/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the interface's maximum transmission unit (MTU), if applicable.
|
|
<running/>
|
|
flag
|
|
<properties/>
|
|
none
|
|
none
|
|
optionally once
|
|
N/A
|
|
This flag's presence indicates that the interface is running, meaning that
resources are allocated for it.
|
|
<promiscuous/>
|
|
flag
|
|
<properties/>
|
|
none
|
|
none
|
|
optionally once
|
|
N/A
|
|
This flag's presence indicates that the interface is in promiscuous mode,
meaning that it gets and processes all data, whether it is addressed to it
or not.
|
|
<loopback/>
|
|
flag
|
|
<properties/>
|
|
none
|
|
none
|
|
optionally once
|
|
N/A
|
|
This flag's presence indicates that the interface is a loopback device.
|
|
<point-to-point/>
|
|
flag
|
|
<properties/>
|
|
none
|
|
dest_addr
|
|
optionally once
|
|
N/A
|
|
This flag's presence indicates that the interface is a point-to-point
device, with the peer's address contained in the
dest_addr
attribute.
|
|
<if_descr/>
|
|
normalizedString
|
|
<interface/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
Only available on OpenBSD:
Contains the optional, user-supplied interface description string that was
set with ifconfig(8).
|
|
<media/>
|
|
token (low parseability)
|
|
<interface/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the network interface media string, if available.
It follows no conventions and is operating system dependent, however,
clients may try to look for and parse a few keywords, such as
Ethernet, full-duplex, etc.
|
|
<link_state/>
|
|
token (parseable, restricted)
|
|
<interface/>
|
|
none
|
|
none
|
|
optionally once
|
unknown
|
Contains the link state of the network interface, if available.
Values restricted to:
up,
down,
unknown
|
|
<duplex/>
|
|
token (parseable, restricted)
|
|
<interface/>
|
|
none
|
|
none
|
|
optionally once
|
unknown
|
Contains the network interface's link duplex status, if available.
Values restricted to:
full,
half,
unknown
|
|
<carp/>
|
|
token (parseable, restricted)
|
|
<interface/>
|
|
none
|
|
carpdev,
vhid,
advskew,
advbase,
preempt,
arpbalance
|
|
optionally once
|
|
none
|
Contains the Common Address Redundancy Protocol (CARP) status of the network
interface.
If this element is not present, the interface is not using CARP.
Values restricted to:
INIT,
MASTER,
BACKUP,
unknown
|
|
<addresses/>
|
|
node
|
|
<interface/>
|
|
<ll_addr/>,
<net_addr/>
|
|
none
|
|
optionally once
|
|
N/A
|
|
Element containing child elements about addresses associated with the
network interface.
Present only if one or more addresses were found.
|
|
<ll_addr/>
|
|
token (parseable)
|
|
<addresses/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the link-local (MAC) address of the interface, if applicable.
The format is six groups of two hexadecimal digits, separated by colons.
|
|
<net_addr/>
|
|
token (high parseability)
|
|
<addresses/>
|
|
none
|
|
family,
prefixlen
|
|
arbitrary
|
|
none
|
|
Contains a network address of the interface.
Parseability depends on the address
family.
Unless it is an IPv4 or IPv6 address (the most common case), the content
should be considered purely informational.
|
|
<in/>
|
|
integer (64-bit, unsigned)
|
|
<packets/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the total number of incoming packets.
|
|
<in_persec/>
|
|
decimal
|
|
<packets/>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of incoming packets, per second, during the last
update interval.
Not present in "One-Shot Mode" or if there was no incoming traffic during
the last update interval.
|
|
<out/>
|
|
integer (64-bit, unsigned)
|
|
<packets/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the total number of outgoing packets.
|
|
<out_persec/>
|
|
decimal
|
|
<packets/>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of outgoing packets, per second, during the last
update interval.
Not present in "One-Shot Mode" or if there was no outgoing traffic during
the last update interval.
|
|
<dropped/>
|
|
integer (64-bit, unsigned)
|
|
<packets/>
|
|
none
|
|
none
|
|
optionally once
|
0
|
|
Contains the total number of dropped packets.
Not present if there were no dropped packets.
|
|
<dropped_persec/>
|
|
decimal
|
|
<packets/>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of dropped packets, per second, during the last
update interval.
Not present in "One-Shot Mode" or if there were no dropped packets during
the last update interval.
|
|
<in/>
|
|
integer (64-bit, unsigned)
|
|
<bytes/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the total number of incoming bytes.
|
|
<in_persec/>
|
|
decimal
|
|
<bytes/>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of incoming bytes, per second, during the last
update interval.
Not present in "One-Shot Mode" or if there was no incoming traffic during
the last update interval.
|
|
<out/>
|
|
integer (64-bit, unsigned)
|
|
<bytes/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the total number of outgoing bytes.
|
|
<out_persec/>
|
|
decimal
|
|
<bytes/>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of outgoing bytes, per second, during the last
update interval.
Not present in "One-Shot Mode" or if there was no outgoing traffic during
the last update interval.
|
|
<errors_in/>
|
|
integer (64-bit, unsigned)
|
|
<statistics/>
|
|
none
|
|
none
|
|
optionally once
|
0
|
|
Contains the total number of errors (inbound) on the interface.
Not present if there were no errors of this kind.
|
|
<errors_in_persec/>
|
|
decimal
|
|
<statistics/>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of errors (inbound), per second, during the last
update interval.
Not present in "One-Shot Mode" or if there were no inbound errors during the
last update interval.
|
|
<errors_out/>
|
|
integer (64-bit, unsigned)
|
|
<statistics/>
|
|
none
|
|
none
|
|
optionally once
|
0
|
|
Contains the total number of errors (outbound) on the interface.
Not present if there were no errors of this kind.
|
|
<errors_out_persec/>
|
|
decimal
|
|
<statistics/>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of errors (outbound), per second, during the last
update interval.
Not present in "One-Shot Mode" or if there were no outbound errors during the
last update interval.
|
|
<collisions/>
|
|
integer (64-bit, unsigned)
|
|
<statistics/>
|
|
none
|
|
none
|
|
optionally once
|
0
|
|
Contains the total number of collisions on the interface.
Not present if there were no collisions.
|
|
<collisions_persec/>
|
|
decimal
|
|
<statistics/>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of collisions, per second, during the last update
interval.
Not present in "One-Shot Mode" or if there were no collisions during the
last update interval.
|
|
<packet_filter/>
|
|
node
|
|
<networking/>
|
|
<runtime/>,
<rule_matches/>,
<rule_matches_avg/>,
<rules_matches_persec/>,
<states/>,
<filter_summary/>
XOR
<filtered_if/>
|
|
type,
enabled
|
|
arbitrary
|
|
N/A
|
Element containing child elements with information and statistics from a
packet filter of a certain
type.
Present, if the user requested packet filter statistics to be included in
the output by supplying the -F command line parameter.
Note:
Not all supported packet filters provide the same amount, or kind of
comprehensive counters.
Therefore, the XML tree below this element has rather large layout
variations:
pf: Detailed counters are
available, with different
<filtered_if/>
elements providing address family specific statistics for packets and
bytes.
Note that older pf versions may not have these counters, yet.
ipfilter: One single
<filter_summary/>
element provides address family agnostic statistics for packets.
netfilter: Not implemented, yet.
|
|
<runtime/>
|
|
integer (up to 64-bit, signed)
|
|
<packet_filter/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the time, in seconds, since when the packet filter was activated.
|
|
<rule_matches/>
|
|
integer (64-bit, unsigned)
|
|
<packet_filter/>
|
|
none
|
|
none
|
|
optionally once
|
0
|
|
Contains the total number of filter rule matches.
A rule match is when the ruleset is traversed for a packet that did not
match any existing state, and for which a matching rule was found.
|
|
<rule_matches_avg/>
|
|
decimal
|
|
<packet_filter/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the average number of rule matches, per second, during the runtime
of the packet filter.
A rule match is when the ruleset is traversed for a packet that did not
match any existing state, and for which a matching rule was found.
|
|
<rule_matches_persec/>
|
|
decimal
|
|
<packet_filter/>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of rule matches, per second, during the last update
interval.
Never present in "One-Shot Mode" output.
A rule match is when the ruleset is traversed for a packet that did not
match any existing state, and for which a matching rule was found.
|
|
<states/>
|
|
node
|
|
<packet_filter/>
|
|
<count/>,
<limit/>,
<searches/>,
<searches_avg/>,
<searches_persec/>,
<inserts/>,
<inserts_avg/>,
<inserts_persec/>,
<removals/>,
<removals_avg/>,
<removals_persec/>,
<mismatches/>,
<mismatches_avg/>,
<mismatches_persec/>
|
|
none
|
|
optionally once
|
|
none
|
|
Element containing child elements with information about states kept for
connections.
Only present if
<count/>
or
<searches/>
were ever set higher than zero, i.e. if stateful filtering could be
detected.
|
|
<count/>
|
|
integer (up to 64-bit, unsigned)
|
|
<states/>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of connection states kept by the packet filter.
|
|
<limit/>
|
|
integer (64-bit, signed)
|
|
<states/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the limit that is currently set on the number of states.
It may be assumed that if this element is not present, no state limit is
being imposed by the packet filter.
|
|
<searches/>
|
|
integer (64-bit, unsigned)
|
|
<states/>
|
|
none
|
|
none
|
|
optionally once
|
0
|
|
Contains the total number of state searches.
A state search is when an attempt is made to match a packet with a state
in the packet filter's state table.
|
|
<searches_avg/>
|
|
decimal
|
|
<states/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the average number of state searches, per second, during the
runtime of the packet filter.
A state search is when an attempt is made to match a packet with a state
in the packet filter's state table.
|
|
<searches_persec/>
|
|
decimal
|
|
<states/>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of state searches, per second, during the last update
interval.
Never present in "One-Shot Mode" output.
A state search is when an attempt is made to match a packet with a state
in the packet filter's state table.
|
|
<inserts/>
|
|
integer (64-bit, unsigned)
|
|
<states/>
|
|
none
|
|
none
|
|
optionally once
|
0
|
|
Contains the total number of state inserts.
A state insert is when a packet, e.g. from a new connection, create a new
entry in the state table.
|
|
<inserts_avg/>
|
|
decimal
|
|
<states/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the average number of state inserts, per second, during the
runtime of the packet filter.
A state insert is when a packet, e.g. from a new connection, create a new
entry in the state table.
|
|
<inserts_persec/>
|
|
decimal
|
|
<states/>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of state inserts, per second, during the last update
interval.
Never present in "One-Shot Mode" output.
A state insert is when a packet, e.g. from a new connection, create a new
entry in the state table.
|
|
<removals/>
|
|
integer (64-bit, unsigned)
|
|
<states/>
|
|
none
|
|
none
|
|
optionally once
|
0
|
|
Contains the total number of state removals.
|
|
<removals_avg/>
|
|
decimal
|
|
<states/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the average number of state removals, per second, during the
runtime of the packet filter.
|
|
<removals_persec/>
|
|
decimal
|
|
<states/>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of state removals, per second, during the last update
interval.
Never present in "One-Shot Mode" output.
|
|
<mismatches/>
|
|
integer (64-bit, unsigned)
|
|
<states/>
|
|
none
|
|
none
|
|
optionally once
|
0
|
|
Contains the total number of state mismatches.
A state mismatch is when a packet neither matches a state nor creates a new
one.
|
|
<mismatches_avg/>
|
|
decimal
|
|
<states/>
|
|
none
|
|
none
|
|
optionally once
|
|
none
|
|
Contains the average number of state mismatches, per second, during the
runtime of the packet filter.
A state mismatch is when a packet neither matches a state nor creates a new
one.
|
|
<mismatches_persec/>
|
|
decimal
|
|
<states/>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of state mismatches, per second, during the last update
interval.
Never present in "One-Shot Mode" output.
A state mismatch is when a packet neither matches a state nor creates a new
one.
|
|
<ip/>
|
|
node
|
|
<filtered_if/>
|
|
<packets/>,
<bytes/>
|
|
none
|
|
optionally once
|
|
N/A
|
|
Element containing child elements with filter statistics about all filtered
IP traffic on a specific interface.
|
|
<ipv4/>
|
|
node
|
|
<filtered_if/>
|
|
<packets/>,
<bytes/>
|
|
none
|
|
optionally once
|
|
N/A
|
|
Element containing child elements with filter statistics about all filtered
IPv4 traffic on a specific interface.
|
|
<ipv6/>
|
|
node
|
|
<filtered_if/>
|
|
<packets/>,
<bytes/>
|
|
none
|
|
optionally once
|
|
N/A
|
|
Element containing child elements with filter statistics about all filtered
IPv6 traffic on a specific interface.
|
|
<in_blocked/>
|
|
integer (64-bit, unsigned)
|
|
<packets>
XOR
<packets>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of incoming packets that were blocked.
|
|
<in_blocked_persec/>
|
|
decimal
|
|
<packets>
XOR
<packets>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of incoming packets that were blocked, per second,
during the last update interval.
|
|
<in_passed/>
|
|
integer (64-bit, unsigned)
|
|
<packets>
XOR
<packets>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of incoming packets that were passed.
|
|
<in_passed_persec/>
|
|
decimal
|
|
<packets>
XOR
<packets>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of incoming packets that were passed, per second,
during the last update interval.
|
|
<out_blocked/>
|
|
integer (64-bit, unsigned)
|
|
<packets>
XOR
<packets>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of outgoing packets that were blocked.
|
|
<out_blocked_persec/>
|
|
decimal
|
|
<packets>
XOR
<packets>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of outgoing packets that were blocked, per second,
during the last update interval.
|
|
<out_passed/>
|
|
integer (64-bit, unsigned)
|
|
<packets>
XOR
<packets>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of outgoing packets that were passed.
|
|
<out_passed_persec/>
|
|
decimal
|
|
<packets>
XOR
<packets>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of outgoing packets that were passed, per second,
during the last update interval.
|
|
<in_blocked/>
|
|
integer (64-bit, unsigned)
|
|
<bytes>
XOR
<bytes>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of incoming bytes that were blocked.
|
|
<in_blocked_persec/>
|
|
decimal
|
|
<bytes>
XOR
<bytes>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of incoming bytes that were blocked, per second,
during the last update interval.
|
|
<in_passed/>
|
|
integer (64-bit, unsigned)
|
|
<bytes>
XOR
<bytes>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of incoming bytes that were passed.
|
|
<in_passed_persec/>
|
|
decimal
|
|
<bytes>
XOR
<bytes>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of incoming bytes that were passed, per second,
during the last update interval.
|
|
<out_blocked/>
|
|
integer (64-bit, unsigned)
|
|
<bytes>
XOR
<bytes>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of outgoing bytes that were blocked.
|
|
<out_blocked_persec/>
|
|
decimal
|
|
<bytes>
XOR
<bytes>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of outgoing bytes that were blocked, per second,
during the last update interval.
|
|
<out_passed/>
|
|
integer (64-bit, unsigned)
|
|
<bytes>
XOR
<bytes>
|
|
none
|
|
none
|
|
once
|
|
none
|
|
Contains the number of outgoing bytes that were passed.
|
|
<out_passed_persec/>
|
|
decimal
|
|
<bytes>
XOR
<bytes>
|
|
none
|
|
none
|
|
optionally once
|
0.0
|
|
Contains the number of outgoing bytes that were passed, per second,
during the last update interval.
|
Attributes
|
schema_version
|
|
token (parseable)
|
|
<xsi_config/>
|
|
mandatory
|
|
none
|
Contains the version number of the XML Schema that defines and validates
the output.
The version number of is loosely tied to the XMLSysInfo version and has the
format <major>.<minor>[-<alpha|beta>].
It follows the following versioning convention:
major:
XML Schemas with different major version numbers are incompatible with each
other.
minor:
A schema of a higher minor version number validates the output of earlier
XMLSysInfo versions that produce output according to a lower minor, but the
same major version number.
That is, the Schema is backwards compatible.
Clients that receive output from XMLSysInfo that uses a schema with a higher
minor number can handle the output by ignoring unknown elements.
Optional -alpha or -beta suffix:
Denotes whether the Schema is currently in a special development phase.
-alpha means that it may change, while approaching the respective
major.minor version.
-beta is the next step, where the Schema is frozen and only
important bug fixes are permitted.
Examples:
1.0-alpha - Anything in the XML Schema is subject to change
while work is being done for an XMLSysInfo 1 release.
1.1-beta - Only important bug fixes to the new
additions between the 1.0 and upcoming 1.1 releases are permitted (the
Schema is "frozen".)
No major version bump means that old contents remain unchangeable.
2.0 - The Schema is version 2.0 and will never change in any
way without a version bump.
|
|
xsi_version
|
|
token (parseable)
|
|
<xsi_config/>
|
|
mandatory
|
|
none
|
Contains the XMLSysInfo version number that generated the output.
This number is tied to the
XML Schema version
and has the format
<major>.<minor><.|-<alpha|beta>><micro>.
It follows the following versioning convention:
major:
The major version number is always identical to the supported XML
Schema version.
minor:
The minor version number is always identical to the supported XML
Schema version.
-alpha, -beta or .:
Denotes the development status, alpha (anything goes),
beta (bug fixes and cleanups) and release/stable
(maintenance, fixes), respectively.
It is also in sync with the status of the XML Schema.
micro:
Version number independent of the XML Schema, for XMLSysInfo itself only.
Used to distinguish different alpha, beta and release/stable releases.
|
|
num
|
|
integer (32-bit, signed)
|
|
<cpu_load/>,
<cpu_load_total/>
|
|
optional
|
|
none
|
Contains the CPU number, starting at 0, of the CPU that the
element applies to.
If this attribute is not present, only one of the CPU load elements is
present and not CPU-specific, showing the load distribution of all CPUs in
the system.
|
|
source
|
|
normalizedString
|
|
<ints_persec/>
|
|
mandatory
|
|
none
|
|
Contains the name of the interrupt source.
Unfortunately, this name is very operating system dependent and has little
to no value for a parser.
|
|
username
|
|
normalizedString
|
|
<euid/>
|
|
optional
|
|
none
|
Contains the username that goes with the EUID.
Can be suppressed by the user with the -N command line
parameter, in which case the
<no_names>
flag appears below
<xsi_config/>.
If neither a username nor the no_names-flag are present, two possible this
happened:
1. XMLSysInfo is running inside a chroot() jail and has no access
to the system's user database.
See the README file about how to fix this.
2. The process runs with an EUID that has no corresponding user in the user
database.
|
|
id
|
|
integer (32-bit, signed)
|
|
<sensor/>
|
|
mandatory
|
|
none
|
|
Contains the ID number of the sensor.
If this number does not come from the operating itself, XSI will generate
one.
Together with the
dev
and
type
attributes, it uniquely identifies a sensor in the output and the system.
|
|
dev
|
|
token (very low parseability)
|
|
<sensor/>
|
|
mandatory
|
|
none
|
Contains the name of the device the sensor is attached to.
This name is very operating system dependent.
If the operating system does not allow a sensor<->device association,
XSI uses the interface name where it received the data.
For example, acpi on FreeBSD and picl on Solaris.
Together with the
id
and
type
attributes, it uniquely identifies a sensor in the output and the system.
|
|
type
|
|
token (parseable, restricted)
|
|
<sensor/>
|
|
mandatory
|
|
none
|
Contains the sensor type name.
Together with the
id
and
dev
attributes, it uniquely identifies a sensor in the output and the system.
Values restricted to:
other,
temperature,
fan_speed,
voltage_dc,
voltage_ac,
resistance,
power,
current,
energy,
charge,
illuminance,
percentage,
indicator,
generic,
timedelta,
drive
|
|
unit
|
|
token (parseable, restricted)
|
|
<value/>
|
|
optional
|
|
none
|
Contains the unit name of the sensor value, if applicable.
Sensors of the types indicator, drive and
other are special in that their values do not show up in the
<value/>
element, and a generic sensor just has a raw integer value
without a unit.
Values restricted to:
C,
rpm,
V,
Ohm,
W,
A,
Wh,
Ah,
percent,
lx,
ms
|
|
unit
|
|
token (low parseability)
|
|
<other_value/>
|
|
optional
|
|
none
|
Contains the unit name of the sensor value, if applicable, and belongs to
a sensor of the
type
other.
|
|
type
|
|
token (low parseability)
|
|
<mount/>
|
|
mandatory
|
|
none
|
Contains the filesystem type name, in its abbreviated form as it is used by
the operating system.
For example: ffs, nfs.
|
|
from
|
|
token (very low parseability)
|
|
<mount/>
|
|
mandatory
|
|
none
|
|
Contains the device name, symbolic name or URI from which the filesystem was
mounted.
|
|
to
|
|
token (parseable)
|
|
<mount/>
|
|
mandatory
|
|
none
|
|
Contains the UNIX path name where the filesystem was mounted to.
|
|
name
|
|
token (low parseability)
|
|
<disk/>
|
|
mandatory
|
|
none
|
|
Contains the symbolic name of the disk device.
|
|
idle
|
|
boolean
|
|
<disk/>
|
|
optional
|
false
|
|
Indicates whether the disk device is currently idle or not.
|
|
idle
|
|
boolean
|
|
<disk_summary/>
|
|
optional
|
false
|
|
Indicates whether all disk devices are currently idle or not.
|
|
controller
|
|
token (low parseability)
|
|
<raid/>
|
|
mandatory
|
|
none
|
|
Contains the name of the RAID controller device.
|
|
dev
|
|
token (low parseability)
|
|
<volume/>
|
|
mandatory
|
|
none
|
|
Contains the RAID volume's device name in the system.
|
|
id
|
|
integer (32-bit, signed)
|
|
<volume/>
|
|
mandatory
|
|
none
|
|
Contains the RAID volume's ID number.
|
|
family
|
|
token (parseable, restricted)
|
|
<default/>
|
|
mandatory
|
|
none
|
Contains the address family of the default route.
Values restricted to:
IPv4,
IPv6
|
|
name
|
|
token (low parseability)
|
|
<interface/>
|
|
mandatory
|
|
none
|
|
Contains the device name of the network interface.
|
|
up
|
|
boolean
|
|
<interface/>
|
|
optional
|
true
|
|
Indicates whether the network interface is "up" or "down".
|
|
dest_addr
|
|
token (parseable)
|
|
<point-to-point/>
|
|
mandatory
|
|
none
|
|
Contains the IP address of the point-to-point peer.
|
|
carpdev
|
|
token (high parseability)
|
|
<carp/>
|
|
optional
|
|
none
|
|
Contains the name of the virtual CARP network device.
|
|
vhid
|
|
integer (32-bit, signed)
|
|
<carp/>
|
|
mandatory
|
|
none
|
|
Contains the CARP virtual host ID (VHID.)
|
|
advskew
|
|
integer (32-bit, signed)
|
|
<carp/>
|
|
mandatory
|
|
none
|
|
Contains the CARP advertisement skew value.
|
|
advbase
|
|
integer (32-bit, signed)
|
|
<carp/>
|
|
mandatory
|
|
none
|
|
Contains the base CARP advertisement interval, in seconds.
|
|
preempt
|
|
boolean
|
|
<carp/>
|
|
optional
|
|
none
|
|
Indicates whether virtual hosts preempt each other, and whether CARP
interfaces are failing over as a group.
Only present if this feature is available.
|
|
arpbalance
|
|
boolean
|
|
<carp/>
|
|
optional
|
|
none
|
|
Indicates whether ARP-based load balancing is enabled or not.
Only present if this feature is available.
|
|
family
|
|
token (parseable, restricted)
|
|
<net_addr/>
|
|
mandatory
|
|
none
|
Contains the address family of the network address.
Values restricted to:
unspecified,
IPv4,
IPv6,
other,
unknown
|
|
prefixlen
|
|
integer (32-bit, signed)
|
|
<net_addr/>
|
|
optional
|
|
none
|
|
Contains the prefix length of the network address, if applicable.
|
|
has_traffic
|
|
boolean
|
|
<statistics/>
|
|
optional
|
true
|
|
Indicates whether traffic occurred on the interface or not.
|
|
type
|
|
token (parseable, restricted)
|
|
<packet_filter/>
|
|
mandatory
|
|
none
|
Contains the name (i.e. type) of the packet filter.
Values restricted to:
pf,
ipfilter,
netfilter
|
|
enabled
|
|
boolean
|
|
<packet_filter/>
|
|
optional
|
true
|
|
Indicates whether the packet filter is enabled or not.
|
|
has_traffic
|
|
boolean
|
|
<filter_summary/>
|
|
optional
|
true
|
|
Indicates whether the packet filter filtered any traffic at all or not.
|
|
name
|
|
token (low parseability)
|
|
<filtered_if/>
|
|
mandatory
|
|
none
|
|
Contains the name of the interface the element applies to.
|
|
has_traffic
|
|
boolean
|
|
<filtered_if/>
|
|
optional
|
true
|
|
Indicates whether the packet filter filtered any traffic on this interface
or not.
|