Management System

1. Introduction

This document describes SYSTEM related configuration and get of status information.

2. Reading the Vendor hardware information.

The Vendor can specify a string with information about the hardware like PCB and Switch device ID and revision.
This can read out.

FETCH request message.

- "/ietf-system:system-state/platform/machine"

FETCH response message.

- "/ietf-system:system-state/platform/machine": LAN969x - ev23x71a (pcb8398)

The Switch is a LAN969x product and the board is a ev23x71a (pcb8398).

3. Copy running configuration to startup configuration.

The running or current configuration can be save as the configuration loaded during next boot of the system.

POST request message.

- "/mchp-velocitysp-system:save-config":

4. Factory reset the system.

The system can be restored to its factory default configuration by erasing the startup configuration and user DTLS certificates.

POST request message

- ? "/mchp-velocitysp-system:system-factory-reset"
  :

5. Reading memory usage.

The device exposes a read-only snapshot of main heap usage captured at the end of boot-time initialisation. The values do not change at runtime.

5.1. Total used and free bytes

FETCH request message.

- "/ietf-system:system/mchp-velocitysp-system:memory/used"
- "/ietf-system:system/mchp-velocitysp-system:memory/free"

FETCH response message.

- "/ietf-system:system/mchp-velocitysp-system:memory/used": 1234560
- "/ietf-system:system/mchp-velocitysp-system:memory/free":  876032

The sum of used and free equals the total heap size configured for the target.

5.2. Per-capability breakdown

The capability list shows how many bytes each board-configuration capability consumed. Only capabilities with a non-zero allocation appear in the list. The id leaf is an enum whose values match the lm_os_cap_t identifiers (e.g. port-cnt, stream-cnt, coap-session-cnt).

FETCH request message.

- "/ietf-system:system/mchp-velocitysp-system:memory/capability"

FETCH response message.

- "/ietf-system:system/mchp-velocitysp-system:memory/capability":
    - id: port-cnt
      bytes: 38400
    - id: stream-cnt
      bytes: 204800
    - id: coap-session-cnt
      bytes: 16384

The sum of all bytes values across capabilities is less than used because module-state structures and driver tables are counted in used but not broken out by capability.