Guide descriptions

The AOS-CX documents describe the switch operating system features and configuration information. Configuration examples are also provided.

This guide provides brief descriptions of what is found in each of the documents in the AOS-CX suite.

Not all topics apply to all switch platforms. See the individual guides for details on which features are supported.

AOS-CX manuals


Command-Line Interface

This document contains reference information for the CLI commands for the AOS-CX network operating system.

This guide includes syntax, parameters, options, context, and authority required for all commands supported.

ACLs and Classifiers Policy Guide

This document contains information about Access Control Lists (ACLs) and classifier policies for the AOS-CX network operating system

This guide includes:

  • Access Control Lists (ACLs)
  • ACL configuration examples
  • Classifier policies
  • Classifier policy configuration examples
  • ACL and policy hardware resource considerations
  • High capacity TCAM

CoPP Guide

CoPP provides a way to for administrators to protect the management processor on the switch from high packet loads (generated by malicious or nonmalicious sources) that might interfere with its ability to keep data plane traffic flowing.

This guide provides information on CoPP and how it is configured.

Diagnostics and Supportability Guide

This document provides information on how to diagnose issues with AOS-CX. Topics include:

  • Debug logging
  • Log rotation
  • Finding events
  • Cable diagnostics
  • Event logs
  • Supportability copy
  • Traceroute
  • Ping
  • Remote syslog
  • Runtime diagnostics
  • ServiceOS
  • In-System programming
  • Selftest
  • Zeroization
  • Terminal Monitor
  • Troubleshooting Web UI and REST API access issues

Fundamentals Guide

This document contains information for getting started with the AOS-CX network operating system. Only basic information on each topic is provided. Further detail is found in the other guides. Topics include:

  • Introduction to the OS
  • CLI session commands
  • Initial configuration


    Aruba CX mobile app



    In-band management

    Network Time Protocol (NTP)

    Precision Time Protocol (PTP)

    Restore factory default

  • Interface configuration
  • Source interface selection
  • VLANs
  • Configuration and firmware management
  • Dynamic segmentation
  • SNMP
  • CoPP
  • Aruba Central integration
  • Port filtering
  • DNS
  • Device discovery and configuration



  • DCBx
  • Zero Touch Provisioning
  • Switch system and hardware commands

High Availability Guide

This document contains information about the high availability functionality of the AOS-CX network operating system. Management Module failover and high availability commands are discussed.

Bidirectional Forwarding Detection (BFD) and Ethernet Ring Protection Switching (ERPS) are also covered in this guide.

Introduction to the WebUI Guide

This document provides an introduction to the AOS-CX WebUI. The Web UI provides quick and easy visibility into what is happening on the switch.

IP Routing Guide

This document contains IP routing reference information for the AOS-CX network operating system.

This guide includes:

  • Virtual Routing and Forwarding (VRF)
  • Loopback
  • Static routing
  • Open Shortest Path First (OSPF) versions 2 and 3
  • Border Gateway Protocol (BGP)
  • Route policies and route maps
  • Equal Cost Multipath (ECMP)
  • Virtual Router Redundancy Protocol (VRRP)
  • Inter-Virtual Router Forwarding (IVRF)
  • Policy Based Routing (PBR)
  • IP Directed Broadcast
  • IP Neighbor Flood
  • Key chain
  • IP Client Tracker
  • Routing Information Protocol (RIP)

IP Services Guide

This document contains information for configuring IP services on the AOS-CX network operating system.

This guide includes:

  • IRDP
  • IPv6 router advertisement
  • sFlow
  • DHCP
  • DHCP snooping
  • ND Snooping
  • IP tunnels
  • IP source lockdown
  • Internet Control Message Protocol (ICMP)
  • DNS
  • ARP
  • Network Load Balancing (NLB)

Job Scheduler

This document contains information for configuring the Job Scheduler, which can be used to execute batches of CLI commands on a user-configured schedule or interval.

Layer 2 Bridging Guide

This document contains information for configuring layer 2 bridging with the AOS-CX network operating system.

This guide includes:

  • MAC address table
  • VLANs
  • Loop protection
  • Spanning tree protocols
  • MVRP
  • UDLD

Link Aggregation Guide

Provides information on configuring Link Aggregation Groups (LAGs).

Monitoring Guide

This document contains information about the monitoring functionality of the AOS-CX network operating system.

This guide includes:

  • Member, slot, and port notation
  • Monitoring hardware through visual observation
  • LEDs
  • Boot commands
  • External storage
  • IP-SLA
  • L1 100Mbps downshift
  • Mirroring
  • Monitoring the device using SNMP
  • Power over Ethernet
  • Breakout cable support
  • AirWave

MPLS Guide

This document contains information about the Multiprotocol Label Switching (MPLS) routing.

This guide includes:

  • MPLS protocol and feature standards
  • Configuration task lists
  • Use Cases
  • MPLS commands
  • Debugging and troubleshooting information

Multicast Guide

This document contains information about multicast functionality of the AOS-CX network operating system.

This guide includes:

  • Multicast overview
  • Internet Group Management Protocol (IGMP)
  • IGMP snooping
  • MLD snooping
  • Protocol Independent Multicast - Sparse Mode (PIM-SM)
  • Protocol Independent Multicast - Dense Mode (PIM-DM)
  • Multicast Source Discover Protocol (MSDP)
  • mDNS gateway

Networks Analytics Engine Guide

This document describes the AOS-CX Network Analytics Engine, including information about example use cases for the Network Analytics Engine, creating agents that use Network Analytics Engine scripts, using scripts provided by Hewlett Packard Enterprise, finding and using scripts written by others, and creating your own scripts.

Topics include:

  • Overview
  • Framework
  • Managing scripts
  • Managing agents
  • Troubleshooting agent and script issues
  • Using the Aruba Solutions Exchange (ASE)
  • NAE scripts repository on GitHub
  • Scripts and security
  • Scripts
  • Agents
  • NAE commands
  • HTTPS server commands

Quality of Service Guide

This document contains information for configuring quality of service (QoS) on AOS-CX.


These guides (one for RESTv1 and one for RESTv10.xx) describe the AOS-CX REST API. It is intended for experienced users who require a programmatic interface to the switch and understand the schema and data relationships of the switch as modeled by the switch configuration database.

Topics include:

  • Introduction to the AOS-CX REST API
  • Enabling access to the API
  • Accessing the REST API
  • AOS-CX REST API reference
  • Using curl commands
  • VSX peer switches and REST API access
  • Troubleshooting

NOTE: The RESTv1 API User Guide is available for AOS-CX 10.11 and earlier releases. The RESTv1 API is fully deprecated starting with AOS-CX 10.12.

Security Guide

This document contains information about authentication for the AOS-CX network operating system.

Topics include:

  • Managing local users and groups
  • SSH server and client
  • Local AAA
  • Remote AAA with TACACS+
  • Remote AAA with RADIUS
  • RADIUS dynamic authorization
  • PKI
  • Captive portal (RADIUS)
  • Enhanced security
  • Auditors and auditing tasks
  • Port access commands
  • Port security
  • Fault Monitor


This guide provides information on configuring SNMP on AOS-CX. Information on the MIBs available on AOS-CX is also provided.

Virtual Switching Framework (VSF) Guide

Virtual Switching Framework, or VSF, defines a virtual switch, comprising multiple individual physical switches, interconnected through standard Ethernet links. VSF applies only to the 6300 Switch Series.

Topics include:

  • Stack management
  • Failure and recovery
  • Configuring a VSF stack
  • VSF restrictions

NOTE: VSF features are available on 6200 and 6300 Switches.

Virtual Switching Extension (VSX) Guide

VSX binds two AOS-CX switches of the same model type to operate as one device for layer 2. VSX also operates as independent nodes for layer 3.

Topics include:

  • Upgrading to the latest version of VSX
  • Setting up the VSX environment
  • Enabling VSX configuration synchronization
  • Monitoring VSX
  • Preventing traffic loss
  • SPT and VSX
  • Loop protect configurations over VSX
  • EVPN VSX support
  • Upstream connectivity
  • Troubleshooting

NOTE: VSX features are available on 6400, 83XX and 10000 Series Switches.


Virtual eXtensible LAN (VXLAN) is a MAC-in-UDP technology that provides layer 2 connectivity between networks across an IP network. VXLAN is typically used to extend layer 2 segments across an entire data center or between remote data centers. It is also used to provide multi-tenant services, where the same IP/MAC addresses or VLANs are used on different network segments.

Topics include:

  • VXLAN configuration
  • Static VXLAN
  • VXLAN scenarios
  • Hardware switch controller (HSC)

NOTE: The VXLAN features are is available on 6200, 6300, 6400, 8325, 8360, 8400, and 10000 Series switches