logo Technical Documentation
Home Technical Documentation Trainings
    • Documentation Overview
    • RBFS Overview
      • RtBrick Full Stack (RBFS) Overview
    • Platform
      • Platform Overview
      • Platform Hardware Information
        • RBFS Access Leaf and Consolidated BNG Images on UfiSpace S9600-72XC
        • RBFS Spine Image on UfiSpace S9600-32X
        • RBFS Access Leaf Image on Delta AGCVA48S
        • RBFS Access Leaf & Consolidated BNG Images on
        • RBFS Spine Image on Edgecore AGR400 (AS7946-30XB)
        • RBFS Consolidated BNG Image on UfiSpace S9510-28DC
        • RBFS Consolidated BNG Image on Edgecore CSR440 (AS7535-28XB)
        • RBFS Consolidated BNG Image on UfiSpace S9500-22XST
        • RBFS Consolidated BNG Image on Edgecore CSR320 (AS7316-26XB)
      • Feature Support Matrix
      • Feature/Resource Usage
    • Installation
      • RBFS Installation, ZTP, and Licensing
      • Zero Touch Provisioning
      • RBFS Licensing
    • RBFS User Guides
      • RBFS CLI Overview
        • RBFS Command Line Interface
      • BDS Overview
        • BDS Overview
        • BDS Operational Commands
      • Routing
        • RIB
          • RIB Overview
          • Operational commands
        • BGP
          • BGP Overview
          • BGP Configuration
          • BGP Operational Commands
        • IS-IS
          • IS-IS Overview
          • IS-IS Configuration
          • IS-IS Operational Commands
        • OSPF
          • OSPF Overview
          • Configuring OSPF
          • OSPF Operational Commands
        • LDP
          • LDP Overview
          • LDP Configuration Hierarchy
          • LDP Operational Commands
        • Policy
          • Policy Overview
          • Policy Configuration
          • Policy Operational Commands
        • Static Routing
          • Static Routing Overview
          • Configuring Static Routes
          • Operational Commands
      • Subscriber Management
        • Subscriber Management
          • Subscriber Management Overview
          • Configuring Subscriber Management
            • Access Interface Configuration
            • Access Profile Configuration
            • DHCP Server Configuration
            • AAA Profile Configuration
            • RADIUS Profile Configuration
            • RADIUS Server Configuration
            • Service Profile Configuration
            • L2TP Profile Configuration
            • L2TP Tunnel Pool Configuration
            • User Profile Configuration
            • Address Pool Configuration
            • Control Plane Outbound Marking Configuration
            • Configuration Examples
          • Operations
          • Supported Standards
        • RBFS RADIUS Services
          • RADIUS Services Overview
          • RADIUS Service Solution Overview
          • RADIUS Control
          • RADIUS Accounting
          • RADIUS Counters
          • RADIUS Accounting Adjustment Configuration
          • RADIUS Redundancy
          • Test AAA
          • Appendix A - RADIUS Dictionary
          • Appendix B - RADIUS Standard Attributes Supported
          • Appendix C - Access Deployments
        • RBFS HTTP Redirect Service
          • RBFS HTTP Redirect Service
          • HTTP Redirect Service Configuration
        • RBFS Subscriber Filters
          • RBFS Subscriber Filters
          • Subscriber Filters Configuration
          • Operational Commands
        • Lawful Interception
          • Lawful Interception Overview
          • LI Encapsulation
          • Enabling Lawful Interception
        • L2BSA
          • L2BSA Overview
          • L2BSA Configuration
          • L2BSA Operational Commands
          • L2BSA Operational State API
        • Redundancy
          • RBFS Redundancy for Subscriber Groups
          • Deploy RBFS in Redundancy Mode
          • RBFS Redundancy Operational Commands
      • Forwarding
        • Interfaces
          • Interfaces Overview
          • Configuring Interfaces
          • Interfaces Operational Commands
        • ARP/ND
          • ARP/ND Overview
          • ARP/ND Configuration
          • ARP/ND Operational Commands
        • ACLs
          • ACL Overview
          • Configuring Access Control Lists
          • ACL Operational Commands
        • Port Mirroring
          • Port Mirroring Overview
          • Port Mirroring Configuration
          • Port Mirroring Operational Commands
        • OAM Support
          • OAM Overview
          • Configuring OAM
        • LAG
          • LAG Overview
          • Configuring Link Aggregation Groups (LAGs)
          • LAG Operational Commands
        • L2X
          • L2X Overview
          • L2X Configuration
          • L2X Operational Commands
        • HQoS
          • HQoS Overview
          • HQoS Features
          • Configuring HQoS
          • Viewing HQoS Configurations
          • HQoS Show Commands
        • LLDP
          • LLDP Overview
          • LLDP Configuration
          • LLDP Operational Commands
      • Multicast
        • IGMP
          • IGMP Overview
          • Configuring IGMP
          • IGMP Operational Commands
        • PIM
          • PIM Overview
          • Configuring PIM
          • PIM Operational Commands
        • Multicast VPN
          • MVPN Overview
          • Configuring Multicast VPN
          • MVPN Operational Commands
      • Infrastructure
        • NTP
          • NTP Overview
          • NTP Configuration
          • NTP Operational Commands
        • Logging
          • Logging Overview
          • Logging Configuration
          • Logging Operational Commands
          • RBFS Log Reference
        • LED Control
          • LED Overview
          • LED Definitions
        • IPMI
          • IPMI Overview
          • IPMI Configuration
          • IPMI Operational Commands
        • Inband Management
          • In-band Management Overview
          • Configuring In-band Management
          • In-Band Management Operational Commands
        • DHCP Relay/Proxy
          • DHCP Relay Overview
          • DHCP Relay Configuration
          • DHCP Relay Operations
      • Telemetry
        • TSDB
          • Prometheus Time Series Database (TSDB) Integration Overview
          • Configuring Time Series Database
          • Installation
        • Resmon
          • Resource Monitoring (resmon) Overview
          • Resmon Configuration
          • Resmon Operational Commands
        • SNMP
          • SNMP Overview
          • Configuring SNMP
      • Security
        • Securing Management Plane
          • Securing the Management Plane Overview
          • RtBrick Token
          • Role Based Access Control (RBAC)
          • SSH with TACACS+
        • Securing Control Plane
          • Securing the Control Plane Overview
          • Configuring Control Plane Security
          • Operations
        • Local User Management
          • Local User Management Overview
          • Configuring Local user management
    • RBMS Overview
      • RtBrick Management Suite (RBMS) Overview
    • RBMS User Guides
      • Managing Inventory
      • Managing Software Images
      • Zero-Touch Provisioning (ZTP)
        • ZTP Overview
        • ZTP in a Nutshell
        • References
      • Managing Logs
      • Metric Management
      • Metric Sampling and Monitoring
        • Metric sampling Overview
        • Temperature Monitoring
        • CPU Utilization
        • PPPoE Session Count
        • Count of Received IPv4 Unicast Prefixes
        • Metric Management
        • Grafana Dashboards
        • Summary
        • References
      • Administering RBMS
        • Administration
        • Managing Jobs
      • RBMS Configuration Store
      • RBMS Template Engine
      • Auto-DNS Provisioning
        • DNS Introduction
        • DNS Overview
        • DNS Record Management
    • API References
      • RBFS API User Guide
        • RBFS REST APIs
        • Functions and Use cases of RBFS REST APIs
        • Configure API Gateway and CtrlD Components
        • Events
        • Appendix: Use case Scenario and Examples for RBFS REST APIs
        • Related Documentation
      • RBFS APIs
      • RBMS APIs
    • Reference Designs
      • RBFS C-BNG for PPPoE Subscribers
        • An Overview of RBFS C-BNG for PPPoE Subscribers
        • Configuration and Settings
        • Protocol Configurations
        • PPPoE Subscriber Management Configuration
        • Appendixes
      • RBFS C-BNG for IPoE Subscribers
        • An Overview of RBFS C-BNG for IPoE Subscribers
        • Configuration and Settings
        • Protocol Configurations
        • IPoE Subscriber Management Configuration
        • Appendixes
      • RBFS C-BNG with Redundancy for IPoE Subscribers
        • RBFS C-BNG with Redundancy for IPoE Subscribers
        • RBFS Redundancy Configurations
    • Troubleshooting
      • Troubleshooting Guide Overview
      • System Health
      • Physical Layer
      • Application Layer
      • Logging
      • Reporting Issues to RtBrick
    • End-of-Life Policy
  • Technical Documentation
  • API References
  • RBFS APIs
25.2.1.2 (current) 25.2.1 25.2.1.1 25.1.1 25.1.1.1 25.1.1.2 24.9.1 24.9.1.1 24.9.1.2 24.8.1 24.7.1 24.3.1 24.1.1
Related Documentation RBMS APIs

(C)Copyright 2025 RtBrick, Inc. All rights reserved.

The information contained herein is subject to change without notice. The trademarks, logos and service marks ("Marks") displayed in this documentation are the property of RtBrick in the United States and other countries. Use of the Marks are subject to RtBrick’s Term of Use Policy, available at https://www.rtbrick.com/privacy. Use of marks belonging to other parties is for informational purposes only.

Made with RtBrick Antora UI, which is licensed under the MPL-2.0 license. Includes portions of Material for MkDocs, which is licensed under the MIT license.