Skip to content

pppoe_status

Overview

This resource provides details about PPPOE enabled VNI and status

Version information

Version : v2

URI scheme

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

Tags

  • pppoe_status : Operations related to pppoe_status

Paths

Get operation for pppoe_status

GET /pppoe_status

Description

Use this operation to get the pppoe session details. Pagination is not supported for this API

Responses

HTTP Code Description Schema
200 API Successfully executed pppoe_status_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

  • pppoe_status

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

gateway_ip_address

IP address of the Gateway

Type : string

local_ip_address

IP address learned for pppoe connection

Type : string

mac_associated_with_gateway_ip

MAC address associated with local ip

Type : string

pppoe_status_delete_success_schema

Name Schema
pppoe_status
optional
pppoe_status

pppoe_status

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

pppoe_status_post_success_schema

Name Schema
pppoe_status
optional
pppoe_status

pppoe_status

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

pppoe_status_put_success_schema

Name Schema
pppoe_status
optional
pppoe_status

pppoe_status

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

pppoe_status_response_schema

Type : < pppoe_status_response_schema > array

pppoe_status_response_schema

Name Schema
gateway_ip_address
optional
gateway_ip_address
local_ip_address
optional
local_ip_address
mac_associated_with_gateway_ip
optional
mac_associated_with_gateway_ip
session_id
optional
session_id
status
optional
status
status_message
optional
status_message
vni_name
optional
vni_name

session_id

PPPOE session ID

Type : string

status

PPPOE session status

Type : string

status_message

Comment related to the status of PPPOE session

Type : string

vni_name

Name of the Virtual Network Interface

Type : string