R&S® HUMS
Health & Utilization
Monitoring Service
User Manual
(;ÝS?2)
1179351502
Version 03
This document describes the R&S® optional health and utilization monitoring service application available
for selected instruments from the following product groups:
●
Rohde & Schwarz spectrum analyzers
●
Rohde & Schwarz network analyzers
●
Rohde & Schwarz signal generators
●
Rohde & Schwarz radio communication testers
All supported instruments are listed in a separate chapter of this manual.
© 2022 Rohde & Schwarz GmbH & Co. KG
Muehldorfstr. 15, 81671 Muenchen, Germany
Phone: +49 89 41 29 - 0
Email: info@rohde-schwarz.com
Internet: www.rohde-schwarz.com
Subject to change – data without tolerance limits is not binding.
R&S® is a registered trademark of Rohde & Schwarz GmbH & Co. KG.
Trade names are trademarks of the owners.
1179.3515.02 | Version 03 | R&S® HUMS
Throughout this manual, products from Rohde & Schwarz are indicated without the ® symbol, e.g. R&S ® HUMS is indicated as
R&S HUMS.
R&S® HUMS
Contents
Contents
1 Welcome to R&S HUMS.........................................................................5
2 Documentation overview.......................................................................6
3 Preparation............................................................................................. 7
3.1 Requirements................................................................................................................ 7
3.2 Installation..................................................................................................................... 7
4 Operation................................................................................................ 8
4.1 Access via web interface..............................................................................................8
4.2 Access via SNMP.......................................................................................................... 9
4.3 Access via REST (HTTP)............................................................................................ 11
4.4 Access via SCPI commands...................................................................................... 11
5 General monitoring parameters..........................................................13
5.1 Table functions............................................................................................................ 13
5.2 Device information......................................................................................................13
5.3 Device tags.................................................................................................................. 14
5.4 Equipment....................................................................................................................15
5.5 Event history............................................................................................................... 17
5.6 Status........................................................................................................................... 18
5.7 Service......................................................................................................................... 20
5.8 Security........................................................................................................................ 21
5.9 Storage.........................................................................................................................21
5.10 Utilizations................................................................................................................... 22
5.10.1 Utilizations overall......................................................................................................... 22
5.10.2 Utilizations history......................................................................................................... 23
5.10.3 Utilizations general........................................................................................................24
5.10.4 Custom utilizations........................................................................................................ 26
5.10.5 Utilizations SCPI........................................................................................................... 27
6 Instrument specific monitoring parameters...................................... 28
7 Remote control.....................................................................................30
7.1 System information commands.................................................................................30
3User Manual 1179.3515.02 ─ 03
R&S® HUMS
Contents
7.2 Device tags commands.............................................................................................. 41
7.3 Utilization commands................................................................................................. 42
7.4 Custom utilizations commands................................................................................. 47
7.5 Service data commands............................................................................................. 49
8 Supported products.............................................................................52
9 Overview of status messages.............................................................53
10 Overview of utilizations.......................................................................54
List of commands................................................................................ 57
4User Manual 1179.3515.02 ─ 03
R&S® HUMS
Welcome to R&S HUMS
1 Welcome to R&S HUMS
In this day and age of internet of things, more and more devices are connected to the
local network, making it even more difficult for the IT department to monitor them.
Rohde & Schwarz instruments are also increasingly accessed via their LAN interface,
which provides additional convenience features such as remote desktop, SMB file
transfer or a web interface. To make it easier to monitor the use and status of instruments, some devices offer a software option, the Health and Utilization Monitoring Service (HUMS).
The R&S Health and Utilization Monitoring Service (HUMS) which is available for several R&S products is a software option providing information about a certain instrument
such as use and status. Aim is to increase the overall utilization, to avoid downtime
and to increase the overall security level of a fleet of instruments.
R&S HUMS provides, for example, information about:
●
Instrument identification, hardware components, software packages, licenses
●
Usage of remote control, usage via keyboard / mouse, usage of test applications
●
Hardware utilization and status, including S.M.A.R.T. data of the system drive
●
User-defined static information, for example, an inventory code.
The R&S HUMS software runs as a service in the background on the instrument. It
communicates with the instrument's operating system and firmware. For control,
R&S HUMS can be accessed via different interfaces within the LAN such as web interface, REST, SNMP or SCPI. R&S HUMS opens the corresponding interface depending
on your selection to read the monitoring and utilization data.
This user manual describes how to access and use R&S HUMS.
5User Manual 1179.3515.02 ─ 03
R&S® HUMS
Documentation overview
2 Documentation overview
This section provides an overview of the R&S HUMS user documentation. The documents are available online on the internet or on Gloris.
HUMS user manual
Contains information about the features of the health utilization and monitoring service
(HUMS). This includes features available for all products that support HUMS as well as
features that are available for certain products only.
The user manual is available for download or immediate display on the internet.
HUMS application note
Contains information about the SNMP and REST API, including a list of all SNMP variables and REST endpoints.
The HUMS application note is available on the internet.
Product user manuals
Contain information about HUMS featuers integrated into the product's firmware or
software.
Product user manuals are available on the internet or Gloris, depending on the product.
6User Manual 1179.3515.02 ─ 03
R&S® HUMS
3.1 Requirements
Preparation
3 Preparation
R&S HUMS can be accessed via different interfaces such as web interface, SNMP,
REST or via SCPI commands. Using the web interface requires a browser to be installed on your PC.
Use one of the following web browsers:
●
Microsoft Edge (from version 79)
●
Google Chrome (from version 63)
●
Mozilla Firefox (from version 66)
●
Opera (from version 64).
SNMP-specific requirements:
To read out the data, a third party monitoring software running in the background is
required. You can download one of the following software (recommendation):
●
Open Source:
– Net-SNMP
– Icinga 2
– Nagios Core
– Pandora FMS
●
Purchasable:
– SolarWinds Network Performance Monitor
– ManageEngine OpManager
– Paessler PRTG Network Monitor
Installation
3.2 Installation
R&S HUMS is already part of the firmware. Separate installation is not required.
7User Manual 1179.3515.02 ─ 03
R&S® HUMS
4.1 Access via web interface
Access via web interface
4 Operation
R&S HUMS supports various application programming interfaces (APIs) from which
device information can be retrieved such as identification, BIOS, date, time, system,
health and utilization data and software information.
You can access R&S HUMS via the following interfaces and protocols such as:
●
Web interface
●
SNMP
●
REST (HTTP)
●
SCPI.
Operation
1. Open your internet browser.
For supported browsers, see Chapter 3, "Preparation", on page 7.
2. Enter the IP address or device name of your instrument.
For information about the IP address or device name, see settings of your instrument.
The "Device Web" interface opens.
3. Select "Health and Utilization Monitoring" from the menu.
The web interface of R&S HUMS opens.
Graphical user interface (GUI)
The following figure gives an overview of the graphical user interface of R&S HUMS.
Depending on your instrument, you can also access the R&S HUMS web interface
locally. For more information, see the main user manual of your instrument.
8User Manual 1179.3515.02 ─ 03
R&S® HUMS
Operation
Access via SNMP
1
2
3 4
1 = Menu including categories of the usage data (expanded)
2 = Subcategories
3 = Details of selected usage data
4 = Display mode
4.2 Access via SNMP
SNMP (Simple Network Management Protocol) is a protocol which provides its users a
set of operations that allows many instruments to be managed remotely.
SNMP queries and manipulates data in the form of variables arranged in a tree structure. Each variable has an address that describes where it is located in the tree.This
address is called object identifier (OID). An OID is described with a sequence of numbers separated by a dot, e.g. "1.3.6.1.4.1.2566.125.2.1.2.6.2.1". The length of the row
represents how deep you are in the tree and each number represents the index in the
respective node.
An OID has a similar format to an IP address. As with IP addresses, there is a name
resolution. This is not done by a DNS (= Domain Name System) but by a so-called
Management Information Base (MIB). In this case, the necessary R&S HUMS name
resolutions in the form of MIB files are provided by the device and can be loaded as an
archive.
9User Manual 1179.3515.02 ─ 03
R&S® HUMS
Operation
Access via SNMP
Before accessing R&S HUMS via SNMP interface, check the SNMP-specific requirements Chapter 3, "Preparation", on page 7.
Downloading SNMP MIB files
1. Open your internet browser.
For supported browsers, see Chapter 3, "Preparation", on page 7.
2. Enter the R&S HUMS specific address
http://<DEVICE-ADDRESS>/api/hums/v1/documents?name=snmp
to load the MIB files.
Replace the <DEVICE-ADDRESS> part with the IP address or device name of
your instrument.
For information about the device name, check the settings of your instrument.
3. Press "Enter".
The MIB files are automatically downloaded onto your device.
4. Now you can import the downloaded MIB files (ZIP file) into the third-party monitoring software you installed before.
Depending on your software, it displays the tree structure and the OIDs or nodes.
5. You can start to query and evaluate specific data points.
Example (manual query):
Here is an example to query data manually. In this case, the tool snmpwalk is used.
1. Open a command line.
2. Enter the R&S HUMS specific command
-c <SNMP_COMMUNITY> -m +<MIB> <DEVICE-ADDRESS> <OID>
including the MIB and OID you want to retrieve data from.
Replace the <SNMP_COMMUNITY> part with the appropriate SNMP community and
the <DEVICE-ADDRESS> part with the IP address or device name of your instrument.
Replace the MIB and OID with the appropriate nodes. For all available SNMP-specific MIBs and OIDs, see Application Note Instrument Health & Utilization Monitor-
ing.
Example command line:
snmpwalk -v2c -c public 192.168.0.1 .1.3.6.1.4.1.2566.125.2
-v2c = SNMPv2
public = SNMPv2 community
192.168.0.1 = Device address
.1.3.6.1.4.1.2566.125.1 = numeric OID
3. Press "Enter".
The requested data is returned.
10User Manual 1179.3515.02 ─ 03
R&S® HUMS
4.3 Access via REST (HTTP)
Operation
Access via SCPI commands
Representational State Transfer (REST) is a convention on how to design an HTTP
interface that accesses resources. In this case, a REST interface can be used as an
alternative to SNMP to read or write variable data.
How to get REST API specification
1. Open your internet browser.
For supported browsers, see Chapter 3, "Preparation", on page 7.
2. Enter the R&S HUMS specific address
http://<DEVICE-ADDRESS>/api/hums/v1/documents?name=rest.
Replace the <DEVICE-ADDRESS> part with the IP address or device name of
your instrument.
For information about the IP address or device name, check the settings of your
instrument.
3. Press "Enter".
The API specifications open.
4. Now you can start to query and evaluate specific data points.
For a more visual presentation of the retrieved data, alternatively you can use REST
API tools such as Postman or Swagger editor.
Depending on your tool, enter the following command including the specific REST
node, e.g. http://<DEVICE-ADDRESS>/api/hums/v1/<RESTNODE>.
4.4 Access via SCPI commands
If performance is an issue, we recommend using SNMP or REST instead of SCPI.
Using SCPI for HUMS analysis can slow down the instrument performance, because it
communicates with the firmware. SNMP or REST communicate directly with the HUMS
service and therefore have no effect on the firmware itself.
Standard Commands for Programmable Instruments (SCPI) is an instruction set to
control instruments and another method to access R&S HUMS. Commands are program messages that a controller (e.g. a PC) sends to the instrument or software. They
operate its functions ('setting commands' or 'events') and request information ('query
commands'). Some commands can only be used in one way, others work in two ways
(setting and query). If not indicated otherwise, the commands can be used for settings
and queries.
The syntax of a SCPI command consists of a header and, usually, one or more parameters. To use a command as a query, you have to append a question mark after the
last header element, even if the command contains a parameter.
11User Manual 1179.3515.02 ─ 03
R&S® HUMS
Operation
Access via SCPI commands
A header contains one or more keywords, separated by a colon. Header and parameters are separated by a "white space" (ASCII code 0 to 9, 11 to 32 decimal, e.g. blank).
If there is more than one parameter for a command, they are separated by a comma
from one another.
Only the most important characteristics that you need to know when working with SCPI
commands are described here. For a complete description, refer to the main user manual of your instrument.
12User Manual 1179.3515.02 ─ 03
R&S® HUMS
5.1 Table functions
General monitoring parameters
Device information
5 General monitoring parameters
The R&S HUMS application provides monitoring parameters available on all instrument
type that support the application.
In addition to these general monitoring parameters, there are also monitoring parameters that are specific to certain instrument types. For more information about these, see
Chapter 6, "Instrument specific monitoring parameters", on page 28.
Several of the dialogs available in the R&S HUMS application contain tables that you
can configure. Using these tables is based on the same principle. This section gives
you information about the table functions and how to work with them.
Column selector
Most tables contain the icon. Use this icon to select the columns you want to be displayed in the table.
●
To display all parameters:
Select the icon and select "Show all".
●
To display specific parameters:
Select the ones you want to display.
Filter and sorting function
Most tables contain the icon. Use this icon to sort the values inside the table in
alphabetical order or vice versa or filter by a specific character or name.
●
To activate alphabetical order:
Select the column you want to sort. Select "Sort 1 to N".
●
To activate descending order:
Select the column you want to sort. Select "Sort N to 1".
●
To filter by a specific character or name:
Select the column you want to filter. In the search bar, type in your preferred character or name.
You can only activate one filter at a time.
5.2 Device information
Access: "Device Info"
The "Device Info" dialog contains general, system-specific and BIOS-related information about the connected instrument.
13User Manual 1179.3515.02 ─ 03
R&S® HUMS
General monitoring parameters
Device tags
General
The "General" tab contains general information about the instrument that is monitored.
The "Identification" list contains basic information about the instrument, for example the
manufacturer, the instrument model or the serial number.
The "Date and Time" list shows the current time (UTC and local) and the time zone set
on the instrument and the state of daylight saving time.
System
The "System" tab contains information about the system components of the instrument
that is monitored. This information includes, for example, information about the network
configuration (IP address, hostname etc.), the operating system (type, version etc.),
memory usage and hardware components (manufacturer, model etc.).
On instruments running on a Linux operating system, the "System" characteristics are
only partially evaluated.
Remote command:
DIAGnostic:HUMS:SYSTem:INFO? on page 39
BIOS
The "Bios" tab contains detailed information about the BIOS on the monitored instrument, including manufacturer, version and release date.
Remote command:
DIAGnostic:HUMS:BIOS? on page 31
API
The "API" tab contains the SNMP MIB (a .zip file) and the REST API (a .yaml file)
as a download.
5.3 Device tags
Access: "Device Tags"
14User Manual 1179.3515.02 ─ 03
R&S® HUMS
General monitoring parameters
Equipment
The "Device Tags" contains functionality to manage device tags.
A device tag is a label to assign to your instrument. You can create any device tag for
your instrument and define it by a specific key and value.
Add
Adds a new device tag.
Key
Defines a key for your device tag. A device tag key represents the type of tag.
Value
Defines the actual value of the device tag or key.
Example:
●
"Key" = Location
●
"Value" = Building 1
You can also sort the device tags inside the table. See Chapter 5.1, "Table functions",
on page 13.
You can use the edit icon to change the tag later or you can use the delete icon to
delete the tag.
Remote command:
Add or modify a tag: DIAGnostic:HUMS:TAGS[:VALue] on page 41
Return all tags: DIAGnostic:HUMS:TAGS:ALL? on page 41
Delete a tag: DIAGnostic:HUMS:TAGS:DELete on page 42
5.4 Equipment
Access: "Equipment"
15User Manual 1179.3515.02 ─ 03
R&S® HUMS
General monitoring parameters
Equipment
The "Equipment" dialog contains information about hardware and software configuration of your instrument.
This information can be useful when problems occur with the instrument and you
require support from Rohde & Schwarz.
Note that tabs or individual columns in the "Equipment" dialog can be empty, depending on the connected instrument.
Licenses
The "Licenses" tab provides an overview of all installed hardware and software licenses (optional features).
Every listed license is described by its:
●
Part name (description of the license)
●
Part number (order number of the license)
●
(Part) type (name of the license)
●
License count (number of installations of a specific license)
You can also sort each column in alphabetical or descending order. See Chapter 5.1,
"Table functions", on page 13.
Products
The "Products" tab provides an overview of the components that are a separate product.
Every listed component is described by its:
●
Part name (description of the product)
●
Part number (order number of the product)
●
(Part) type (name of the product)
You can also sort each column in alphabetical or descending order. See Chapter 5.1,
"Table functions", on page 13.
Hardware
The "Hardware" tab provides an overview of the installed hardware components on
your device.
Every listed component is described by its:
●
Name (name of the component)
●
Part name (description of the component)
●
Part number
●
Serial number
16User Manual 1179.3515.02 ─ 03
R&S® HUMS
General monitoring parameters
Event history
●
Production date
●
Hardware code
●
Read code
●
Test instruction
You can also sort the columns in alphabetical or descending order, see Chapter 5.1,
"Table functions", on page 13.
Software
The "Software" tab provides an overview of the installed software components on your
instrument.
Every listed component is described by its:
●
Manufacturer (name and description of the software; includes the manufactorer if
applicable)
●
Version (software version, can be empty if software is part of a package)
●
Status
●
Vendor name
●
Configuration
●
Release state
You can also sort each column in alphabetical or descending order. See Chapter 5.1,
"Table functions", on page 13.
Remote command:
DIAGnostic:HUMS:EQUipment? on page 34
5.5 Event history
Access: "Event History"
The "Event History" dialog shows a list of all logged events that have occurred on the
connected instrument. Note that the screenshot below is an example and can show
status messages that are not available on your instrument.
17User Manual 1179.3515.02 ─ 03
R&S® HUMS
General monitoring parameters
Status
The type of evaluated events depends on the instrument type HUMS is running on.
For each event, the table contains various additional information, like a a description.
Note, however, that the level of detail of the additional information depends on the type
of event and the connected instrument type.
Severity
Shows the severity of the event.
●
Information
Event that is not critical and is logged for informational purposes.
●
Warning
Event that can have a negative effect on the instrument performance.
●
Error
Event that will have a negative effect on the instrument performance if it is not
resolved.
Remote command:
Query event list: DIAGnostic:HUMS:DEVice:HISTory? on page 32
Clear event list: DIAGnostic:HUMS:DEVice:HISTory:DELete:ALL on page 33
Timestamp
Shows the time and date when the event has occured.
Message
Shows a short description of the event.
The message usually appears in the user interface of the connected instrument.
Details
Shows a more comprehensive description of the event, for example which firmware
version was installed.
Source
Shows the source of the event.
●
Device
Event was logged automatically by the instrument.
●
Custom
Event was added manually. Adding events manually is possible with a SCPI command.
Remote command:
Add an event: DIAGnostic:HUMS:DEVice:HISTory:EVENt:ADD on page 33
Event ID
Shows the ID of the event. The ID is a unique identifier for each event in consecutive
order.
5.6 Status
Access: "Status"
18User Manual 1179.3515.02 ─ 03
Loading...