NoContents
1Service Accounting
2Service Acl
3Service AclPort
4Service AclVlan
5Service Activate
6Service AllowUnsupportedTransceiver
7Service ArpProtect
8Service ArpTable
9Service ArubaVpn
10Service AuthOrder
11Service AuthPriority
12Service Authentication
13Service Authorization
14Service AuthorizationUserRole
15Service AuthorizationUserRoleName
16Service Banner
17Service BpsCommand
18Service BpsConfig
19Service CableDiagnostics
20Service CaptivePortal
21Service Cdp
22Service CfgBackupCmd
23Service CfgRestoreCmd
24Service CfgRestoreDiff
25Service CfgRestorePayload
26Service CfgRestorePayloadDiff
27Service CliBatchCommand
28Service CliCommand
29Service ConfigHash
30Service ConfigPayload
31Service ConfigurationResetCommand
32Service CryptoClearpassConfig
33Service CryptoPkiConfig
34Service DebugLog
35Service DeviceFingerPrinting
36Service DeviceManagementUser
37Service DeviceProfile
38Service DhcpRelay
39Service DhcpRelayVlan
40Service DhcpServer
41Service DhcpServerPool
42Service Dns
43Service Dot1x
44Service Dot1xAuthenticationMethod
45Service Dot1xAuthenticatorPort
46Service Dot1xDeviceIdentity
47Service Dot1xPortSecurity
48Service Dot1xSupplicantPort
49Service Dsnoop
50Service EncryptCredentials
51Service EventLog [Applicable for Central Customers Only]
52Service EventSubscription [Applicable for Central Customers Only]
53Service Fastboot
54Service FileTransfer
55Service Igmp
56Service IncludeCredentials
57Service IpAddressSubnet
58Service IpAuth
59Service IpClientTracker
60Service IpIcmp
61Service IpRoute
62Service IpSlaClearCommand
63Service IpSlaClearResponderStatsCommand
64Service IpSlaConfig
65Service IpSlaResponder
66Service IpSlaResponderStats
67Service IpSourceInterface
68Service IsolateList
69Service Lacp
70Service Lldp
71Service LocalUser
72Service LocatorLedBlink
73Service LoopProtect
74Service MacAuthentication
75Service MacAuthenticationPort
76Service MacLockout
77Service MacTable
78Service Module
79Service Oobm
80Service PacketCapture
81Service Ping
82Service Poe
83Service Port
84Service PortMirrorSession
85Service PortRateLimit
86Service PortSecurity
87Service PrivateVlan
88Service Qos
89Service QosPort
90Service QosTrust
91Service QosVlan
92Service RadiusAccountingStats
93Service RadiusAuthStats
94Service RadiusDynAuthorizationStats
95Service RadiusProfile
96Service RadiusServer
97Service RadiusServerGroup
98Service RedundancyManagement
99Service RemovePatchfileCommand
100Service RestLoginSessions
101Service RestSessionIdleTimeout
102Service RestVersion
103Service SmartratePort
104Service SnmpServer
105Service SnmpServerCommunities
106Service SnmpServerHosts
107Service SnmpServerMib
108Service SnmpServerResponseSource
109Service SnmpServerTrapSource
110Service SnmpServerTraps
111Service Snmpv3
112Service Sntp
113Service SntpServerDetails
114Service SpanningTree
115Service SwitchConfig [Applicable for Central Customers Only]
116Service SwitchSystem
117Service Syslog
118Service SyslogEventCriteria
119Service SyslogFilter
120Service System
121Service SystemVariable [Applicable for Central Customers Only]
122Service TACACSProfile
123Service TaConfig
124Service TelnetServer
125Service TftpClient
126Service TraceRoute
127Service Transceiver
128Service Trunk
129Service TunneledNode
130Service Vlan
131Service VlanPort
132Service VsfCommand
133Service VsfConfig
134Service WebAuth
135Service WebAuthPort

Service Accounting

HTTP MethodResourceRequestResponseDescription
GET.../accountingN/AAccountingReturns accounting configuration.
PUT.../accountingAccountingAccountingUpdates the given accounting configuration to the system.
GET.../accounting/sessionsN/AAccountingSessionsReturns accounting sessions.

Service Acl

HTTP MethodResourceRequestResponseDescription
GET.../aclsN/ACommonElementListReturns the list of ACL elements matching the given query.
POST.../aclsAclAclAdds the given ACL to the model.
GET.../acls/{Acl.id}N/AAclReturns the ACL matching the given ID.
DELETE.../acls/{Acl.id}N/AN/ADeletes the ACL with the given ID from the model.
GET.../acls/{Acl.id}/rulesN/ACommonElementListReturns the list of ACL Rule elements matching the given query.
POST.../acls/{AclRule.acl_id}/rulesAclRuleAclRuleAdds the given ACL Rule to the model.
GET.../acls/{AclRule.acl_id}/rules/{AclRule.sequence_no}N/AAclRuleReturns the ACL Rule matching the given ID.
PUT.../acls/{AclRule.acl_id}/rules/{AclRule.sequence_no}AclRuleAclRuleUpdates the given ACL Rule in the model.
DELETE.../acls/{AclRule.acl_id}/rules/{AclRule.sequence_no}N/AN/ADeletes the ACL Rule with the given ID from the model.
POST.../acls/{ResequenceCommand.acl_id}/rules/resequenceResequenceCommandN/ATriggers a resequence of ACL Rule elements based on the given parameters.
GET.../acls/deny_fragmented_tcp_headerN/ATcpFragHeaderReturns the ACL deny-fragmented-tcp-header .
PUT.../acls/deny_fragmented_tcp_headerTcpFragHeaderTcpFragHeaderUpdate deny-fragmented-tcp-header.
GET.../acls/rulesN/ACommonElementListReturns the list of ACL Rule elements for all the ACLs.

Service AclPort

HTTP MethodResourceRequestResponseDescription
GET.../ports-access-groupsN/AWiredElementListReturns the list of ACL Port Policy elements matching the given query.
POST.../ports-access-groupsAclPortPolicyAclPortPolicyAdds the given ACL Port Policy to the model.
DELETE.../ports-access-groups/{AclPortPolicy.port_id}-{AclPortPolicy.acl_id}-{AclPortPolicy.direction}N/AN/ADeletes the ACL Port Policy with the given ID from the model.
GET.../ports-access-groups/{AclPortPolicy.port_id}-{AclPortPolicy.acl_id}-{AclPortPolicy.direction}/statsN/AAclPortPolicyStatsReturns the ACL statistics for given ACL ID, Port and Direction

Service AclVlan

HTTP MethodResourceRequestResponseDescription
GET.../vlans-access-groupsN/AWiredElementListReturns the list of ACL VLAN Policy elements matching the given query.
POST.../vlans-access-groupsAclVlanPolicyAclVlanPolicyAdds the given ACL VLAN Policy to the model.
DELETE.../vlans-access-groups/{AclVlanPolicy.vlan_id}-{AclVlanPolicy.acl_id}-{AclVlanPolicy.direction}N/AN/ADeletes the ACL VLAN Policy with the given ID from the model.
GET.../vlans-access-groups/{AclVlanPolicy.vlan_id}-{AclVlanPolicy.acl_id}-{AclVlanPolicy.direction}/statsN/AAclVlanPolicyStatsReturns the ACL statistics for given ACL ID, VLAN and Direction

Service Activate

HTTP MethodResourceRequestResponseDescription
POST.../activateActivateProvisionRequestActivateProvisionResultEnable system provisioning using Aruba Activate.
GET.../activate/configN/AActivateConfigReturns Aruba Activate provisioning configuration.
PUT.../activate/configActivateConfigActivateConfigUpdates attributes for Aruba Activate provisioning.

Service AllowUnsupportedTransceiver

HTTP MethodResourceRequestResponseDescription
GET.../allow_unsupported_transceiverN/AAllowUnsupportedTransceiverReturns AllowUnsupportedTransceiver system attribute.
PUT.../allow_unsupported_transceiverAllowUnsupportedTransceiverAllowUnsupportedTransceiverUpdates AllowUnsupportedTransceiver system attribute.

Service ArpProtect

HTTP MethodResourceRequestResponseDescription
GET.../arp-protectN/AArpProtectReturns the attributes of arp protection
PUT.../arp-protectArpProtectArpProtectUpdates attributes of Arp Protection
GET.../arp-protect/portsN/AWiredElementListReturns Arp Protect configuration for all ports.
GET.../arp-protect/ports/{ArpProtectPort.port_id}N/AArpProtectPortReturns Arp Protect per port details
PUT.../arp-protect/ports/{ArpProtectPort.port_id}ArpProtectPortArpProtectPortUpdates attributes of Arp Protect per port.
GET.../arp-protect/vlansN/AWiredElementListRetrieves Arp Protect vlans
GET.../arp-protect/vlans/{ArpProtectVlan.vlan_id}N/AArpProtectVlanRetrieves Arp Protect vlans by vlan_id
PUT.../arp-protect/vlans/{ArpProtectVlan.vlan_id}ArpProtectVlanArpProtectVlanUpdates Arp Protect vlans by vlan_id

Service ArpTable

HTTP MethodResourceRequestResponseDescription
GET.../arp-tableN/AWiredElementListReturns a list of all ARP entries (capped to 1K right now).
GET.../arp-table/{IpAddress.octets}N/AArpTableEntryReturns list of ARP entries learned on a given IP Address.
GET.../arp-table/mac-address/{MacAddress.octets}N/AWiredElementListReturns the ARP table entry for the given MAC address.
GET.../arp-table/vlan/{Vlan.vlan_id}N/AWiredElementListReturns list of ARP entries learned on a given VLAN ID.

Service ArubaVpn

HTTP MethodResourceRequestResponseDescription
GET.../amp-serverN/AAmpServerReturns the Amp server IP, group, folder and secret
PUT.../amp-serverAmpServerAmpServerConfigure the Amp Server
DELETE.../amp-serverN/AN/ADeletes the Aruba VPN configuration.
GET.../aruba-vpnN/AArubaVpnReturns the Aruba VPN type, peer IP address,ToS and TTL value.
PUT.../aruba-vpnArubaVpnArubaVpnConfigure the Aruba VPN
DELETE.../aruba-vpnN/AN/ADeletes the Aruba VPN configuration.

Service AuthOrder

HTTP MethodResourceRequestResponseDescription
GET.../auth_orderN/AWiredElementListReturns all auth-order for clients configuration
POST.../auth_orderAuthOrderAuthOrderAdds the given auth-order for clients to the model.
GET.../auth_order/{AuthOrder.port_id}N/AAuthOrderReturns the given auth-order for clients configuration
PUT.../auth_order/{AuthOrder.port_id}AuthOrderAuthOrderUpdate the given auth-order for clients to the model.
DELETE.../auth_order/{AuthOrder.port_id}N/AN/ADeletes the given auth-order for clients configuration

Service AuthPriority

HTTP MethodResourceRequestResponseDescription
GET.../auth_priorityN/AWiredElementListReturns all auth-priority for clients configuration
POST.../auth_priorityAuthPriorityAuthPriorityAdds the given auth-priority for clients to the model.
GET.../auth_priority/{AuthPriority.port_id}N/AAuthPriorityReturns the given auth-priority for clients configuration
PUT.../auth_priority/{AuthPriority.port_id}AuthPriorityAuthPriorityUpdate the given auth-priority for clients to the model.
DELETE.../auth_priority/{AuthPriority.port_id}N/AN/ADeletes the given auth-priority for clients configuration

Service Authentication

HTTP MethodResourceRequestResponseDescription
GET.../authenticationN/AAuthenticationReturns authentication configuration.
PUT.../authenticationAuthenticationAuthenticationUpdates the given authentication configuration to the system.
GET.../authentication/consoleN/AAuthenticationConsoleReturns console authentication configuration .
PUT.../authentication/consoleAuthenticationConsoleAuthenticationConsoleUpdates the given console authentication configuration to the system.
GET.../authentication/last_login/{AuthenticationLastLogin.last_login_order}N/AAuthenticationLastLoginReturns authentication last-login users.
GET.../authentication/mac_basedN/AAuthenticationMacbasedReturns mac based authentication configuration.
PUT.../authentication/mac_basedAuthenticationMacbasedAuthenticationMacbasedUpdates the given mac based authentication configuration to the system.
GET.../authentication/restN/AAuthenticationRestReturns Rest authentication configuration .
PUT.../authentication/restAuthenticationRestAuthenticationRestUpdates the given rest authentication configuration to the system.
GET.../authentication/sshN/AAuthenticationSshReturns ssh authentication configuration.
PUT.../authentication/sshAuthenticationSshAuthenticationSshUpdates the given ssh authentication configuration to the system.
GET.../authentication/telnetN/AAuthenticationTelnetReturns telnet authentication configuration .
PUT.../authentication/telnetAuthenticationTelnetAuthenticationTelnetUpdates the given telnet authentication configuration to the system.
GET.../authentication/webN/AAuthenticationWebReturns web authentication configuration .
PUT.../authentication/webAuthenticationWebAuthenticationWebUpdates the given web authentication configuration to the system.
GET.../authentication/web_basedN/AAuthenticationWebbasedReturns web based authentication configuration .
PUT.../authentication/web_basedAuthenticationWebbasedAuthenticationWebbasedUpdates the given web based authentication configuration to the system.

Service Authorization

HTTP MethodResourceRequestResponseDescription
GET.../authorizationN/AAuthorizationReturns authorization configuration.
PUT.../authorizationAuthorizationAuthorizationUpdates the given authorization configuration to the system.
GET.../authorization_groupN/AWiredElementListReturns all authorization group in the system.
POST.../authorization_groupAuthorizationGroupAuthorizationGroupCreates the new authorization group in the system.
GET.../authorization_group/{AuthorizationGroup.group_name}-{AuthorizationGroup.seq_num}N/AAuthorizationGroupReturns authorization group configuration.
PUT.../authorization_group/{AuthorizationGroup.group_name}-{AuthorizationGroup.seq_num}AuthorizationGroupAuthorizationGroupModify authorization group in the system.
DELETE.../authorization_group/{AuthorizationGroup.group_name}-{AuthorizationGroup.seq_num}N/AN/AReturns authorization group configuration.
GET.../authorization_rest_groupN/AWiredElementListReturns all authorization rest-uri group in the system.
POST.../authorization_rest_groupAuthorizationRestGroupAuthorizationRestGroupCreates the new authorization rest-uri group in the system.
GET.../authorization_rest_group/{AuthorizationRestGroup.group_name}-{AuthorizationRestGroup.seq_num}N/AAuthorizationRestGroupReturns authorization rest group configuration based on sequence num and group name.
PUT.../authorization_rest_group/{AuthorizationRestGroup.group_name}-{AuthorizationRestGroup.seq_num}AuthorizationRestGroupAuthorizationRestGroupModify authorization rest-uri group in the system.
DELETE.../authorization_rest_group/{AuthorizationRestGroup.group_name}-{AuthorizationRestGroup.seq_num}N/AN/AReturns authorization rest group configuration based on sequence num and group name.

Service AuthorizationUserRole

HTTP MethodResourceRequestResponseDescription
GET.../authorization_user_role_stateN/AAuthorizationUserRoleReturns authorization user-role state and initial-role mapping in the system.
PUT.../authorization_user_role_stateAuthorizationUserRoleAuthorizationUserRoleUpdates global user-role config and initial-role mapping.

Service AuthorizationUserRoleName

HTTP MethodResourceRequestResponseDescription
GET.../authorization_user_roleN/AWiredElementListReturns all authorization user-roles in the system.
POST.../authorization_user_roleAuthorizationUserRoleNameAuthorizationUserRoleNameAdd authorization user-role in the system.
GET.../authorization_user_role/{AuthorizationUserRoleName.user_role_name}N/AAuthorizationUserRoleNameReturns authorization user-role based on name in the system.
PUT.../authorization_user_role/{AuthorizationUserRoleName.user_role_name}AuthorizationUserRoleNameAuthorizationUserRoleNameModify authorization user-role in the system.
DELETE.../authorization_user_role/{AuthorizationUserRoleName.user_role_name}N/AN/ADeletes authorization user-role in the system.

Service Banner

HTTP MethodResourceRequestResponseDescription
GET.../bannerN/ABannerReturns Banner system attributes.
PUT.../bannerBannerBannerUpdates Banner system attributes.

Service BpsCommand

HTTP MethodResourceRequestResponseDescription
POST.../stacking/bps/disableN/AN/ADisable BPS stack
POST.../stacking/bps/enableBpsEnableCommandN/AEnable BPS stack. Request body is optional to execute this API
POST.../stacking/bps/factory_resetN/AN/AErase the startup config and all knowledge of other stack members.
POST.../stacking/bps/member/removeBpsMemberRemoveCommandN/AErases the stack member's configuration.
POST.../stacking/bps/member/shutdownBpsMemberShutdownCommandN/AShut down the specified stack member.
POST.../stacking/bps/set_stackN/AN/ATo set an active stack after split. Not applicable for inactive stack.

Service BpsConfig

HTTP MethodResourceRequestResponseDescription
GET.../stacking/bps/infoN/ABpsGlobalConfigReturns the BPS stack information.
PUT.../stacking/bps/infoBpsGlobalConfigBpsGlobalConfigUpdates the BPS stack information.
GET.../stacking/bps/membersN/AWiredElementListReturns all BPS members' configuration.
POST.../stacking/bps/membersBpsMemberBpsMemberAdds the BPS member matching the given member ID.
GET.../stacking/bps/members/{BpsMember.member_id}N/ABpsMemberReturns the BPS member's configuration matching the given member ID.
PUT.../stacking/bps/members/{BpsMember.member_id}BpsMemberBpsMemberUpdates the BPS member's configuration matching the given member ID.
GET.../stacking/bps/members/system_infoN/AWiredElementListReturns all BPS members' system information.
GET.../stacking/bps/members/system_info/{BpsMemberSystemInfo.member_id}N/ABpsMemberSystemInfoReturns the BPS member's system information matching the given member ID.
GET.../stacking/bps/stack_portsN/AWiredElementListReturns all BPS stack ports.
GET.../stacking/bps/stack_ports/members/{BpsStackPort.member_id}/stack_port/{BpsStackPort.stacking_port}N/ABpsStackPortReturns the details of the specified stack port of the member matching the given member ID.

Service CableDiagnostics

HTTP MethodResourceRequestResponseDescription
POST.../cable_diagnosticsN/AN/ATo run cable diagnostics on all ports those support cable diagnostics.
No response will be seen if the diagnostics is run on a port connected to rest client.
POST.../cable_diagnostics/clearN/AN/ATo clear cable diagnostics on all ports.
POST.../cable_diagnostics/clear/portCableDiagnosticsCommandN/ATo clear cable diagnostics results on a port
POST.../cable_diagnostics/portCableDiagnosticsCommandN/ATo run cable diagnostics on a port.
No response will be seen if the diagnostics is run on a port connected to rest client.
GET.../cable_diagnostics/statusN/AWiredElementListReturns cable diagnostics status
GET.../cable_diagnostics/status/{CableDiagnostics.port_id}N/ACableDiagnosticsReturns cable diagnostics status per port

Service CaptivePortal

HTTP MethodResourceRequestResponseDescription
GET.../captive_portalN/ACaptivePortalReturns the global Captive Portal Configuration.
PUT.../captive_portalCaptivePortalCaptivePortalUpdates the global Captive Portal Configuration.

Service Cdp

HTTP MethodResourceRequestResponseDescription
GET.../cdpN/ACdpReturns the global CDP configuration data.
PUT.../cdpCdpCdpUpdates the global CDP configuration data.
GET.../cdp/portN/ACommonElementListReturns the CDP configuration data for all the ports
GET.../cdp/port/{CdpPort.port_id}N/ACdpPortReturns the CDP configuration data per port
PUT.../cdp/port/{CdpPort.port_id}CdpPortCdpPortUpdates the CDP configuration data per port.

Service CfgBackupCmd

HTTP MethodResourceRequestResponseDescription
GET.../system/config/cfg_backup_filesN/AWiredElementListReturns the list of backup configuration file details.
POST.../system/config/cfg_backup_filesCfgBackupconfConfigFileDetailsSave the given configuration File to the system.
GET.../system/config/cfg_backup_files/{ConfigFileDetails.file_name}N/AConfigFileDetailsReturns the details of backup configuration files by name.

Service CfgRestoreCmd

HTTP MethodResourceRequestResponseDescription
POST.../system/config/cfg_restoreCfgRestoreCurrentRestoreStatusRestore the given configuration as the running
configuration without reboot.
REST performs the config restoration in non-blocking mode.
GET.../system/config/cfg_restore/statusN/ACfgRestoreDetailsReturns the status of cfg-restore process.

Service CfgRestoreDiff

HTTP MethodResourceRequestResponseDescription
POST.../system/config/cfg_restore/latest_diffCfgRestoreDiffCurrentDiffStatusProvide the list of changes that will be applied on the running configuration.
GET.../system/config/cfg_restore/latest_diff/statusN/ACfgRestoreDiffStatusReturns the status difference between two configuration files.

Service CfgRestorePayload

HTTP MethodResourceRequestResponseDescription
POST.../system/config/cfg_restore/payloadCfgRestorePayloadCfgRestorePayloadStatusAccepts the encoded input and restore it as running configuration;
REST performs the config restoration in non-blocking mode.
GET.../system/config/cfg_restore/payload/statusN/ACfgRestoreDetailsReturns the status of the applied encoded configuration file.

Service CfgRestorePayloadDiff

HTTP MethodResourceRequestResponseDescription
POST.../system/config/cfg_restore/payload/latest_diffCfgRestorePayloadDiffCurrentPayloadDiffStatusProvide the list of changes that will be applied on the running configuration.
GET.../system/config/cfg_restore/payload/latest_diff/statusN/ACfgRestoreDiffStatusReturns the status difference between two configuration files.

Service CliBatchCommand

HTTP MethodResourceRequestResponseDescription
POST.../cli_batchCliBatchCommandCliBatchCommandResultCLI batch command.
GET.../cli_batch/statusN/ACliBatchResultCLI batch command status.

Service CliCommand

HTTP MethodResourceRequestResponseDescription
POST.../cliCliCommandCliCommandResultCLI command interface.

Service ConfigHash

HTTP MethodResourceRequestResponseDescription
GET.../system/config/config_hashN/AConfigHashReturns the SHA of startup configuration.
GET.../system/config/running_config_hashN/ARunningConfigHashReturns the SHA of running configuration.

Service ConfigPayload

HTTP MethodResourceRequestResponseDescription
POST.../system/config/payloadConfigPayloadConfigPayloadStatusAccepts the encoded input.
If it is for backup configuration, backup the configuration to flash.
If it is a patch file content then download it to flash.

Service ConfigurationResetCommand

HTTP MethodResourceRequestResponseDescription
POST.../system/configuration-resetN/AN/AReset the system configuration.

Service CryptoClearpassConfig

HTTP MethodResourceRequestResponseDescription
GET.../crypto_clearpassN/ACryptoClearpassOptionsReturns the Crypto Clearpass CA download options.
PUT.../crypto_clearpassCryptoClearpassOptionsCryptoClearpassOptionsUpdates the Crypto Clearpass CA download options.

Service CryptoPkiConfig

HTTP MethodResourceRequestResponseDescription
POST.../crypto_pki/create_csrCsrConfigDetailLocalCertificateDetailCreates CSR for given Certificate Name, TA Profile and returns the Certificate Signed Request.
POST.../crypto_pki/install_signed_certificateSignedCertificateDetailN/AInstall Signed Certificate.
GET.../crypto_pki/local_certificateN/AWiredElementListReturns the list of Local Certificate details matching the given query.
GET.../crypto_pki/local_certificate/{LocalCertificateDetail.certificate_name}N/ALocalCertificateDetailReturns the CSR matching the given Local Certificate Name.
DELETE.../crypto_pki/local_certificate/{LocalCertificateDetail.certificate_name}N/AN/ADelete Local Certificate Details.

Service DebugLog

HTTP MethodResourceRequestResponseDescription
POST.../debug-log/filterDebugLogFilterCommandDebugLogStatsTriggers a filtering of the debug logs based on the given parameters.
GET.../debug-log/statusN/ADebugLogStatsReturns the status of the debug log filters.

Service DeviceFingerPrinting

HTTP MethodResourceRequestResponseDescription
GET.../deviceFingerPrinting/{deviceFingerprinting.port}N/AWiredElementListReturns all the device finger printing client details which got from cppm

Service DeviceManagementUser

HTTP MethodResourceRequestResponseDescription
GET.../management-userN/ACommonElementListReturns the list of Management User elements matching the given query.
POST.../management-userDeviceManagementUserDeviceManagementUserAdds the given Management User to the model.
GET.../management-user/{DeviceManagementUser.type}N/ADeviceManagementUserReturns the Management User matching the given ID.
PUT.../management-user/{DeviceManagementUser.type}DeviceManagementUserDeviceManagementUserUpdates the given Management User in the model.
DELETE.../management-user/{DeviceManagementUser.type}N/AN/ADeletes the Management User with the given ID from the model.

Service DeviceProfile

HTTP MethodResourceRequestResponseDescription
GET.../device_identitiesN/AWiredElementListReturns all the device identity configuration
POST.../device_identitiesDeviceIdentityDeviceIdentityAdds the given device identity configuration to the model.
GET.../device_identities-cdpN/AWiredElementListReturns all the device identity for cdp configuration
POST.../device_identities-cdpDeviceIdentityCdpDeviceIdentityCdpAdds the given cdp device identity configuration to the model.
GET.../device_identities-cdp/{DeviceIdentityCdp.device_name}-{DeviceIdentityCdp.cdp_type}-{DeviceIdentityCdp.cdp_value}N/ADeviceIdentityCdpReturns the given device identity for cdp configuration
PUT.../device_identities-cdp/{DeviceIdentityCdp.device_name}-{DeviceIdentityCdp.cdp_type}-{DeviceIdentityCdp.cdp_value}DeviceIdentityCdpDeviceIdentityCdpUpdate the given device identity cdp configuration to the model.
DELETE.../device_identities-cdp/{DeviceIdentityCdp.device_name}-{DeviceIdentityCdp.cdp_type}-{DeviceIdentityCdp.cdp_value}N/AN/ADeletes the given device identity cdp configuration
GET.../device_identities/{DeviceIdentity.device_name}N/ADeviceIdentityReturns the given device identity configuration
PUT.../device_identities/{DeviceIdentity.device_name}DeviceIdentityDeviceIdentityUpdate the given device identity configuration to the model.
DELETE.../device_identities/{DeviceIdentity.device_name}N/AN/ADeletes the given device identity configuration
GET.../device_profilesN/AWiredElementListReturns all device-profile configurations.
POST.../device_profilesDeviceProfileConfigDeviceProfileConfigAdds the given device-profile configuration to the model.
GET.../device_profiles-vlansN/AWiredElementListReturns all device-profile associations.
POST.../device_profiles-vlansDeviceProfileVlanDeviceProfileVlanAdds the given device-profile association to the model.
GET.../device_profiles-vlans/{DeviceProfileVlan.device_profile_name}-{DeviceProfileVlan.tagged_vlan_id}N/ADeviceProfileVlanReturns the device-profile vlan configuration.
DELETE.../device_profiles-vlans/{DeviceProfileVlan.device_profile_name}-{DeviceProfileVlan.tagged_vlan_id}N/AN/ADeletes device-profile vlans
GET.../device_profiles/{DeviceProfileConfig.device_profile_name}N/ADeviceProfileConfigReturns the device-profile configuration.
PUT.../device_profiles/{DeviceProfileConfig.device_profile_name}DeviceProfileConfigDeviceProfileConfigUpdate the given device-profile configuration to the model.
DELETE.../device_profiles/{DeviceProfileConfig.device_profile_name}N/AN/ADeletes device-profile configuration
GET.../device_profiles/statusN/AWiredElementListReturns the device profile status configuration.
GET.../device_typesN/AWiredElementListReturns all device type configurations.
GET.../device_types/{DeviceTypeConfig.device_type}N/ADeviceTypeConfigReturns the device type configuration.
PUT.../device_types/{DeviceTypeConfig.device_type}DeviceTypeConfigDeviceTypeConfigUpdate the given device type configuration to the model.

Service DhcpRelay

HTTP MethodResourceRequestResponseDescription
GET.../dhcp-relayN/ADhcpRelayReturns the DHCP-Relay global attributes.
PUT.../dhcp-relayDhcpRelayDhcpRelayUpdate the DHCP-Relay global attributes.
GET.../dhcp-relay/option_82N/ADhcpRelayOption82Returns the DHCP Relay Option 82
PUT.../dhcp-relay/option_82DhcpRelayOption82DhcpRelayOption82Updates the given DHCP Relay Option 82
GET.../dhcp/optionsN/ADhcpOptionsReturns the status of DHCP Options
PUT.../dhcp/optionsDhcpOptionsDhcpOptionsUpdates the status of given DHCP Options

Service DhcpRelayVlan

HTTP MethodResourceRequestResponseDescription
GET.../vlans/dhcp-relayN/AWiredElementListReturns the all helper addresses under all vlans.
POST.../vlans/dhcp-relayDhcpRelayVlanDhcpRelayVlanAdds the given DHCP Relay VLAN with helper address in the model.
GET.../vlans/dhcp-relay/{DhcpRelayVlan.vlan_id}-{DhcpRelayVlan.dhcp_helper_address.octets}N/ADhcpRelayVlanReturns the DHCP Relay VLAN with helper address
DELETE.../vlans/dhcp-relay/{DhcpRelayVlan.vlan_id}-{DhcpRelayVlan.dhcp_helper_address.octets}N/AN/ADeletes the DHCP Relay VLAN Helper address from a VLAN ID.

Service DhcpServer

HTTP MethodResourceRequestResponseDescription
GET.../dhcp-serverN/ADhcpServerReturns the DHCP-Server.
PUT.../dhcp-serverDhcpServerDhcpServerUpdates DHCP-Server in the model.

Service DhcpServerPool

HTTP MethodResourceRequestResponseDescription
GET.../dhcp-server/poolsN/AWiredElementListReturns DHCP-Server pools.
POST.../dhcp-server/poolsDhcpServerPoolDhcpServerPoolAdds the given DHCP-Server pool to the model.
GET.../dhcp-server/pools/{DhcpServerPool.pool_name}N/ADhcpServerPoolReturns the DHCP-Server pool by name.
DELETE.../dhcp-server/pools/{DhcpServerPool.pool_name}N/AN/ADeletes DHCP-Server pool by name.

Service Dns

HTTP MethodResourceRequestResponseDescription
GET.../dnsN/ADnsReturns the host system attributes.
PUT.../dnsDnsDnsUpdates the host system attributes.

Service Dot1x

HTTP MethodResourceRequestResponseDescription
GET.../dot1xN/ADot1xReturns the global 802.1X configuration.
PUT.../dot1xDot1xDot1xUpdates the global 802.1X configuration.

Service Dot1xAuthenticationMethod

HTTP MethodResourceRequestResponseDescription
GET.../dot1x/authentication_methodN/ADot1xAuthenticationMethodReturns the 802.1X Authentication method details.
PUT.../dot1x/authentication_methodDot1xAuthenticationMethodDot1xAuthenticationMethodUpdates the given 802.1X Authentication method details.

Service Dot1xAuthenticatorPort

HTTP MethodResourceRequestResponseDescription
GET.../dot1x/authenticatorN/AWiredElementListReturns the list of 802.1X Authenticator Port elements matching the given query.
GET.../dot1x/authenticator/{Dot1xAuthenticatorPort.port_id}N/ADot1xAuthenticatorPortReturns the 802.1X Authenticator Port matching the given ID.
PUT.../dot1x/authenticator/{Dot1xAuthenticatorPort.port_id}Dot1xAuthenticatorPortDot1xAuthenticatorPortUpdates the given 802.1X Authenticator Port in the model.
POST.../dot1x/authenticator/{Dot1xAuthenticatorPort.port_id}/clearstatsN/AN/AClear statistics of dot1x authenticator based on port id
GET.../dot1x/authenticator/{Dot1xAuthenticatorClientStats.port_id}/client_statsN/ADot1xAuthenticatorClientStatsReturns the 802.1X Authenticator client session statistics matching the given port.
POST.../dot1x/authenticator/{Dot1xAuthenticatorPort.port_id}/initializeN/AN/AInitialize of dot1x authenticator based on port id
POST.../dot1x/authenticator/{Dot1xAuthenticatorPort.port_id}/reauthenticateN/AN/AReauthenticate of dot1x authenticator based on port id
GET.../dot1x/authenticator/{Dot1xAuthenticatorSessionCounters.port_id}/session_countersN/ADot1xAuthenticatorSessionCountersReturns the 802.1X Authenticator session counters matching the given port.
GET.../dot1x/authenticator/{Dot1xAuthenticatorStats.port_id}/statsN/ADot1xAuthenticatorStatsReturns the 802.1X Authenticator statistics matching the given port.
GET.../dot1x/authenticator/{Dot1xAuthenticatorStatus.port_id}/statusN/ADot1xAuthenticatorStatusReturns the 802.1X Authenticator status matching the given port.
GET.../dot1x/authenticator/client_statsN/AWiredElementListReturns the list of 802.1X Authenticator client session statistics elements matching the given query.
GET.../dot1x/authenticator/session_countersN/AWiredElementListReturns the list of 802.1X Authenticator session counters elements matching the given query.
GET.../dot1x/authenticator/statsN/AWiredElementListReturns the list of 802.1X Authenticator statistics elements matching the given query.
GET.../dot1x/authenticator/statusN/AWiredElementListReturns the list of 802.1X Authenticator status elements matching the given query.

Service Dot1xDeviceIdentity

HTTP MethodResourceRequestResponseDescription
GET.../dot1x/device_identityN/AWiredElementListReturns all dot1x device identity for cdp-bypass configuration
POST.../dot1x/device_identityDot1xDeviceIdentityDot1xDeviceIdentityAdds the given dot1x device identity for cdp-bypass to the model.
GET.../dot1x/device_identity/{Dot1xDeviceIdentity.device_name}-{Dot1xDeviceIdentity.port_id}N/ADot1xDeviceIdentityReturns the given dot1x device identity for cdp-bypass configuration
PUT.../dot1x/device_identity/{Dot1xDeviceIdentity.device_name}-{Dot1xDeviceIdentity.port_id}Dot1xDeviceIdentityDot1xDeviceIdentityUpdate the given dot1x device identity for cdp-bypass to the model.
DELETE.../dot1x/device_identity/{Dot1xDeviceIdentity.device_name}-{Dot1xDeviceIdentity.port_id}N/AN/ADeletes the given dot1x device identity for cdp-bypass configuration

Service Dot1xPortSecurity

HTTP MethodResourceRequestResponseDescription
GET.../dot1x/port_securityN/AWiredElementListReturns the list of 802.1X Port Security elements matching the given query.
GET.../dot1x/port_security/{Dot1xPortSecurity.port_id}N/ADot1xPortSecurityReturns the 802.1X Port security details matching the given ID.
PUT.../dot1x/port_security/{Dot1xPortSecurity.port_id}Dot1xPortSecurityDot1xPortSecurityUpdates the given 802.1X Port security in the model.

Service Dot1xSupplicantPort

HTTP MethodResourceRequestResponseDescription
GET.../dot1x/supplicantN/ACommonElementListReturns the list of 802.1X Supplicant Port elements matching the given query.
GET.../dot1x/supplicant/{Dot1xSupplicantPort.port_id}N/ADot1xSupplicantPortReturns the 802.1X Supplicant Port matching the given ID.
PUT.../dot1x/supplicant/{Dot1xSupplicantPort.port_id}Dot1xSupplicantPortDot1xSupplicantPortUpdates the given 802.1X Supplicant Port in the model.
POST.../dot1x/supplicant/{Dot1xSupplicantPort.port_id}/clearstatsN/AN/AClear statistics of dot1x supplicant based on port id
POST.../dot1x/supplicant/{Dot1xSupplicantPort.port_id}/initializeN/AN/AInitialize of dot1x supplicant based on port id
GET.../dot1x/supplicant/{Dot1xSupplicantStats.port_id}/statsN/ADot1xSupplicantStatsReturns the 802.1X Supplicant statistics matching the given port.
GET.../dot1x/supplicant/statsN/ACommonElementListReturns the list of 802.1X Supplicant statistics elements matching the given query.

Service Dsnoop

HTTP MethodResourceRequestResponseDescription
GET.../dsnoopN/ADsnoopReturns the DHCP-Snooping global attributes.
PUT.../dsnoopDsnoopDsnoopUpdate the DHCP-Snooping global attributes.
GET.../dsnoop/authorized_serverN/AWiredElementListReturns the DHCP-Snooping authorized server details.
POST.../dsnoop/authorized_serverDsnoopAuthServerDsnoopAuthServerAdd a DHCP Snooping Authorized server to the system.
GET.../dsnoop/authorized_server/{DsnoopAuthServer.authorized_server.octets}N/ADsnoopAuthServerGET a DHCP Snooping Authorized server from the system.
DELETE.../dsnoop/authorized_server/{DsnoopAuthServer.authorized_server.octets}N/AN/ARemove a DHCP Snooping Authorized server from the system.
GET.../dsnoop/option_82N/ADsnoopOption82Returns the DHCP-Snooping option 82 attributes.
PUT.../dsnoop/option_82DsnoopOption82DsnoopOption82Update the DHCP-Snooping option 82 attributes.

Service EncryptCredentials

HTTP MethodResourceRequestResponseDescription
GET.../system/encrypt-credentialsN/AEncryptCredentialsReturns the Encrypt-Credentials settings.
PUT.../system/encrypt-credentialsEncryptCredentialsEncryptCredentialsUpdates the encrypt-Credentials settings.

Service EventLog [Applicable for Central Customers Only]

HTTP MethodResourceRequestResponseDescription
GET.../system-event-logEventLoggedLoggedEventResponseListDownload/Query logged events from system

Service EventSubscription [Applicable for Central Customers Only]

HTTP MethodResourceRequestResponseDescription
GET.../event-subscriptionN/ASubscriptionStatusListReturns the subscription status list
POST.../event-subscriptionSubscriptionRequestSubscriptionStatusSubscribe to receive events
GET.../event-subscription/{SubscriptionStatus.subscription_id}N/ASubscriptionStatusReturns the subscription status
PUT.../event-subscription/{SubscriptionStatus.subscription_id}SubscriptionRequestSubscriptionStatusUpdate subscription
DELETE.../event-subscription/{SubscriptionStatus.subscription_id}N/AN/ADelete subscription

Service Fastboot

HTTP MethodResourceRequestResponseDescription
GET.../fastbootN/AFastbootReturns Fastboot system attribute.
PUT.../fastbootFastbootFastbootUpdates Fastboot system attribute.

Service FileTransfer

HTTP MethodResourceRequestResponseDescription
POST.../file-transferFileTransferCommandVoidTriggers a file transfer based on the given parameters.
GET.../file-transfer/statusN/AFileTransferStatusReturns the status of file transfer process.

Service Igmp

HTTP MethodResourceRequestResponseDescription
GET.../igmpN/AIgmpReturns IGMP global configuration.
PUT.../igmpIgmpIgmpUpdates the IGMP global configuration.
GET.../igmp/portsN/AWiredElementListReturns the list of IGMP fastlearn Port elements matching the given query.
GET.../igmp/ports/{IgmpPort.port_id}N/AIgmpPortReturns IGMP port fastlearn details.
PUT.../igmp/ports/{IgmpPort.port_id}IgmpPortIgmpPortUpdates the IGMP port fastlearn details.
POST.../igmp/reloadN/AN/AReset IGMP state on all interfaces
GET.../igmp/vlansN/AWiredElementListReturns the list of VLAN IGMP elements matching the given query.
GET.../igmp/vlans/portsN/AWiredElementListReturns the list of VLAN IGMP port configuration elements matching the given query.
GET.../igmp/vlans/static_groupsN/AWiredElementListReturns the list of VLAN IGMP static groups configuration elements matching the given query.
POST.../igmp/vlans/static_groupsVlanIgmpStaticGroupVlanIgmpStaticGroupCreates the given VLAN IGMP static groups configuration in the model.
GET.../igmp/vlans/static_groups/{VlanIgmpStaticGroup.id}N/AVlanIgmpStaticGroupReturns the VLAN IGMP static group configuration matching the given ID.
DELETE.../igmp/vlans/static_groups/{VlanIgmpStaticGroup.id}N/AN/ADeletes the VLAN IGMP static group configuration matching the given ID.
GET.../igmp/vlans/statsN/AWiredElementListReturns the list of VLAN IGMP Stats elements matching the given query.
GET.../vlans/{VlanIgmp.vlan_id}/igmpN/AVlanIgmpReturns the VLAN IGMP matching the given ID.
PUT.../vlans/{VlanIgmp.vlan_id}/igmpVlanIgmpVlanIgmpUpdates the given VLAN IGMP in the model.
GET.../vlans/{VlanIgmpPort.vlan_id}/igmp/ports/{VlanIgmpPort.port_id}N/AVlanIgmpPortReturns the VLAN IGMP port configuration matching the given ID.
PUT.../vlans/{VlanIgmpPort.vlan_id}/igmp/ports/{VlanIgmpPort.port_id}VlanIgmpPortVlanIgmpPortUpdates the given VLAN IGMP port configuration in the model.
GET.../vlans/{VlanIgmp.vlan_id}/igmp/statsN/AVlanIgmpStatsReturns the VLAN IGMP Stats matching the given ID.

Service IncludeCredentials

HTTP MethodResourceRequestResponseDescription
GET.../system/include-credentialsN/AIncludeCredentialsReturns the Include-Credentials settings.
PUT.../system/include-credentialsIncludeCredentialsIncludeCredentialsUpdates the Include-Credentials settings.

Service IpAddressSubnet

HTTP MethodResourceRequestResponseDescription
GET.../ipaddressesN/ACommonElementListReturns the list of IP Address Subnets elements matching the given query.
GET.../vlans/{IpAddressSubnet.vlan_id}/ipaddressesN/ACommonElementListReturns all IP Address Subnets for the specified VLAN.
POST.../vlans/{IpAddressSubnet.vlan_id}/ipaddressesIpAddressSubnetIpAddressSubnetAdds the given IP Address Subnet in the model.
DELETE.../vlans/{IpAddressSubnet.vlan_id}/ipaddressesN/AN/ADeletes all IP Address Subnets for the specified VLAN.
GET.../vlans/{IpAddressSubnet.vlan_id}/ipaddresses/{IpAddressSubnet.ip_address_mode}-{IpAddressSubnet.ip_address.octets}N/AIpAddressSubnetReturns the IP Address Subnet element matching the given query.
For IAAM_DHCP mode, octets will not be present in the uri.
DELETE.../vlans/{IpAddressSubnet.vlan_id}/ipaddresses/{IpAddressSubnet.ip_address_mode}-{IpAddressSubnet.ip_address.octets}N/AN/ADeletes specified IP Address Subnet for the specified VLAN.
For IAAM_DHCP mode, octets will not be present in the uri.

Service IpAuth

HTTP MethodResourceRequestResponseDescription
GET.../ip_authN/AWiredElementListReturns the list of Ip Auth Configuration matching the given query.
POST.../ip_authIpAuthIpAuthAdds the given IP Auth Configuration to the system.
GET.../ip_auth/{IpAuth.id}N/AIpAuthReturns the IP Auth Configuration matching the given ID.
PUT.../ip_auth/{IpAuth.id}IpAuthIpAuthUpdates the given IP Auth Configuration to the system.
DELETE.../ip_auth/{IpAuth.id}N/AN/ADeletes the Ip Auth Configuration with the given ID from the model.

Service IpClientTracker

HTTP MethodResourceRequestResponseDescription
GET.../ip/client_trackerN/AIpClientTrackerReturns Ip Client Tracker attributes.
PUT.../ip/client_trackerIpClientTrackerIpClientTrackerUpdate the Ip Client Tracker attributes.

Service IpIcmp

HTTP MethodResourceRequestResponseDescription
GET.../ip_icmpN/AIpIcmpReturns IP ICMP attributes.
PUT.../ip_icmpIpIcmpIpIcmpUpdates IP ICMP attributes.

Service IpRoute

HTTP MethodResourceRequestResponseDescription
GET.../ip-routeN/ACommonElementListReturns the list of IP Route elements matching the given query.
POST.../ip-routeIpRouteIpRouteAdds the given IP Route in the model.
GET.../ip-route/{IpRoute.id}N/AIpRouteReturns the IP Route matching the given ID.
PUT.../ip-route/{IpRoute.id}IpRouteIpRouteUpdates the given IP Route matching the given ID.
DELETE.../ip-route/{IpRoute.id}N/AN/ADeletes the IP Route with the given ID from the model.
GET.../ip-route/settingsN/AIpRouteSettingsReturns the global IP Route settings.
PUT.../ip-route/settingsIpRouteSettingsIpRouteSettingsUpdates the global IP Route settings.

Service IpSlaClearCommand

HTTP MethodResourceRequestResponseDescription
POST.../ip-slas/{IpSlaConfig.ipsla_id}/clearstatsN/AN/AClears History and Message statistics of IP-SLA based on IPSLA ID

Service IpSlaClearResponderStatsCommand

HTTP MethodResourceRequestResponseDescription
POST.../ipsla_responders/clear_stats/{IpSlaResponder.responder_type}-{IpSlaResponder.destination_address.octets}-{IpSlaResponder.destination_port}-{IpSlaResponder.source_address.octets}N/AN/AClears statistics of IP-SLA responder based on responder details

Service IpSlaConfig

HTTP MethodResourceRequestResponseDescription
GET.../ip-slasN/AWiredElementListReturns the list of IP-SLA elements matching the given query.
POST.../ip-slasIpSlaConfigIpSlaConfigAdds the given IP-SLA to the model.
GET.../ip-slas/{IpSlaConfig.ipsla_id}N/AIpSlaConfigReturns the IP-SLA matching the given ID.
DELETE.../ip-slas/{IpSlaConfig.ipsla_id}N/AN/ADeletes the IP-SLA with the given ID from the model.
GET.../ip-slas/{IpSlaStatus.ipsla_id}/statusN/AIpSlaStatusReturns the IP-SLA matching the given ID.
PUT.../ip-slas/{IpSlaStatus.ipsla_id}/statusIpSlaStatusIpSlaStatusUpdates the IP-SLA status matching the given ID.
GET.../ip-slas/history/{IpSlaHistory.ipsla_id}N/AIpSlaHistoryReturns the IP-SLA history matching the given ID.
GET.../ip-slas/jitter-voip/aggregated_results/{IpSlaJitterVoipResults.ipsla_id}N/AIpSlaJitterVoipResultsReturns the IP-SLA aggregated results for UDP Jitter/ Jitter-For-Voip for the given ID.
GET.../ip-slas/jitter-voip/results/{IpSlaJitterVoipResults.ipsla_id}N/AIpSlaJitterVoipResultsReturns the IP-SLA results for UDP Jitter/ Jitter-For-Voip for the given ID.
GET.../ip-slas/stats/{IpSlaMessageStats.ipsla_id}N/AIpSlaMessageStatsReturns the IP-SLA stats matching the given ID.

Service IpSlaResponder

HTTP MethodResourceRequestResponseDescription
GET.../ipsla_respondersN/AWiredElementListReturns IP-SLA Responder List
POST.../ipsla_respondersIpSlaResponderIpSlaResponderAdds the given IP-SLA responder to the model
GET.../ipsla_responders/{IpSlaResponder.responder_type}-{IpSlaResponder.destination_address.octets}-{IpSlaResponder.destination_port}-{IpSlaResponder.source_address.octets}N/AIpSlaResponderReturns the IP-SLA responder by given responder details
DELETE.../ipsla_responders/{IpSlaResponder.responder_type}-{IpSlaResponder.destination_address.octets}-{IpSlaResponder.destination_port}-{IpSlaResponder.source_address.octets}N/AN/ADeletes IP-SLA responder by given responder details

Service IpSlaResponderStats

HTTP MethodResourceRequestResponseDescription
GET.../ipslas_responders/statistics/{IpSlaResponder.responder_type}-{IpSlaResponder.destination_address.octets}-{IpSlaResponder.destination_port}-{IpSlaResponder.source_address.octets}N/AIpSlaResponderStatsReturns the IP-SLA responder statistics by responder details

Service IpSourceInterface

HTTP MethodResourceRequestResponseDescription
GET.../ip_source_interfaceN/AIpSourceInterfaceReturns all IP source-interfaces.
GET.../ip_source_interface/{IpSourceInterface.protocol}N/AIpSourceInterfaceReturns IP source-interface based on the protocol.
PUT.../ip_source_interface/{IpSourceInterface.protocol}IpSourceInterfaceIpSourceInterfaceUpdate IP source-interface record for a protocol. If both ip_addess and vlan_id are null, configuration will be removed based on protocol.
If both valid ip_address & vlan_id are given in REST request, ip_address will have preference over vlan_id.

Service IsolateList

HTTP MethodResourceRequestResponseDescription
GET.../isolate-listN/AWiredElementListReturns the list of all configured Isolate-List elements.
POST.../isolate-listIsolateListIsolateListAdds the given port into Isolate-List in the specified Vlan id.
GET.../isolate-list/{IsolateList.vlan_id}-{IsolateList.port_id}N/AIsolateListReturns the Isolate-List matching for the given Vlan & Port ID.
DELETE.../isolate-list/{IsolateList.vlan_id}-{IsolateList.port_id}N/AN/ADeletes the given Isolate-List port assignment from the vlan.
GET.../isolate-list/vlan/{Vlan.vlan_id}N/AWiredElementListReturns the list of all Isolate-List elements matching the given Vlan ID.

Service Lacp

HTTP MethodResourceRequestResponseDescription
GET.../lacp/portN/AWiredElementListReturns the list port trunk configurations
POST.../lacp/portLacpLacpAdds port to a Lacp Trunk
GET.../lacp/port/{Lacp.port_id}N/ALacpReturns the LACP Port Configuration
DELETE.../lacp/port/{Lacp.port_id}N/AN/ADeletes Port From A Lacp trunk;

Service Lldp

HTTP MethodResourceRequestResponseDescription
GET.../lldpN/ALldpGet LLDP Global Status
PUT.../lldpLldpLldpLLDP Global Configurations
GET.../lldp/auto_provision/radio_portsN/ALldpAutoProvisionRadioPortsRetrieve LLDP radio port automatic provisioning
PUT.../lldp/auto_provision/radio_portsLldpAutoProvisionRadioPortsLldpAutoProvisionRadioPortsSet LLDP radio port automatic provisioning
GET.../lldp/local-portN/ACommonElementListRetrieve the complete list of LLDP Local Port elements including OOBM port
GET.../lldp/local-port/{LldpLocalPort.port_name}N/ALldpLocalPortGet LLDP Local Port Configurations
PUT.../lldp/local-port/{LldpLocalPort.port_name}LldpLocalPortLldpLocalPortSet LLDP Local Port Configurations
GET.../lldp/local-port/oobmN/ALldpOobmPortRetrieve LLDP OOBM Port Configurations
PUT.../lldp/local-port/oobmLldpOobmPortLldpOobmPortSet LLDP OOBM Port Configurations
GET.../lldp/local_device/infoN/ALldpLocalDeviceRetrieve the LLDP Local Device Information.
GET.../lldp/local_device/portsN/ACommonElementListRetrieve the LLDP Local Information of all ports including OOBM.
GET.../lldp/local_device/ports/{LldpLocalDevicePort.port_name}N/ALldpLocalDevicePortRetrieve the LLDP Local Information per port.
GET.../lldp/local_device/ports/oobmN/ALldpLocalDevicePortRetrieve the Local OOBM port Information.
GET.../lldp/remote-deviceN/ACommonElementListRetrieve the LLDP Remote Information including devices connected to OOBM.
GET.../lldp/remote-device/{LldpRemoteDevice.local_port}N/ALldpRemoteDeviceRetrieve the LLDP Remote Information per port.
GET.../lldp/remote-device/oobmN/ALldpOobmRemoteDeviceRetrieve the OOBM Remote Information.
GET.../lldp/stats/deviceN/ALldpDeviceStatsRetrieve the LLDP Neighbour Stats.
GET.../lldp/stats/portsN/ACommonElementListRetrieve the LLDP Port Stats for all ports including OOBM.
GET.../lldp/stats/ports/{LldpPortStats.port_name}N/ALldpPortStatsRetrieve the LLDP per Port Stats.
GET.../lldp/stats/ports/oobmN/ALldpPortStatsRetrieve the LLDP OOBM Stats.

Service LocalUser

HTTP MethodResourceRequestResponseDescription
GET.../local_userN/AWiredElementListReturns the local user configuration matching the given user name Configuration.
POST.../local_userLocalUserLocalUserAdds a local user to the authorized group.
GET.../local_user/{LocalUser.local_user_name}N/ALocalUserReturns the local user configuration matching the given user name Configuration.
PUT.../local_user/{LocalUser.local_user_name}LocalUserLocalUserUpdates the local user Configuration matching the given user name.
DELETE.../local_user/{LocalUser.local_user_name}N/AN/ADeletes the local user Configuration with the given user name from the model.

Service LocatorLedBlink

HTTP MethodResourceRequestResponseDescription
GET.../led_locator_infoN/ALocatorLedInfoReturns the LED Locator information.
GET.../led_locator_info/{LocatorLedBlinkCommand.member_id}N/ALocatorLedResultReturns the LED Locator information by member.
POST.../locator-led-blinkLocatorLedBlinkCommandN/ATriggers a locator led blink based on the given parameters.

Service LoopProtect

HTTP MethodResourceRequestResponseDescription
GET.../loop_protectN/ALoopProtectReturns the attributes of loop protection
PUT.../loop_protectLoopProtectLoopProtectUpdates attributes of Loop Protection
GET.../loop_protect/portsN/AWiredElementListReturns Loop Protect configuration for all ports.
GET.../loop_protect/ports/{LoopProtectPort.port_id}N/ALoopProtectPortReturns Loop Protect per port details
PUT.../loop_protect/ports/{LoopProtectPort.port_id}LoopProtectPortLoopProtectPortUpdates attributes of Loop Protect per port.
GET.../loop_protect/vlansN/AWiredElementListRetrieves Loop Protect vlans
GET.../loop_protect/vlans/{LoopProtectVlan.vlan_id}N/ALoopProtectVlanRetrieves Loop Protect vlans by vlan_id
PUT.../loop_protect/vlans/{LoopProtectVlan.vlan_id}LoopProtectVlanLoopProtectVlanUpdates Loop Protect vlans by vlan_id

Service MacAuthentication

HTTP MethodResourceRequestResponseDescription
GET.../mac-authenticationN/AMacAuthenticationReturns the global MAC authentication configuration.
PUT.../mac-authenticationMacAuthenticationMacAuthenticationUpdates the global MAC authentication configuration.

Service MacAuthenticationPort

HTTP MethodResourceRequestResponseDescription
GET.../mac-authentication/portN/AWiredElementListReturns the list of MAC Authentication Port elements matching the given query.
GET.../mac-authentication/port/{MacAuthenticationPort.port_id}N/AMacAuthenticationPortReturns the MAC Authentication Port matching the given ID.
PUT.../mac-authentication/port/{MacAuthenticationPort.port_id}MacAuthenticationPortMacAuthenticationPortUpdates the given MAC Authentication Port in the model.

Service MacLockout

HTTP MethodResourceRequestResponseDescription
GET.../lockout_macN/AWiredElementListReturns all the locked out mac address list
POST.../lockout_macLockoutMacLockoutMacAdds the given mac address to lockout list for blacklisting
DELETE.../lockout_mac/{LockoutMac.mac_address}N/AN/ADeletes the mac address from the lockout list

Service MacTable

HTTP MethodResourceRequestResponseDescription
GET.../mac-tableN/AWiredElementListReturns a list of all MAC entries (capped to 1K right now).
GET.../mac-table/{MacAddress.octets}N/AMacTableEntryReturns the MAC table entry for the given MAC address.
GET.../ports/{Port.id}/mac-tableN/AWiredElementListReturns list of MAC entries learned on a given Port ID.
GET.../vlans/{Vlan.vlan_id}/mac-tableN/AWiredElementListReturns list of MAC entries learned on a given VLAN ID.

Service Module

HTTP MethodResourceRequestResponseDescription
GET.../modulesN/AModuleReturns the Module Information.

Service Oobm

HTTP MethodResourceRequestResponseDescription
GET.../oobmN/AOobmReturns the OOBM settings.
PUT.../oobmOobmOobmUpdates the OOBM settings.
GET.../oobm/interfaceN/AOobmInterfaceReturns the OOBM Interface settings of non-stacked switches
PUT.../oobm/interfaceOobmInterfaceOobmInterfaceUpdates the OOBM Interface settings of non-stacked switches
GET.../oobm/interface/membersN/AOobmInterfaceMembersReturns the OOBM Interface settings for all members in stacked switches
GET.../oobm/interface/members/{OobmInterface.member_id}N/AOobmInterfaceReturns the OOBM Interface settings per member_id in stacked switches
PUT.../oobm/interface/members/{OobmInterface.member_id}OobmInterfaceOobmInterfaceUpdates the OOBM Interface settings per member_id in stacked switches
GET.../oobm/interface/members/{OobmInterfaceStats.member_id}/statsN/AOobmInterfaceStatsReturns the OOBM Interface stats per member_id in stacked switches
GET.../oobm/interface/members/statsN/AOobmInterfaceMembersStatsReturns the OOBM Interface stats for all members in stacked switches
GET.../oobm/interface/statsN/AOobmInterfaceStatsReturns the OOBM Interface stats of non-stacked switches
GET.../oobm/ipN/AOobmIpReturns the Global OOBM IP settings
PUT.../oobm/ipOobmIpOobmIpUpdates the Global OOBM IP settings
GET.../oobm/ip/membersN/AOobmIpMembersReturns the OOBM IP settings for all members in stacked switches
GET.../oobm/ip/members/{OobmIp.member_id}N/AOobmIpReturns the OOBM IP settings per member_id in stacked switches
PUT.../oobm/ip/members/{OobmIp.member_id}OobmIpOobmIpUpdates the OOBM IP settings per member_id in stacked switches

Service PacketCapture

HTTP MethodResourceRequestResponseDescription
POST.../packet_capturePacketCapturePacketCaptureAdds the packet capture rule for the MAC on a given port.
DELETE.../packet_capture/{mac_address}-{port_id}N/AN/ADeletes the packet capture rule for the MAC on a given port.

Service Ping

HTTP MethodResourceRequestResponseDescription
POST.../pingPingCommandPingCommandResultTriggers a ping based on the given parameters.

Service Poe

HTTP MethodResourceRequestResponseDescription
GET.../members/{MemberPoe.member_id}/poeN/AMemberPoeReturns the member PoE details matching the given member ID in stacking enabled switches.
PUT.../members/{MemberPoe.member_id}/poeMemberPoeMemberPoeUpdates the given member PoE details matching the given member ID in stacking enabled switches.
GET.../poe/membersN/AWiredElementListReturns the list of member elements matching the given query in stacking enabled switches.
GET.../poe/portsN/AWiredElementListReturns the list of Port PoE elements matching the given query.
POST.../poe/ports/{PortPoe.port_id}/resetN/AN/AReset the PoE controller to which the port belongs.
GET.../poe/ports/statsN/AWiredElementListReturns the list of Port PoE Stats elements matching the given query.
GET.../poe/slotsN/AWiredElementListReturns the list of Slot PoE elements matching the given query.
GET.../ports/{PortPoe.port_id}/poeN/APortPoeReturns the Port PoE matching the given ID.
PUT.../ports/{PortPoe.port_id}/poePortPoePortPoeUpdates the given Port PoE in the model.
GET.../ports/{PortPoe.port_id}/poe/statsN/APortPoeStatsReturns the Port PoE stats matching the given ID.
GET.../slots/{SlotPoe.slot_name}/poeN/ASlotPoeReturns the Slot PoE matching the given ID.
PUT.../slots/{SlotPoe.slot_name}/poeSlotPoeSlotPoeUpdates the given Slot PoE.
GET.../system/status/power/consumptionN/ASystemPowerConsumptionStatsArrayReturns the Power-Consumption status of the host system.
GET.../system/status/power/supplyN/ASystemPowerSupplyStatsElementReturns the Power-Supply status of the host system.
GET.../system/status/power/supply/{SystemPowerSupplyStats.member_id}N/ASystemPowerSupplyStatsElementReturns the Power-Supply status of the host system by member id in stacked switch

Service Port

HTTP MethodResourceRequestResponseDescription
GET.../port-statisticsN/ACommonElementListReturns All Ports statistics.
GET.../port-statistics/{PortStatistics.id}N/APortStatisticsReturns the Port statistics matching the given ID.
GET.../portsN/ACommonElementListReturns the list of Port elements matching the given query.
GET.../ports/{Port.id}N/APortReturns the Port matching the given ID.
PUT.../ports/{Port.id}PortPortUpdates the given Port in the model.

Service PortMirrorSession

HTTP MethodResourceRequestResponseDescription
GET.../port-mirrorN/AWiredElementListReturns the list of Port Mirror Session elements matching the given query.
POST.../port-mirrorPortMirrorSessionPortMirrorSessionAdds the given Port Mirror Session to the model.
GET.../port-mirror/{PortMirrorSession.session_id}N/APortMirrorSessionReturns the Port Mirror Session matching the given ID.
PUT.../port-mirror/{PortMirrorSession.session_id}PortMirrorSessionPortMirrorSessionUpdates the given Port Mirror Session in the model.
DELETE.../port-mirror/{PortMirrorSession.session_id}N/AN/ADeletes the Port Mirror Session with the given ID from the model.

Service PortRateLimit

HTTP MethodResourceRequestResponseDescription
GET.../ports/icmp_rate_limitN/AWiredElementListReturns ICMP rate limit configurations for all ports
GET.../ports/icmp_rate_limit/{PortIcmpRateLimit.port_id}N/APortIcmpRateLimitReturns port ICMP rate limit per port id
PUT.../ports/icmp_rate_limit/{PortIcmpRateLimit.port_id}PortIcmpRateLimitPortIcmpRateLimitUpdates attributes of port ICMP rate limit per port id
POST.../ports/icmp_rate_limit_trap_clear/{PortIcmpRateLimitTrapClear.port_id}PortIcmpRateLimitTrapClearN/AClears an existing ICMP rate limiting trap condition.
GET.../ports/queues_rate_limitN/AWiredElementListReturns Egress queues rate limit configurations for all ports
GET.../ports/queues_rate_limit/{PortQueuesRateLimit.port_id}-{PortQueuesRateLimit.queues_direction}N/APortQueuesRateLimitReturns egress queues rate limit per port id
PUT.../ports/queues_rate_limit/{PortQueuesRateLimit.port_id}-{PortQueuesRateLimit.queues_direction}PortQueuesRateLimitPortQueuesRateLimitUpdates attributes of egress queues rate limit per port id
GET.../ports/rate_limitN/AWiredElementListReturns rate limit configurations for all ports and bcast, mcast, unknown-unicast and all traffic types
GET.../ports/rate_limit/{PortRateLimit.port_id}-{PortRateLimit.traffic_type}-{PortRateLimit.direction}N/APortRateLimitReturns port rate limit per port id, traffic type and direction
PUT.../ports/rate_limit/{PortRateLimit.port_id}-{PortRateLimit.traffic_type}-{PortRateLimit.direction}PortRateLimitPortRateLimitUpdates attributes of port rate limit per port id, traffic type and direction

Service PortSecurity

HTTP MethodResourceRequestResponseDescription
GET.../intrusion_logsN/AWiredElementListReturns the intrusion logs
GET.../portsec_policiesN/AWiredElementListReturns the list of Port Security elements matching the given query.
GET.../portsec_policies/{PortSecurityPolicy.port_id}N/APortSecurityPolicyReturns the Port Security matching the given ID.
PUT.../portsec_policies/{PortSecurityPolicy.port_id}PortSecurityPolicyPortSecurityPolicyUpdates the given Port Security in the model.
GET.../portsec_policies/{PortSecMacAddress.port_id}/mac_addresses/{PortSecMacAddress.mac_address.octets}N/APortSecMacAddressReturns the Port Security authorized mac address configured on a port.
MAC format in uri should be xxx-xxx.
DELETE.../portsec_policies/{PortSecMacAddress.port_id}/mac_addresses/{PortSecMacAddress.mac_address.octets}N/AN/ADeletes a given Port Security authorized mac address configured.
MAC format in uri should be xxx-xxx.
GET.../portsec_policies/mac_addressesN/AWiredElementListReturns all the Port Security authorized mac address configured.
POST.../portsec_policies/mac_addressesPortSecMacAddressPortSecMacAddressAdds an authorized mac address to port.

Service PrivateVlan

HTTP MethodResourceRequestResponseDescription
GET.../private-vlansN/ACommonElementListReturns all the primary/isolated/community details.
GET.../private-vlans/isl-portsN/ACommonElementListReturn list of isl ports associated to primary VID's.
GET.../private-vlans/promiscuous-portsN/ACommonElementListReturn list of promiscuous ports associated to primary VID's.

Service Qos

HTTP MethodResourceRequestResponseDescription
GET.../qos/dscp-mapN/ACommonElementListReturns the list of QoS DSCP Map elements matching the given query.
GET.../qos/dscp-map/{QosDscpMap.dscp_value}QosDscpMapQosDscpMapReturns the QoS DSCP Map matching the given ID.
PUT.../qos/dscp-map/{QosDscpMap.dscp_value}QosDscpMapQosDscpMapUpdates the given QoS DSCP Map in the model.
GET.../qos/policiesN/ACommonElementListReturns the list of QoS Policy elements matching the given query.
POST.../qos/policiesQosPolicyQosPolicyAdds the given QoS Policy to the model.
GET.../qos/policies-actionsN/ACommonElementListReturns the list of all QoS Policy actions.
GET.../qos/policies/{QosPolicy.id}QosPolicyQosPolicyReturns the QoS Policy matching the given ID.
DELETE.../qos/policies/{QosPolicy.id}N/AN/ADeletes the QoS Policy with the given ID from the model.
GET.../qos/policies/{QosPolicy.id}/policy-actionsQosPolicyCommonElementListReturns the list of QoS Policy Action elements matching the given query.
POST.../qos/policies/{QosPolicyAction.policy_id}/policy-actionsQosPolicyActionQosPolicyActionAdds the given QoS Policy Action to the model.
GET.../qos/policies/{QosPolicyAction.policy_id}/policy-actions/{QosPolicyAction.sequence_no}QosPolicyActionQosPolicyActionReturns the QoS Policy Action matching the given ID.
PUT.../qos/policies/{QosPolicyAction.policy_id}/policy-actions/{QosPolicyAction.sequence_no}QosPolicyActionQosPolicyActionUpdates the given QoS Policy Action in the model.
DELETE.../qos/policies/{QosPolicyAction.policy_id}/policy-actions/{QosPolicyAction.sequence_no}N/AN/ADeletes the QoS Policy Action with the given ID from the model.
POST.../qos/policies/{ResequenceCommand.policy_id}/policy-actions/resequenceResequenceCommandN/ATriggers a resequence of QoS Policy Action elements based on the given parameters.
GET.../qos/traffic-classesN/ACommonElementListReturns the list of QoS Traffic Class elements matching the given query.
POST.../qos/traffic-classesQosTrafficClassQosTrafficClassAdds the given QoS Traffic Class to the model.
GET.../qos/traffic-classes-matchesN/ACommonElementListReturns the QoS Class Matches for all the traffic classes.
GET.../qos/traffic-classes/{QosTrafficClass.id}QosTrafficClassQosTrafficClassReturns the QoS Traffic Class matching the given ID.
DELETE.../qos/traffic-classes/{QosTrafficClass.id}N/AN/ADeletes the QoS Traffic Class with the given ID from the model.
GET.../qos/traffic-classes/{QosTrafficClass.id}/matchesQosTrafficClassCommonElementListReturns the list of QoS Class Match elements matching the given query.
POST.../qos/traffic-classes/{QosClassMatch.traffic_class_id}/matchesQosClassMatchQosClassMatchAdds the given QoS Class Match to the model.
GET.../qos/traffic-classes/{QosClassMatch.traffic_class_id}/matches/{QosClassMatch.sequence_no}QosClassMatchQosClassMatchReturns the QoS Class Match matching the given ID.
PUT.../qos/traffic-classes/{QosClassMatch.traffic_class_id}/matches/{QosClassMatch.sequence_no}QosClassMatchQosClassMatchUpdates the given QoS Class Match in the model.
DELETE.../qos/traffic-classes/{QosClassMatch.traffic_class_id}/matches/{QosClassMatch.sequence_no}N/AN/ADeletes the QoS Class Match with the given ID from the model.
POST.../qos/traffic_classes/{ResequenceCommand.traffic_class_id}/matches/resequenceResequenceCommandN/ATriggers a resequence of QoS Class Match elements based on the given parameters.

Service QosPort

HTTP MethodResourceRequestResponseDescription
GET.../qos/ports-policiesN/AWiredElementListReturns the list of QoS Port Policy elements matching the given query.
POST.../qos/ports-policiesQosPortPolicyQosPortPolicyAdds the given QoS Port Policy to the model.
DELETE.../qos/ports-policies/{QosPortPolicy.port_id}-{QosPortPolicy.policy_id}-{QosPortPolicy.direction}N/AN/ADeletes the QoS Port Policy with the given ID from the model.
GET.../qos/ports-policies/{QosPortPolicyStats.port_id}-{QosPortPolicyStats.policy_id}/statsN/AQosPortPolicyStatsReturns the QoS statistics for given policy and Port

Service QosTrust

HTTP MethodResourceRequestResponseDescription
GET.../qos/trust/portsN/AWiredElementListReturns the QoS Trust configurations.
GET.../qos/trust/ports/{QosTrust.port_id}N/AQosTrustReturns the QoS Trust configuration by port_id.
PUT.../qos/trust/ports/{QosTrust.port_id}QosTrustQosTrustUpdate the QoS Trust configuration by port_id.

Service QosVlan

HTTP MethodResourceRequestResponseDescription
GET.../qos/vlans-policiesN/AWiredElementListReturns the list of QoS VLAN Policy elements matching the given query.
POST.../qos/vlans-policiesQosVlanPolicyQosVlanPolicyAdds the given QoS VLAN Policy to the model.
DELETE.../qos/vlans-policies/{QosVlanPolicy.vlan_id}-{QosVlanPolicy.policy_id}N/AN/ADeletes the QoS VLAN Policy with the given ID from the model.
GET.../qos/vlans-policies/{QosVlanPolicy.vlan_id}-{QosVlanPolicy.policy_id}/statsN/AQosVlanPolicyStatsReturns the QoS statistics for given policy and VLAN

Service RadiusAccountingStats

HTTP MethodResourceRequestResponseDescription
GET.../radius_accountingN/ARadiusAccountingStatsReturns the radius accounting statistics

Service RadiusAuthStats

HTTP MethodResourceRequestResponseDescription
GET.../radius_authenticationN/ARadiusAuthStatsReturns the radius authentication statistics

Service RadiusDynAuthorizationStats

HTTP MethodResourceRequestResponseDescription
GET.../radius_dyn_authorizationN/ARadiusDynAuthorizationStatsReturns the radius dyn-authorization statistics
GET.../radius_dyn_authorization/{RadiusDynAuthorizationStats.radius_server_id}N/ARadiusDynAuthorizationStatsReturns the radius dyn-authorization statistics based on server ID

Service RadiusProfile

HTTP MethodResourceRequestResponseDescription
GET.../radius_profileN/ARadiusProfileReturns the radius profile information.
PUT.../radius_profileRadiusProfileRadiusProfileUpdates the given Radius profile in the model.

Service RadiusServer

HTTP MethodResourceRequestResponseDescription
GET.../radius_serversN/ACommonElementListReturns the radius server information.
POST.../radius_serversRadiusServerRadiusServerCreate the given Radius server in the model.
GET.../radius_servers/{RadiusServer.radius_server_id}N/ARadiusServerReturns the given Radius server information.
PUT.../radius_servers/{RadiusServer.radius_server_id}RadiusServerRadiusServerUpdates the given Radius server in the model.
DELETE.../radius_servers/{RadiusServer.radius_server_id}N/AN/ADeletes the given radius server from the model.

Service RadiusServerGroup

HTTP MethodResourceRequestResponseDescription
POST.../radius/server_groupRadiusServerGroupRadiusServerGroupAdds the given Radius server group to the model.
GET.../radius/server_group/{RadiusServerGroup.server_group_name}N/ARadiusServerGroupReturns the Radius server group by name.
DELETE.../radius/server_group/{RadiusServerGroup.server_group_name}N/AN/ADeletes Radius server group by name.

Service RedundancyManagement

HTTP MethodResourceRequestResponseDescription
GET.../redundancy-managementN/ARedundancyManagementReturns the Redundancy Management settings. Applicable for Redundant Management switches
PUT.../redundancy-managementRedundancyManagementRedundancyManagementUpdates the Redundancy Management settings. Applicable for Redundant Management switches
GET.../redundancy-management/statsN/ARedundancyManagementStatsTableReturns the Redundancy Management stats.
POST.../redundancy-management/switchoverN/AN/ATriggers a redundancy switchover.

Service RemovePatchfileCommand

HTTP MethodResourceRequestResponseDescription
POST.../system/configuration_reset/patch_fileN/AErasePatchFileErase the stored patch file.

Service RestLoginSessions

HTTP MethodResourceRequestResponseDescription
POST.../login-sessionsRestLoginSessionsRestLoginSessionsResultAllow user to login to the system
DELETE.../login-sessionsN/AN/AAllow user to logout from the system

Service RestSessionIdleTimeout

HTTP MethodResourceRequestResponseDescription
GET.../session-idle-timeoutN/ARestSessionIdleTimeoutReturns the session idle timeout details.
PUT.../session-idle-timeoutRestSessionIdleTimeoutRestSessionIdleTimeoutUpdates the session idle timeout details.

Service RestVersion

HTTP MethodResourceRequestResponseDescription
GET.../versionN/AWiredElementListReturns the REST Version details.

Service SmartratePort

HTTP MethodResourceRequestResponseDescription
GET.../smartrate/portsN/ACommonElementListReturns the list of Smartrate Port elements matching the given query.
GET.../smartrate/ports/{SmartratePort.port_id}N/ASmartratePortReturns the Smartrate Port info and stats matching the given ID.

Service SnmpServer

HTTP MethodResourceRequestResponseDescription
GET.../snmp-serverN/ASnmpServerReturns properties of SNMP-Server.
PUT.../snmp-serverSnmpServerSnmpServerUpdates properties of SNMP-Server in the model.

Service SnmpServerCommunities

HTTP MethodResourceRequestResponseDescription
GET.../snmp-server/communitiesN/AWiredElementListReturns the SNMP-Server Community list.
POST.../snmp-server/communitiesSnmpServerCommunitySnmpServerCommunityAdds SNMP-Server Communities in the model.
GET.../snmp-server/communities/{SnmpServerCommunity.community_name}N/ASnmpServerCommunityReturns the SNMP-Server Community by name.
PUT.../snmp-server/communities/{SnmpServerCommunity.community_name}N/ASnmpServerCommunityUpdates the SNMP-Server Community by name.
DELETE.../snmp-server/communities/{SnmpServerCommunity.community_name}N/AN/ADeletes the SNMP-Server Community by name.

Service SnmpServerHosts

HTTP MethodResourceRequestResponseDescription
GET.../snmp-server/hostsN/AWiredElementListReturns the SNMP-Server Host details.
POST.../snmp-server/hostsSnmpServerHostSnmpServerHostAdds SNMP-Server Hosts in the model.
GET.../snmp-server/hosts/{SnmpServerHost.host_ip}-{SnmpServerHost.community}N/ASnmpServerHostReturns the SNMP-Server Host by name.
PUT.../snmp-server/hosts/{SnmpServerHost.host_ip}-{SnmpServerHost.community}SnmpServerHostSnmpServerHostUpdates SNMP-Server Host in the model.
DELETE.../snmp-server/hosts/{SnmpServerHost.host_ip}-{SnmpServerHost.community}N/AN/ADeletes the SNMP-Server Host by name.

Service SnmpServerMib

HTTP MethodResourceRequestResponseDescription
GET.../snmp-server/mibN/ASnmpServerMibReturns SNMP-Server MIB settings
PUT.../snmp-server/mibSnmpServerMibSnmpServerMibUpdates SNMP-Server MIB settings in the model.

Service SnmpServerResponseSource

HTTP MethodResourceRequestResponseDescription
GET.../snmp-server/response-sourceN/ASnmpServerResponseSourceReturns the SNMP-Server Response Source details.
PUT.../snmp-server/response-sourceSnmpServerResponseSourceSnmpServerResponseSourceUpdates SNMP-Server Response Source in the model.

Service SnmpServerTrapSource

HTTP MethodResourceRequestResponseDescription
GET.../snmp-server/trap-sourceN/ASnmpServerTrapSourceReturns the SNMP-Server Trap Source details.
PUT.../snmp-server/trap-sourceSnmpServerTrapSourceSnmpServerTrapSourceUpdates SNMP-Server Trap Source in the model.

Service SnmpServerTraps

HTTP MethodResourceRequestResponseDescription
GET.../snmp-server/trapsN/ASnmpServerTrapsReturns the SNMP-Server Traps.
PUT.../snmp-server/trapsSnmpServerTrapsSnmpServerTrapsUpdates the SNMP-Server Traps in the model.
GET.../snmp-server/traps/linktrapsN/AWiredElementListReturns the SNMP-Server Link Change Traps.
GET.../snmp-server/traps/linktraps/{SnmpServerLinkChangeTrap.port_id}N/ASnmpServerLinkChangeTrapReturns the SNMP-Server Link Traps for specified port.
PUT.../snmp-server/traps/linktraps/{SnmpServerLinkChangeTrap.port_id}SnmpServerLinkChangeTrapSnmpServerLinkChangeTrapUpdates the SNMP-Server Link Traps for specified port in the model.

Service Snmpv3

HTTP MethodResourceRequestResponseDescription
GET.../snmpv3N/ASnmpV3Returns the Snmpv3Server.
PUT.../snmpv3SnmpV3SnmpV3Updates the Snmpv3Server.
GET.../snmpv3/notify_namesN/AWiredElementListReturns all the Snmpv3Notify entries.
POST.../snmpv3/notify_namesSnmpV3NotifyNameSnmpV3NotifyNameAdds the given Snmpv3Notify entry.
GET.../snmpv3/notify_names/{SnmpV3NotifyName.notify_name}N/ASnmpV3NotifyNameReturns the specified Snmpv3Notify entry.
DELETE.../snmpv3/notify_names/{SnmpV3NotifyName.notify_name}N/AN/ADeletes the given Snmpv3Notify entry.
GET.../snmpv3/paramsN/AWiredElementListReturns all the Snmpv3Params entries.
POST.../snmpv3/paramsSnmpV3ParamSnmpV3ParamAdds the given Snmpv3Param entry.
GET.../snmpv3/params/{SnmpV3Param.parameter_name}N/ASnmpV3ParamReturns the specified Snmpv3Param entry.
PUT.../snmpv3/params/{SnmpV3Param.parameter_name}SnmpV3ParamSnmpV3ParamUpdates the given Snmpv3Param entry.
DELETE.../snmpv3/params/{SnmpV3Param.parameter_name}N/AN/ADeletes the given Snmpv3Param entry.
GET.../snmpv3/target_addressesN/AWiredElementListReturns all the Snmpv3TargetAddresses entries.
POST.../snmpv3/target_addressesSnmpV3TargetAddressSnmpV3TargetAddressAdds the given Snmpv3TargetAddress entry.
GET.../snmpv3/target_addresses/{SnmpV3TargetAddress.target_address_name}N/ASnmpV3TargetAddressReturns the specified Snmpv3TargetAddress entry.
PUT.../snmpv3/target_addresses/{SnmpV3TargetAddress.target_address_name}SnmpV3TargetAddressSnmpV3TargetAddressUpdates the given Snmpv3TargetAddress entry.
DELETE.../snmpv3/target_addresses/{SnmpV3TargetAddress.target_address_name}N/AN/ADeletes the given Snmpv3TargetAddress entry.
GET.../snmpv3/usersN/AWiredElementListReturns all the Snmpv3Users.
POST.../snmpv3/usersSnmpV3UserSnmpV3UserAdds the given Snmpv3User.
GET.../snmpv3/users/{SnmpV3User.user_name}N/ASnmpV3UserReturns the specified Snmpv3User.
PUT.../snmpv3/users/{SnmpV3User.user_name}SnmpV3UserSnmpV3UserUpdates the given Snmpv3User.
DELETE.../snmpv3/users/{SnmpV3User.user_name}N/AN/ADeletes the given Snmpv3User.

Service Sntp

HTTP MethodResourceRequestResponseDescription
GET.../system/sntpN/ASntpReturns SNTP system attributes.
PUT.../system/sntpSntpSntpUpdates SNTP system attributes.

Service SntpServerDetails

HTTP MethodResourceRequestResponseDescription
GET.../system/sntp_serverN/ACommonElementListReturns SNTP server system attributes.
POST.../system/sntp_serverSntpServerDetailsSntpServerDetailsAdd SNTP server system attributes.
GET.../system/sntp_server/{SntpServerDetails.sntp_server_priority}-{SntpServerDetails.sntp_server_address}N/ASntpServerDetailsReturns SNTP server system attributes.
DELETE.../system/sntp_server/{SntpServerDetails.sntp_server_priority}-{SntpServerDetails.sntp_server_address}N/AN/ADelete SNTP server system attributes.

Service SpanningTree

HTTP MethodResourceRequestResponseDescription
GET.../stpN/ASpanningTreeReturns Spanning Tree global configuration.
PUT.../stpSpanningTreeSpanningTreeUpdates attributes of SpanningTree
GET.../stp/portsN/AWiredElementListReturns Spanning Tree configuration for all ports.
GET.../stp/ports/{SpanningTreePort.port_id}N/ASpanningTreePortReturns Spanning Tree per port configuration
PUT.../stp/ports/{SpanningTreePort.port_id}SpanningTreePortSpanningTreePortUpdates attributes of SpanningTree per port.

Service SwitchConfig [Applicable for Central Customers Only]

HTTP MethodResourceRequestResponseDescription
GET.../switch-configN/ASwitchConfigReturns the config.
POST.../switch-configSwitchConfigCmdSwitchConfigCmdResultUpdates the given config to the model.
GET.../switch-config/statusN/ASwitchConfigStatusReturns the config upload status.

Service SwitchSystem

HTTP MethodResourceRequestResponseDescription
GET.../system/status/switchN/ASwitchSystemInfoStatsReturns the status of the Switch system.

Service Syslog

HTTP MethodResourceRequestResponseDescription
GET.../syslogN/ASyslogReturns the syslog details.
PUT.../syslogSyslogSyslogAdds the given syslog configurations.
GET.../syslog/serversN/AWiredElementListReturns the syslog server details.
POST.../syslog/serversSyslogServerSyslogServerAdds the given syslog server configurations.
GET.../syslog/servers/{SyslogServer.ip_address.octets}N/ASyslogServerReturns the syslog server details by server.
PUT.../syslog/servers/{SyslogServer.ip_address.octets}SyslogServerSyslogServerUpdates the Syslog server Configurations by server.
DELETE.../syslog/servers/{SyslogServer.ip_address.octets}N/AN/ADeletes the Syslog server Configurations by server.

Service SyslogEventCriteria

HTTP MethodResourceRequestResponseDescription
GET.../syslog/filters/{filter_name}/event-criteriasN/AWiredElementListReturns the syslog filter criteria details.
POST.../syslog/filters/{filter_name}/event-criteriasSyslogEventCriteriaSyslogEventCriteriaAdds the given syslog filter criteria configurations.
GET.../syslog/filters/{filter_name}/event-criterias/{criteria_id}N/ASyslogEventCriteriaReturns the syslog filter criteria details by Criteria id.
PUT.../syslog/filters/{filter_name}/event-criterias/{criteria_id}SyslogEventCriteriaSyslogEventCriteriaUpdate the Syslog EventCriteria Configurations by criteria id .
DELETE.../syslog/filters/{filter_name}/event-criterias/{criteria_id}N/AN/ADeletes the Syslog EventCriteria Configurations by criteria_id .

Service SyslogFilter

HTTP MethodResourceRequestResponseDescription
GET.../syslog/filtersN/AWiredElementListReturns the syslog filter details.
POST.../syslog/filtersSyslogFilterSyslogFilterAdds the given syslog configurations.
GET.../syslog/filters/{filter_name}N/ASyslogFilterGet the Syslog Filter Configurations by filter name .
PUT.../syslog/filters/{filter_name}SyslogFilterSyslogFilterUpdate the Syslog Filter Configurations by filter name .
DELETE.../syslog/filters/{filter_name}N/AN/ADeletes the Syslog Filter Configurations by filter name .

Service System

HTTP MethodResourceRequestResponseDescription
GET.../systemN/ASystemAttributesReturns the host system attributes.
PUT.../systemSystemAttributesSystemAttributesUpdates the host system attributes.
POST.../system/rebootRebootCommandN/ATriggers a system reboot based on the given parameters.
POST.../system/reboot/commanderN/AN/ATriggers a commander boot on stacked device
POST.../system/reboot/member/{MemberSystemStatusInfo.member_id}N/AN/ATriggers a member boot on stacked switch with given member_id
POST.../system/reboot/standbyN/AN/ATriggers a standby boot on stacked device
GET.../system/statusN/ASystemInfoStatsReturns the status of the host system for standalone switches.
GET.../system/status/global_infoN/AStackSystemInfoStatsGlobalReturns the global system information for stacked switches.
GET.../system/status/membersN/ACommonElementListReturns the list of member specific system information for stacked switches.
GET.../system/status/members/{MemberSystemStatusInfo.member_id}N/AMemberSystemStatusInfoReturns the member specific system information for stacked switches.
GET.../system/timeN/ASystemTimeReturns the host system time configuration.
PUT.../system/timeSystemTimeSystemTimeUpdates the host system time configuration.
POST.../system/time/set-manuallySetSystemDateTimeCommandN/ASets the system date/time based on the given parameters.

Service SystemVariable [Applicable for Central Customers Only]

HTTP MethodResourceRequestResponseDescription
GET.../system_variablesN/AWiredElementListReturns the list of system variable elements matching the given query.
GET.../system_variables/{SystemVariable.system_variable_id}N/ASystemVariableReturns the system variables matching the given ID.

Service TACACSProfile

HTTP MethodResourceRequestResponseDescription
GET.../tacacs_profileN/ATacacsProfileReturns TACACS Profile.
PUT.../tacacs_profileTacacsProfileTacacsProfileUpdates attributes of TACACS Profile.
GET.../tacacs_profile/serverN/AWiredElementListReturns all TACACS Profile Servers
POST.../tacacs_profile/serverTacacsServerTacacsServerAdds a server to TACACS Profile.
GET.../tacacs_profile/server/{TacacsServer.server_ip.octets}N/ATacacsServerReturns a TACACS Profile Server with matching IP Address
PUT.../tacacs_profile/server/{TacacsServer.server_ip.octets}TacacsServerTacacsServerUpdates TACACS Server attributes with matching IP Address.
DELETE.../tacacs_profile/server/{TacacsServer.server_ip.octets}N/AN/ARemoves TACACS Profile Server with matching IP Address

Service TaConfig

HTTP MethodResourceRequestResponseDescription
GET.../ta_profilesN/AWiredElementListReturns the list of TA Profiles matching the given query.
POST.../ta_profilesTaProfileTaProfileAdds the given TA profile to the system.
GET.../ta_profiles/{TaProfile.ta_name}N/ATaProfileReturns the TA profile configuration matching the given profile name.
PUT.../ta_profiles/{TaProfile.ta_name}TaProfileTaProfileUpdates the TA Profile Configuration matching the given profile name.
DELETE.../ta_profiles/{TaProfile.ta_name}N/AN/ADeletes the TA profile Configuration with the given profile name from the model.

Service TelnetServer

HTTP MethodResourceRequestResponseDescription
GET.../telnet/serverN/ATelnetServerReturns the telnet server configuration
PUT.../telnet/serverTelnetServerTelnetServerUpdates the telnet server configuration

Service TftpClient

HTTP MethodResourceRequestResponseDescription
GET.../tftp/clientN/ATftpClientReturns TFTP Client system attributes.
PUT.../tftp/clientTftpClientTftpClientUpdates TFTP Client system attributes.

Service TraceRoute

HTTP MethodResourceRequestResponseDescription
POST.../trace-routeTraceRouteCommandTraceRouteCommandResultTriggers a trace route based on the given parameters.

Service Transceiver

HTTP MethodResourceRequestResponseDescription
GET.../transceiversN/AWiredElementListReturns the list of Transceiver elements matching the given query.
GET.../transceivers/{Transceiver.serial_number}N/ATransceiverReturns the Transceiver matching the given ID.
GET.../transceivers/{Transceiver.serial_number}/diagnosticsN/ATransceiverDiagnosticsReturns the Transceiver Diagnostics matching the given ID.

Service Trunk

HTTP MethodResourceRequestResponseDescription
GET.../trunk/portN/AWiredElementListReturns the list port trunk configurations
POST.../trunk/portTrunkTrunkAdds port to a Static Manual Trunk
GET.../trunk/port/{Trunk.port_id}N/ATrunkReturns the TRUNK Port Configuration
DELETE.../trunk/port/{Trunk.port_id}N/AN/ADeletes Port From A Trunk;

Service TunneledNode

HTTP MethodResourceRequestResponseDescription
GET.../tunneled_node_serverN/ATunneledNodeServerReturns the Tunneled Node configurations.
PUT.../tunneled_node_serverTunneledNodeServerTunneledNodeServerUpdate the Tunneled Node configurations.
GET.../tunneled_node_server/portsN/AWiredElementListReturns all the Tunneled Node Ports configurations.
GET.../tunneled_node_server/ports/{TunneledNodePort.port_id}N/ATunneledNodePortReturns the Tunneled Node configurations per port.
PUT.../tunneled_node_server/ports/{TunneledNodePort.port_id}TunneledNodePortTunneledNodePortUpdate the Tunneled Node Port configurations.
GET.../tunneled_node_server/ports/{TunneledNodePortStatistics.port_id}/statisticsN/ATunneledNodePortStatisticsReturns the Tunneled Node Server statistics per port.
GET.../tunneled_node_server/ports/aggregate_statisticsN/ATunneledNodeAggregateStatisticsReturns the Tunneled Node aggregate statistics.
GET.../tunneled_node_server/ports/statisticsN/AWiredElementListReturns the Tunneled Node Server statistics for all ports.
GET.../tunneled_node_server/userN/AWiredElementListReturns the User Based Tunneled Node information.

Service Vlan

HTTP MethodResourceRequestResponseDescription
GET.../vlansN/ACommonElementListReturns the list of VLAN elements matching the given query.
POST.../vlansVlanVlanAdds the given VLAN to the model.
GET.../vlans/{Vlan.vlan_id}N/AVlanReturns the VLAN matching the given ID.
PUT.../vlans/{Vlan.vlan_id}VlanVlanUpdates the given VLAN in the model.
DELETE.../vlans/{Vlan.vlan_id}N/AN/ADeletes the VLAN with the given ID from the model.

Service VlanPort

HTTP MethodResourceRequestResponseDescription
GET.../vlans-portsN/ACommonElementListReturns the list of VLAN-Port elements matching the given query.
POST.../vlans-portsVlanPortVlanPortAdds the given VLAN-Port using the specified mode.
GET.../vlans-ports/{VlanPort.vlan_id}-{VlanPort.port_id}N/AVlanPortReturns the VLAN-Port matching the given ID.
PUT.../vlans-ports/{VlanPort.vlan_id}-{VlanPort.port_id}VlanPortVlanPortUpdates the given VLAN-Port using the specified mode.
DELETE.../vlans-ports/{VlanPort.vlan_id}-{VlanPort.port_id}N/AN/ADeletes the given VLAN-Port assignment from the model.

Service VsfCommand

HTTP MethodResourceRequestResponseDescription
POST.../stacking/vsf/disableN/AN/ADisable VSF stack
POST.../stacking/vsf/enableVsfEnableCommandN/AEnable and Modify domain of VSF stack
POST.../stacking/vsf/member/removeVsfRemoveMemberCommandN/ARemoves the member specified by member id and reboots the member if reboot is true
POST.../stacking/vsf/member/shutdownVsfMemberShutdownCommandN/AShutdown the member specified by member id
POST.../stacking/vsf/sequenced_rebootVsfSequencedRebootCommandN/AInitiate a reboot of the VSF virtual chassis

Service VsfConfig

HTTP MethodResourceRequestResponseDescription
GET.../stacking/vsf/global_configN/AVsfGlobalConfigReturns the VSF Global Configuration.
PUT.../stacking/vsf/global_configVsfGlobalConfigVsfGlobalConfigUpdates the VSF Global Configuration.
GET.../stacking/vsf/infoN/AVsfStackInfoReturns the VSF stack Information.
GET.../stacking/vsf/membersN/AWiredElementListReturns the list of VSF Members matching the given query.
POST.../stacking/vsf/membersVsfMemberVsfMemberAdds the given VSF Member to the system.
GET.../stacking/vsf/members/{VsfMember.member_id}N/AVsfMemberReturns the VSF Member Configuration matching the given ID.
PUT.../stacking/vsf/members/{VsfMember.member_id}VsfMemberVsfMemberUpdates the VSF Member Configuration matching the given ID.
GET.../stacking/vsf/members/{member_id}/linksN/AWiredElementListReturns the list of VSF Links matching the given query.
POST.../stacking/vsf/members/{VsfLink.member_id}/linksVsfLinkVsfLinkAdds the given VSF Link to the system.
GET.../stacking/vsf/members/{VsfLink.member_id}/links/{VsfLink.link_id}N/AVsfLinkReturns the VSF Link Configuration matching the given ID.
PUT.../stacking/vsf/members/{VsfLink.member_id}/links/{VsfLink.link_id}VsfLinkVsfLinkUpdates the VSF Link Configuration matching the given ID.
DELETE.../stacking/vsf/members/{VsfLink.member_id}/links/{VsfLink.link_id}N/AN/ADeletes the VSF Link with the given ID from the model.
GET.../stacking/vsf/members/{member_id}/links/{link_id}/portsN/AWiredElementListReturns the list of VSF Ports matching the given query.
POST.../stacking/vsf/members/{VsfPort.member_id}/links/{VsfPort.link_id}/portsVsfPortVsfPortAdds the given VSF Port to the link
DELETE.../stacking/vsf/members/{VsfPort.member_id}/links/{VsfPort.link_id}/ports/{VsfPort.port_id}N/AN/ADeletes the VSF Port from the link
GET.../stacking/vsf/members/system_infoN/AWiredElementListReturns the list of VSF Member Information matching the given query.
GET.../stacking/vsf/members/system_info/{VsfMemberSystemInfo.member_id}N/AVsfMemberSystemInfoReturns the VSF Member Information matching the given ID.
GET.../stacking/vsf/members_links_portsN/AVsfMembersLinksPortsReturns the list of VSF Members-Links-Ports Associations in the system.

Service WebAuth

HTTP MethodResourceRequestResponseDescription
GET.../webauthN/AWebAuthReturns the global WEB Auth configuration.
PUT.../webauthWebAuthWebAuthUpdates the global WEB Auth configuration.

Service WebAuthPort

HTTP MethodResourceRequestResponseDescription
GET.../webauth/portN/AWiredElementListReturns the list of WEB Auth Port elements matching the given query.
GET.../webauth/port/{WebAuthPort.port_id}N/AWebAuthPortReturns the WEB Auth Port matching the given ID.
PUT.../webauth/port/{WebAuthPort.port_id}WebAuthPortWebAuthPortUpdates the given WEB Auth Port in the model.