| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../accounting | N/A | Accounting | Returns accounting configuration. |
| PUT | .../accounting | Accounting | Accounting | Updates the given accounting configuration to the system. |
| GET | .../accounting/sessions | N/A | AccountingSessions | Returns accounting sessions. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../acls | N/A | CommonElementList | Returns the list of ACL elements matching the given query. |
| POST | .../acls | Acl | Acl | Adds the given ACL to the model. |
| GET | .../acls/{Acl.id} | N/A | Acl | Returns the ACL matching the given ID. |
| DELETE | .../acls/{Acl.id} | N/A | N/A | Deletes the ACL with the given ID from the model. |
| GET | .../acls/{Acl.id}/rules | N/A | CommonElementList | Returns the list of ACL Rule elements matching the given query. |
| POST | .../acls/{AclRule.acl_id}/rules | AclRule | AclRule | Adds the given ACL Rule to the model. |
| GET | .../acls/{AclRule.acl_id}/rules/{AclRule.sequence_no} | N/A | AclRule | Returns the ACL Rule matching the given ID. |
| PUT | .../acls/{AclRule.acl_id}/rules/{AclRule.sequence_no} | AclRule | AclRule | Updates the given ACL Rule in the model. |
| DELETE | .../acls/{AclRule.acl_id}/rules/{AclRule.sequence_no} | N/A | N/A | Deletes the ACL Rule with the given ID from the model. |
| POST | .../acls/{ResequenceCommand.acl_id}/rules/resequence | ResequenceCommand | N/A | Triggers a resequence of ACL Rule elements based on the given parameters. |
| GET | .../acls/deny_fragmented_tcp_header | N/A | TcpFragHeader | Returns the ACL deny-fragmented-tcp-header . |
| PUT | .../acls/deny_fragmented_tcp_header | TcpFragHeader | TcpFragHeader | Update deny-fragmented-tcp-header. |
| GET | .../acls/rules | N/A | CommonElementList | Returns the list of ACL Rule elements for all the ACLs. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../ports-access-groups | N/A | WiredElementList | Returns the list of ACL Port Policy elements matching the given query. |
| POST | .../ports-access-groups | AclPortPolicy | AclPortPolicy | Adds the given ACL Port Policy to the model. |
| DELETE | .../ports-access-groups/{AclPortPolicy.port_id}-{AclPortPolicy.acl_id}-{AclPortPolicy.direction} | N/A | N/A | Deletes the ACL Port Policy with the given ID from the model. |
| GET | .../ports-access-groups/{AclPortPolicy.port_id}-{AclPortPolicy.acl_id}-{AclPortPolicy.direction}/stats | N/A | AclPortPolicyStats | Returns the ACL statistics for given ACL ID, Port and Direction |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../vlans-access-groups | N/A | WiredElementList | Returns the list of ACL VLAN Policy elements matching the given query. |
| POST | .../vlans-access-groups | AclVlanPolicy | AclVlanPolicy | Adds the given ACL VLAN Policy to the model. |
| DELETE | .../vlans-access-groups/{AclVlanPolicy.vlan_id}-{AclVlanPolicy.acl_id}-{AclVlanPolicy.direction} | N/A | N/A | Deletes the ACL VLAN Policy with the given ID from the model. |
| GET | .../vlans-access-groups/{AclVlanPolicy.vlan_id}-{AclVlanPolicy.acl_id}-{AclVlanPolicy.direction}/stats | N/A | AclVlanPolicyStats | Returns the ACL statistics for given ACL ID, VLAN and Direction |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../activate | ActivateProvisionRequest | ActivateProvisionResult | Enable system provisioning using Aruba Activate. |
| GET | .../activate/config | N/A | ActivateConfig | Returns Aruba Activate provisioning configuration. |
| PUT | .../activate/config | ActivateConfig | ActivateConfig | Updates attributes for Aruba Activate provisioning. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../allow_unsupported_transceiver | N/A | AllowUnsupportedTransceiver | Returns AllowUnsupportedTransceiver system attribute. |
| PUT | .../allow_unsupported_transceiver | AllowUnsupportedTransceiver | AllowUnsupportedTransceiver | Updates AllowUnsupportedTransceiver system attribute. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../arp-protect | N/A | ArpProtect | Returns the attributes of arp protection |
| PUT | .../arp-protect | ArpProtect | ArpProtect | Updates attributes of Arp Protection |
| GET | .../arp-protect/ports | N/A | WiredElementList | Returns Arp Protect configuration for all ports. |
| GET | .../arp-protect/ports/{ArpProtectPort.port_id} | N/A | ArpProtectPort | Returns Arp Protect per port details |
| PUT | .../arp-protect/ports/{ArpProtectPort.port_id} | ArpProtectPort | ArpProtectPort | Updates attributes of Arp Protect per port. |
| GET | .../arp-protect/vlans | N/A | WiredElementList | Retrieves Arp Protect vlans |
| GET | .../arp-protect/vlans/{ArpProtectVlan.vlan_id} | N/A | ArpProtectVlan | Retrieves Arp Protect vlans by vlan_id |
| PUT | .../arp-protect/vlans/{ArpProtectVlan.vlan_id} | ArpProtectVlan | ArpProtectVlan | Updates Arp Protect vlans by vlan_id |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../arp-table | N/A | WiredElementList | Returns a list of all ARP entries (capped to 1K right now). |
| GET | .../arp-table/{IpAddress.octets} | N/A | ArpTableEntry | Returns list of ARP entries learned on a given IP Address. |
| GET | .../arp-table/mac-address/{MacAddress.octets} | N/A | WiredElementList | Returns the ARP table entry for the given MAC address. |
| GET | .../arp-table/vlan/{Vlan.vlan_id} | N/A | WiredElementList | Returns list of ARP entries learned on a given VLAN ID. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../amp-server | N/A | AmpServer | Returns the Amp server IP, group, folder and secret |
| PUT | .../amp-server | AmpServer | AmpServer | Configure the Amp Server |
| DELETE | .../amp-server | N/A | N/A | Deletes the Aruba VPN configuration. |
| GET | .../aruba-vpn | N/A | ArubaVpn | Returns the Aruba VPN type, peer IP address,ToS and TTL value. |
| PUT | .../aruba-vpn | ArubaVpn | ArubaVpn | Configure the Aruba VPN |
| DELETE | .../aruba-vpn | N/A | N/A | Deletes the Aruba VPN configuration. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../auth_order | N/A | WiredElementList | Returns all auth-order for clients configuration |
| POST | .../auth_order | AuthOrder | AuthOrder | Adds the given auth-order for clients to the model. |
| GET | .../auth_order/{AuthOrder.port_id} | N/A | AuthOrder | Returns the given auth-order for clients configuration |
| PUT | .../auth_order/{AuthOrder.port_id} | AuthOrder | AuthOrder | Update the given auth-order for clients to the model. |
| DELETE | .../auth_order/{AuthOrder.port_id} | N/A | N/A | Deletes the given auth-order for clients configuration |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../auth_priority | N/A | WiredElementList | Returns all auth-priority for clients configuration |
| POST | .../auth_priority | AuthPriority | AuthPriority | Adds the given auth-priority for clients to the model. |
| GET | .../auth_priority/{AuthPriority.port_id} | N/A | AuthPriority | Returns the given auth-priority for clients configuration |
| PUT | .../auth_priority/{AuthPriority.port_id} | AuthPriority | AuthPriority | Update the given auth-priority for clients to the model. |
| DELETE | .../auth_priority/{AuthPriority.port_id} | N/A | N/A | Deletes the given auth-priority for clients configuration |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../authentication | N/A | Authentication | Returns authentication configuration. |
| PUT | .../authentication | Authentication | Authentication | Updates the given authentication configuration to the system. |
| GET | .../authentication/console | N/A | AuthenticationConsole | Returns console authentication configuration . |
| PUT | .../authentication/console | AuthenticationConsole | AuthenticationConsole | Updates the given console authentication configuration to the system. |
| GET | .../authentication/last_login/{AuthenticationLastLogin.last_login_order} | N/A | AuthenticationLastLogin | Returns authentication last-login users. |
| GET | .../authentication/mac_based | N/A | AuthenticationMacbased | Returns mac based authentication configuration. |
| PUT | .../authentication/mac_based | AuthenticationMacbased | AuthenticationMacbased | Updates the given mac based authentication configuration to the system. |
| GET | .../authentication/rest | N/A | AuthenticationRest | Returns Rest authentication configuration . |
| PUT | .../authentication/rest | AuthenticationRest | AuthenticationRest | Updates the given rest authentication configuration to the system. |
| GET | .../authentication/ssh | N/A | AuthenticationSsh | Returns ssh authentication configuration. |
| PUT | .../authentication/ssh | AuthenticationSsh | AuthenticationSsh | Updates the given ssh authentication configuration to the system. |
| GET | .../authentication/telnet | N/A | AuthenticationTelnet | Returns telnet authentication configuration . |
| PUT | .../authentication/telnet | AuthenticationTelnet | AuthenticationTelnet | Updates the given telnet authentication configuration to the system. |
| GET | .../authentication/web | N/A | AuthenticationWeb | Returns web authentication configuration . |
| PUT | .../authentication/web | AuthenticationWeb | AuthenticationWeb | Updates the given web authentication configuration to the system. |
| GET | .../authentication/web_based | N/A | AuthenticationWebbased | Returns web based authentication configuration . |
| PUT | .../authentication/web_based | AuthenticationWebbased | AuthenticationWebbased | Updates the given web based authentication configuration to the system. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../authorization | N/A | Authorization | Returns authorization configuration. |
| PUT | .../authorization | Authorization | Authorization | Updates the given authorization configuration to the system. |
| GET | .../authorization_group | N/A | WiredElementList | Returns all authorization group in the system. |
| POST | .../authorization_group | AuthorizationGroup | AuthorizationGroup | Creates the new authorization group in the system. |
| GET | .../authorization_group/{AuthorizationGroup.group_name}-{AuthorizationGroup.seq_num} | N/A | AuthorizationGroup | Returns authorization group configuration. |
| PUT | .../authorization_group/{AuthorizationGroup.group_name}-{AuthorizationGroup.seq_num} | AuthorizationGroup | AuthorizationGroup | Modify authorization group in the system. |
| DELETE | .../authorization_group/{AuthorizationGroup.group_name}-{AuthorizationGroup.seq_num} | N/A | N/A | Returns authorization group configuration. |
| GET | .../authorization_rest_group | N/A | WiredElementList | Returns all authorization rest-uri group in the system. |
| POST | .../authorization_rest_group | AuthorizationRestGroup | AuthorizationRestGroup | Creates the new authorization rest-uri group in the system. |
| GET | .../authorization_rest_group/{AuthorizationRestGroup.group_name}-{AuthorizationRestGroup.seq_num} | N/A | AuthorizationRestGroup | Returns authorization rest group configuration based on sequence num and group name. |
| PUT | .../authorization_rest_group/{AuthorizationRestGroup.group_name}-{AuthorizationRestGroup.seq_num} | AuthorizationRestGroup | AuthorizationRestGroup | Modify authorization rest-uri group in the system. |
| DELETE | .../authorization_rest_group/{AuthorizationRestGroup.group_name}-{AuthorizationRestGroup.seq_num} | N/A | N/A | Returns authorization rest group configuration based on sequence num and group name. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../authorization_user_role_state | N/A | AuthorizationUserRole | Returns authorization user-role state and initial-role mapping in the system. |
| PUT | .../authorization_user_role_state | AuthorizationUserRole | AuthorizationUserRole | Updates global user-role config and initial-role mapping. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../authorization_user_role | N/A | WiredElementList | Returns all authorization user-roles in the system. |
| POST | .../authorization_user_role | AuthorizationUserRoleName | AuthorizationUserRoleName | Add authorization user-role in the system. |
| GET | .../authorization_user_role/{AuthorizationUserRoleName.user_role_name} | N/A | AuthorizationUserRoleName | Returns authorization user-role based on name in the system. |
| PUT | .../authorization_user_role/{AuthorizationUserRoleName.user_role_name} | AuthorizationUserRoleName | AuthorizationUserRoleName | Modify authorization user-role in the system. |
| DELETE | .../authorization_user_role/{AuthorizationUserRoleName.user_role_name} | N/A | N/A | Deletes authorization user-role in the system. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../banner | N/A | Banner | Returns Banner system attributes. |
| PUT | .../banner | Banner | Banner | Updates Banner system attributes. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../stacking/bps/disable | N/A | N/A | Disable BPS stack |
| POST | .../stacking/bps/enable | BpsEnableCommand | N/A | Enable BPS stack. Request body is optional to execute this API |
| POST | .../stacking/bps/factory_reset | N/A | N/A | Erase the startup config and all knowledge of other stack members. |
| POST | .../stacking/bps/member/remove | BpsMemberRemoveCommand | N/A | Erases the stack member's configuration. |
| POST | .../stacking/bps/member/shutdown | BpsMemberShutdownCommand | N/A | Shut down the specified stack member. |
| POST | .../stacking/bps/set_stack | N/A | N/A | To set an active stack after split. Not applicable for inactive stack. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../stacking/bps/info | N/A | BpsGlobalConfig | Returns the BPS stack information. |
| PUT | .../stacking/bps/info | BpsGlobalConfig | BpsGlobalConfig | Updates the BPS stack information. |
| GET | .../stacking/bps/members | N/A | WiredElementList | Returns all BPS members' configuration. |
| POST | .../stacking/bps/members | BpsMember | BpsMember | Adds the BPS member matching the given member ID. |
| GET | .../stacking/bps/members/{BpsMember.member_id} | N/A | BpsMember | Returns the BPS member's configuration matching the given member ID. |
| PUT | .../stacking/bps/members/{BpsMember.member_id} | BpsMember | BpsMember | Updates the BPS member's configuration matching the given member ID. |
| GET | .../stacking/bps/members/system_info | N/A | WiredElementList | Returns all BPS members' system information. |
| GET | .../stacking/bps/members/system_info/{BpsMemberSystemInfo.member_id} | N/A | BpsMemberSystemInfo | Returns the BPS member's system information matching the given member ID. |
| GET | .../stacking/bps/stack_ports | N/A | WiredElementList | Returns all BPS stack ports. |
| GET | .../stacking/bps/stack_ports/members/{BpsStackPort.member_id}/stack_port/{BpsStackPort.stacking_port} | N/A | BpsStackPort | Returns the details of the specified stack port of the member matching the given member ID. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../cable_diagnostics | N/A | N/A | To 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/clear | N/A | N/A | To clear cable diagnostics on all ports. |
| POST | .../cable_diagnostics/clear/port | CableDiagnosticsCommand | N/A | To clear cable diagnostics results on a port |
| POST | .../cable_diagnostics/port | CableDiagnosticsCommand | N/A | To 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/status | N/A | WiredElementList | Returns cable diagnostics status |
| GET | .../cable_diagnostics/status/{CableDiagnostics.port_id} | N/A | CableDiagnostics | Returns cable diagnostics status per port |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../captive_portal | N/A | CaptivePortal | Returns the global Captive Portal Configuration. |
| PUT | .../captive_portal | CaptivePortal | CaptivePortal | Updates the global Captive Portal Configuration. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../cdp | N/A | Cdp | Returns the global CDP configuration data. |
| PUT | .../cdp | Cdp | Cdp | Updates the global CDP configuration data. |
| GET | .../cdp/port | N/A | CommonElementList | Returns the CDP configuration data for all the ports |
| GET | .../cdp/port/{CdpPort.port_id} | N/A | CdpPort | Returns the CDP configuration data per port |
| PUT | .../cdp/port/{CdpPort.port_id} | CdpPort | CdpPort | Updates the CDP configuration data per port. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../system/config/cfg_backup_files | N/A | WiredElementList | Returns the list of backup configuration file details. |
| POST | .../system/config/cfg_backup_files | CfgBackupconf | ConfigFileDetails | Save the given configuration File to the system. |
| GET | .../system/config/cfg_backup_files/{ConfigFileDetails.file_name} | N/A | ConfigFileDetails | Returns the details of backup configuration files by name. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../system/config/cfg_restore | CfgRestore | CurrentRestoreStatus | Restore the given configuration as the running
configuration without reboot. REST performs the config restoration in non-blocking mode. |
| GET | .../system/config/cfg_restore/status | N/A | CfgRestoreDetails | Returns the status of cfg-restore process. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../system/config/cfg_restore/latest_diff | CfgRestoreDiff | CurrentDiffStatus | Provide the list of changes that will be applied on the running configuration. |
| GET | .../system/config/cfg_restore/latest_diff/status | N/A | CfgRestoreDiffStatus | Returns the status difference between two configuration files. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../system/config/cfg_restore/payload | CfgRestorePayload | CfgRestorePayloadStatus | Accepts the encoded input and restore it as running configuration;
REST performs the config restoration in non-blocking mode. |
| GET | .../system/config/cfg_restore/payload/status | N/A | CfgRestoreDetails | Returns the status of the applied encoded configuration file. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../system/config/cfg_restore/payload/latest_diff | CfgRestorePayloadDiff | CurrentPayloadDiffStatus | Provide the list of changes that will be applied on the running configuration. |
| GET | .../system/config/cfg_restore/payload/latest_diff/status | N/A | CfgRestoreDiffStatus | Returns the status difference between two configuration files. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../cli_batch | CliBatchCommand | CliBatchCommandResult | CLI batch command. |
| GET | .../cli_batch/status | N/A | CliBatchResult | CLI batch command status. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../cli | CliCommand | CliCommandResult | CLI command interface. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../system/config/config_hash | N/A | ConfigHash | Returns the SHA of startup configuration. |
| GET | .../system/config/running_config_hash | N/A | RunningConfigHash | Returns the SHA of running configuration. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../system/config/payload | ConfigPayload | ConfigPayloadStatus | Accepts 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. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../system/configuration-reset | N/A | N/A | Reset the system configuration. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../crypto_clearpass | N/A | CryptoClearpassOptions | Returns the Crypto Clearpass CA download options. |
| PUT | .../crypto_clearpass | CryptoClearpassOptions | CryptoClearpassOptions | Updates the Crypto Clearpass CA download options. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../crypto_pki/create_csr | CsrConfigDetail | LocalCertificateDetail | Creates CSR for given Certificate Name, TA Profile and returns the Certificate Signed Request. |
| POST | .../crypto_pki/install_signed_certificate | SignedCertificateDetail | N/A | Install Signed Certificate. |
| GET | .../crypto_pki/local_certificate | N/A | WiredElementList | Returns the list of Local Certificate details matching the given query. |
| GET | .../crypto_pki/local_certificate/{LocalCertificateDetail.certificate_name} | N/A | LocalCertificateDetail | Returns the CSR matching the given Local Certificate Name. |
| DELETE | .../crypto_pki/local_certificate/{LocalCertificateDetail.certificate_name} | N/A | N/A | Delete Local Certificate Details. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../debug-log/filter | DebugLogFilterCommand | DebugLogStats | Triggers a filtering of the debug logs based on the given parameters. |
| GET | .../debug-log/status | N/A | DebugLogStats | Returns the status of the debug log filters. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../deviceFingerPrinting/{deviceFingerprinting.port} | N/A | WiredElementList | Returns all the device finger printing client details which got from cppm |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../management-user | N/A | CommonElementList | Returns the list of Management User elements matching the given query. |
| POST | .../management-user | DeviceManagementUser | DeviceManagementUser | Adds the given Management User to the model. |
| GET | .../management-user/{DeviceManagementUser.type} | N/A | DeviceManagementUser | Returns the Management User matching the given ID. |
| PUT | .../management-user/{DeviceManagementUser.type} | DeviceManagementUser | DeviceManagementUser | Updates the given Management User in the model. |
| DELETE | .../management-user/{DeviceManagementUser.type} | N/A | N/A | Deletes the Management User with the given ID from the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../device_identities | N/A | WiredElementList | Returns all the device identity configuration |
| POST | .../device_identities | DeviceIdentity | DeviceIdentity | Adds the given device identity configuration to the model. |
| GET | .../device_identities-cdp | N/A | WiredElementList | Returns all the device identity for cdp configuration |
| POST | .../device_identities-cdp | DeviceIdentityCdp | DeviceIdentityCdp | Adds the given cdp device identity configuration to the model. |
| GET | .../device_identities-cdp/{DeviceIdentityCdp.device_name}-{DeviceIdentityCdp.cdp_type}-{DeviceIdentityCdp.cdp_value} | N/A | DeviceIdentityCdp | Returns the given device identity for cdp configuration |
| PUT | .../device_identities-cdp/{DeviceIdentityCdp.device_name}-{DeviceIdentityCdp.cdp_type}-{DeviceIdentityCdp.cdp_value} | DeviceIdentityCdp | DeviceIdentityCdp | Update the given device identity cdp configuration to the model. |
| DELETE | .../device_identities-cdp/{DeviceIdentityCdp.device_name}-{DeviceIdentityCdp.cdp_type}-{DeviceIdentityCdp.cdp_value} | N/A | N/A | Deletes the given device identity cdp configuration |
| GET | .../device_identities/{DeviceIdentity.device_name} | N/A | DeviceIdentity | Returns the given device identity configuration |
| PUT | .../device_identities/{DeviceIdentity.device_name} | DeviceIdentity | DeviceIdentity | Update the given device identity configuration to the model. |
| DELETE | .../device_identities/{DeviceIdentity.device_name} | N/A | N/A | Deletes the given device identity configuration |
| GET | .../device_profiles | N/A | WiredElementList | Returns all device-profile configurations. |
| POST | .../device_profiles | DeviceProfileConfig | DeviceProfileConfig | Adds the given device-profile configuration to the model. |
| GET | .../device_profiles-vlans | N/A | WiredElementList | Returns all device-profile associations. |
| POST | .../device_profiles-vlans | DeviceProfileVlan | DeviceProfileVlan | Adds the given device-profile association to the model. |
| GET | .../device_profiles-vlans/{DeviceProfileVlan.device_profile_name}-{DeviceProfileVlan.tagged_vlan_id} | N/A | DeviceProfileVlan | Returns the device-profile vlan configuration. |
| DELETE | .../device_profiles-vlans/{DeviceProfileVlan.device_profile_name}-{DeviceProfileVlan.tagged_vlan_id} | N/A | N/A | Deletes device-profile vlans |
| GET | .../device_profiles/{DeviceProfileConfig.device_profile_name} | N/A | DeviceProfileConfig | Returns the device-profile configuration. |
| PUT | .../device_profiles/{DeviceProfileConfig.device_profile_name} | DeviceProfileConfig | DeviceProfileConfig | Update the given device-profile configuration to the model. |
| DELETE | .../device_profiles/{DeviceProfileConfig.device_profile_name} | N/A | N/A | Deletes device-profile configuration |
| GET | .../device_profiles/status | N/A | WiredElementList | Returns the device profile status configuration. |
| GET | .../device_types | N/A | WiredElementList | Returns all device type configurations. |
| GET | .../device_types/{DeviceTypeConfig.device_type} | N/A | DeviceTypeConfig | Returns the device type configuration. |
| PUT | .../device_types/{DeviceTypeConfig.device_type} | DeviceTypeConfig | DeviceTypeConfig | Update the given device type configuration to the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../dhcp-relay | N/A | DhcpRelay | Returns the DHCP-Relay global attributes. |
| PUT | .../dhcp-relay | DhcpRelay | DhcpRelay | Update the DHCP-Relay global attributes. |
| GET | .../dhcp-relay/option_82 | N/A | DhcpRelayOption82 | Returns the DHCP Relay Option 82 |
| PUT | .../dhcp-relay/option_82 | DhcpRelayOption82 | DhcpRelayOption82 | Updates the given DHCP Relay Option 82 |
| GET | .../dhcp/options | N/A | DhcpOptions | Returns the status of DHCP Options |
| PUT | .../dhcp/options | DhcpOptions | DhcpOptions | Updates the status of given DHCP Options |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../vlans/dhcp-relay | N/A | WiredElementList | Returns the all helper addresses under all vlans. |
| POST | .../vlans/dhcp-relay | DhcpRelayVlan | DhcpRelayVlan | Adds the given DHCP Relay VLAN with helper address in the model. |
| GET | .../vlans/dhcp-relay/{DhcpRelayVlan.vlan_id}-{DhcpRelayVlan.dhcp_helper_address.octets} | N/A | DhcpRelayVlan | Returns the DHCP Relay VLAN with helper address |
| DELETE | .../vlans/dhcp-relay/{DhcpRelayVlan.vlan_id}-{DhcpRelayVlan.dhcp_helper_address.octets} | N/A | N/A | Deletes the DHCP Relay VLAN Helper address from a VLAN ID. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../dhcp-server | N/A | DhcpServer | Returns the DHCP-Server. |
| PUT | .../dhcp-server | DhcpServer | DhcpServer | Updates DHCP-Server in the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../dhcp-server/pools | N/A | WiredElementList | Returns DHCP-Server pools. |
| POST | .../dhcp-server/pools | DhcpServerPool | DhcpServerPool | Adds the given DHCP-Server pool to the model. |
| GET | .../dhcp-server/pools/{DhcpServerPool.pool_name} | N/A | DhcpServerPool | Returns the DHCP-Server pool by name. |
| DELETE | .../dhcp-server/pools/{DhcpServerPool.pool_name} | N/A | N/A | Deletes DHCP-Server pool by name. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../dns | N/A | Dns | Returns the host system attributes. |
| PUT | .../dns | Dns | Dns | Updates the host system attributes. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../dot1x | N/A | Dot1x | Returns the global 802.1X configuration. |
| PUT | .../dot1x | Dot1x | Dot1x | Updates the global 802.1X configuration. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../dot1x/authentication_method | N/A | Dot1xAuthenticationMethod | Returns the 802.1X Authentication method details. |
| PUT | .../dot1x/authentication_method | Dot1xAuthenticationMethod | Dot1xAuthenticationMethod | Updates the given 802.1X Authentication method details. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../dot1x/authenticator | N/A | WiredElementList | Returns the list of 802.1X Authenticator Port elements matching the given query. |
| GET | .../dot1x/authenticator/{Dot1xAuthenticatorPort.port_id} | N/A | Dot1xAuthenticatorPort | Returns the 802.1X Authenticator Port matching the given ID. |
| PUT | .../dot1x/authenticator/{Dot1xAuthenticatorPort.port_id} | Dot1xAuthenticatorPort | Dot1xAuthenticatorPort | Updates the given 802.1X Authenticator Port in the model. |
| POST | .../dot1x/authenticator/{Dot1xAuthenticatorPort.port_id}/clearstats | N/A | N/A | Clear statistics of dot1x authenticator based on port id |
| GET | .../dot1x/authenticator/{Dot1xAuthenticatorClientStats.port_id}/client_stats | N/A | Dot1xAuthenticatorClientStats | Returns the 802.1X Authenticator client session statistics matching the given port. |
| POST | .../dot1x/authenticator/{Dot1xAuthenticatorPort.port_id}/initialize | N/A | N/A | Initialize of dot1x authenticator based on port id |
| POST | .../dot1x/authenticator/{Dot1xAuthenticatorPort.port_id}/reauthenticate | N/A | N/A | Reauthenticate of dot1x authenticator based on port id |
| GET | .../dot1x/authenticator/{Dot1xAuthenticatorSessionCounters.port_id}/session_counters | N/A | Dot1xAuthenticatorSessionCounters | Returns the 802.1X Authenticator session counters matching the given port. |
| GET | .../dot1x/authenticator/{Dot1xAuthenticatorStats.port_id}/stats | N/A | Dot1xAuthenticatorStats | Returns the 802.1X Authenticator statistics matching the given port. |
| GET | .../dot1x/authenticator/{Dot1xAuthenticatorStatus.port_id}/status | N/A | Dot1xAuthenticatorStatus | Returns the 802.1X Authenticator status matching the given port. |
| GET | .../dot1x/authenticator/client_stats | N/A | WiredElementList | Returns the list of 802.1X Authenticator client session statistics elements matching the given query. |
| GET | .../dot1x/authenticator/session_counters | N/A | WiredElementList | Returns the list of 802.1X Authenticator session counters elements matching the given query. |
| GET | .../dot1x/authenticator/stats | N/A | WiredElementList | Returns the list of 802.1X Authenticator statistics elements matching the given query. |
| GET | .../dot1x/authenticator/status | N/A | WiredElementList | Returns the list of 802.1X Authenticator status elements matching the given query. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../dot1x/device_identity | N/A | WiredElementList | Returns all dot1x device identity for cdp-bypass configuration |
| POST | .../dot1x/device_identity | Dot1xDeviceIdentity | Dot1xDeviceIdentity | Adds the given dot1x device identity for cdp-bypass to the model. |
| GET | .../dot1x/device_identity/{Dot1xDeviceIdentity.device_name}-{Dot1xDeviceIdentity.port_id} | N/A | Dot1xDeviceIdentity | Returns the given dot1x device identity for cdp-bypass configuration |
| PUT | .../dot1x/device_identity/{Dot1xDeviceIdentity.device_name}-{Dot1xDeviceIdentity.port_id} | Dot1xDeviceIdentity | Dot1xDeviceIdentity | Update the given dot1x device identity for cdp-bypass to the model. |
| DELETE | .../dot1x/device_identity/{Dot1xDeviceIdentity.device_name}-{Dot1xDeviceIdentity.port_id} | N/A | N/A | Deletes the given dot1x device identity for cdp-bypass configuration |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../dot1x/port_security | N/A | WiredElementList | Returns the list of 802.1X Port Security elements matching the given query. |
| GET | .../dot1x/port_security/{Dot1xPortSecurity.port_id} | N/A | Dot1xPortSecurity | Returns the 802.1X Port security details matching the given ID. |
| PUT | .../dot1x/port_security/{Dot1xPortSecurity.port_id} | Dot1xPortSecurity | Dot1xPortSecurity | Updates the given 802.1X Port security in the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../dot1x/supplicant | N/A | CommonElementList | Returns the list of 802.1X Supplicant Port elements matching the given query. |
| GET | .../dot1x/supplicant/{Dot1xSupplicantPort.port_id} | N/A | Dot1xSupplicantPort | Returns the 802.1X Supplicant Port matching the given ID. |
| PUT | .../dot1x/supplicant/{Dot1xSupplicantPort.port_id} | Dot1xSupplicantPort | Dot1xSupplicantPort | Updates the given 802.1X Supplicant Port in the model. |
| POST | .../dot1x/supplicant/{Dot1xSupplicantPort.port_id}/clearstats | N/A | N/A | Clear statistics of dot1x supplicant based on port id |
| POST | .../dot1x/supplicant/{Dot1xSupplicantPort.port_id}/initialize | N/A | N/A | Initialize of dot1x supplicant based on port id |
| GET | .../dot1x/supplicant/{Dot1xSupplicantStats.port_id}/stats | N/A | Dot1xSupplicantStats | Returns the 802.1X Supplicant statistics matching the given port. |
| GET | .../dot1x/supplicant/stats | N/A | CommonElementList | Returns the list of 802.1X Supplicant statistics elements matching the given query. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../dsnoop | N/A | Dsnoop | Returns the DHCP-Snooping global attributes. |
| PUT | .../dsnoop | Dsnoop | Dsnoop | Update the DHCP-Snooping global attributes. |
| GET | .../dsnoop/authorized_server | N/A | WiredElementList | Returns the DHCP-Snooping authorized server details. |
| POST | .../dsnoop/authorized_server | DsnoopAuthServer | DsnoopAuthServer | Add a DHCP Snooping Authorized server to the system. |
| GET | .../dsnoop/authorized_server/{DsnoopAuthServer.authorized_server.octets} | N/A | DsnoopAuthServer | GET a DHCP Snooping Authorized server from the system. |
| DELETE | .../dsnoop/authorized_server/{DsnoopAuthServer.authorized_server.octets} | N/A | N/A | Remove a DHCP Snooping Authorized server from the system. |
| GET | .../dsnoop/option_82 | N/A | DsnoopOption82 | Returns the DHCP-Snooping option 82 attributes. |
| PUT | .../dsnoop/option_82 | DsnoopOption82 | DsnoopOption82 | Update the DHCP-Snooping option 82 attributes. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../system/encrypt-credentials | N/A | EncryptCredentials | Returns the Encrypt-Credentials settings. |
| PUT | .../system/encrypt-credentials | EncryptCredentials | EncryptCredentials | Updates the encrypt-Credentials settings. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../system-event-log | EventLogged | LoggedEventResponseList | Download/Query logged events from system |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../event-subscription | N/A | SubscriptionStatusList | Returns the subscription status list |
| POST | .../event-subscription | SubscriptionRequest | SubscriptionStatus | Subscribe to receive events |
| GET | .../event-subscription/{SubscriptionStatus.subscription_id} | N/A | SubscriptionStatus | Returns the subscription status |
| PUT | .../event-subscription/{SubscriptionStatus.subscription_id} | SubscriptionRequest | SubscriptionStatus | Update subscription |
| DELETE | .../event-subscription/{SubscriptionStatus.subscription_id} | N/A | N/A | Delete subscription |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../fastboot | N/A | Fastboot | Returns Fastboot system attribute. |
| PUT | .../fastboot | Fastboot | Fastboot | Updates Fastboot system attribute. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../file-transfer | FileTransferCommand | Void | Triggers a file transfer based on the given parameters. |
| GET | .../file-transfer/status | N/A | FileTransferStatus | Returns the status of file transfer process. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../igmp | N/A | Igmp | Returns IGMP global configuration. |
| PUT | .../igmp | Igmp | Igmp | Updates the IGMP global configuration. |
| GET | .../igmp/ports | N/A | WiredElementList | Returns the list of IGMP fastlearn Port elements matching the given query. |
| GET | .../igmp/ports/{IgmpPort.port_id} | N/A | IgmpPort | Returns IGMP port fastlearn details. |
| PUT | .../igmp/ports/{IgmpPort.port_id} | IgmpPort | IgmpPort | Updates the IGMP port fastlearn details. |
| POST | .../igmp/reload | N/A | N/A | Reset IGMP state on all interfaces |
| GET | .../igmp/vlans | N/A | WiredElementList | Returns the list of VLAN IGMP elements matching the given query. |
| GET | .../igmp/vlans/ports | N/A | WiredElementList | Returns the list of VLAN IGMP port configuration elements matching the given query. |
| GET | .../igmp/vlans/static_groups | N/A | WiredElementList | Returns the list of VLAN IGMP static groups configuration elements matching the given query. |
| POST | .../igmp/vlans/static_groups | VlanIgmpStaticGroup | VlanIgmpStaticGroup | Creates the given VLAN IGMP static groups configuration in the model. |
| GET | .../igmp/vlans/static_groups/{VlanIgmpStaticGroup.id} | N/A | VlanIgmpStaticGroup | Returns the VLAN IGMP static group configuration matching the given ID. |
| DELETE | .../igmp/vlans/static_groups/{VlanIgmpStaticGroup.id} | N/A | N/A | Deletes the VLAN IGMP static group configuration matching the given ID. |
| GET | .../igmp/vlans/stats | N/A | WiredElementList | Returns the list of VLAN IGMP Stats elements matching the given query. |
| GET | .../vlans/{VlanIgmp.vlan_id}/igmp | N/A | VlanIgmp | Returns the VLAN IGMP matching the given ID. |
| PUT | .../vlans/{VlanIgmp.vlan_id}/igmp | VlanIgmp | VlanIgmp | Updates the given VLAN IGMP in the model. |
| GET | .../vlans/{VlanIgmpPort.vlan_id}/igmp/ports/{VlanIgmpPort.port_id} | N/A | VlanIgmpPort | Returns the VLAN IGMP port configuration matching the given ID. |
| PUT | .../vlans/{VlanIgmpPort.vlan_id}/igmp/ports/{VlanIgmpPort.port_id} | VlanIgmpPort | VlanIgmpPort | Updates the given VLAN IGMP port configuration in the model. |
| GET | .../vlans/{VlanIgmp.vlan_id}/igmp/stats | N/A | VlanIgmpStats | Returns the VLAN IGMP Stats matching the given ID. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../system/include-credentials | N/A | IncludeCredentials | Returns the Include-Credentials settings. |
| PUT | .../system/include-credentials | IncludeCredentials | IncludeCredentials | Updates the Include-Credentials settings. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../ipaddresses | N/A | CommonElementList | Returns the list of IP Address Subnets elements matching the given query. |
| GET | .../vlans/{IpAddressSubnet.vlan_id}/ipaddresses | N/A | CommonElementList | Returns all IP Address Subnets for the specified VLAN. |
| POST | .../vlans/{IpAddressSubnet.vlan_id}/ipaddresses | IpAddressSubnet | IpAddressSubnet | Adds the given IP Address Subnet in the model. |
| DELETE | .../vlans/{IpAddressSubnet.vlan_id}/ipaddresses | N/A | N/A | Deletes all IP Address Subnets for the specified VLAN. |
| GET | .../vlans/{IpAddressSubnet.vlan_id}/ipaddresses/{IpAddressSubnet.ip_address_mode}-{IpAddressSubnet.ip_address.octets} | N/A | IpAddressSubnet | Returns 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/A | N/A | Deletes specified IP Address Subnet for the specified VLAN.
For IAAM_DHCP mode, octets will not be present in the uri. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../ip_auth | N/A | WiredElementList | Returns the list of Ip Auth Configuration matching the given query. |
| POST | .../ip_auth | IpAuth | IpAuth | Adds the given IP Auth Configuration to the system. |
| GET | .../ip_auth/{IpAuth.id} | N/A | IpAuth | Returns the IP Auth Configuration matching the given ID. |
| PUT | .../ip_auth/{IpAuth.id} | IpAuth | IpAuth | Updates the given IP Auth Configuration to the system. |
| DELETE | .../ip_auth/{IpAuth.id} | N/A | N/A | Deletes the Ip Auth Configuration with the given ID from the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../ip/client_tracker | N/A | IpClientTracker | Returns Ip Client Tracker attributes. |
| PUT | .../ip/client_tracker | IpClientTracker | IpClientTracker | Update the Ip Client Tracker attributes. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../ip_icmp | N/A | IpIcmp | Returns IP ICMP attributes. |
| PUT | .../ip_icmp | IpIcmp | IpIcmp | Updates IP ICMP attributes. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../ip-route | N/A | CommonElementList | Returns the list of IP Route elements matching the given query. |
| POST | .../ip-route | IpRoute | IpRoute | Adds the given IP Route in the model. |
| GET | .../ip-route/{IpRoute.id} | N/A | IpRoute | Returns the IP Route matching the given ID. |
| PUT | .../ip-route/{IpRoute.id} | IpRoute | IpRoute | Updates the given IP Route matching the given ID. |
| DELETE | .../ip-route/{IpRoute.id} | N/A | N/A | Deletes the IP Route with the given ID from the model. |
| GET | .../ip-route/settings | N/A | IpRouteSettings | Returns the global IP Route settings. |
| PUT | .../ip-route/settings | IpRouteSettings | IpRouteSettings | Updates the global IP Route settings. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../ip-slas/{IpSlaConfig.ipsla_id}/clearstats | N/A | N/A | Clears History and Message statistics of IP-SLA based on IPSLA ID |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../ipsla_responders/clear_stats/{IpSlaResponder.responder_type}-{IpSlaResponder.destination_address.octets}-{IpSlaResponder.destination_port}-{IpSlaResponder.source_address.octets} | N/A | N/A | Clears statistics of IP-SLA responder based on responder details |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../ip-slas | N/A | WiredElementList | Returns the list of IP-SLA elements matching the given query. |
| POST | .../ip-slas | IpSlaConfig | IpSlaConfig | Adds the given IP-SLA to the model. |
| GET | .../ip-slas/{IpSlaConfig.ipsla_id} | N/A | IpSlaConfig | Returns the IP-SLA matching the given ID. |
| DELETE | .../ip-slas/{IpSlaConfig.ipsla_id} | N/A | N/A | Deletes the IP-SLA with the given ID from the model. |
| GET | .../ip-slas/{IpSlaStatus.ipsla_id}/status | N/A | IpSlaStatus | Returns the IP-SLA matching the given ID. |
| PUT | .../ip-slas/{IpSlaStatus.ipsla_id}/status | IpSlaStatus | IpSlaStatus | Updates the IP-SLA status matching the given ID. |
| GET | .../ip-slas/history/{IpSlaHistory.ipsla_id} | N/A | IpSlaHistory | Returns the IP-SLA history matching the given ID. |
| GET | .../ip-slas/jitter-voip/aggregated_results/{IpSlaJitterVoipResults.ipsla_id} | N/A | IpSlaJitterVoipResults | Returns 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/A | IpSlaJitterVoipResults | Returns the IP-SLA results for UDP Jitter/ Jitter-For-Voip for the given ID. |
| GET | .../ip-slas/stats/{IpSlaMessageStats.ipsla_id} | N/A | IpSlaMessageStats | Returns the IP-SLA stats matching the given ID. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../ipsla_responders | N/A | WiredElementList | Returns IP-SLA Responder List |
| POST | .../ipsla_responders | IpSlaResponder | IpSlaResponder | Adds 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/A | IpSlaResponder | Returns 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/A | N/A | Deletes IP-SLA responder by given responder details |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../ipslas_responders/statistics/{IpSlaResponder.responder_type}-{IpSlaResponder.destination_address.octets}-{IpSlaResponder.destination_port}-{IpSlaResponder.source_address.octets} | N/A | IpSlaResponderStats | Returns the IP-SLA responder statistics by responder details |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../ip_source_interface | N/A | IpSourceInterface | Returns all IP source-interfaces. |
| GET | .../ip_source_interface/{IpSourceInterface.protocol} | N/A | IpSourceInterface | Returns IP source-interface based on the protocol. |
| PUT | .../ip_source_interface/{IpSourceInterface.protocol} | IpSourceInterface | IpSourceInterface | Update 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. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../isolate-list | N/A | WiredElementList | Returns the list of all configured Isolate-List elements. |
| POST | .../isolate-list | IsolateList | IsolateList | Adds the given port into Isolate-List in the specified Vlan id. |
| GET | .../isolate-list/{IsolateList.vlan_id}-{IsolateList.port_id} | N/A | IsolateList | Returns the Isolate-List matching for the given Vlan & Port ID. |
| DELETE | .../isolate-list/{IsolateList.vlan_id}-{IsolateList.port_id} | N/A | N/A | Deletes the given Isolate-List port assignment from the vlan. |
| GET | .../isolate-list/vlan/{Vlan.vlan_id} | N/A | WiredElementList | Returns the list of all Isolate-List elements matching the given Vlan ID. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../lacp/port | N/A | WiredElementList | Returns the list port trunk configurations |
| POST | .../lacp/port | Lacp | Lacp | Adds port to a Lacp Trunk |
| GET | .../lacp/port/{Lacp.port_id} | N/A | Lacp | Returns the LACP Port Configuration |
| DELETE | .../lacp/port/{Lacp.port_id} | N/A | N/A | Deletes Port From A Lacp trunk; |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../lldp | N/A | Lldp | Get LLDP Global Status |
| PUT | .../lldp | Lldp | Lldp | LLDP Global Configurations |
| GET | .../lldp/auto_provision/radio_ports | N/A | LldpAutoProvisionRadioPorts | Retrieve LLDP radio port automatic provisioning |
| PUT | .../lldp/auto_provision/radio_ports | LldpAutoProvisionRadioPorts | LldpAutoProvisionRadioPorts | Set LLDP radio port automatic provisioning |
| GET | .../lldp/local-port | N/A | CommonElementList | Retrieve the complete list of LLDP Local Port elements including OOBM port |
| GET | .../lldp/local-port/{LldpLocalPort.port_name} | N/A | LldpLocalPort | Get LLDP Local Port Configurations |
| PUT | .../lldp/local-port/{LldpLocalPort.port_name} | LldpLocalPort | LldpLocalPort | Set LLDP Local Port Configurations |
| GET | .../lldp/local-port/oobm | N/A | LldpOobmPort | Retrieve LLDP OOBM Port Configurations |
| PUT | .../lldp/local-port/oobm | LldpOobmPort | LldpOobmPort | Set LLDP OOBM Port Configurations |
| GET | .../lldp/local_device/info | N/A | LldpLocalDevice | Retrieve the LLDP Local Device Information. |
| GET | .../lldp/local_device/ports | N/A | CommonElementList | Retrieve the LLDP Local Information of all ports including OOBM. |
| GET | .../lldp/local_device/ports/{LldpLocalDevicePort.port_name} | N/A | LldpLocalDevicePort | Retrieve the LLDP Local Information per port. |
| GET | .../lldp/local_device/ports/oobm | N/A | LldpLocalDevicePort | Retrieve the Local OOBM port Information. |
| GET | .../lldp/remote-device | N/A | CommonElementList | Retrieve the LLDP Remote Information including devices connected to OOBM. |
| GET | .../lldp/remote-device/{LldpRemoteDevice.local_port} | N/A | LldpRemoteDevice | Retrieve the LLDP Remote Information per port. |
| GET | .../lldp/remote-device/oobm | N/A | LldpOobmRemoteDevice | Retrieve the OOBM Remote Information. |
| GET | .../lldp/stats/device | N/A | LldpDeviceStats | Retrieve the LLDP Neighbour Stats. |
| GET | .../lldp/stats/ports | N/A | CommonElementList | Retrieve the LLDP Port Stats for all ports including OOBM. |
| GET | .../lldp/stats/ports/{LldpPortStats.port_name} | N/A | LldpPortStats | Retrieve the LLDP per Port Stats. |
| GET | .../lldp/stats/ports/oobm | N/A | LldpPortStats | Retrieve the LLDP OOBM Stats. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../local_user | N/A | WiredElementList | Returns the local user configuration matching the given user name Configuration. |
| POST | .../local_user | LocalUser | LocalUser | Adds a local user to the authorized group. |
| GET | .../local_user/{LocalUser.local_user_name} | N/A | LocalUser | Returns the local user configuration matching the given user name Configuration. |
| PUT | .../local_user/{LocalUser.local_user_name} | LocalUser | LocalUser | Updates the local user Configuration matching the given user name. |
| DELETE | .../local_user/{LocalUser.local_user_name} | N/A | N/A | Deletes the local user Configuration with the given user name from the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../led_locator_info | N/A | LocatorLedInfo | Returns the LED Locator information. |
| GET | .../led_locator_info/{LocatorLedBlinkCommand.member_id} | N/A | LocatorLedResult | Returns the LED Locator information by member. |
| POST | .../locator-led-blink | LocatorLedBlinkCommand | N/A | Triggers a locator led blink based on the given parameters. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../loop_protect | N/A | LoopProtect | Returns the attributes of loop protection |
| PUT | .../loop_protect | LoopProtect | LoopProtect | Updates attributes of Loop Protection |
| GET | .../loop_protect/ports | N/A | WiredElementList | Returns Loop Protect configuration for all ports. |
| GET | .../loop_protect/ports/{LoopProtectPort.port_id} | N/A | LoopProtectPort | Returns Loop Protect per port details |
| PUT | .../loop_protect/ports/{LoopProtectPort.port_id} | LoopProtectPort | LoopProtectPort | Updates attributes of Loop Protect per port. |
| GET | .../loop_protect/vlans | N/A | WiredElementList | Retrieves Loop Protect vlans |
| GET | .../loop_protect/vlans/{LoopProtectVlan.vlan_id} | N/A | LoopProtectVlan | Retrieves Loop Protect vlans by vlan_id |
| PUT | .../loop_protect/vlans/{LoopProtectVlan.vlan_id} | LoopProtectVlan | LoopProtectVlan | Updates Loop Protect vlans by vlan_id |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../mac-authentication | N/A | MacAuthentication | Returns the global MAC authentication configuration. |
| PUT | .../mac-authentication | MacAuthentication | MacAuthentication | Updates the global MAC authentication configuration. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../mac-authentication/port | N/A | WiredElementList | Returns the list of MAC Authentication Port elements matching the given query. |
| GET | .../mac-authentication/port/{MacAuthenticationPort.port_id} | N/A | MacAuthenticationPort | Returns the MAC Authentication Port matching the given ID. |
| PUT | .../mac-authentication/port/{MacAuthenticationPort.port_id} | MacAuthenticationPort | MacAuthenticationPort | Updates the given MAC Authentication Port in the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../lockout_mac | N/A | WiredElementList | Returns all the locked out mac address list |
| POST | .../lockout_mac | LockoutMac | LockoutMac | Adds the given mac address to lockout list for blacklisting |
| DELETE | .../lockout_mac/{LockoutMac.mac_address} | N/A | N/A | Deletes the mac address from the lockout list |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../mac-table | N/A | WiredElementList | Returns a list of all MAC entries (capped to 1K right now). |
| GET | .../mac-table/{MacAddress.octets} | N/A | MacTableEntry | Returns the MAC table entry for the given MAC address. |
| GET | .../ports/{Port.id}/mac-table | N/A | WiredElementList | Returns list of MAC entries learned on a given Port ID. |
| GET | .../vlans/{Vlan.vlan_id}/mac-table | N/A | WiredElementList | Returns list of MAC entries learned on a given VLAN ID. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../modules | N/A | Module | Returns the Module Information. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../oobm | N/A | Oobm | Returns the OOBM settings. |
| PUT | .../oobm | Oobm | Oobm | Updates the OOBM settings. |
| GET | .../oobm/interface | N/A | OobmInterface | Returns the OOBM Interface settings of non-stacked switches |
| PUT | .../oobm/interface | OobmInterface | OobmInterface | Updates the OOBM Interface settings of non-stacked switches |
| GET | .../oobm/interface/members | N/A | OobmInterfaceMembers | Returns the OOBM Interface settings for all members in stacked switches |
| GET | .../oobm/interface/members/{OobmInterface.member_id} | N/A | OobmInterface | Returns the OOBM Interface settings per member_id in stacked switches |
| PUT | .../oobm/interface/members/{OobmInterface.member_id} | OobmInterface | OobmInterface | Updates the OOBM Interface settings per member_id in stacked switches |
| GET | .../oobm/interface/members/{OobmInterfaceStats.member_id}/stats | N/A | OobmInterfaceStats | Returns the OOBM Interface stats per member_id in stacked switches |
| GET | .../oobm/interface/members/stats | N/A | OobmInterfaceMembersStats | Returns the OOBM Interface stats for all members in stacked switches |
| GET | .../oobm/interface/stats | N/A | OobmInterfaceStats | Returns the OOBM Interface stats of non-stacked switches |
| GET | .../oobm/ip | N/A | OobmIp | Returns the Global OOBM IP settings |
| PUT | .../oobm/ip | OobmIp | OobmIp | Updates the Global OOBM IP settings |
| GET | .../oobm/ip/members | N/A | OobmIpMembers | Returns the OOBM IP settings for all members in stacked switches |
| GET | .../oobm/ip/members/{OobmIp.member_id} | N/A | OobmIp | Returns the OOBM IP settings per member_id in stacked switches |
| PUT | .../oobm/ip/members/{OobmIp.member_id} | OobmIp | OobmIp | Updates the OOBM IP settings per member_id in stacked switches |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../packet_capture | PacketCapture | PacketCapture | Adds the packet capture rule for the MAC on a given port. |
| DELETE | .../packet_capture/{mac_address}-{port_id} | N/A | N/A | Deletes the packet capture rule for the MAC on a given port. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../ping | PingCommand | PingCommandResult | Triggers a ping based on the given parameters. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../members/{MemberPoe.member_id}/poe | N/A | MemberPoe | Returns the member PoE details matching the given member ID in stacking enabled switches. |
| PUT | .../members/{MemberPoe.member_id}/poe | MemberPoe | MemberPoe | Updates the given member PoE details matching the given member ID in stacking enabled switches. |
| GET | .../poe/members | N/A | WiredElementList | Returns the list of member elements matching the given query in stacking enabled switches. |
| GET | .../poe/ports | N/A | WiredElementList | Returns the list of Port PoE elements matching the given query. |
| POST | .../poe/ports/{PortPoe.port_id}/reset | N/A | N/A | Reset the PoE controller to which the port belongs. |
| GET | .../poe/ports/stats | N/A | WiredElementList | Returns the list of Port PoE Stats elements matching the given query. |
| GET | .../poe/slots | N/A | WiredElementList | Returns the list of Slot PoE elements matching the given query. |
| GET | .../ports/{PortPoe.port_id}/poe | N/A | PortPoe | Returns the Port PoE matching the given ID. |
| PUT | .../ports/{PortPoe.port_id}/poe | PortPoe | PortPoe | Updates the given Port PoE in the model. |
| GET | .../ports/{PortPoe.port_id}/poe/stats | N/A | PortPoeStats | Returns the Port PoE stats matching the given ID. |
| GET | .../slots/{SlotPoe.slot_name}/poe | N/A | SlotPoe | Returns the Slot PoE matching the given ID. |
| PUT | .../slots/{SlotPoe.slot_name}/poe | SlotPoe | SlotPoe | Updates the given Slot PoE. |
| GET | .../system/status/power/consumption | N/A | SystemPowerConsumptionStatsArray | Returns the Power-Consumption status of the host system. |
| GET | .../system/status/power/supply | N/A | SystemPowerSupplyStatsElement | Returns the Power-Supply status of the host system. |
| GET | .../system/status/power/supply/{SystemPowerSupplyStats.member_id} | N/A | SystemPowerSupplyStatsElement | Returns the Power-Supply status of the host system by member id in stacked switch |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../port-statistics | N/A | CommonElementList | Returns All Ports statistics. |
| GET | .../port-statistics/{PortStatistics.id} | N/A | PortStatistics | Returns the Port statistics matching the given ID. |
| GET | .../ports | N/A | CommonElementList | Returns the list of Port elements matching the given query. |
| GET | .../ports/{Port.id} | N/A | Port | Returns the Port matching the given ID. |
| PUT | .../ports/{Port.id} | Port | Port | Updates the given Port in the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../port-mirror | N/A | WiredElementList | Returns the list of Port Mirror Session elements matching the given query. |
| POST | .../port-mirror | PortMirrorSession | PortMirrorSession | Adds the given Port Mirror Session to the model. |
| GET | .../port-mirror/{PortMirrorSession.session_id} | N/A | PortMirrorSession | Returns the Port Mirror Session matching the given ID. |
| PUT | .../port-mirror/{PortMirrorSession.session_id} | PortMirrorSession | PortMirrorSession | Updates the given Port Mirror Session in the model. |
| DELETE | .../port-mirror/{PortMirrorSession.session_id} | N/A | N/A | Deletes the Port Mirror Session with the given ID from the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../ports/icmp_rate_limit | N/A | WiredElementList | Returns ICMP rate limit configurations for all ports |
| GET | .../ports/icmp_rate_limit/{PortIcmpRateLimit.port_id} | N/A | PortIcmpRateLimit | Returns port ICMP rate limit per port id |
| PUT | .../ports/icmp_rate_limit/{PortIcmpRateLimit.port_id} | PortIcmpRateLimit | PortIcmpRateLimit | Updates attributes of port ICMP rate limit per port id |
| POST | .../ports/icmp_rate_limit_trap_clear/{PortIcmpRateLimitTrapClear.port_id} | PortIcmpRateLimitTrapClear | N/A | Clears an existing ICMP rate limiting trap condition. |
| GET | .../ports/queues_rate_limit | N/A | WiredElementList | Returns Egress queues rate limit configurations for all ports |
| GET | .../ports/queues_rate_limit/{PortQueuesRateLimit.port_id}-{PortQueuesRateLimit.queues_direction} | N/A | PortQueuesRateLimit | Returns egress queues rate limit per port id |
| PUT | .../ports/queues_rate_limit/{PortQueuesRateLimit.port_id}-{PortQueuesRateLimit.queues_direction} | PortQueuesRateLimit | PortQueuesRateLimit | Updates attributes of egress queues rate limit per port id |
| GET | .../ports/rate_limit | N/A | WiredElementList | Returns 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/A | PortRateLimit | Returns port rate limit per port id, traffic type and direction |
| PUT | .../ports/rate_limit/{PortRateLimit.port_id}-{PortRateLimit.traffic_type}-{PortRateLimit.direction} | PortRateLimit | PortRateLimit | Updates attributes of port rate limit per port id, traffic type and direction |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../intrusion_logs | N/A | WiredElementList | Returns the intrusion logs |
| GET | .../portsec_policies | N/A | WiredElementList | Returns the list of Port Security elements matching the given query. |
| GET | .../portsec_policies/{PortSecurityPolicy.port_id} | N/A | PortSecurityPolicy | Returns the Port Security matching the given ID. |
| PUT | .../portsec_policies/{PortSecurityPolicy.port_id} | PortSecurityPolicy | PortSecurityPolicy | Updates the given Port Security in the model. |
| GET | .../portsec_policies/{PortSecMacAddress.port_id}/mac_addresses/{PortSecMacAddress.mac_address.octets} | N/A | PortSecMacAddress | Returns 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/A | N/A | Deletes a given Port Security authorized mac address configured.
MAC format in uri should be xxx-xxx. |
| GET | .../portsec_policies/mac_addresses | N/A | WiredElementList | Returns all the Port Security authorized mac address configured. |
| POST | .../portsec_policies/mac_addresses | PortSecMacAddress | PortSecMacAddress | Adds an authorized mac address to port. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../private-vlans | N/A | CommonElementList | Returns all the primary/isolated/community details. |
| GET | .../private-vlans/isl-ports | N/A | CommonElementList | Return list of isl ports associated to primary VID's. |
| GET | .../private-vlans/promiscuous-ports | N/A | CommonElementList | Return list of promiscuous ports associated to primary VID's. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../qos/dscp-map | N/A | CommonElementList | Returns the list of QoS DSCP Map elements matching the given query. |
| GET | .../qos/dscp-map/{QosDscpMap.dscp_value} | QosDscpMap | QosDscpMap | Returns the QoS DSCP Map matching the given ID. |
| PUT | .../qos/dscp-map/{QosDscpMap.dscp_value} | QosDscpMap | QosDscpMap | Updates the given QoS DSCP Map in the model. |
| GET | .../qos/policies | N/A | CommonElementList | Returns the list of QoS Policy elements matching the given query. |
| POST | .../qos/policies | QosPolicy | QosPolicy | Adds the given QoS Policy to the model. |
| GET | .../qos/policies-actions | N/A | CommonElementList | Returns the list of all QoS Policy actions. |
| GET | .../qos/policies/{QosPolicy.id} | QosPolicy | QosPolicy | Returns the QoS Policy matching the given ID. |
| DELETE | .../qos/policies/{QosPolicy.id} | N/A | N/A | Deletes the QoS Policy with the given ID from the model. |
| GET | .../qos/policies/{QosPolicy.id}/policy-actions | QosPolicy | CommonElementList | Returns the list of QoS Policy Action elements matching the given query. |
| POST | .../qos/policies/{QosPolicyAction.policy_id}/policy-actions | QosPolicyAction | QosPolicyAction | Adds the given QoS Policy Action to the model. |
| GET | .../qos/policies/{QosPolicyAction.policy_id}/policy-actions/{QosPolicyAction.sequence_no} | QosPolicyAction | QosPolicyAction | Returns the QoS Policy Action matching the given ID. |
| PUT | .../qos/policies/{QosPolicyAction.policy_id}/policy-actions/{QosPolicyAction.sequence_no} | QosPolicyAction | QosPolicyAction | Updates the given QoS Policy Action in the model. |
| DELETE | .../qos/policies/{QosPolicyAction.policy_id}/policy-actions/{QosPolicyAction.sequence_no} | N/A | N/A | Deletes the QoS Policy Action with the given ID from the model. |
| POST | .../qos/policies/{ResequenceCommand.policy_id}/policy-actions/resequence | ResequenceCommand | N/A | Triggers a resequence of QoS Policy Action elements based on the given parameters. |
| GET | .../qos/traffic-classes | N/A | CommonElementList | Returns the list of QoS Traffic Class elements matching the given query. |
| POST | .../qos/traffic-classes | QosTrafficClass | QosTrafficClass | Adds the given QoS Traffic Class to the model. |
| GET | .../qos/traffic-classes-matches | N/A | CommonElementList | Returns the QoS Class Matches for all the traffic classes. |
| GET | .../qos/traffic-classes/{QosTrafficClass.id} | QosTrafficClass | QosTrafficClass | Returns the QoS Traffic Class matching the given ID. |
| DELETE | .../qos/traffic-classes/{QosTrafficClass.id} | N/A | N/A | Deletes the QoS Traffic Class with the given ID from the model. |
| GET | .../qos/traffic-classes/{QosTrafficClass.id}/matches | QosTrafficClass | CommonElementList | Returns the list of QoS Class Match elements matching the given query. |
| POST | .../qos/traffic-classes/{QosClassMatch.traffic_class_id}/matches | QosClassMatch | QosClassMatch | Adds the given QoS Class Match to the model. |
| GET | .../qos/traffic-classes/{QosClassMatch.traffic_class_id}/matches/{QosClassMatch.sequence_no} | QosClassMatch | QosClassMatch | Returns the QoS Class Match matching the given ID. |
| PUT | .../qos/traffic-classes/{QosClassMatch.traffic_class_id}/matches/{QosClassMatch.sequence_no} | QosClassMatch | QosClassMatch | Updates the given QoS Class Match in the model. |
| DELETE | .../qos/traffic-classes/{QosClassMatch.traffic_class_id}/matches/{QosClassMatch.sequence_no} | N/A | N/A | Deletes the QoS Class Match with the given ID from the model. |
| POST | .../qos/traffic_classes/{ResequenceCommand.traffic_class_id}/matches/resequence | ResequenceCommand | N/A | Triggers a resequence of QoS Class Match elements based on the given parameters. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../qos/ports-policies | N/A | WiredElementList | Returns the list of QoS Port Policy elements matching the given query. |
| POST | .../qos/ports-policies | QosPortPolicy | QosPortPolicy | Adds the given QoS Port Policy to the model. |
| DELETE | .../qos/ports-policies/{QosPortPolicy.port_id}-{QosPortPolicy.policy_id}-{QosPortPolicy.direction} | N/A | N/A | Deletes the QoS Port Policy with the given ID from the model. |
| GET | .../qos/ports-policies/{QosPortPolicyStats.port_id}-{QosPortPolicyStats.policy_id}/stats | N/A | QosPortPolicyStats | Returns the QoS statistics for given policy and Port |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../qos/trust/ports | N/A | WiredElementList | Returns the QoS Trust configurations. |
| GET | .../qos/trust/ports/{QosTrust.port_id} | N/A | QosTrust | Returns the QoS Trust configuration by port_id. |
| PUT | .../qos/trust/ports/{QosTrust.port_id} | QosTrust | QosTrust | Update the QoS Trust configuration by port_id. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../qos/vlans-policies | N/A | WiredElementList | Returns the list of QoS VLAN Policy elements matching the given query. |
| POST | .../qos/vlans-policies | QosVlanPolicy | QosVlanPolicy | Adds the given QoS VLAN Policy to the model. |
| DELETE | .../qos/vlans-policies/{QosVlanPolicy.vlan_id}-{QosVlanPolicy.policy_id} | N/A | N/A | Deletes the QoS VLAN Policy with the given ID from the model. |
| GET | .../qos/vlans-policies/{QosVlanPolicy.vlan_id}-{QosVlanPolicy.policy_id}/stats | N/A | QosVlanPolicyStats | Returns the QoS statistics for given policy and VLAN |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../radius_accounting | N/A | RadiusAccountingStats | Returns the radius accounting statistics |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../radius_authentication | N/A | RadiusAuthStats | Returns the radius authentication statistics |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../radius_dyn_authorization | N/A | RadiusDynAuthorizationStats | Returns the radius dyn-authorization statistics |
| GET | .../radius_dyn_authorization/{RadiusDynAuthorizationStats.radius_server_id} | N/A | RadiusDynAuthorizationStats | Returns the radius dyn-authorization statistics based on server ID |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../radius_profile | N/A | RadiusProfile | Returns the radius profile information. |
| PUT | .../radius_profile | RadiusProfile | RadiusProfile | Updates the given Radius profile in the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../radius_servers | N/A | CommonElementList | Returns the radius server information. |
| POST | .../radius_servers | RadiusServer | RadiusServer | Create the given Radius server in the model. |
| GET | .../radius_servers/{RadiusServer.radius_server_id} | N/A | RadiusServer | Returns the given Radius server information. |
| PUT | .../radius_servers/{RadiusServer.radius_server_id} | RadiusServer | RadiusServer | Updates the given Radius server in the model. |
| DELETE | .../radius_servers/{RadiusServer.radius_server_id} | N/A | N/A | Deletes the given radius server from the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../radius/server_group | RadiusServerGroup | RadiusServerGroup | Adds the given Radius server group to the model. |
| GET | .../radius/server_group/{RadiusServerGroup.server_group_name} | N/A | RadiusServerGroup | Returns the Radius server group by name. |
| DELETE | .../radius/server_group/{RadiusServerGroup.server_group_name} | N/A | N/A | Deletes Radius server group by name. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../redundancy-management | N/A | RedundancyManagement | Returns the Redundancy Management settings. Applicable for Redundant Management switches |
| PUT | .../redundancy-management | RedundancyManagement | RedundancyManagement | Updates the Redundancy Management settings. Applicable for Redundant Management switches |
| GET | .../redundancy-management/stats | N/A | RedundancyManagementStatsTable | Returns the Redundancy Management stats. |
| POST | .../redundancy-management/switchover | N/A | N/A | Triggers a redundancy switchover. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../system/configuration_reset/patch_file | N/A | ErasePatchFile | Erase the stored patch file. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../login-sessions | RestLoginSessions | RestLoginSessionsResult | Allow user to login to the system |
| DELETE | .../login-sessions | N/A | N/A | Allow user to logout from the system |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../session-idle-timeout | N/A | RestSessionIdleTimeout | Returns the session idle timeout details. |
| PUT | .../session-idle-timeout | RestSessionIdleTimeout | RestSessionIdleTimeout | Updates the session idle timeout details. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../version | N/A | WiredElementList | Returns the REST Version details. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../smartrate/ports | N/A | CommonElementList | Returns the list of Smartrate Port elements matching the given query. |
| GET | .../smartrate/ports/{SmartratePort.port_id} | N/A | SmartratePort | Returns the Smartrate Port info and stats matching the given ID. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../snmp-server | N/A | SnmpServer | Returns properties of SNMP-Server. |
| PUT | .../snmp-server | SnmpServer | SnmpServer | Updates properties of SNMP-Server in the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../snmp-server/communities | N/A | WiredElementList | Returns the SNMP-Server Community list. |
| POST | .../snmp-server/communities | SnmpServerCommunity | SnmpServerCommunity | Adds SNMP-Server Communities in the model. |
| GET | .../snmp-server/communities/{SnmpServerCommunity.community_name} | N/A | SnmpServerCommunity | Returns the SNMP-Server Community by name. |
| PUT | .../snmp-server/communities/{SnmpServerCommunity.community_name} | N/A | SnmpServerCommunity | Updates the SNMP-Server Community by name. |
| DELETE | .../snmp-server/communities/{SnmpServerCommunity.community_name} | N/A | N/A | Deletes the SNMP-Server Community by name. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../snmp-server/hosts | N/A | WiredElementList | Returns the SNMP-Server Host details. |
| POST | .../snmp-server/hosts | SnmpServerHost | SnmpServerHost | Adds SNMP-Server Hosts in the model. |
| GET | .../snmp-server/hosts/{SnmpServerHost.host_ip}-{SnmpServerHost.community} | N/A | SnmpServerHost | Returns the SNMP-Server Host by name. |
| PUT | .../snmp-server/hosts/{SnmpServerHost.host_ip}-{SnmpServerHost.community} | SnmpServerHost | SnmpServerHost | Updates SNMP-Server Host in the model. |
| DELETE | .../snmp-server/hosts/{SnmpServerHost.host_ip}-{SnmpServerHost.community} | N/A | N/A | Deletes the SNMP-Server Host by name. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../snmp-server/mib | N/A | SnmpServerMib | Returns SNMP-Server MIB settings |
| PUT | .../snmp-server/mib | SnmpServerMib | SnmpServerMib | Updates SNMP-Server MIB settings in the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../snmp-server/response-source | N/A | SnmpServerResponseSource | Returns the SNMP-Server Response Source details. |
| PUT | .../snmp-server/response-source | SnmpServerResponseSource | SnmpServerResponseSource | Updates SNMP-Server Response Source in the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../snmp-server/trap-source | N/A | SnmpServerTrapSource | Returns the SNMP-Server Trap Source details. |
| PUT | .../snmp-server/trap-source | SnmpServerTrapSource | SnmpServerTrapSource | Updates SNMP-Server Trap Source in the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../snmp-server/traps | N/A | SnmpServerTraps | Returns the SNMP-Server Traps. |
| PUT | .../snmp-server/traps | SnmpServerTraps | SnmpServerTraps | Updates the SNMP-Server Traps in the model. |
| GET | .../snmp-server/traps/linktraps | N/A | WiredElementList | Returns the SNMP-Server Link Change Traps. |
| GET | .../snmp-server/traps/linktraps/{SnmpServerLinkChangeTrap.port_id} | N/A | SnmpServerLinkChangeTrap | Returns the SNMP-Server Link Traps for specified port. |
| PUT | .../snmp-server/traps/linktraps/{SnmpServerLinkChangeTrap.port_id} | SnmpServerLinkChangeTrap | SnmpServerLinkChangeTrap | Updates the SNMP-Server Link Traps for specified port in the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../snmpv3 | N/A | SnmpV3 | Returns the Snmpv3Server. |
| PUT | .../snmpv3 | SnmpV3 | SnmpV3 | Updates the Snmpv3Server. |
| GET | .../snmpv3/notify_names | N/A | WiredElementList | Returns all the Snmpv3Notify entries. |
| POST | .../snmpv3/notify_names | SnmpV3NotifyName | SnmpV3NotifyName | Adds the given Snmpv3Notify entry. |
| GET | .../snmpv3/notify_names/{SnmpV3NotifyName.notify_name} | N/A | SnmpV3NotifyName | Returns the specified Snmpv3Notify entry. |
| DELETE | .../snmpv3/notify_names/{SnmpV3NotifyName.notify_name} | N/A | N/A | Deletes the given Snmpv3Notify entry. |
| GET | .../snmpv3/params | N/A | WiredElementList | Returns all the Snmpv3Params entries. |
| POST | .../snmpv3/params | SnmpV3Param | SnmpV3Param | Adds the given Snmpv3Param entry. |
| GET | .../snmpv3/params/{SnmpV3Param.parameter_name} | N/A | SnmpV3Param | Returns the specified Snmpv3Param entry. |
| PUT | .../snmpv3/params/{SnmpV3Param.parameter_name} | SnmpV3Param | SnmpV3Param | Updates the given Snmpv3Param entry. |
| DELETE | .../snmpv3/params/{SnmpV3Param.parameter_name} | N/A | N/A | Deletes the given Snmpv3Param entry. |
| GET | .../snmpv3/target_addresses | N/A | WiredElementList | Returns all the Snmpv3TargetAddresses entries. |
| POST | .../snmpv3/target_addresses | SnmpV3TargetAddress | SnmpV3TargetAddress | Adds the given Snmpv3TargetAddress entry. |
| GET | .../snmpv3/target_addresses/{SnmpV3TargetAddress.target_address_name} | N/A | SnmpV3TargetAddress | Returns the specified Snmpv3TargetAddress entry. |
| PUT | .../snmpv3/target_addresses/{SnmpV3TargetAddress.target_address_name} | SnmpV3TargetAddress | SnmpV3TargetAddress | Updates the given Snmpv3TargetAddress entry. |
| DELETE | .../snmpv3/target_addresses/{SnmpV3TargetAddress.target_address_name} | N/A | N/A | Deletes the given Snmpv3TargetAddress entry. |
| GET | .../snmpv3/users | N/A | WiredElementList | Returns all the Snmpv3Users. |
| POST | .../snmpv3/users | SnmpV3User | SnmpV3User | Adds the given Snmpv3User. |
| GET | .../snmpv3/users/{SnmpV3User.user_name} | N/A | SnmpV3User | Returns the specified Snmpv3User. |
| PUT | .../snmpv3/users/{SnmpV3User.user_name} | SnmpV3User | SnmpV3User | Updates the given Snmpv3User. |
| DELETE | .../snmpv3/users/{SnmpV3User.user_name} | N/A | N/A | Deletes the given Snmpv3User. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../system/sntp | N/A | Sntp | Returns SNTP system attributes. |
| PUT | .../system/sntp | Sntp | Sntp | Updates SNTP system attributes. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../system/sntp_server | N/A | CommonElementList | Returns SNTP server system attributes. |
| POST | .../system/sntp_server | SntpServerDetails | SntpServerDetails | Add SNTP server system attributes. |
| GET | .../system/sntp_server/{SntpServerDetails.sntp_server_priority}-{SntpServerDetails.sntp_server_address} | N/A | SntpServerDetails | Returns SNTP server system attributes. |
| DELETE | .../system/sntp_server/{SntpServerDetails.sntp_server_priority}-{SntpServerDetails.sntp_server_address} | N/A | N/A | Delete SNTP server system attributes. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../stp | N/A | SpanningTree | Returns Spanning Tree global configuration. |
| PUT | .../stp | SpanningTree | SpanningTree | Updates attributes of SpanningTree |
| GET | .../stp/ports | N/A | WiredElementList | Returns Spanning Tree configuration for all ports. |
| GET | .../stp/ports/{SpanningTreePort.port_id} | N/A | SpanningTreePort | Returns Spanning Tree per port configuration |
| PUT | .../stp/ports/{SpanningTreePort.port_id} | SpanningTreePort | SpanningTreePort | Updates attributes of SpanningTree per port. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../switch-config | N/A | SwitchConfig | Returns the config. |
| POST | .../switch-config | SwitchConfigCmd | SwitchConfigCmdResult | Updates the given config to the model. |
| GET | .../switch-config/status | N/A | SwitchConfigStatus | Returns the config upload status. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../system/status/switch | N/A | SwitchSystemInfoStats | Returns the status of the Switch system. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../syslog | N/A | Syslog | Returns the syslog details. |
| PUT | .../syslog | Syslog | Syslog | Adds the given syslog configurations. |
| GET | .../syslog/servers | N/A | WiredElementList | Returns the syslog server details. |
| POST | .../syslog/servers | SyslogServer | SyslogServer | Adds the given syslog server configurations. |
| GET | .../syslog/servers/{SyslogServer.ip_address.octets} | N/A | SyslogServer | Returns the syslog server details by server. |
| PUT | .../syslog/servers/{SyslogServer.ip_address.octets} | SyslogServer | SyslogServer | Updates the Syslog server Configurations by server. |
| DELETE | .../syslog/servers/{SyslogServer.ip_address.octets} | N/A | N/A | Deletes the Syslog server Configurations by server. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../syslog/filters/{filter_name}/event-criterias | N/A | WiredElementList | Returns the syslog filter criteria details. |
| POST | .../syslog/filters/{filter_name}/event-criterias | SyslogEventCriteria | SyslogEventCriteria | Adds the given syslog filter criteria configurations. |
| GET | .../syslog/filters/{filter_name}/event-criterias/{criteria_id} | N/A | SyslogEventCriteria | Returns the syslog filter criteria details by Criteria id. |
| PUT | .../syslog/filters/{filter_name}/event-criterias/{criteria_id} | SyslogEventCriteria | SyslogEventCriteria | Update the Syslog EventCriteria Configurations by criteria id . |
| DELETE | .../syslog/filters/{filter_name}/event-criterias/{criteria_id} | N/A | N/A | Deletes the Syslog EventCriteria Configurations by criteria_id . |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../syslog/filters | N/A | WiredElementList | Returns the syslog filter details. |
| POST | .../syslog/filters | SyslogFilter | SyslogFilter | Adds the given syslog configurations. |
| GET | .../syslog/filters/{filter_name} | N/A | SyslogFilter | Get the Syslog Filter Configurations by filter name . |
| PUT | .../syslog/filters/{filter_name} | SyslogFilter | SyslogFilter | Update the Syslog Filter Configurations by filter name . |
| DELETE | .../syslog/filters/{filter_name} | N/A | N/A | Deletes the Syslog Filter Configurations by filter name . |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../system | N/A | SystemAttributes | Returns the host system attributes. |
| PUT | .../system | SystemAttributes | SystemAttributes | Updates the host system attributes. |
| POST | .../system/reboot | RebootCommand | N/A | Triggers a system reboot based on the given parameters. |
| POST | .../system/reboot/commander | N/A | N/A | Triggers a commander boot on stacked device |
| POST | .../system/reboot/member/{MemberSystemStatusInfo.member_id} | N/A | N/A | Triggers a member boot on stacked switch with given member_id |
| POST | .../system/reboot/standby | N/A | N/A | Triggers a standby boot on stacked device |
| GET | .../system/status | N/A | SystemInfoStats | Returns the status of the host system for standalone switches. |
| GET | .../system/status/global_info | N/A | StackSystemInfoStatsGlobal | Returns the global system information for stacked switches. |
| GET | .../system/status/members | N/A | CommonElementList | Returns the list of member specific system information for stacked switches. |
| GET | .../system/status/members/{MemberSystemStatusInfo.member_id} | N/A | MemberSystemStatusInfo | Returns the member specific system information for stacked switches. |
| GET | .../system/time | N/A | SystemTime | Returns the host system time configuration. |
| PUT | .../system/time | SystemTime | SystemTime | Updates the host system time configuration. |
| POST | .../system/time/set-manually | SetSystemDateTimeCommand | N/A | Sets the system date/time based on the given parameters. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../system_variables | N/A | WiredElementList | Returns the list of system variable elements matching the given query. |
| GET | .../system_variables/{SystemVariable.system_variable_id} | N/A | SystemVariable | Returns the system variables matching the given ID. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../tacacs_profile | N/A | TacacsProfile | Returns TACACS Profile. |
| PUT | .../tacacs_profile | TacacsProfile | TacacsProfile | Updates attributes of TACACS Profile. |
| GET | .../tacacs_profile/server | N/A | WiredElementList | Returns all TACACS Profile Servers |
| POST | .../tacacs_profile/server | TacacsServer | TacacsServer | Adds a server to TACACS Profile. |
| GET | .../tacacs_profile/server/{TacacsServer.server_ip.octets} | N/A | TacacsServer | Returns a TACACS Profile Server with matching IP Address |
| PUT | .../tacacs_profile/server/{TacacsServer.server_ip.octets} | TacacsServer | TacacsServer | Updates TACACS Server attributes with matching IP Address. |
| DELETE | .../tacacs_profile/server/{TacacsServer.server_ip.octets} | N/A | N/A | Removes TACACS Profile Server with matching IP Address |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../ta_profiles | N/A | WiredElementList | Returns the list of TA Profiles matching the given query. |
| POST | .../ta_profiles | TaProfile | TaProfile | Adds the given TA profile to the system. |
| GET | .../ta_profiles/{TaProfile.ta_name} | N/A | TaProfile | Returns the TA profile configuration matching the given profile name. |
| PUT | .../ta_profiles/{TaProfile.ta_name} | TaProfile | TaProfile | Updates the TA Profile Configuration matching the given profile name. |
| DELETE | .../ta_profiles/{TaProfile.ta_name} | N/A | N/A | Deletes the TA profile Configuration with the given profile name from the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../telnet/server | N/A | TelnetServer | Returns the telnet server configuration |
| PUT | .../telnet/server | TelnetServer | TelnetServer | Updates the telnet server configuration |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../tftp/client | N/A | TftpClient | Returns TFTP Client system attributes. |
| PUT | .../tftp/client | TftpClient | TftpClient | Updates TFTP Client system attributes. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../trace-route | TraceRouteCommand | TraceRouteCommandResult | Triggers a trace route based on the given parameters. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../transceivers | N/A | WiredElementList | Returns the list of Transceiver elements matching the given query. |
| GET | .../transceivers/{Transceiver.serial_number} | N/A | Transceiver | Returns the Transceiver matching the given ID. |
| GET | .../transceivers/{Transceiver.serial_number}/diagnostics | N/A | TransceiverDiagnostics | Returns the Transceiver Diagnostics matching the given ID. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../trunk/port | N/A | WiredElementList | Returns the list port trunk configurations |
| POST | .../trunk/port | Trunk | Trunk | Adds port to a Static Manual Trunk |
| GET | .../trunk/port/{Trunk.port_id} | N/A | Trunk | Returns the TRUNK Port Configuration |
| DELETE | .../trunk/port/{Trunk.port_id} | N/A | N/A | Deletes Port From A Trunk; |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../tunneled_node_server | N/A | TunneledNodeServer | Returns the Tunneled Node configurations. |
| PUT | .../tunneled_node_server | TunneledNodeServer | TunneledNodeServer | Update the Tunneled Node configurations. |
| GET | .../tunneled_node_server/ports | N/A | WiredElementList | Returns all the Tunneled Node Ports configurations. |
| GET | .../tunneled_node_server/ports/{TunneledNodePort.port_id} | N/A | TunneledNodePort | Returns the Tunneled Node configurations per port. |
| PUT | .../tunneled_node_server/ports/{TunneledNodePort.port_id} | TunneledNodePort | TunneledNodePort | Update the Tunneled Node Port configurations. |
| GET | .../tunneled_node_server/ports/{TunneledNodePortStatistics.port_id}/statistics | N/A | TunneledNodePortStatistics | Returns the Tunneled Node Server statistics per port. |
| GET | .../tunneled_node_server/ports/aggregate_statistics | N/A | TunneledNodeAggregateStatistics | Returns the Tunneled Node aggregate statistics. |
| GET | .../tunneled_node_server/ports/statistics | N/A | WiredElementList | Returns the Tunneled Node Server statistics for all ports. |
| GET | .../tunneled_node_server/user | N/A | WiredElementList | Returns the User Based Tunneled Node information. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../vlans | N/A | CommonElementList | Returns the list of VLAN elements matching the given query. |
| POST | .../vlans | Vlan | Vlan | Adds the given VLAN to the model. |
| GET | .../vlans/{Vlan.vlan_id} | N/A | Vlan | Returns the VLAN matching the given ID. |
| PUT | .../vlans/{Vlan.vlan_id} | Vlan | Vlan | Updates the given VLAN in the model. |
| DELETE | .../vlans/{Vlan.vlan_id} | N/A | N/A | Deletes the VLAN with the given ID from the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../vlans-ports | N/A | CommonElementList | Returns the list of VLAN-Port elements matching the given query. |
| POST | .../vlans-ports | VlanPort | VlanPort | Adds the given VLAN-Port using the specified mode. |
| GET | .../vlans-ports/{VlanPort.vlan_id}-{VlanPort.port_id} | N/A | VlanPort | Returns the VLAN-Port matching the given ID. |
| PUT | .../vlans-ports/{VlanPort.vlan_id}-{VlanPort.port_id} | VlanPort | VlanPort | Updates the given VLAN-Port using the specified mode. |
| DELETE | .../vlans-ports/{VlanPort.vlan_id}-{VlanPort.port_id} | N/A | N/A | Deletes the given VLAN-Port assignment from the model. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| POST | .../stacking/vsf/disable | N/A | N/A | Disable VSF stack |
| POST | .../stacking/vsf/enable | VsfEnableCommand | N/A | Enable and Modify domain of VSF stack |
| POST | .../stacking/vsf/member/remove | VsfRemoveMemberCommand | N/A | Removes the member specified by member id and reboots the member if reboot is true |
| POST | .../stacking/vsf/member/shutdown | VsfMemberShutdownCommand | N/A | Shutdown the member specified by member id |
| POST | .../stacking/vsf/sequenced_reboot | VsfSequencedRebootCommand | N/A | Initiate a reboot of the VSF virtual chassis |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../stacking/vsf/global_config | N/A | VsfGlobalConfig | Returns the VSF Global Configuration. |
| PUT | .../stacking/vsf/global_config | VsfGlobalConfig | VsfGlobalConfig | Updates the VSF Global Configuration. |
| GET | .../stacking/vsf/info | N/A | VsfStackInfo | Returns the VSF stack Information. |
| GET | .../stacking/vsf/members | N/A | WiredElementList | Returns the list of VSF Members matching the given query. |
| POST | .../stacking/vsf/members | VsfMember | VsfMember | Adds the given VSF Member to the system. |
| GET | .../stacking/vsf/members/{VsfMember.member_id} | N/A | VsfMember | Returns the VSF Member Configuration matching the given ID. |
| PUT | .../stacking/vsf/members/{VsfMember.member_id} | VsfMember | VsfMember | Updates the VSF Member Configuration matching the given ID. |
| GET | .../stacking/vsf/members/{member_id}/links | N/A | WiredElementList | Returns the list of VSF Links matching the given query. |
| POST | .../stacking/vsf/members/{VsfLink.member_id}/links | VsfLink | VsfLink | Adds the given VSF Link to the system. |
| GET | .../stacking/vsf/members/{VsfLink.member_id}/links/{VsfLink.link_id} | N/A | VsfLink | Returns the VSF Link Configuration matching the given ID. |
| PUT | .../stacking/vsf/members/{VsfLink.member_id}/links/{VsfLink.link_id} | VsfLink | VsfLink | Updates the VSF Link Configuration matching the given ID. |
| DELETE | .../stacking/vsf/members/{VsfLink.member_id}/links/{VsfLink.link_id} | N/A | N/A | Deletes the VSF Link with the given ID from the model. |
| GET | .../stacking/vsf/members/{member_id}/links/{link_id}/ports | N/A | WiredElementList | Returns the list of VSF Ports matching the given query. |
| POST | .../stacking/vsf/members/{VsfPort.member_id}/links/{VsfPort.link_id}/ports | VsfPort | VsfPort | Adds the given VSF Port to the link |
| DELETE | .../stacking/vsf/members/{VsfPort.member_id}/links/{VsfPort.link_id}/ports/{VsfPort.port_id} | N/A | N/A | Deletes the VSF Port from the link |
| GET | .../stacking/vsf/members/system_info | N/A | WiredElementList | Returns the list of VSF Member Information matching the given query. |
| GET | .../stacking/vsf/members/system_info/{VsfMemberSystemInfo.member_id} | N/A | VsfMemberSystemInfo | Returns the VSF Member Information matching the given ID. |
| GET | .../stacking/vsf/members_links_ports | N/A | VsfMembersLinksPorts | Returns the list of VSF Members-Links-Ports Associations in the system. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../webauth | N/A | WebAuth | Returns the global WEB Auth configuration. |
| PUT | .../webauth | WebAuth | WebAuth | Updates the global WEB Auth configuration. |
| HTTP Method | Resource | Request | Response | Description |
|---|---|---|---|---|
| GET | .../webauth/port | N/A | WiredElementList | Returns the list of WEB Auth Port elements matching the given query. |
| GET | .../webauth/port/{WebAuthPort.port_id} | N/A | WebAuthPort | Returns the WEB Auth Port matching the given ID. |
| PUT | .../webauth/port/{WebAuthPort.port_id} | WebAuthPort | WebAuthPort | Updates the given WEB Auth Port in the model. |