feat: Implement DeviceProvider for IOS-XR

Author: sven-rosenzweig

internal/provider/cisco/iosxr/intf.go

@@ -42,10 +42,18 @@ const (
 	StateShutDown  PhysIfStateType = "im-state-shutdown"
 )
 
+type Ifaces struct {
+	PhysIfList []*Iface `json:"interface-configuration"`
+}
+
+func (i *Ifaces) XPath() string {
+	return "Cisco-IOS-XR-ifmgr-cfg:interface-configurations"
+}
+
 // Iface represents physical and bundle interfaces as part of the same struct as they share a lot of common configuration
 // and only differ in a few attributes like the interface name and the presence of bundle configuration or not.
 type Iface struct {
-	Name         string        `json:"-"`
+	Name         string        `json:"interface-name"`
 	Description  string        `json:"description,omitzero"`
 	Statistics   Statistics    `json:"Cisco-IOS-XR-infra-statsd-cfg:statistics,omitzero"`
 	MTUs         MTUs          `json:"mtus,omitzero"`
@@ -193,6 +201,21 @@ func ExtractInterfaceSpeedFromName(ifaceName string) (IFaceSpeed, error) {
 	}
 }
 
+func MapInterfaceSpeedToNumeric(speed IFaceSpeed) (int32, error) {
+	switch speed {
+	case Speed10G:
+		return 10000, nil
+	case Speed25G:
+		return 25000, nil
+	case Speed40G:
+		return 40000, nil
+	case Speed100G:
+		return 100000, nil
+	default:
+		return 0, fmt.Errorf("unsupported interface speed %s", speed)
+	}
+}
+
 func CheckInterfaceNameTypeAggregate(name string) error {
 	if name == "" {
 		return errors.New("interface name must not be empty")

internal/provider/cisco/iosxr/provider.go

@@ -21,6 +21,7 @@ import (
 
 var (
 	_ provider.Provider          = &Provider{}
+	_ provider.DeviceProvider    = &Provider{}
 	_ provider.InterfaceProvider = &Provider{}
 )
 
@@ -49,6 +50,58 @@ func (p *Provider) Disconnect(ctx context.Context, conn *deviceutil.Connection)
 	return p.conn.Close()
 }
 
+func (p *Provider) ListPorts(ctx context.Context) ([]provider.DevicePort, error) {
+	iFaces := new(Ifaces)
+	err := p.client.GetConfig(ctx, iFaces)
+	if err != nil {
+		return nil, fmt.Errorf("failed to list ports: %w", err)
+	}
+
+	dp := make([]provider.DevicePort, 0, len(iFaces.PhysIfList))
+	for _, intf := range iFaces.PhysIfList {
+		var speeds = []int32{}
+		s, _ := ExtractInterfaceSpeedFromName(intf.Name)
+
+		if n, err := MapInterfaceSpeedToNumeric(s); err == nil {
+			speeds = append(speeds, n)
+		}
+		// (fixme): name already contains the speed information, convert them to standardized string value (e.g. 10G, 25G, 40G, 100G)
+		dp = append(dp, provider.DevicePort{
+			ID:                  intf.Name,
+			Type:                intf.Name,
+			SupportedSpeedsGbps: speeds,
+		})
+	}
+	return dp, nil
+}
+
+func (p *Provider) GetDeviceInfo(ctx context.Context) (*provider.DeviceInfo, error) {
+	i := new(BasicDeviceInfo)
+
+	if err := p.client.GetState(ctx, i); err != nil {
+		return nil, err
+	}
+
+	return &provider.DeviceInfo{
+		Manufacturer:    Manufacturer,
+		Model:           i.Model,
+		SerialNumber:    i.SerialNumber,
+		FirmwareVersion: i.FirmwareVersion,
+	}, nil
+}
+
+func (p *Provider) Reboot(ctx context.Context, conn *deviceutil.Connection) error {
+	return errors.New("IOS XR Provider does not support rebooting the device")
+}
+
+func (p *Provider) FactoryReset(ctx context.Context, conn *deviceutil.Connection) error {
+	return errors.New("IOS XR Provider does not support factory reset")
+}
+
+func (p *Provider) Reprovision(cxt context.Context, conn *deviceutil.Connection) error {
+	return errors.New("IOS XR Provider does not support reprovisioning")
+}
+
 func (p *Provider) EnsureInterface(ctx context.Context, req *provider.EnsureInterfaceRequest) error {
 	if p.client == nil {
 		return errors.New("client is not connected")

internal/provider/cisco/iosxr/system.go

@@ -0,0 +1,19 @@
+// SPDX-FileCopyrightText: 2025 SAP SE or an SAP affiliate company and IronCore contributors
+// SPDX-License-Identifier: Apache-2.0
+
+package iosxr
+
+const Manufacturer = "Cisco"
+
+// Model is the chassis model of the device, e.g. "NCS-57C3-MOD-SYS".
+// SerialNumber is the serial number of the device, e.g. "9VT9OHZBC3H".
+// FirmwareVersion is the firmware version of the device, e.g. "25.2.2".
+type BasicDeviceInfo struct {
+	Model           string `json:"model-name"`
+	SerialNumber    string `json:"serial-number"`
+	FirmwareVersion string `json:"firmware-version"`
+}
+
+func (*BasicDeviceInfo) XPath() string {
+	return "Cisco-IOS-XR-platform-inventory-oper:/platform-inventory/racks/rack[name=0]/attributes/basic-info"
+}