API Guide

id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
field_name string
Field name where the error was seen
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
}]
}
20.4 GET /switches/{switch-id}/interfaces/{interface-id}/bfd
Get bfd information of port channel.
Get bfd information of a port channel interface for the given timestamp Timestamp is optional. If it not specied then it
returns information of current timestamp.
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*switch-id string
Unique identier of the switch.
*interface-id string
Unique identier of the interface.
QUERY PARAMETERS
NAME TYPE DESCRIPTION
timestamp int64
Timestamp at which interface information to be retrieved.
RESPONSE
STATUS CODE - 200: port channel information of a switch.
RESPONSE MODEL - application/json
{
bfd information
session_state enum ALLOWED:BFD_UNSET, INIT, DOWN, ADMIN_DOWN, UP
bfd session state.
desired_minimum_tx_interval integer
The minimum interval between transmission of BFD control packets that the
operator desires. This value is advertised to the peer, however the actual interval
used is specied by taking the maximum of desired-minimum-tx-interval and the
value of the remote required-minimum-receive interval value. It is in micro sec.
required_minimum_receive integer
The minimum interval between received BFD control packets that this system
should support. This value is advertised to the remote peer to indicate the
maximum frequency (i.e., minimum inter-packet interval) between BFD control
packets that is acceptable to the local system.
detection_multiplier integer
The number of packets that must be missed to declare this session as down.
The detection interval for the BFD session is calculated by multiplying the value
of the negotiated transmission interval by this value.
}
STATUS CODE - 401: You are not authorized to perform this operation.
RESPONSE MODEL - application/json
{
new_object_id string
This represents the id of the new object created for the POST API call.
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
257 of 340