Skip to content

ipsec_tunnels_stats

Overview

This resource provides IPSec Tunnels Statistics

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/monitor/
Schemes : HTTP

Tags

  • ipsec_tunnels_stats : Operations related to ipsec_tunnels_stats

Paths

Get operation for ipsec_tunnels_stats

GET /ipsec_tunnels_stats

Description

Use this operation to get IPSec Tunnels statistics. Filter and Pagination are supported for this API. Refer Getting Started Guide where filtering and pagination is explained via example of application monitoring API

Responses

HTTP Code Description Schema
200 API Successfully executed ipsec_tunnels_stats_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • ipsec_tunnels_stats

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

MTU

MTU for current IPSec Tunnel

Type : integer

bytes_dropped

Total bytes dropped

Type : integer

ipsec_tunnels_stats_delete_success_schema

Name Schema
ipsec_tunnels_stats
optional
ipsec_tunnels_stats

ipsec_tunnels_stats

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

ipsec_tunnels_stats_post_success_schema

Name Schema
ipsec_tunnels_stats
optional
ipsec_tunnels_stats

ipsec_tunnels_stats

Name Description Schema
message
optional
Example : "resource added succesfully" string

ipsec_tunnels_stats_put_success_schema

Name Schema
ipsec_tunnels_stats
optional
ipsec_tunnels_stats

ipsec_tunnels_stats

Name Description Schema
message
optional
Example : "resource modified succesfully" string

ipsec_tunnels_stats_response_schema

Type : < ipsec_tunnels_stats_response_schema > array

ipsec_tunnels_stats_response_schema

Name Schema
MTU
optional
MTU
bytes_dropped
optional
bytes_dropped
kbps_received
optional
kbps_received
kbps_sent
optional
kbps_sent
name
optional
name
packets_dropped
optional
packets_dropped
packets_received
optional
packets_received
packets_sent
optional
packets_sent
routing_domain_name
optional
routing_domain_name
service_type
optional
service_type
state
optional
state

kbps_received

Total bytes received

Type : integer

kbps_sent

Total bytes received

Type : integer

name

Name of the IPSec Tunnels

Type : string

packets_dropped

Total packets dropped

Type : integer

packets_received

Total packets received

Type : integer

packets_sent

Total packets sent

Type : integer

routing_domain_name

Routing Domain Name to which IPSec Tunnel belong

Type : string

service_type

Service Type of the IPSec Tunnel

Type : string

state

State of the IPSec Tunnels

Type : string