About the ArubaOS-CX 10.04 Documentation

The ArubaOS-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 ArubaOS-CX suite.

Links to the ArubaOS-CX documentation can be found in the Aruba Support Portal at asp.arubanetworks.com/downloads.

ArubaOS-CX manuals Content
Command-Line Interface Guide

This document contains reference information for the CLI commands for the ArubaOS-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 ArubaOS-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

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 ArubaOS-CX. Topics include:

  • Debug logging

  • Log rotation

  • Finding events

  • Switch system and hardware commands

  • Supportability copy

  • Traceroute

  • Ping

  • Remote syslog

  • Runtime diagnostics

  • ServiceOS

  • In-System programming

  • Selftest

  • Zeroization

  • Troubleshooting Web UI and REST API access issues

Fundamentals Guide

This document contains information for getting started with the ArubaOS-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

  • Layer 2/3 interfaces

  • VLANs

  • Configuration and firmware management

  • User-based tunneling (6xxx Switch Series only)

  • SNMP

  • CoPP

  • Port filtering

  • DNS

  • Device discovery and configuration

  • DCBx (8325 Switch Series only)

  • Zero Touch Provisioning

  • Switch system and hardware commands

High Availability Guide

This document contains information about the high availability functionality of the ArubaOS-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 Web UI Guide

This document provides an introduction to the ArubaOS-CX Web UI. 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 ArubaOS-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)

  • Ethernet VPN (EVPN) over VXLAN (6300, 6400, and 8325 Switch Series only)

  • 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 Services Guide

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

This guide includes:

  • IRDP

  • IPv6 router advertisement

  • sFlow

  • DHCP

  • DHCP snooping (6300, 6400, 8400 Switch Series only)

  • ND Snooping (6300, 6400 Switch Series only)

  • IP source lockdown (6300, 6400, 8400 Switch Series only)

  • IP tunnels

  • Internet Control Message Protocol (ICMP)

  • DNS

  • ARP

Layer 2 Bridging Guide

This document contains information for configuring layer 2 bridging with the ArubaOS-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 ArubaOS-CX network operating system.

This guide includes:

  • Member, slot, and port notation (6xxx and 8400 Switch Series only)

  • Monitoring hardware through visual observation

  • LEDs

  • Boot commands

  • Switch system hardware commands

  • External storage

  • Mirroring

  • Monitoring the device using SNMP

  • IP-SLA

  • Power over Ethernet (6xxx Switch Series only)

  • AirWave

Multicast Guide

This document contains information about multicast functionality of the ArubaOS-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)

Network Analytics Engine Guide

This document describes the ArubaOS-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 ArubaOS-CX.

REST API Guide

These guides (one for v1 and one for v10.04) describe the ArubaOS-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:

  • Enabling access to the REST API

  • Ways to access

  • GET method usage and considerations

  • Write methods (POST, PUT, and DELETE)

  • VSX peer-switches and RESTP API access

  • Real-time notifications subsystem

  • HTTPS server commands

  • REST API response codes

  • Troubleshooting

Security Guide

This document contains information about authentication for the ArubaOS-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 (6xxx Switch Series only)

  • PKI

  • Enhanced security

  • Auditors and auditing tasks

  • Port access commands (6xxx Switch Series only)

SNMP/MIB Guide

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

Virtual Switching Extension (VSX) Guide

VSX binds two ArubaOS-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

  • Upstream connectivity

  • Troubleshooting

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:

  • Console connection to VSF member switch

  • Failure and recovery

  • Configuring a VSF stack

  • VSF restrictions

VXLAN Guide

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

  • VXLAN scenarios

  • Hardware switch controller (HSC)