Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Switch Port Mapper

Examples

Return data from an SPM file.

https://{server}/api-spm?password={pw};filename={file}

Options:

FilenameDescriptionOutput Format (CSV)
arpARP Tablesepoch,ipaddress,mac
ip2macIP to MAC mappingepoch,mac,ipaddress
mac2ipMAC to IP mappingepoch,mac,ipaddress
mac2spMAC to Switch Port mappingepoch,mac,switch,port
mac2vspaMAC to Vendor, Switch, Port, IP Addressmac,vendor,switch,port,ipaddress
sp2macSwitch Port to MACswitch,port,mac
sp2vlanSwitch Port to VLANepoch,switch,port,vlan,id
vlan2spVLAN to Switch Portepoch,vlan,switch,port
vlansList of all VLANsvlan

Return search results on one/multiple MAC addresses.

https://{server}/api-spm?password={pw};mac={MAC1,MAC2,...}

Activate the Switch Port Mapper web API:

Go to Admin > API > Web API Settings.

Click the Switch Port Mapper option On.

Click Save.

User api-ro is required.

Switch Port Mapper data is stored in CSV format. You can access it via:

  • the command console
  • system log viewer (Go to Admin > System > System Log Viewer)
  • web API

CSV output

FilenameDescriptionOutput format (CSV)
arpARP tablesepoch,ipaddress,mac
ip2macIP to MAC mappingepoch,mac,ipaddress
mac2ipMAC to IP mappingepoch,mac,ipaddress
mac2spMAC to switch interface mappingepoch,mac, switch,port
mac2vspaMAC to vendor, switch, interface,IP addressmac,vendor,switch,port,ipaddress
sp2macswitch interface to MACswitch,port,mac
sp2vlanswitch interface to VLANepoch,switch, port,vlan
vlan2spVLAN to switch interfaceepoch,vlan, switch,port
vlanslist of all VLANsvlan