`WLAN`

Manage XGS4 WLAN

WLAN (CAPWAP) offload: WLAN ports, clients, tunnel initiators and multicast groups. The built-in help starts with “Only for XGS4 devices”. This feature belongs to older Triumph chips. On Trident 3 the commands fail with Feature unavailable followed by Failed to execute the diagnostic command. Error: Operation failed. SONiC does not use it.

All words before the Key=<value> arguments must be written out in full; case does not matter. An unknown command prints Error:Unknown WLAN command <n>.

port get|show, client get|show, tunnel initiator get and options are safe. Everything else changes SDK state.

Unvalidated

drivshell> wlan options Type=TUNNEL

wlan init

Initialise the WLAN module. On failure it prints WLAN_CLI: Error: bcm_wlan_init failed, <reason>. wlan detach tears it down.

Unvalidated

drivshell> wlan init

wlan options Type=<PORT | CLIENT | TUNNEL>

List the flag names used by the other sub-commands. Safe.

Unvalidated

drivshell> wlan options Type=PORT

wlan port show

Walk and print all WLAN ports. wlan port get Port=<wlan_port_id> shows one. Safe.

Hardware-validated

drivshell> wlan port show
WLAN_CLI: Error: bcm_wlan_port_traverse failed, Feature unavailable

Failed to execute the diagnostic command. Error: Operation failed.

wlan port add Port=<wlan_port> PhysPort=<port> [FLaGs=<flags>] [IntfCLass=<class>] [BSSid=<bssid>] [RadioID=<radio_id>] [MatchTunnel=<tunnel_id>] [EgressTunnel=<tunnel_id>] [EgressClientMultiCast=<bitmap>]

Add a WLAN port. The built-in help shows BSSid<bssid>; write BSSid=<bssid>. wlan port delete Port=<id> and wlan port clear (all ports) remove ports.

Unvalidated

drivshell> wlan port clear

wlan client show

Walk and print all WLAN clients. wlan client get MAC=<mac> shows one. Safe.

Hardware-validated

drivshell> wlan client show
WLAN_CLI: Error: bcm_wlan_client_traverse failed, Feature unavailable

Failed to execute the diagnostic command. Error: Operation failed.

wlan client add WlanPort=<wlan_port_id> MAC=<mac> [FLaGs=<flags>] [HomeAgent=<gport>] [WTP=<gport>]

Add a WLAN client. wlan client delete MAC=<mac> and wlan client clear remove clients.

Unvalidated

drivshell> wlan client delete MAC=00:00:5e:00:53:01

wlan tunnel initiator get TunnelID=<tid>

Show a CAPWAP tunnel initiator. Safe. The error message prints the tunnel ID as -1 whatever TunnelID you give.

Hardware-validated

drivshell> wlan tunnel initiator get TunnelID=1
ERROR WLAN: getting tunnel initiator for -1 Feature unavailable

Failed to execute the diagnostic command. Error: Operation failed.

wlan tunnel initiator create TYpe=<type> DIP=<ip> SIP=<ip> [FLaGs=<flags>] [TTL=<ttl>] [DstMac=<mac>] [DIP6=<ip6>] [SIP6=<ip6>] [DSCPSel=<n>] [DSCPV=<n>] [DFSEL4=<n>] [DFSEL6=<n>] [DSCPMap=<id>] [TunnelID=<tid>] [L4DstPort=<port>] [L4SrcPort=<port>] [SrcMac=<mac>] [MTU=<mtu>] [VID=<vid>] [TPID=<tpid>] [PktPri=<pri>] [PktCfi=<cfi>] [Ipv4ID=<n>]

Create a CAPWAP tunnel initiator. The built-in help shows L4SrcPort<port>; write L4SrcPort=<port>. wlan tunnel initiator destroy TunnelID=<tid> deletes it.

Unvalidated

drivshell> wlan tunnel initiator destroy TunnelID=1

wlan mcast group create [l2 | wlan] McastGroup=<mcast_group>

Create a multicast group. The other forms are wlan mcast group delete McastGroup=<id>, wlan mcast group port add|delete McastGroup=<id> WlanPort=<wlan_port_id> and wlan mcast group addr McastGroup=<id> Mac=<mac> VLAN=<vid>.

Unvalidated

drivshell> wlan mcast group create wlan McastGroup=10

Built-in help

Only for XGS4 devices.
      wlan init
            - Init WLAN software system.
      wlan detach
            - Detach WLAN software system.
      wlan port add Port=<Wlan_port> PhysPort=<port>
                    FLaGs=<flags> IntfCLass=<class>
                    BSSid<bssid> RadioID=<radio_id>
                    MatchTunnel=<tunnel_id> EgressTunnel=<tunnel_id>
                    EgressClientMultiCast=<client_mc_bitmap>
            - Add a WLAN port.
      wlan port delete Port=<wlan_port_id>
            - Delete a WLAN port.
      wlan port clear
            - Delete all WLAN ports.
      wlan port get Port=<wlan_port_id>
            - Display a WLAN port information.
      wlan port show
            - Traverse all WLAN ports.
      wlan client add FLaGs=<flags> WlanPort=<Wlan_port_id>
                    MAC=<client_mac_addr> HomeAgent=<home_agent_gport>
                    WTP=<access_point_gport>
            - Add a WLAN client.
      wlan client delete MAC=<client_mac>
            - Delete a WLAN client.
      wlan client clear
            - Delete all WLAN clients.
      wlan client get MAC=<client_mac>
            - Display a WLAN client information.
      wlan client show
            - Traverse all WLAN clients.
      wlan mcast group create [l2|wlan] McastGroup=<mcast_group>
            - Create a multicast group.
      wlan mcast group delete McastGroup=<mcast_group>
            - Delete a multicast group.
      wlan mcast group port add McastGroup=<mcast_type_id>
                                WlanPort=<wlan_port_id>
            - Add WLAN port to multicast group.
      wlan mcast group port delete  McastGroup=<mcast_type_id>
                                    WlanPort=<wlan_port_id>
            - Delete WLAN port from multicast group
      wlan mcast group addr McastGroup=<mcast_type_id>
                            Mac=<mcast mac> VLAN=<vlan_id>
            - Add multicast group Mac address.
      wlan tunnel initiator create FLaGs=<flags> TYpe=<type> TTL=<ttl>
                                   DstMac=<mac> DIP=<ip> SIP=<ip>
                                   DIP6=<ip6> SIP6=<ip6> DSCPSel=<num>
                                   DSCPV=<val> DFSEL4=<num> DFSEL6=<num>
                                   DSCPMap=<mapID> TunnelID=<tid>
                                   L4DstPort=<port> L4SrcPort<port>
                                   SrcMac=<mac> MTU=<mtu> VID=<vid>
                                   TPID=<tpid> PktPri=<pri> PktCfi=<cfi>
                                   Ipv4ID=<val>
            - Create a WLAN (CAPWAP) tunnel initiator.
      wlan tunnel initiator destroy TunnelID=<tid>
            - Destroy a WLAN (CAPWAP) tunnel initiator.
      wlan tunnel initiator get TunnelID=<tid>
            - Get a WLAN (CAPWAP) tunnel initiator.
      wlan options Type=[PORT|CLIENT|TUNNEL]
            - List various options/flags used in wlan commands.

WLAN

`WLAN`