{"info":{"_postman_id":"52a5a547-19dd-4852-b380-26bd1ad16b2a","name":"ArubaOS 8 Controller","description":"

Aruba OS 8 Controller REST API Collection:

Author Brent Van Doorn bvd@hpe.com

v2 19 API's included.

Updated 6/4/2020 -- Show Commands added to Collect Operational Access Point Stats.

** Please note all operations do not take effect on the controller until the Write Memory API Call is performed. **

Controller Operations:

1. Login to the Controller\n2. Log out of the Controller\n3. Write Memory - Save Config\n4. Enable SSID\n5. Disable SSID\n6. Configure a new AP Group\n7. Add a WLAN to an AP Group\n8. Remove WLAN from an AP Group\n9. Add a new Layer 2 VLAN\n10. Enable Client Isolation on a WLAN\n11. Disable Client Isolation on a WLAN\n12. Hide SSID from Broadcasting for a WLAN\n13. Enable Broadcasting of an SSID (Disable hide)\n14. Enable and Configure WPA2 PSK and set a passphrase\n15. Disable WPA2 and the passphrase\n16. Change the ESSID Name\n    17. Show AP Image Version\n    18. Show AP Active\n    19. Show AP Associated\n

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2980877","collectionId":"52a5a547-19dd-4852-b380-26bd1ad16b2a","publishedId":"SVYouLCo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-08-01T23:59:52.000Z"},"item":[{"name":"ArubaOS 8 Login","event":[{"listen":"test","script":{"id":"1cc721da-762d-4e89-89fb-c94eaf531781","exec":["var uidaruba = postman.getResponseCookie(\"SESSION\").value;\r","pm.globals.set(\"UIDARUBA\", uidaruba);"],"type":"text/javascript"}}],"id":"58957208-eb6d-47ba-a9e8-a992375e5b53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"username","value":"{{USERNAME}}","description":"

Admin or API username on the Controller

\n","type":"text"},{"key":"password","value":"{{PASSWORD}}","description":"

Password used to login the Controller

\n","type":"text"}]},"url":"https://{{CONTROLLERIP}}:4343/v1/api/login","description":"

Initial Login and Cookie store

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","api","login"],"host":["{{CONTROLLERIP}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"58957208-eb6d-47ba-a9e8-a992375e5b53"},{"name":"ArubaOS 8 Logout","id":"b1c8cae8-8fde-4020-aa4e-70491bd82faa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://{{CONTROLLERIP}}:4343/v1/api/logout","description":"

Log out of controller

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","api","logout"],"host":["{{CONTROLLERIP}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b1c8cae8-8fde-4020-aa4e-70491bd82faa"},{"name":"Write Memory (Save Config)","id":"832cfa50-df36-4038-8c9f-2739fc933f8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/write_memory?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Save the Controller Configuration

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","object","write_memory"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"config_path","value":"%2Fmm%2Fmynode"},{"description":{"content":"

Session Cookie for Authorization

\n","type":"text/plain"},"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"832cfa50-df36-4038-8c9f-2739fc933f8e"},{"name":"Enable SSID","id":"0f52178f-e2d5-418a-ad31-a5a8e8471738","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"profile-name\": \"[[VAP_NAME]]\",\n \"vap_enable\": {\n \"_action\": \"add\"\n }\n}"},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/virtual_ap?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Enable SSID on the virtual AP

*** [[VAP_NAME]] *** set the value to the name of your virtual AP.

Session Cookie used for Authorization

\n","type":"text/plain"},"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"0f52178f-e2d5-418a-ad31-a5a8e8471738"},{"name":"Disable SSID","id":"8b3b1bd6-6cd8-4ff4-906d-b71efe844cbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"profile-name\": \"[[VAP_NAME]]\",\r\n\t\"vap_enable\": {\r\n\t\t\"_action\": \"delete\"\r\n\t}\r\n}"},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/virtual_ap?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Disable SSID on the virtual AP

*** [[VAP_NAME]] *** set the value to the name of your virtual AP.

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","object","virtual_ap"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"config_path","value":"%2Fmm%2Fmynode"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"8b3b1bd6-6cd8-4ff4-906d-b71efe844cbd"},{"name":"Configure AP Group","id":"94a0ad30-a39b-415b-bf83-1672ba8ba364","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"profile-name\": \"[[AP_GROUP_NAME]]\",\r\n\t\"_action\": \"add\"\r\n}"},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/ap_group?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Add a new AP Group to the Aruba Controller

*** [[AP_GROUP_NAME]] *** set the value to the name of your AP Group.

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","object","ap_group"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"config_path","value":"%2Fmm%2Fmynode"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"94a0ad30-a39b-415b-bf83-1672ba8ba364"},{"name":"Add WLAN (virtual ap) to AP Group","id":"9562200a-57cc-4945-8db5-3deaffdebb73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"profile-name\": \"[[AP_GROUP_NAME]]\",\r\n\t\"virtual_ap\": [{\r\n\t\t\"profile-name\": \"[[VAP_NAME]]\"\r\n\t}]\r\n}"},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/ap_group?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Add a new Virtual_AP which contains a WLAN SSID to an AP Group

Two Values Required:

*** [[VAP_NAME]] *** set the value to the name of your virtual AP.

*** [[AP_GROUP_NAME ]] *** set the value to the name of your AP Group.

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","object","ap_group"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"config_path","value":"%2Fmm%2Fmynode"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"9562200a-57cc-4945-8db5-3deaffdebb73"},{"name":"Remove WLAN (virtual ap) from AP Group","id":"156193d8-8326-465b-b2ad-1a347502ec80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"profile-name\": \"[[AP_GROUP_NAME]]\",\r\n\t\"virtual_ap\": [{\r\n\t\t\"profile-name\": \"[[VAP_NAME]]\",\r\n\t\t\"_action\": \"delete\"\r\n\t}]\r\n}"},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/ap_group?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Remove the WLAN from the AP Group

Two Values Required:

*** [[VAP_NAME]] *** set the value to the name of your virtual AP.

*** [[AP_GROUP_NAME ]] *** set the value to the name of your AP Group.

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","object","ap_group"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"config_path","value":"%2Fmm%2Fmynode"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"156193d8-8326-465b-b2ad-1a347502ec80"},{"name":"Add a new L2 VLAN","id":"dc5771d8-fa2c-40c6-9ad2-a2bb101a78a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"id\": 50,\r\n\t\"vlan_id__descr\": {\r\n\t\t\"descr\": \"new_vlan50\"\r\n\t}\r\n}"},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/vlan_id?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Add a new VLAN ID to the controller, VLAN id is a number.

Two Values Required:

*** \"id\": 20 *** set the numeric value of the VLAN.

*** [[VLAN_DESCRIPTION ]] *** set the value to the VLAN Description

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","object","vlan_id"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"config_path","value":"%2Fmm%2Fmynode"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"dc5771d8-fa2c-40c6-9ad2-a2bb101a78a4"},{"name":"Enable Client Isolation (Deny Inter-user-Traffic)","id":"5f07fe53-d143-44fd-8d65-d138a872474a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"profile-name\": \"MAC-Auth-SS\",\r\n\t\"deny_vap_inter_user_traffic\": {\r\n\t\t\"_action\": \"add\"\r\n\t}\r\n}"},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/virtual_ap?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Enable Client Isolation, to deny users from talking to each other on the same network

*** [[VAP_NAME]] *** set the value to the name of your virtual AP you want to modify.

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","object","virtual_ap"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"config_path","value":"%2Fmm%2Fmynode"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"5f07fe53-d143-44fd-8d65-d138a872474a"},{"name":"Disable Client Isolation (Deny Inter-user-Traffic)","id":"266b46ea-103f-48de-b10f-64b5e80466e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"profile-name\": \"[[VAP_NAME]]\",\r\n\t\"deny_vap_inter_user_traffic\": {\r\n\t\t\"_action\": \"delete\"\r\n\t}\r\n}"},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/virtual_ap?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Disable Client Isolation, allow users to communicate on same WLAN/LAN.

*** [[VAP_NAME]] *** set the value to the name of your virtual AP you want to modify.

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","object","virtual_ap"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"config_path","value":"%2Fmm%2Fmynode"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"266b46ea-103f-48de-b10f-64b5e80466e3"},{"name":"Hide SSID (Disable Broadcasting)","id":"05632ea8-68a3-455f-bc32-afd3297c8a26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"profile-name\": \"[[VAP_NAME]]\",\r\n\t\"hide_ssid\": {\r\n\t\t\"_action\": \"add\"\r\n\t}\r\n}"},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/ssid_prof?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Hide the SSID from beacons, still visible in client probe requests.

*** [[VAP_NAME]] *** set the value to the name of your virtual AP you want to modify.

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","object","ssid_prof"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"config_path","value":"%2Fmm%2Fmynode"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"05632ea8-68a3-455f-bc32-afd3297c8a26"},{"name":"Enable Broadcasting (Remove Hide SSID)","id":"1115d445-7771-4c11-a728-cd311753e8ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"profile-name\": \"MAC-Auth-SS\",\r\n \"hide_ssid\": {\r\n\t\t\"_action\": \"delete\"\r\n\t}\r\n}"},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/ssid_prof?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Enable SSID Broadcasting, SSID visible in WLAN Beacon frame

*** [[VAP_NAME]] *** set the value to the name of your virtual AP you want to modify.

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","object","ssid_prof"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"config_path","value":"%2Fmm%2Fmynode"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"1115d445-7771-4c11-a728-cd311753e8ea"},{"name":"Enable WPA2 PSK and Set a Passphrase","id":"090d6b61-a9d0-4c63-b3a0-61bc8c909a33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"profile-name\": \"MAC-Auth-SS\",\r\n\t\"opmode\": {\r\n\t\t\"wpa2-psk-aes\": true\r\n\t},\r\n\t\"wpa_passphrase\": {\r\n\t\t\"wpa-passphrase\": \"mypassword123\"\r\n\t}\r\n}"},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/ssid_prof?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Configure WPA2 PSK with AES encryption, and set the password/passphrase to access the WLAN.

Two Values Required:

*** [[VAP_NAME]] *** set the value to the name of your virtual AP.

*** [[WPA_PASSPHRASE ]] *** set the value to the PSK.

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","object","ssid_prof"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"config_path","value":"%2Fmm%2Fmynode"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"090d6b61-a9d0-4c63-b3a0-61bc8c909a33"},{"name":"Disable WPA2 Enable Open SSID (no password)","id":"ce4130c5-ddaa-4fa2-9ecd-68ea54428ade","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"profile-name\": \"MAC-Auth-SS\",\r\n\t\"opmode\": {\r\n\t\t\"opensystem\": true\r\n\t}\r\n}"},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/ssid_prof?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Remove WPA2 PSK Auth requirements, no authenticaiton or encryption.

*** [[VAP_NAME]] *** set the value to the name of your virtual AP.

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","object","ssid_prof"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"config_path","value":"%2Fmm%2Fmynode"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"ce4130c5-ddaa-4fa2-9ecd-68ea54428ade"},{"name":"Change ESSID Name","id":"4777150b-39b5-4e26-9466-13d96dda79a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"profile-name\": \"MAC-Auth-SS\",\r\n\t\"essid\": {\r\n\t\t\"essid\": \"mac-authNew\"\r\n\t}\r\n}"},"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/object/ssid_prof?config_path=%2Fmm%2Fmynode&UIDARUBA={{UIDARUBA}}","description":"

Change the Broadcasted SSID Name.

Two Values Required:

*** [[VAP_NAME]] *** set the value to the name of your virtual AP.

*** [[ESSID_NAME]] *** set the name of the ESSID

ArubaOS 8 Show Command

Show AP Image Version

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","showcommand"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"command","value":"show ap image version"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"d9a4772c-646e-4e74-bc06-423a9cab0b28"},{"name":"Show AP Active","id":"5eaa992d-dae8-4d41-81da-a486dad065a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/showcommand?command=show ap active&UIDARUBA={{UIDARUBA}}","description":"

Shows:\nAccess Point Name\nAccess Point IP\nUptime\nRadio Band Details\nClient Count

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","showcommand"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"command","value":"show ap active"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"5eaa992d-dae8-4d41-81da-a486dad065a3"},{"name":"Show AP Associated","id":"76468d87-bdaf-4cd9-a915-3a2ed9983e06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{CONTROLLERIP}}:4343/v1/configuration/showcommand?command=show ap association&UIDARUBA={{UIDARUBA}}","description":"

Shows AP Associated Client details

\n","urlObject":{"protocol":"https","port":"4343","path":["v1","configuration","showcommand"],"host":["{{CONTROLLERIP}}"],"query":[{"key":"command","value":"show ap association"},{"key":"UIDARUBA","value":"{{UIDARUBA}}"}],"variable":[]}},"response":[],"_postman_id":"76468d87-bdaf-4cd9-a915-3a2ed9983e06"}],"event":[{"listen":"prerequest","script":{"id":"a6c97e7d-de7b-41be-b816-f840ab342246","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e36078f5-9f0e-4c6f-a58f-bf2247691857","type":"text/javascript","exec":[""]}}]}