BgpCfg (onos-bgp-api 1.4.0 API)

```
public interface BgpCfg
```
Abstraction of an BGP configuration. Manages the BGP configuration from CLI to the BGP controller.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class BgpCfg.State

Nested Classes
Modifier and Type	Interface and Description
`static class`	`BgpCfg.State`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`addPeer(String routerid, int remoteAs)` Add the BGP peer IP address and the AS number to which it belongs.
`boolean`	`addPeer(String routerid, int remoteAs, short holdTime)` Add the BGP peer IP address, the AS number to which it belongs and keep alive time.
`boolean`	`addPeer(String routerid, short holdTime)` Add the BGP peer IP address and the keep alive time.
`boolean`	`connectPeer(String routerid)` Connect to BGP peer with this IP address.
`boolean`	`disconnectPeer(String routerid)` Disconnect this BGP peer with this IP address.
`TreeMap<String,BgpPeerCfg>`	`displayPeers()` Returns the peer tree information.
`BgpPeerCfg`	`displayPeers(String routerid)` Return the BGP Peer information with this matching IP.
`int`	`getAsNumber()` Get the AS number to which this BGP speaker belongs.
`short`	`getHoldTime()` Returns the connection hold timer in seconds.
`boolean`	`getLargeASCapability()` Get the status of the 32 bit AS support for this BGP speaker.
`boolean`	`getLsCapability()` Get the status of the link state support for this BGP speaker.
`int`	`getMaxConnRetryCount()` Get the connection retry count number.
`int`	`getMaxConnRetryTime()` Get the connection retry time in seconds.
`int`	`getMaxSession()` Returns the maximum number of session supported.
`BgpPeerCfg.State`	`getPeerConnState(String routerid)` Get the current peer connection state information.
`TreeMap<String,BgpPeerCfg>`	`getPeerTree()` Return the peer tree map.
`String`	`getRouterId()` Returns the Router ID of this BGP speaker.
`BgpCfg.State`	`getState()` Returns the status of the configuration based on this state certain operations like connection is handled.
`boolean`	`isPeerConfigured(String routerid)` Check if this BGP peer is configured.
`boolean`	`isPeerConnectable(String routerid)` Check if the peer can be connected or not.
`boolean`	`isPeerConnected(String routerid)` Check if this BGP speaker is having connection with the peer.
`boolean`	`removePeer(String routerid)` Remove the BGP peer with this IP address.
`void`	`setAsNumber(int localAs)` Set the AS number to which this BGP speaker belongs.
`void`	`setHoldTime(short holdTime)` Set the keep alive timer for the connection.
`void`	`setLargeASCapability(boolean largeAs)` Set the 32 bit AS support capability to this BGP speaker.
`void`	`setLsCapability(boolean lscapability)` Set the link state support to this BGP speaker.
`void`	`setMaxConnRetryCout(int retryCount)` Set the connection retry count.
`void`	`setMaxConnRetryTime(int retryTime)` Set the connection retry time in seconds.
`void`	`setMaxSession(int maxsession)` Set the maximum number of sessions to support.
`void`	`setPeerConnState(String routerid, BgpPeerCfg.State state)` Set the current connection state information.
`void`	`setRouterId(String routerid)` Set the Router ID of this BGP speaker.
`void`	`setState(BgpCfg.State state)` To set the current state of the configuration.

- Method Detail
  - getState
```
BgpCfg.State getState()
```
    Returns the status of the configuration based on this state certain operations like connection is handled.
    
    Returns:
    
    State of the configuration
  - setState
```
void setState(BgpCfg.State state)
```
    To set the current state of the configuration.
    
    Parameters:
    
    state - Configuration State enum
  - getLsCapability
```
boolean getLsCapability()
```
    Get the status of the link state support for this BGP speaker.
    
    Returns:
    
    true if the link state is supported else false
  - setLsCapability
```
void setLsCapability(boolean lscapability)
```
    Set the link state support to this BGP speaker.
    
    Parameters:
    
    lscapability - true value if link state is supported else false
  - getLargeASCapability
```
boolean getLargeASCapability()
```
    Get the status of the 32 bit AS support for this BGP speaker.
    
    Returns:
    
    true if the 32 bit AS number is supported else false
  - setLargeASCapability
```
void setLargeASCapability(boolean largeAs)
```
    Set the 32 bit AS support capability to this BGP speaker.
    
    Parameters:
    
    largeAs - true value if the 32 bit AS is supported else false
  - setAsNumber
```
void setAsNumber(int localAs)
```
    Set the AS number to which this BGP speaker belongs.
    
    Parameters:
    
    localAs - 16 or 32 bit AS number, length is dependent on the capability
  - getAsNumber
```
int getAsNumber()
```
    Get the AS number to which this BGP speaker belongs.
    
    Returns:
    
    16 or 32 bit AS number, length is dependent on the capability
  - getMaxConnRetryCount
```
int getMaxConnRetryCount()
```
    Get the connection retry count number.
    
    Returns:
    
    connection retry count if there is a connection error
  - setMaxConnRetryCout
```
void setMaxConnRetryCout(int retryCount)
```
    Set the connection retry count.
    
    Parameters:
    
    retryCount - number of times to try to connect if there is any error
  - getMaxConnRetryTime
```
int getMaxConnRetryTime()
```
    Get the connection retry time in seconds.
    
    Returns:
    
    connection retry time in seconds
  - setMaxConnRetryTime
```
void setMaxConnRetryTime(int retryTime)
```
    Set the connection retry time in seconds.
    
    Parameters:
    
    retryTime - connection retry times in seconds
  - setHoldTime
```
void setHoldTime(short holdTime)
```
    Set the keep alive timer for the connection.
    
    Parameters:
    
    holdTime - connection hold timer in seconds
  - getHoldTime
```
short getHoldTime()
```
    Returns the connection hold timer in seconds.
    
    Returns:
    
    connection hold timer in seconds
  - getMaxSession
```
int getMaxSession()
```
    Returns the maximum number of session supported.
    
    Returns:
    
    maximum number of session supported
  - setMaxSession
```
void setMaxSession(int maxsession)
```
    Set the maximum number of sessions to support.
    
    Parameters:
    
    maxsession - maximum number of session
  - getRouterId
```
String getRouterId()
```
    Returns the Router ID of this BGP speaker.
    
    Returns:
    
    IP address in string format
  - setRouterId
```
void setRouterId(String routerid)
```
    Set the Router ID of this BGP speaker.
    
    Parameters:
    
    routerid - IP address in string format
  - addPeer
```
boolean addPeer(String routerid,
                int remoteAs)
```
    Add the BGP peer IP address and the AS number to which it belongs.
    
    Parameters:
    
    routerid - IP address in string format
    
    remoteAs - AS number to which it belongs
    
    Returns:
    
    true if added successfully else false
  - addPeer
```
boolean addPeer(String routerid,
                short holdTime)
```
    Add the BGP peer IP address and the keep alive time.
    
    Parameters:
    
    routerid - IP address in string format
    
    holdTime - keep alive time for the connection
    
    Returns:
    
    true if added successfully else false
  - addPeer
```
boolean addPeer(String routerid,
                int remoteAs,
                short holdTime)
```
    Add the BGP peer IP address, the AS number to which it belongs and keep alive time.
    
    Parameters:
    
    routerid - IP address in string format
    
    remoteAs - AS number to which it belongs
    
    holdTime - keep alive time for the connection
    
    Returns:
    
    true if added successfully else false
  - removePeer
```
boolean removePeer(String routerid)
```
    Remove the BGP peer with this IP address.
    
    Parameters:
    
    routerid - router IP address
    
    Returns:
    
    true if removed successfully else false
  - connectPeer
```
boolean connectPeer(String routerid)
```
    Connect to BGP peer with this IP address.
    
    Parameters:
    
    routerid - router IP address
    
    Returns:
    
    true of the configuration is found and able to connect else false
  - disconnectPeer
```
boolean disconnectPeer(String routerid)
```
    Disconnect this BGP peer with this IP address.
    
    Parameters:
    
    routerid - router IP address in string format
    
    Returns:
    
    true if the configuration is found and able to disconnect else false
  - displayPeers
```
TreeMap<String,BgpPeerCfg> displayPeers()
```
    Returns the peer tree information.
    
    Returns:
    
    return the tree map with IP as key and BGPPeerCfg as object
  - displayPeers
```
BgpPeerCfg displayPeers(String routerid)
```
    Return the BGP Peer information with this matching IP.
    
    Parameters:
    
    routerid - router IP address in string format
    
    Returns:
    
    BGPPeerCfg object
  - isPeerConfigured
```
boolean isPeerConfigured(String routerid)
```
    Check if this BGP peer is configured.
    
    Parameters:
    
    routerid - router IP address in string format
    
    Returns:
    
    true if configured exists else false
  - isPeerConnected
```
boolean isPeerConnected(String routerid)
```
    Check if this BGP speaker is having connection with the peer.
    
    Parameters:
    
    routerid - router IP address in string format
    
    Returns:
    
    true if the connection exists else false
  - getPeerTree
```
TreeMap<String,BgpPeerCfg> getPeerTree()
```
    Return the peer tree map.
    
    Returns:
    
    return the tree map with IP as key and BGPPeerCfg as object
  - setPeerConnState
```
void setPeerConnState(String routerid,
                      BgpPeerCfg.State state)
```
    Set the current connection state information.
    
    Parameters:
    
    routerid - router IP address in string format
    
    state - state information
  - isPeerConnectable
```
boolean isPeerConnectable(String routerid)
```
    Check if the peer can be connected or not.
    
    Parameters:
    
    routerid - router IP address in string format
    
    Returns:
    
    true if the peer can be connected else false
  - getPeerConnState
```
BgpPeerCfg.State getPeerConnState(String routerid)
```
    Get the current peer connection state information.
    
    Parameters:
    
    routerid - router IP address in string format
    
    Returns:
    
    state information

Interface BgpCfg

Nested Class Summary

Method Summary

Method Detail

getState

setState

getLsCapability

setLsCapability

getLargeASCapability

setLargeASCapability

setAsNumber

getAsNumber

getMaxConnRetryCount

setMaxConnRetryCout

getMaxConnRetryTime

setMaxConnRetryTime

setHoldTime

getHoldTime

getMaxSession

setMaxSession

getRouterId

setRouterId

addPeer

addPeer

addPeer

removePeer

connectPeer

disconnectPeer

displayPeers

displayPeers

isPeerConfigured

isPeerConnected

getPeerTree

setPeerConnState

isPeerConnectable

getPeerConnState