Find Technical Content
  • Home
  • Ruckus Support Portal
  • Ruckus Networks
  • Table of Contents
  • Dark Mode

Powered by Titania Delivery

⚠ This cached page may be outdated. Click refresh to get the latest content.
Cached Version You are Offline

You are viewing a cached version of this page.

You are currently offline. This page was loaded from cache.

RESTCONF

  • 1 RESTCONF for RUCKUS ICX Switches
    • 1.1 Introduction
    • 1.2 RESTCONF-Supported HTTP Methods
    • 1.3 RESTCONF Supported Modules
    • 1.4 ICX Management
    • 1.5 RESTCONF Resources
      • 1.5.1 URI
      • 1.5.2 Base URI
      • 1.5.3 Data
      • 1.5.4 YANG Library Version
      • 1.5.5 Operation Resource
      • 1.5.6 CRUD Operations
        • 1.5.6.1 POST Method
        • 1.5.6.2 PUT Method
        • 1.5.6.3 PATCH Method
        • 1.5.6.4 DELETE Method
    • 1.6 XML Representation
    • 1.7 JSON Representation
    • 1.8 Media Types
    • 1.9 Capabilities
    • 1.10 Schema Resources
    • 1.11 YANG Module Retrieval
    • 1.12 Query Parameters
    • 1.13 Transport Protocol Requirements
    • 1.14 Web Requests with Tools (curl)
    • 1.15 RESTCONF Configuration
      • 1.15.1 Configuring ICX Using the RESTCONF Management Interface
        • 1.15.1.1 AAA Authentication Login
        • 1.15.1.2 AAA Authentication Users
        • 1.15.1.3 AAA Authorization Commands
        • 1.15.1.4 AAA Authorization EXEC
        • 1.15.1.5 AAA Accounting Commands
        • 1.15.1.6 AAA Accounting EXEC
        • 1.15.1.7 AAA Server Groups (RADIUS/TACACS)
        • 1.15.1.8 Archive File Upload and Download Operations
        • 1.15.1.9 Listing of Archive Files
        • 1.15.1.10 Differences between Archives
        • 1.15.1.11 Creating an Archive
        • 1.15.1.12 Reloading an Archive
        • 1.15.1.13 Deleting an Archive
        • 1.15.1.14 Archiving a Backup File
        • 1.15.1.15 ARP Inspection
        • 1.15.1.16 BPDU Guard
        • 1.15.1.17 Boot
        • 1.15.1.18 CLI Template
        • 1.15.1.19 Collectd SNMP Configuration
        • 1.15.1.20 DHCP Client
        • 1.15.1.21 DHCP: Relay-Agent IP Helper Address
        • 1.15.1.22 DHCP Server
        • 1.15.1.23 DHCPv4 Snooping
        • 1.15.1.24 DHCPv6 Snooping
        • 1.15.1.25 Multicast-IGMP Snooping
        • 1.15.1.26 Ethernet
        • 1.15.1.27 Firmware
        • 1.15.1.28 FlexAuth REST Configuration
        • 1.15.1.29 Forwarding Profile
        • 1.15.1.30 NTP
        • 1.15.1.31 LLDP-MED
        • 1.15.1.32 SNMP-Server Group
        • 1.15.1.33 SNMP-Server User
        • 1.15.1.34 Stacking
        • 1.15.1.35 Static Routes
        • 1.15.1.36 IP Route Table
        • 1.15.1.37 IP Address on Management Interface for Router Image
        • 1.15.1.38 IP Address on Management Interface for Switch Image
        • 1.15.1.39 MAC Address Table (Static and Dynamic)
        • 1.15.1.40 IPv6 Address on Interfaces
        • 1.15.1.41 IPv6 Address on Management Port for Router Image
        • 1.15.1.42 IPv6 Address on Management Port for Switch Image
        • 1.15.1.43 Default-Gateway Address on Management VLAN for Switch Image
        • 1.15.1.44 IP Default-Gateway Address on Switch Image
        • 1.15.1.45 IPv4, IPv6 and MAC ACLs
        • 1.15.1.46 Port-name on VE Interface
        • 1.15.1.47 Spanning Tree Root Protect
        • 1.15.1.48 Spanning Tree Admin-Edge Protect
        • 1.15.1.49 PVST
        • 1.15.1.50 RSTP
        • 1.15.1.51 Trunk VLAN and Access VLAN
        • 1.15.1.52 Management VLAN
        • 1.15.1.53 Default VLAN
        • 1.15.1.54 Update Tagged/Untagged LAG under VLAN
        • 1.15.1.55 IPv6 Neighbor Inspection
        • 1.15.1.56 Source Guard
        • 1.15.1.57 IPSG and IPv6 Source Guard Selective Port
        • 1.15.1.58 IP Voice VLAN
        • 1.15.1.59 Web Authentication
        • 1.15.1.60 VXLAN and VXLAN Tunnel Endpoints (VTEP)
        • 1.15.1.61 Logging Host
        • 1.15.1.62 ICX Health Check and Get Switch Mode
        • 1.15.1.63 Inline Power Priority
        • 1.15.1.64 Storm Control REST Configuration
        • 1.15.1.65 Write Memory
        • 1.15.1.66 LAG
        • 1.15.1.67 Protected Port
        • 1.15.1.68 Hostname
        • 1.15.1.69 Provision Backup Restore
        • 1.15.1.70 Supportsave Operations
        • 1.15.1.71 Jumbo Frame
        • 1.15.1.72 Trust DSCP
        • 1.15.1.73 Reload
        • 1.15.1.74 Ping
        • 1.15.1.75 Traceroute
      • 1.15.2 Enabling the RESTCONF Management Interface
        • 1.15.2.1 Troubleshooting Web-management and HTTPS Dependency
      • 1.15.3 Displaying RESTCONF Configuration and Status Information
      • 1.15.4 High Availability
      • 1.15.5 Security Considerations

Web Requests with Tools (curl)

  • To send a simple GET request, the following command can be used: curl harp://6a7214064c282d8ad6c44b90/pr/ORIGINAL/RUCKUS%20FastIron%20RESTCONF%20Programmers%20Guide_v6_GUID-290FF6E5-C1CE-4027-A3D2-4810B6FA171E/https%3A%2F%2F%3Cmgmt%20IP%3E%2Frestconf%2Fdata%2Frestconf-state%2Fcapabilities%20-H%20%22Accept%3Aapplication%2Fyang-data%2Bxml%22%20--insecure%20-u%20%3Cusername%3E%3A%3Cpassword%3E
  • In order to retrieve data in different encoding use --header (-H) parameter with specific Accept header value (XML or JSON). The following request "Accepts" replies in JSON encoding: curl harp://6a7214064c282d8ad6c44b90/pr/ORIGINAL/RUCKUS%20FastIron%20RESTCONF%20Programmers%20Guide_v6_GUID-290FF6E5-C1CE-4027-A3D2-4810B6FA171E/https%3A%2F%2F%3Cmgmt%20IP%3E%2Frestconf%2Fdata%2Frestconf-state%2Fcapabilities%20-H%20%22Accept%3Aapplication%2Fyang-data%2Bjson%22%20--insecure%20-u%20%3Cusername%3E%3A%3Cpassword%3E
  • The same request with RESTCONF query parameters, for example, "depth" would look as follows: curl harp://6a7214064c282d8ad6c44b90/pr/ORIGINAL/RUCKUS%20FastIron%20RESTCONF%20Programmers%20Guide_v6_GUID-290FF6E5-C1CE-4027-A3D2-4810B6FA171E/https%3A%2F%2F%3Cmgmt%20IP%3E%2Frestconf%2Fdata%2Frestconf-state%2Fcapabilities%3Fdepth%3D1
Parent topic: RESTCONF for RUCKUS ICX Switches

Did you find what you were looking for?

Thanks!

Ruckus Wireless

© 2026 Ruckus Wireless LLC All rights reserved.

  • Accessibility
  • Privacy & Cookies
  • Do Not Sell My Information
  • Trademarks
  • Terms
  • Feedback