IBM i: The SQL Way · #14

View IBM i Service Tools Server Configuration Entries with SQL

Use QSYS2.SERVICE_TOOLS_SERVER_CONFIGURATION_ENTRY_INFO to review stored partition-specific STS LAN configuration entries used during IPL recovery scenarios.

IBM i 7.6 can store partition-specific Service Tools Server LAN configuration entries for recovery scenarios where a replicated or FlashCopy load-source image starts on different hardware. The entries can now be reviewed through SQL.

The view is:

QSYS2.SERVICE_TOOLS_SERVER_CONFIGURATION_ENTRY_INFO

Critical distinction

The view does not necessarily show the currently active Service Tools Server configuration.

It shows stored configuration entries that can be used during IPL when IBM i detects that the load-source image is running with different hardware.

To view the current STS configuration, use:

QSYS2.SERVICE_TOOLS_SERVER_INFO

Think of the two views as:

SERVICE_TOOLS_SERVER_INFO
    Current active configuration

SERVICE_TOOLS_SERVER_CONFIGURATION_ENTRY_INFO
    Stored partition-specific recovery entries

Basic query

SELECT *
FROM QSYS2.SERVICE_TOOLS_SERVER_CONFIGURATION_ENTRY_INFO;

Focused query

SELECT
    HEX(PARTITION_UUID) AS PARTITION_UUID_HEX,
    RESOURCE_NAME,
    IPV4_ADDRESS,
    GATEWAY_ADDRESS,
    SUBNET_MASK,
    IPV6_ADDRESS,
    VIRTUAL_LAN_ID,
    HEX(INTERFACE_ID) AS INTERFACE_ID_HEX
FROM QSYS2.SERVICE_TOOLS_SERVER_CONFIGURATION_ENTRY_INFO
ORDER BY PARTITION_UUID_HEX;

Binary identifiers are easier to compare when displayed through HEX.

Result columns

PARTITION_UUID

A 16-byte UUID identifying the partition for which the entry applies.

The UUID is the key used to match a stored configuration entry during the recovery or alternate-hardware IPL scenario.

RESOURCE_NAME

The communication-device resource that the Service Tools Server should use.

IPV4_ADDRESS

The IPv4 address to use for the STS LAN server.

It is null when IPv4 is not configured for the entry.

GATEWAY_ADDRESS

The IPv4 gateway address.

SUBNET_MASK

The IPv4 subnet mask.

IPV6_ADDRESS

The configured IPv6 address.

VIRTUAL_LAN_ID

The VLAN identifier when VLAN tagging is used.

INTERFACE_ID

The eight-byte IPv6 interface identifier.

Display it as hexadecimal for reliable comparison.

Compare stored entries with the current configuration

SELECT
    'CURRENT' AS CONFIGURATION_SOURCE,
    RESOURCE_NAME,
    IPV4_ADDRESS,
    GATEWAY_ADDRESS,
    SUBNET_MASK,
    IPV6_ADDRESS,
    VIRTUAL_LAN_ID
FROM QSYS2.SERVICE_TOOLS_SERVER_INFO

UNION ALL

SELECT
    'STORED ENTRY',
    RESOURCE_NAME,
    IPV4_ADDRESS,
    GATEWAY_ADDRESS,
    SUBNET_MASK,
    IPV6_ADDRESS,
    VIRTUAL_LAN_ID
FROM QSYS2.SERVICE_TOOLS_SERVER_CONFIGURATION_ENTRY_INFO;

This comparison can highlight whether recovery entries differ from the production system’s active STS network.

Review the exact columns available in SERVICE_TOOLS_SERVER_INFO on the installed PTF level and adjust the projection if needed.

Find entries missing IPv4

SELECT
    HEX(PARTITION_UUID) AS PARTITION_UUID_HEX,
    RESOURCE_NAME,
    IPV6_ADDRESS,
    VIRTUAL_LAN_ID
FROM QSYS2.SERVICE_TOOLS_SERVER_CONFIGURATION_ENTRY_INFO
WHERE IPV4_ADDRESS IS NULL;

A missing IPv4 address may be expected for an IPv6-only design.

Find entries for one resource

SELECT
    HEX(PARTITION_UUID) AS PARTITION_UUID_HEX,
    RESOURCE_NAME,
    IPV4_ADDRESS,
    GATEWAY_ADDRESS,
    SUBNET_MASK
FROM QSYS2.SERVICE_TOOLS_SERVER_CONFIGURATION_ENTRY_INFO
WHERE RESOURCE_NAME = 'CMN01';

Replace CMN01 with the actual communication-resource name.

Why these entries exist

A load-source image replicated or copied to another managed system contains the original STS LAN configuration.

That configuration may not work on the target hardware.

Stored partition-specific configuration entries allow IBM i to reconfigure the STS LAN server during IPL when the different hardware is detected.

This is particularly important when a Remote Key Agent must communicate with the system during IPL to provide the Save/Restore key.

Maximum number of entries

IBM documents a maximum of:

10 configuration entries

Use the count query:

SELECT
    COUNT(*) AS CONFIGURATION_ENTRY_COUNT
FROM QSYS2.SERVICE_TOOLS_SERVER_CONFIGURATION_ENTRY_INFO;

Before adding an entry, review whether an obsolete partition UUID should be removed.

Obtain a partition UUID

On the partition whose UUID is required:

SELECT
    HEX(PARTITION_UUID) AS PARTITION_UUID_HEX
FROM QSYS2.SYSTEM_STATUS_INFO_BASIC;

Record the UUID exactly.

Do not invent or copy a UUID from a different logical partition.

Authority

The caller must:

Have *IOSYSCFG special authority
and
Be linked to a service tools user ID
with the Display/Alter/Dump privilege

Both requirements matter.

An IBM i profile with *IOSYSCFG but no correctly linked service-tools user ID may still be unable to use the view.

Security considerations

These rows expose management-network details.

Restrict access because the result can include:

• service-network addresses
• communication-resource names
• gateway and subnet information
• partition identifiers
• VLAN information

Do not expose the view through a general application profile.

IBM i 7.6 only

IBM lists this view as supported at:

IBM i 7.6 — Db2 Group PTF SF99960 Level 3

It is not listed as supported on IBM i 7.5, 7.4, or 7.3.

A practical review workflow

1. Query the stored entries.
2. Confirm every partition UUID with the target system.
3. Confirm resource names on the relevant hardware.
4. Verify IPv4, IPv6, gateway, subnet, VLAN, and interface ID.
5. Compare stored entries with the intended DR design.
6. Confirm Remote Key Agent communication procedures.
7. Test the documented recovery process.
8. Remove entries for retired or rebuilt partitions.

Final takeaway

SERVICE_TOOLS_SERVER_CONFIGURATION_ENTRY_INFO provides SQL visibility into a small but critical part of IBM i recovery planning.

The view is not a replacement for a tested recovery procedure. Its purpose is to help verify that the partition-specific STS LAN entries required by that procedure are actually stored and correct.