HPE ArubaOS-Switch REST API and JSON Schema Reference Guide 16.03

Transcription

1 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide Par Number: Published: January 2017 Ediion: 1

2 Conens Chaper 1 Abou his documen...5 Chaper 2 REST API... 6 Overview REST... 6 Commands...6 res-inerface... 6 [no] res-inerface... 7 Validaion rules... 8 res-inerface session-idle-imeou... 8 Show commands... 8 show res inerface... 8 Resricions... 9 JSON Schema... 9 Use case login-sessions...9 Use case auhenicaion failure... 9 Use case creaing a VLAN Use case feching he VLAN...10 Use case logou of session...11 debug res-inerface Chaper 3 Common elemen lis Service ACL Service DebugLog Service DeviceManagemenUser Service Dns...15 Service Do1xSupplicanPor Service FileTransfer...16 Service IpAddressSubne Service IpRoue Service Lldp Service ResLoginSessions Service Ping...19 Service Por Service Qos Service ResSessionIdleTimeou Service Sysem Service TraceRoue Service VlanPor Service Vlan...27 Chaper 4 Server elemen lis...28 Service Accouning Service AclPor Service AclVlan...29 Service Auhenicaion Service Auhorizaion Service DhcpRelay Conens 2

3 Service DhcpRelayVlan Service DhcpServerPool...32 Service DhcpServer Service Do1xAuhenicaorPor...33 Service Do1x...34 Service Dsnoop...34 Service Igmp Service IncludeCredenials Service Lacp Service LocaorLedBlink Service MacAuhenicaionPor...36 Service MacAuhenicaion Service MacTable...37 Service Msp Service Oobm Service Poe...39 Service PorMirrorSession Service QosPor...42 Service QosVlan Service RedundancyManagemen...43 Service SwichSysem Service Transceiver Service Trunk...44 Chaper 5 Suppor and oher resources Accessing Hewle Packard Enerprise Suppor Accessing updaes...46 Cusomer self repair...46 Remoe suppor Warrany informaion...47 Regulaory informaion...47 Documenaion feedback Conens 3

4 2017 Hewle Packard Enerprise Developmen LP Noices The informaion conained herein is subjec o change wihou noice. The only warranies for Hewle Packard Enerprise producs and services are se forh in he express warrany saemens accompanying such producs and services. Nohing herein should be consrued as consiuing an addiional warrany. Hewle Packard Enerprise shall no be liable for echnical or ediorial errors or omissions conained herein. Confidenial compuer sofware. Valid license from Hewle Packard Enerprise required for possession, use, or copying. Consisen wih FAR and , Commercial Compuer Sofware, Compuer Sofware Documenaion, and Technical Daa for Commercial Iems are licensed o he U.S. Governmen under vendor's sandard commercial license. Links o hird-pary websies ake you ouside he Hewle Packard Enerprise websie. Hewle Packard Enerprise has no conrol over and is no responsible for informaion ouside he Hewle Packard Enerprise websie. Acknowledgmens Inel, Ianium, Penium, Inel Inside, and he Inel Inside logo are rademarks of Inel Corporaion in he Unied Saes and oher counries. Microsof and Windows are eiher regisered rademarks or rademarks of Microsof Corporaion in he Unied Saes and/or oher counries. Adobe and Acroba are rademarks of Adobe Sysems Incorporaed. Java and Oracle are regisered rademarks of Oracle and/or is affiliaes. UNIX is a regisered rademark of The Open Group. Warrany informaion To view he warrany for your produc, see he Safey and Compliance Informaion for Server, Sorage, Power, Neworking, and Rack Producs documen, available a he Hewle Packard Enerprise Suppor Cener: Addiional warrany informaion HPE ProLian and x86 Servers and Opions HPE Enerprise Servers HPE Sorage Producs HPE Neworking Producs

5 Chaper 1 Abou his documen This swich sofware guide is inended for nework adminisraors and suppor personnel, and applies o all swich families. This guide does no provide informaion abou upgrading or replacing swich hardware. The informaion in his guide is subjec o change wihou noice. Applicable Producs Aruba 2530 Swich Series (J9772A, J9773A, J9774A, J9775A, J9776A, J9777A, J9778A, JL070A, J9853A, J9854A, J9855A, J9779A, J9780A, J9781A, J9782A, J9783A) Aruba 2540 Swich Series (JL354A, JL355A, JL356A, JL357A) Aruba 2620 Swich Series (J9623A, J9624A, J9625A, J9626A, J9627A) Aruba 2920 Swich Series (J9836A, J9726A, J9727A, J9728A, J9729A) Aruba 2930F Swich Series (JL253A, JL254A, JL255A, JL256A, JL258A, JL259A, JL260A, JL261A, JL262A, JL263A, JL264A) Aruba 3800 Swich Series (J9573A, J9574A, J9575A, J9576A, J9584A) Aruba 3810 Swich Series (JL071A, JL072A, JL073A, JL074A, JL075A, JL076A) Aruba 5400R zl2 Swich Series (J9821A, J9822A, J9850A, J9851A, JL001A, JL002A, JL003A, JL095A) Chaper 1 Abou his documen 5

6 Chaper 2 REST API Overview REST Represenaional Sae Transfer (REST) is a sofware archiecure syle consising of guidelines and bes pracices for creaing scalable web services. RESTful sysems ypically communicae over HTTP using he same verbs (ha is,,, UT, DELETE) used by web browsers. The REST server lisens for requess from cliens on por 80( HTTP) and por 443 ( HTTPs ). The REST service conex is "/res" followed by REST version. For example, hp:// /res/v1.0. REST requess also maybe sen on he HTTPS por (443). More informaion The REST inerface is enabled by defaul. Web managemen or web managemen SSL mus be enabled. If web managemen is disabled, requess will no be processed, irrespecive of he REST inerface saus. REST requess may also be sen o a swich hrough an OOBM por. JSON Schema and REST API documenaion for X xxxx sofware: JSON Schema X xxxx JSON Schema X xxxx JSON Schema X xxxx Commands res-inerface From wihin he configure conex: Synax Descripion res-inerface Enables he REST inerface. WEB managemen or web managemen SSL mus be enabled o process he REST requess. If WEB managemen is disabled, he REST requess will no be processed even hough he REST inerface is enabled. show res-inerface HP G-PoEP# show res-inerface REST Inerface - Server Configuraion REST Inerface : Enabled REST Operaional Saus : Up REST Session Idle Timeou : 600 seconds HTTP Access : Enabled HTTPS Access : Disabled 6 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

7 [no] web-managemen HP G-PoEP(config)# no web-managemen HP G-PoEP(config)# show res-inerface REST Inerface - Server Configuraion REST Inerface : Enabled REST Operaional Saus : Down HTTP Access : Disabled HTTPS Access : Disabled [no] res-inerface Synax [no] res-inerface Descripion Disables he REST-inerface. Enable res-inerface Aruba G-4SFPP(config)# res-inerface Aruba G-4SFPP(config)# show res-inerface REST Inerface - Server Configuraion REST Inerface : Enabled REST Operaional Saus : Up REST Session Idle Timeou : 600 seconds HTTP Access : Enabled HTTPS Access : Disabled Disable res-inerface HP G-PoEP(config)# no res-inerface HP G-PoEP(config)# show res-inerface REST Inerface - Server Configuraion REST Inerface : Disabled REST Operaional Saus : Down HTTP Access : Enabled HTTPS Access : Disabled Chaper 2 REST API 7

8 Validaion rules Validaion REST inerface is disabled and a REST reques is sen on HTTP por for processing. Boh REST and WEB managemen are enabled. An aemp is made o disable web-managemen. Boh REST and WEB managemen are disabled; an aemp is made o enable he REST inerface. If redirecion of he REST reques fails from HTTP If here is no response from REST server for abou 2 mins Error/Warning/Promp The REST inerface is disabled and requess canno be processed. The REST requess canno be processed when WEB managemen is disabled. The REST requess canno be processed because WEB managemen is disabled. Enable WEB managemen for he REST inerface o be operaional. Redirecion of he REST reques o he REST server failed No response from he REST server res-inerface session-idle-imeou Synax res-inerface session-idle-imeou <SECONDS> Descripion Configure session-idle-imeou for he REST inerface sessions. The configurable value range is from 120 o 7200 seconds wih he defaul value a 600 seconds. Usage [no] res-inerface session-idle-imeou Ses he session-idle-imeou o he defaul value. Show commands show res inerface Synax Descripion show res inerface The REST operaional saus will be shown as Up only when he REST inerface is enabled and eiher Web managemen or Web managemen SSL is enabled. HTTP access is enabled when Web managemen is enabled. HTTPS access is enabled when Web managemen SSL is enabled. 8 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

9 show res-inerface Aruba G-PoEP# show res-inerface REST Inerface - Server Configuraion REST Inerface : Enabled REST Operaional Saus : Up REST Session Idle Timeou : 600 seconds HTTP Access : Enabled HTTPS Access : Disabled Resricions REST inerface is no suppored in sacking device, including VSF. REST inerface is no suppored in FIPS. JSON Schema JSON/REST API on device configuraion and sae JSON Schema is defining he srucure of JSON daa/api. More informaion JSON Schema and REST API documenaion for X xxxx sofware: JSON Schema Use case login-sessions If a user is configured on he swich, login reques mus be posed o he swich for auhenicaion. If user validaion is successful, he swich reurns a session id as a cookie ha will be used for furher requess. Users are able o creae a maximum of five REST sessions simulaneously. WorkSaion# curl --noproxy X hp:// :80/res/v1/login-sessions -d '{"username":"es", "password":"es"}' Response from he swich when user validaion is successful: { "uri": "/res/v1/login-sessions","cookie": "sessionid=09cg1brut5hkcpzi97mmdjpn4ulsmgkbsaawur9h7gxlkbsiasak1peyj7ov3n" } Use case auhenicaion failure The swich will reurn an error if auhenicaion fails: WorkSaion# curl --noproxy X hp:// :80/res/v1/login-sessions -d '{"username":"es", "password":"es"}' Swich response upon failure: Chaper 2 REST API 9

10 { "message": "Auhenicaion failed." } An operaor may only use he mehod. A manager is suppored for all mehods. Posing a login reques is no required and requess may be sen wihou a cookie if a user name is no configured. Oher failure causes 1. The wrong username/password is sen o creae login sessions. 2. The user is configured and REST requess are sen wihou session id. Use case creaing a VLAN Creaing VLAN using REST: WorkSaion# curl --noproxy cookie "sessionid=09cg1brut5hkcpzi97mmdjpn4ulsmgkbsaawur9h7gxlkbsiasak1peyj7ov3n" -X hp:// :80/res/v1/vlans -d '{"vlan_id":5, "name":"vlan5"} Response from he Swich: { } "uri": "/res/v1/vlans/5", "vlan_id": 5, "name": "VLAN5", "saus": "VS_PORT_BASED", "ype": "VT_STATIC", "is_voice_enabled": false, "is_jumbo_enabled": false, "is_dsnoop_enabled": false Use case feching he VLAN Feching he VLAN deails using REST: WorkSaion# curl --noproxy cookie "sessionid=09cg1brut5hkcpzi97mmdjpn4ulsmgkbsaawur9h7gxlkbsiasak1peyj7ov3n" -X hp:// :80/res/v1/vlans Response from he Swich: { "collecion_resul": { "oal_elemens_coun": 2, "filered_elemens_coun": 2 }, "vlan_elemen": [ { "uri": "/res/v1/vlans/1", "vlan_id": 1, "name": "DEFAULT_VLAN", 10 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

11 } ] "saus": "VS_PORT_BASED", "ype": "VT_STATIC", "is_voice_enabled": false, "is_jumbo_enabled": false, "is_dsnoop_enabled": false }, { "uri": "/res/v1/vlans/5", "vlan_id": 5, "name": "VLAN5", "saus": "VS_PORT_BASED", "ype": "VT_STATIC", "is_voice_enabled": false, "is_jumbo_enabled": false, "is_dsnoop_enabled": false } Use case logou of session Logou of REST session. WorkSaion# curl --noproxy cookie "sessionid=09cg1brut5hkcpzi97mmdjpn4ulsmgkbsaawur9h7gxlkbsiasak1peyj7ov3n" -X DELETE hp:// :80/res/v1/login-sessions The swich will respond wih a message simular o: 204 No Conen. [roo@ubunuserver5224 ~]# curl --noproxy v --cookie "sessionid=8xu2msuzbjbxyclpfyvmaageb4iire6c94qsvyifd3xihelpjgurayox5jjwiuq" -X DELETE hp:// :80/res/v1/login-sessions * Abou o connec() o por 80 (#0) * Trying conneced > DELETE /res/v1/login-sessions HTTP/1.1 > User-Agen: curl/ (x86_64-pc-linux-gnu) libcurl/ OpenSSL/1.0.1 zlib/ libidn/1.23 librmp/2.3 > Hos: > Accep: */* > Cookie: sessionid=8xu2msuzbjbxyclpfyvmaageb4iire6c94qsvyifd3xihelpjgurayox5jjwiuq > < HTTP/ No Conen < Server: ehttp v2.0 < Connecion: keep-alive < RequesId: < * Connecion #0 o hos lef inac * Closing connecion #0 [roo@ubunuserver5224 ~]# debug res-inerface Synax debug res-inerface Enables debug logs for he res-inerface. Chaper 2 REST API 11

12 debug res-inerface HP G(config)# debug res-inerface 0000:00:23:14.01 res Hpd:Received REST reques 0000:00:23:14.08 res Hpd:(hp_sae:)hp_process_pos END 0000:00:23:14.15 res Hpd:REST reques redireced o REST server 0000:00:23:14.22 res Hpd:Send REST reques message o REST conrol ask 0000:00:23:14.30 res Hpd:Hpd is unblocked wih necessary cleanup 0000:00:23:14.38 res mres_crl:reques for parse header 0000:00:23:14.44 res mres_crl:reques for parse header afer mehod 12 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

13 Chaper 3 Common elemen lis Service ACL.../acls CommonElemenLis ACL elemens query..../acls Acl Acl * Adds he given ACL o he model..../acls/{acl.id} Acl Reurns he ACL ID. DELETE.../acls/{Acl.id} Delees he ACL wih he given ID from he model..../acls/{acl.id}/rules CommonElemenLis ACL Rule elemens query..../acls/{aclrule.acl_id}/rules AclRule AclRule * Adds he given ACL Rule o he model..../acls/{aclrule.acl_id}/rules/{aclrule.sequence_no} AclRule Reurns he ACL Rule maching he given ID. Table Coninued Chaper 3 Common elemen lis 13

14 .../acls/{aclrule.acl_id}/rules/{aclrule.sequence_no} AclRule AclRule Updaes he given ACL Rule in he model. DELETE.../acls/{AclRule.acl_id}/rules/{AclRule.sequence_no} Delees he ACL Rule wih he given ID from he model..../acls/{resequencecommand.acl_id}/rules/resequence ResequenceComman d Void Triggers a resequence of ACL Rule elemens based on he given parameers..../acls/rules CommonElemenLis ACL Rule elemens for all ACLs. Service DebugLog.../debug-log/filer DebugLogFilerC ommand DebugLogSas Triggers he filering of debug logs based on he given parameers..../debug-log/saus DebugLogSas Reurns he saus of he debug log filers. 14 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

15 Service DeviceManagemenUser.../managemen-user CommonElemenLi s Managemen User elemens maching he given query..../managemen-user DeviceManagemen User DeviceManagemen User * Adds he given Managemen User o he model..../managemen-user/{devicemanagemenuser.ype} DeviceManagemen User Reurns he Managemen User ID..../managemen-user/{DeviceManagemenUser.ype} DeviceManagemen User DeviceManagemen User Updaes he given Managemen User in he model. DELETE.../managemen-user/{DeviceManagemenUser.ype} Delees he Managemen User wih he given ID from he model. Service Dns.../dns Dns Reurns he hos sysem aribues. Table Coninued Chaper 3 Common elemen lis 15

16 .../dns Service Do1xSupplicanPor Dns Dns Updaes he hos sysem aribues.../do1x/supplican CommonElemenLi s 802.1X Supplican Por elemens query..../do1x/supplican/{do1xsupplicanpor.por_id} Do1xSupplican Por Reurns he 802.1X Supplican Por ID..../do1x/supplican/{Do1xSupplicanPor.por_id} Do1xSupplican Por Do1xSupplican Por Updaes he given 802.1X Supplican Por in he model. Service FileTransfer.../file-ransfer FileTransferCom mand Triggers a file ransfer based on he given parameers. 16 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

17 Service IpAddressSubne.../ipaddresses CommonElemenLi s IP Address Subnes elemens maching he given query..../vlans/{vlan.vlan_id}/ipaddresses CommonElemenLi s Reurns IP Address Subnes for he specified VLAN..../vlans/{IpAddressSubne.vlan_id}/ipaddresses IpAddressSubne IpAddressSubne * Adds he given IP Address Subne in he model. DELETE.../vlans/{Vlan.vlan_id}/ipaddresses Delees IP Address Subnes for he specified VLAN. Service IpRoue.../ip-roue CommonElemenLi s IP Roue elemens query..../ip-roue IpRoue IpRoue * Adds he given IP Roue in he model..../ip-roue/{iproue.id} Table Coninued Chaper 3 Common elemen lis 17

18 IpRoue Reurns he IP Roue ID. DELETE.../ip-roue/ {IpRoue.id} Delees he IP Roue wih he given ID from he model..../ip-roue/seings IpRoueSeings Reurns he global IP Roue seings..../ip-roue/seings IpRoueSeings IpRoueSeings Updaes he global IP Roue seings. Service Lldp.../lldp Lldp Ge LLDP Global Saus.../lldp Lldp Lldp Enable/Disable LLDP Globally.../lldp/local-por CommonElemenLi s Rerieve he complee lis of LLDP Local Por elemens.../lldp/local-por/{lldplocalpor.por_id} LldpLocalPor Ge LLDP Local Por Configuraions Table Coninued 18 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

19 .../lldp/local-por/{lldplocalpor.por_id} Service ResLoginSessions LldpLocalPor LldpLocalPor Se LLDP Local Por Configuraions.../res/v1/login-sessions ResLoginSessio ns ResLoginSessio nsresul * Adds he given Managemen User o he model. DELETE.../res/v1/login-sessions Delees he Managemen User wih he given ID from he model Service Ping.../ping PingCommand PingCommandResu l Triggers a ping based on he given parameers Service Por Service Por.../pors CommonElemenLi s Por elemens query. Table Coninued Chaper 3 Common elemen lis 19

20 .../pors/{por.id} Por Reurns he Por ID..../pors/{Por.id} Por Por Updaes he given Por in he model. Service Qos.../qos/dscp-map CommonCollecio nquery CommonElemenLi s QoS DSCP Map elemens maching he given query..../qos/dscp-map/{qosdscpmap.dscp_value} QosDscpMap QosDscpMap Reurns he QoS DSCP Map maching he given ID..../qos/dscp-map/{QosDscpMap.dscp_value} QosDscpMap QosDscpMap Updaes he given QoS DSCP Map in he model..../qos/policies CommonCollecio nquery CommonElemenLi s QoS Policy elemens query..../qos/policies QosPolicy QosPolicy Adds he given QoS Policy o he model. Table Coninued 20 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

21 .../qos/policies/{qospolicy.id} QosPolicy QosPolicy Reurns he QoS Policy maching he given ID. DELETE.../qos/policies/{QosPolicy.id} Delees he QoS Policy wih he given ID from he model..../qos/policies/{qospolicy.id}/policy-acions QosPolicy CommonElemenLi s QoS Policy Acion elemens maching he given query..../qos/policies/{qospolicyacion.policy_id}/policy-acions QosPolicyAcion QosPolicyAcion Adds he given QoS Policy Acion o he model..../qos/policies/{qospolicyacion.policy_id}/policy-acions/ {QosPolicyAcion.sequence_no} QosPolicyAcion QosPolicyAcion Reurns he QoS Policy Acion ID..../qos/policies/{QosPolicyAcion.policy_id}/policy-acions/ {QosPolicyAcion.sequence_no} QosPolicyAcion QosPolicyAcion Updaes he given QoS Policy Acion in he model. DELETE.../qos/policies/{QosPolicyAcion.policy_id}/policy-acions/ {QosPolicyAcion.sequence_no} Delees he QoS Policy Acion wih he given ID from he model. Table Coninued Chaper 3 Common elemen lis 21

22 .../qos/policies/{resequencecommand.policy_id}/policy-acions/resequence ResequenceComma nd Void Triggers a resequence of QoS Policy Acion elemens based on he given parameers..../qos/raffic-classes CommonCollecio nquery CommonElemenLi s QoS Traffic Class elemens maching he given query..../qos/raffic-classes QosTrafficClass QosTrafficClass Adds he given QoS Traffic Class o he model..../qos/raffic-classes/{qostrafficclass.id} QosTrafficClass QosTrafficClass Reurns he QoS Traffic Class ID. DELETE.../qos/raffic-classes/{QosTrafficClass.id} Delees he QoS Traffic Class wih he given ID from he model..../qos/raffic-classes/{qostrafficclass.id}/maches QosTrafficClass CommonElemenLi s QoS Class Mach elemens maching he given query..../qos/raffic-classes/{qosclassmach.raffic_class_id}/maches Table Coninued 22 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

23 QosClassMach QosClassMach Adds he given QoS Class Mach o he model..../qos/raffic-classes/{qosclassmach.raffic_class_id}/maches/ {QosClassMach.sequence_no} QosClassMach QosClassMach Reurns he QoS Class Mach ID..../qos/raffic-classes/{QosClassMach.raffic_class_id}/maches/ {QosClassMach.sequence_no} QosClassMach QosClassMach Updaes he given QoS Class Mach in he model. DELETE.../qos/raffic-classes/{QosClassMach.raffic_class_id}/maches/ {QosClassMach.sequence_no} Delees he QoS Class Mach wih he given ID from he model..../qos/raffic_classes/{resequencecommand.raffic_class_id}/maches/resequence ResequenceComma nd Void Triggers a resequence of QoS Class Mach elemens based on he given parameers. Service ResSessionIdleTimeou.../res/v1/session-idle-imeou ResSessionIdle Timeou Reurns he Managemen User ID. Table Coninued Chaper 3 Common elemen lis 23

24 .../res/v1/session-idle-imeou/{ressessionidletimeou.ype} ResSessionIdle Timeou ResSessionIdle Timeou Updaes he given Managemen User in he model. Service Sysem.../sysem SysemAribues Reurns he hos sysem aribues..../sysem SysemAribues SysemAribues Updaes he hos sysem aribues..../sysem/reboo RebooCommand Triggers a sysem reboo based on he given parameers..../sysem/saus SysemInfoSas Reurns he saus of he hos sysem..../sysem/saus/cpu SysemCpuSas Reurns he CPU saus of he hos sysem (no sampling info)..../sysem/saus/memory SysemMemorySas Reurns he memory saus of he hos sysem (no sampling info). Table Coninued 24 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

25 .../sysem/saus/sorage SysemSorageSa s Reurns he memory sorage of he hos sysem (no sampling info)..../sysem/saus/ime SysemTimeSas Reurns he ime saus of he hos sysem..../sysem/ime SysemTime Reurns he hos sysem ime configuraion..../sysem/ime SysemTime SysemTime Updaes he hos sysem ime configuraion..../sysem/ime/server/swap LisElemenSwapCo mmand Triggers a swap of ime server enries based on he given parameers which effecively changes he order on which ime servers are conaced..../sysem/ime/se-manually SeSysemDaeTime Command Ses he sysem dae/ ime based on he given parameers. Chaper 3 Common elemen lis 25

26 Service TraceRoue.../race-roue TraceRoueComma nd TraceRoueComma ndresul Triggers a race roue based on he given parameers. Service VlanPor.../vlans-pors CommonElemenLis VLAN- Por elemens maching he given query..../vlans-pors VlanPor VlanPor * Adds he given VLAN- Por using he specified mode..../vlans-pors/{vlanpor.vlan_id}-{vlanpor.por_id} VlanPor Reurns he VLAN-Por ID..../vlans-pors/{VlanPor.vlan_id}-{VlanPor.por_id} VlanPor VlanPor * Updaes he given VLAN-Por using he specified mode. DELET E.../vlans-pors/{VlanPor.vlan_id}-{VlanPor.por_id} Delees he given VLAN- Por assignmen from he model. 26 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

27 Service Vlan.../vlans CommonElemenLi s VLAN elemens query..../vlans Vlan Vlan * Adds he given VLAN o he model..../vlans/{vlan.vlan_id} Vlan Reurns he VLAN ID..../vlans/{Vlan.vlan_id} Vlan Vlan Updaes he given VLAN in he model. DELETE.../vlans/{Vlan.vlan_id} Delees he VLAN wih he given ID from he model. Chaper 3 Common elemen lis 27

28 Chaper 4 Server elemen lis Service Accouning.../accouning WiredElemenLis Accouning mehods..../accouning Accouning Accouning Adds he given Accouning mehod o he model..../accouning/{accouning.ype} Accouning Reurns he Accouning mehod wih he ype configured on he sysem..../accouning/{accouning.ype} Accouning Accouning Updaes he given Accouning mehod wih he ype in he model. DELETE.../accouning/{Accouning.ype} Delees he Accouning mehod wih he ype from he model. 28 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

29 Service AclPor.../pors-access-groups WiredElemenLis ACL Por Policy elemens maching he given query..../pors-access-groups AclPorPolicy AclPorPolicy Adds he given ACL Por Policy o he model. DELETE.../pors-access-groups/{AclPorPolicy.por_id}-{AclPorPolicy.acl_id}- {AclPorPolicy.direcion} Delees he ACL Por Policy wih he given ID from he model..../pors-access-groups/{aclporpolicy.por_id}-{aclporpolicy.acl_id}- {AclPorPolicy.direcion}/sas AclPorPolicyS as Reurns he ACL saisics for given ACL ID, Por, and Direcion Service AclVlan.../vlans-access-groups WiredElemenLis ACL VLAN Policy elemens maching he given query..../vlans-access-groups AclVlanPolicy AclVlanPolicy Adds he given ACL VLAN Policy o he model. Table Coninued Chaper 4 Server elemen lis 29

30 DELETE.../vlans-access-groups/{AclVlanPolicy.vlan_id}-{AclVlanPolicy.acl_id}- {AclVlanPolicy.direcion} Delees he ACL VLAN Policy wih he given ID from he model..../vlans-access-groups/{aclvlanpolicy.vlan_id}-{aclvlanpolicy.acl_id}- {AclVlanPolicy.direcion}/sas AclVlanPolicyS as Reurns he ACL saisics for given ACL ID, VLAN, and Direcion Service Auhenicaion.../auhenicaion Auhenicaion Reurns he Auhenicaion Aribues configured on he sysem..../auhenicaion Auhenicaion Auhenicaion Updaes he Auhenicaion Aribues in he model. Service Auhorizaion.../auhorizaion WiredElemenLis Auhorizaion mehods..../auhorizaion Table Coninued 30 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

31 Auhorizaion Auhorizaion Adds he given Auhorizaion mehod o he model..../auhorizaion/{auhorizaion.ype} Auhorizaion Reurns he Auhorizaion mehod wih he ype configured on he sysem..../auhorizaion/{auhorizaion.ype} Auhorizaion Auhorizaion Updaes he given Auhorizaion mehod wih he ype in he model. DELETE.../auhorizaion/{Auhorizaion.ype} Delees he Auhorizaion mehod wih he ype from he model. Service DhcpRelay.../dhcp-relay DhcpRelay Reurns he DHCP- Relay global aribues..../dhcp-relay DhcpRelay DhcpRelay Updae he DHCP- Relay global aribues. Chaper 4 Server elemen lis 31

32 Service DhcpRelayVlan.../vlans/{DhcpRelayVlan.vlan_id}/dhcp-relay DhcpRelayVlan Reurns he DHCP Relay VLAN ID..../vlans/{DhcpRelayVlan.vlan_id}/dhcp-relay Service DhcpServerPool DhcpRelayVlan DhcpRelayVlan Updaes he given DHCP Relay VLAN in he model..../dhcp-server/pools WiredElemenLis Reurns DHCP- Server pools..../dhcp-server/pools DhcpServerPool DhcpServerPool Adds he given DHCP-Server pool o he model..../dhcp-server/pools/{dhcpserverpool.pool_name} DhcpServerPool Reurns he DHCP- Server pool by name. DELETE.../dhcp-server/pools/{DhcpServerPool.pool_name} Void Delees DHCP- Server pool by name. 32 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

33 Service DhcpServer.../dhcp-server DhcpServer Reurns he DHCP- Server..../dhcp-server Service Do1xAuhenicaorPor DhcpServer DhcpServer Updaes DHCP- Server in he model..../do1x/auhenicaor WiredElemenLis 802.1X Auhenicaor Por elemens query..../do1x/auhenicaor/{do1xauhenicaorpor.por_id} Do1xAuhenica orpor Reurns he 802.1X Auhenicaor Por ID..../do1x/auhenicaor/{Do1xAuhenicaorPor.por_id} Do1xAuhenica orpor Do1xAuhenica orpor Updaes he given 802.1X Auhenicaor Por in he model. Chaper 4 Server elemen lis 33

34 Service Do1x.../do1x Do1x Reurns he global 802.1X configuraion..../do1x Do1x Do1x Updaes he global 802.1X configuraion Service Dsnoop.../dsnoop Dsnoop Reurns he DHCP- Snooping global aribues..../dsnoop Dsnoop Dsnoop Updae he DHCP- Snooping global aribues. Service Igmp.../igmp/vlans/sas WiredElemenLis VLAN IGMP Sas elemens maching he given query..../vlans/{vlanigmp.vlan_id}/igmp Table Coninued 34 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

35 VlanIgmp Reurns he VLAN IGMP maching he given ID..../vlans/{VlanIgmp.vlan_id}/igmp VlanIgmp VlanIgmp Updaes he given VLAN IGMP in he model..../vlans/{vlanigmp.vlan_id}/igmp/sas Service IncludeCredenials VlanIgmpSas Reurns he VLAN IGMP Sas ID..../sysem/include-credenials IncludeCredeni als Reurns he Include- Credenials seings..../sysem/include-credenials IncludeCredeni als IncludeCredeni als Updaes he Include- Credenials seings. Service Lacp.../lacp/por WiredElemenLis Reurns he lis por runk configuraions.../lacp/por Lacp Lacp Adds por o a Lacp Trunk Table Coninued Chaper 4 Server elemen lis 35

36 .../lacp/por/{lacp.por_id} Lacp Reurns he LACP Por Configuraion DELETE.../lacp/por/{Lacp.por_id} Service LocaorLedBlink Void Delees Por From a LACP runk;.../locaor-led-blink LocaorLedBlink Command LocaorLedBlink CommandResul Triggers a locaor led blink based on he given parameers. Service MacAuhenicaionPor.../mac-auhenicaion/por WiredElemenLis MAC Auhenicaion Por elemens query..../mac-auhenicaion/por/{macauhenicaionpor.por_id} MacAuhenicai onpor Reurns he MAC Auhenicaion Por ID..../mac-auhenicaion/por/{MacAuhenicaionPor.por_id} MacAuhenicai onpor Updaes he given MAC Auhenicaion Por in he model. 36 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

37 Service MacAuhenicaion.../mac-auhenicaion MacAuhenicai on Reurns he global MAC auhenicaion configuraion..../mac-auhenicaion MacAuhenicai on MacAuhenicai on Updaes he global MAC auhenicaion configuraion. Service MacTable.../mac-able WiredElemenLis Reurns a lis of MAC enries (capped o 1K righ now)..../mac-able/{macaddress.oces} MacTableEnry Reurns he MAC able enry for he given MAC address..../pors/{por.id}/mac-able WiredElemenLis Reurns lis of MAC enries learned on a given Por ID..../vlans/{Vlan.vlan_id}/mac-able WiredElemenLis Reurns lis of MAC enries learned on a given VLAN ID. Chaper 4 Server elemen lis 37

38 Service Msp.../msp Msp Reurns he global MSTP seings..../msp Msp Msp Updaes he global MSTP seings..../msp/por WiredElemenLis MSTP Por elemens query..../msp/por/{msppor.id} MspPor Reurns he MSTP Por maching he given ID..../msp/por/{MspPor.id} MspPor MspPor Updaes he MSTP Por maching he given ID. Service Oobm.../oobm Oobm Reurns he OOBM seings..../oobm Oobm Oobm Updaes he OOBM seings. Table Coninued 38 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

39 .../oobm/inerface OobmInerface Reurns he OOBM Inerface seings..../oobm/inerface OobmInerface OobmInerface Updaes he OOBM Inerface seings..../oobm/inerface/sas OobmInerfaceS as Reurns he OOBM Inerface sas. Service Poe.../poe/pors WiredElemenLis Por PoE elemens query..../poe/pors/sas WiredElemenLis Por PoE Sas elemens maching he given query..../poe/slos WiredElemenLis Slo PoE elemens query..../pors/{porpoe.por_id}/poe PorPoe Reurns he Por PoE ID. Table Coninued Chaper 4 Server elemen lis 39

40 .../pors/{porpoe.por_id}/poe PorPoe PorPoe Updaes he given Por PoE in he model..../pors/{porpoe.por_id}/poe/sas PorPoeSas Reurns he Por PoE sas maching he given ID..../slos/{SloPoe.slo_name}/poe SloPoe Reurns he Slo PoE ID..../slos/{SloPoe.slo_name}/poe SloPoe SloPoe Updaes he given Slo PoE(no sampling info)..../slos/{slopoesas.slo_name}/poe/sas SloPoeSas Reurns he Slo PoE sas maching he given Slo ID..../slos/poe/sas WiredElemenLis Slo PoE Sas elemens maching he given query..../sysem/saus/power/consumpion WiredElemenLis Reurns he Power- Consumpion saus of he hos sysem (no sampling info). Applicable only for Bol plaform. Table Coninued 40 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

41 .../sysem/saus/power/supply WiredElemenLis Reurns he Power- Supply saus of he hos sysem (no sampling info). Service PorMirrorSession.../por-mirror WiredElemenLis Por Mirror Session elemens maching he given query..../por-mirror PorMirrorSessi on PorMirrorSessi on Adds he given Por Mirror Session o he model..../por-mirror/{pormirrorsession.session_id} PorMirrorSessi on Reurns he Por Mirror Session ID..../por-mirror/{PorMirrorSession.session_id} PorMirrorSessi on PorMirrorSessi on Updaes he given Por Mirror Session in he model. DELETE.../por-mirror/{PorMirrorSession.session_id} Delees he Por Mirror Session wih he given ID from he model. Chaper 4 Server elemen lis 41

42 Service QosPor.../qos/pors-policies WiredCollecion Query WiredElemenLis QoS Por Policy elemens maching he given query..../qos/pors-policies QosPorPolicy QosPorPolicy Adds he given QoS Por Policy o he model. DELETE.../qos/pors-policies/{QosPorPolicy.por_id}-{QosPorPolicy.policy_id} Delees he QoS Por Policy wih he given ID from he model..../qos/pors-policies/arg Reurns he QoS saisics for given policy and Por Service QosVlan.../qos/vlans-policies WiredCollecion Query WiredElemenLis QoS VLAN Policy elemens maching he given query..../qos/vlans-policies QosVlanPolicy QosVlanPolicy Adds he given QoS VLAN Policy o he model. Table Coninued 42 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

43 DELETE.../qos/vlans-policies/{QosVlanPolicy.vlan_id}-{QosVlanPolicy.policy_id} Delees he QoS VLAN Policy wih he given ID from he model..../qos/vlans-policies/{qosvlanpolicy.vlan_id}-{qosvlanpolicy.policy_id}/sas QosVlanPolicyS as Reurns he QoS saisics for given policy and VLAN Service RedundancyManagemen.../redundancy-managemen RedundancyManag emen Reurns he Redundancy Managemen seings..../redundancy-managemen RedundancyManag emen RedundancyManag emen Updaes he Redundancy Managemen seings..../redundancy-managemen/sas RedundancyManag emensastable Reurns he Redundancy Managemen sas..../redundancy-managemen/swichover Triggers a redundancy swichover. Chaper 4 Server elemen lis 43

44 Service SwichSysem.../sysem/saus/swich SwichSysemInf osas Reurns he saus of he Swich sysem. Service Transceiver.../ransceivers WiredElemenLis Transceiver elemens maching he given query..../ransceivers/{transceiver.serial_number} Transceiver Reurns he Transceiver ID..../ransceivers/{Transceiver.serial_number}/diagnosics TransceiverDiag nosics Reurns he Transceiver Diagnosics ID. Service Trunk.../runk/por WiredElemenLis Reurns he lis por runk configuraions.../runk/por Table Coninued 44 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

45 Trunk Trunk Adds por o a Saic Manual Trunk.../runk/por/{Trunk.por_id} Trunk Reurns he TRUNK Por Configuraion DELETE.../runk/por/{Trunk.por_id} Void Delees Por From a Trunk; Chaper 4 Server elemen lis 45

46 Chaper 5 Suppor and oher resources Accessing Hewle Packard Enerprise Suppor For live assisance, go o he Conac Hewle Packard Enerprise Worldwide websie: hp:// To access documenaion and suppor services, go o he Hewle Packard Enerprise Suppor Cener websie: hp:// Informaion o collec Technical suppor regisraion number (if applicable) Produc name, model or version, and serial number Operaing sysem name and version Firmware version Error messages Produc-specific repors and logs Add-on producs or componens Third-pary producs or componens Accessing updaes Some sofware producs provide a mechanism for accessing sofware updaes hrough he produc inerface. Review your produc documenaion o idenify he recommended sofware updae mehod. To download produc updaes: Hewle Packard Enerprise Suppor Cener Hewle Packard Enerprise Suppor Cener: Sofware downloads Sofware Depo To subscribe o enewsleers and alers: To view and updae your enilemens, and o link your conracs and warranies wih your profile, go o he Hewle Packard Enerprise Suppor Cener More Informaion on Access o Suppor Maerials page: Access o some updaes migh require produc enilemen when accessed hrough he Hewle Packard Enerprise Suppor Cener. You mus have an HPE Passpor se up wih relevan enilemens. Cusomer self repair Hewle Packard Enerprise cusomer self repair (CSR) programs allow you o repair your produc. If a CSR par needs o be replaced, i will be shipped direcly o you so ha you can insall i a your convenience. Some pars do no qualify for CSR. Your Hewle Packard Enerprise auhorized service provider will deermine wheher a repair can be accomplished by CSR. 46 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03

47 For more informaion abou CSR, conac your local service provider or go o he CSR websie: hp:// Remoe suppor Remoe suppor is available wih suppored devices as par of your warrany or conracual suppor agreemen. I provides inelligen even diagnosis, and auomaic, secure submission of hardware even noificaions o Hewle Packard Enerprise, which will iniiae a fas and accurae resoluion based on your produc's service level. Hewle Packard Enerprise srongly recommends ha you regiser your device for remoe suppor. If your produc includes addiional remoe suppor deails, use search o locae ha informaion. Remoe suppor and Proacive Care informaion HPE Ge Conneced HPE Proacive Care services HPE Proacive Care service: Suppored producs lis HPE Proacive Care advanced service: Suppored producs lis proacivecareadvancedsupporedproducs Proacive Care cusomer informaion Proacive Care cenral Proacive Care service acivaion Warrany informaion To view he warrany for your produc, see he Safey and Compliance Informaion for Server, Sorage, Power, Neworking, and Rack Producs documen, available a he Hewle Packard Enerprise Suppor Cener: Addiional warrany informaion HPE ProLian and x86 Servers and Opions HPE Enerprise Servers HPE Sorage Producs HPE Neworking Producs Regulaory informaion To view he regulaory informaion for your produc, view he Safey and Compliance Informaion for Server, Sorage, Power, Neworking, and Rack Producs, available a he Hewle Packard Enerprise Suppor Cener: Addiional regulaory informaion Hewle Packard Enerprise is commied o providing our cusomers wih informaion abou he chemical subsances in our producs as needed o comply wih legal requiremens such as REACH (Regulaion EC No 1907/2006 of he European Parliamen and he Council). A chemical informaion repor for his produc can be found a: Chaper 5 Suppor and oher resources 47

48 For Hewle Packard Enerprise produc environmenal and safey informaion and compliance daa, including RoHS and REACH, see: For Hewle Packard Enerprise environmenal informaion, including company programs, produc recycling, and energy efficiency, see: Documenaion feedback Hewle Packard Enerprise is commied o providing documenaion ha mees your needs. To help us improve he documenaion, send any errors, suggesions, or commens o Documenaion Feedback (docsfeedback@hpe.com). When submiing your feedback, include he documen ile, par number, ediion, and publicaion dae locaed on he fron cover of he documen. For online help conen, include he produc name, produc version, help ediion, and publicaion dae locaed on he legal noices page. 48 HPE ArubaOS-Swich REST API and JSON Schema Reference Guide 16.03